Merge pull request java-json-tools#1 from jasonchaffee/master

jasonchaffee · web-flow · commit 502f114ff08a · 2017-01-03T15:58:06.000-08:00
Adding a public accessor to JsonPatch to retrieve the contained operation and path
diff --git a/src/main/java/com/github/fge/jsonpatch/JsonPatch.java b/src/main/java/com/github/fge/jsonpatch/JsonPatch.java
@@ -177,4 +177,8 @@ public void serializeWithType(final JsonGenerator jgen,
     {
         serialize(jgen, provider);
     }
+
+    public List<JsonPatchOperation> getOperations() {
+        return ImmutableList.copyOf(operations);
+    }
 }
diff --git a/src/main/java/com/github/fge/jsonpatch/JsonPatchModule.java b/src/main/java/com/github/fge/jsonpatch/JsonPatchModule.java
@@ -0,0 +1,31 @@
+package com.github.fge.jsonpatch;
+
+import com.fasterxml.jackson.databind.jsontype.NamedType;
+import com.fasterxml.jackson.databind.module.SimpleModule;
+import com.github.fge.jsonpatch.operation.AddOperation;
+import com.github.fge.jsonpatch.operation.CopyOperation;
+import com.github.fge.jsonpatch.operation.MoveOperation;
+import com.github.fge.jsonpatch.operation.RemoveOperation;
+import com.github.fge.jsonpatch.operation.ReplaceOperation;
+import com.github.fge.jsonpatch.operation.TestOperation;
+
+/**
+ * This module registers the standard JSON-PATCH operations with Jackson.
+ */
+public class JsonPatchModule extends SimpleModule {
+    private static final long serialVersionUID = 1L;
+
+    /**
+     * Constructor
+     */
+    public JsonPatchModule() {
+        registerSubtypes(
+                new NamedType(AddOperation.class, AddOperation.OPERATION_NAME),
+                new NamedType(CopyOperation.class, CopyOperation.OPERATION_NAME),
+                new NamedType(MoveOperation.class, MoveOperation.OPERATION_NAME),
+                new NamedType(RemoveOperation.class, RemoveOperation.OPERATION_NAME),
+                new NamedType(ReplaceOperation.class, ReplaceOperation.OPERATION_NAME),
+                new NamedType(TestOperation.class, TestOperation.OPERATION_NAME)
+        );
+    }
+}
diff --git a/src/main/java/com/github/fge/jsonpatch/operation/DualPathOperation.java b/src/main/java/com/github/fge/jsonpatch/operation/DualPathOperation.java
@@ -63,6 +63,14 @@ protected DualPathOperation(final String op, final JsonPointer from,
         this.path = path;
     }
 
+    public String getOp() {
+        return this.op;
+    }
+
+    public JsonPointer getPath() {
+        return this.path;
+    }
+
     @Override
     public final void serialize(final JsonGenerator jgen,
         final SerializerProvider provider)
diff --git a/src/main/java/com/github/fge/jsonpatch/operation/JsonPatchOperation.java b/src/main/java/com/github/fge/jsonpatch/operation/JsonPatchOperation.java
@@ -23,6 +23,7 @@
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.JsonSerializable;
+import com.github.fge.jackson.jsonpointer.JsonPointer;
 import com.github.fge.jsonpatch.JsonPatchException;
 
 /**
@@ -55,6 +56,10 @@ public interface JsonPatchOperation
     public JsonNode apply(final JsonNode node)
         throws JsonPatchException;
 
+    public String getOp();
+
+    public JsonPointer getPath();
+
     @Override
     public String toString();
 }
diff --git a/src/main/java/com/github/fge/jsonpatch/operation/PathDualValueOperation.java b/src/main/java/com/github/fge/jsonpatch/operation/PathDualValueOperation.java
@@ -51,6 +51,14 @@ protected PathDualValueOperation(final String op, final JsonPointer path,
         this.toValue = toValue;
     }
 
+    public String getOp() {
+        return this.op;
+    }
+
+    public JsonPointer getPath() {
+        return this.path;
+    }
+
     @Override
     public final void serialize(final JsonGenerator jgen,
         final SerializerProvider provider)
diff --git a/src/main/java/com/github/fge/jsonpatch/operation/PathValueOperation.java b/src/main/java/com/github/fge/jsonpatch/operation/PathValueOperation.java
@@ -27,7 +27,6 @@
 import com.fasterxml.jackson.databind.jsontype.TypeSerializer;
 import com.github.fge.jackson.jsonpointer.JsonPointer;
 import com.github.fge.jsonpatch.JsonPatchMessages;
-import com.github.fge.jsonpatch.operation.JsonPatchOperation;
 import com.github.fge.msgsimple.bundle.MessageBundle;
 import com.github.fge.msgsimple.load.MessageBundles;
 
@@ -64,6 +63,14 @@ protected PathValueOperation(final String op, final JsonPointer path,
         this.value = value.deepCopy();
     }
 
+    public String getOp() {
+        return this.op;
+    }
+
+    public JsonPointer getPath() {
+        return this.path;
+    }
+
     @Override
     public final void serialize(final JsonGenerator jgen,
         final SerializerProvider provider)
diff --git a/src/main/java/com/github/fge/jsonpatch/operation/RemoveOperationBase.java b/src/main/java/com/github/fge/jsonpatch/operation/RemoveOperationBase.java
@@ -23,7 +23,6 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.core.JsonGenerator;
-import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.SerializerProvider;
 import com.fasterxml.jackson.databind.jsontype.TypeSerializer;
@@ -33,7 +32,6 @@
 import com.github.fge.jackson.jsonpointer.JsonPointer;
 import com.github.fge.jsonpatch.JsonPatchException;
 import com.github.fge.jsonpatch.JsonPatchMessages;
-import com.github.fge.jsonpatch.operation.JsonPatchOperation;
 import com.github.fge.jsonpatch.operation.policy.PathMissingPolicy;
 import com.github.fge.msgsimple.bundle.MessageBundle;
 import com.github.fge.msgsimple.load.MessageBundles;
@@ -50,7 +48,7 @@ public abstract class RemoveOperationBase
     protected static final MessageBundle BUNDLE
         = MessageBundles.getBundle(JsonPatchMessages.class);
 
-    private PathMissingPolicy pathMissingPolicy;
+    private final PathMissingPolicy pathMissingPolicy;
 
     protected final String op;
 
@@ -71,48 +69,56 @@ public JsonNode apply(final JsonNode node)
         throws JsonPatchException
     {
         final JsonNode ret = node.deepCopy();
-        if (path.isEmpty())
+        if (this.path.isEmpty())
             return MissingNode.getInstance();
-        if (path.path(node).isMissingNode()) {
-            switch (pathMissingPolicy) {
+        if (this.path.path(node).isMissingNode()) {
+            switch (this.pathMissingPolicy) {
                 case THROW:
                     throw new JsonPatchException(BUNDLE.getMessage(
                         "jsonPatch.noSuchPath"));
                 case SKIP:
                     return ret;
             }
         }
-        final JsonNode parentNode = path.parent().get(ret);
-        final String raw = Iterables.getLast(path).getToken().getRaw();
+        final JsonNode parentNode = this.path.parent().get(ret);
+        final String raw = Iterables.getLast(this.path).getToken().getRaw();
         if (parentNode.isObject())
             ((ObjectNode) parentNode).remove(raw);
         else
             ((ArrayNode) parentNode).remove(Integer.parseInt(raw));
         return ret;
     }
 
+    @Override
+	public String getOp() {
+        return this.op;
+    }
+
+    @Override
+	public JsonPointer getPath() {
+        return this.path;
+    }
+
     @Override
     public void serialize(final JsonGenerator jgen,
         final SerializerProvider provider)
-        throws IOException, JsonProcessingException
-    {
+        throws IOException {
         jgen.writeStartObject();
-        jgen.writeStringField("op", op);
-        jgen.writeStringField("path", path.toString());
+        jgen.writeStringField("op", this.op);
+        jgen.writeStringField("path", this.path.toString());
         jgen.writeEndObject();
     }
 
     @Override
     public void serializeWithType(final JsonGenerator jgen,
         final SerializerProvider provider, final TypeSerializer typeSer)
-        throws IOException, JsonProcessingException
-    {
+        throws IOException {
         serialize(jgen, provider);
     }
 
     @Override
     public String toString()
     {
-        return "op: " + op + "; path: \"" + path + '"';
+        return "op: " + this.op + "; path: \"" + this.path + '"';
     }
 }
diff --git a/src/test/java/com/github/fge/jsonpatch/JsonPatchTest.java b/src/test/java/com/github/fge/jsonpatch/JsonPatchTest.java
@@ -31,6 +31,7 @@
 import org.testng.annotations.Test;
 
 import java.io.IOException;
+import java.util.List;
 
 import static org.mockito.Mockito.*;
 import static org.testng.Assert.*;
@@ -120,4 +121,15 @@ public void whenOneOperationFailsNextOperationIsNotCalled()
 
         verifyZeroInteractions(op2);
     }
+
+    @Test
+    public void getOperationsReturnsTheCorrectOpsInTheCorrectOrder()
+    {
+        final JsonPatch patch = new JsonPatch(ImmutableList.of(op1, op2));
+
+        List<JsonPatchOperation> operations = patch.getOperations();
+        assertEquals(operations.size(), 2);
+        assertEquals(operations.get(0), op1);
+        assertEquals(operations.get(1), op2);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -177,4 +177,8 @@ public void serializeWithType(final JsonGenerator jgen,`
`177`	`177`	`{`
`178`	`178`	`serialize(jgen, provider);`
`179`	`179`	`}`
	`180`	`+`
	`181`	`+ public List<JsonPatchOperation> getOperations() {`
	`182`	`+ return ImmutableList.copyOf(operations);`
	`183`	`+ }`
`180`	`184`	`}`