initial working fix for #233

erosb · erosb · commit c72cf3cf9b5c · 2018-12-27T22:58:42.000+01:00
* wiring SchemaLocation into SchemaBuilder
 * adding `JSONPointer#getRefTokens()`
 * tracking the location in both `Schema#location` and `Schema#schemaLocation` (unfortunately the latter is protected so needs to be maintained)
 * adding `SchemaLocation#parseURI()` and using it in `ReferenceLookup`
diff --git a/core/src/main/java/org/everit/json/schema/JSONPointer.java b/core/src/main/java/org/everit/json/schema/JSONPointer.java
@@ -285,6 +285,10 @@ private Object readByIndexToken(Object current, String indexToken) throws JSONPo
         }
     }
 
+    List<String> getRefTokens() {
+        return refTokens;
+    }
+
     /**
      * Returns a string representing the JSONPointer path value using string
      * representation
diff --git a/core/src/main/java/org/everit/json/schema/Schema.java b/core/src/main/java/org/everit/json/schema/Schema.java
@@ -63,13 +63,12 @@ public Builder<S> id(String id) {
          */
         @Deprecated
         public Builder<S> schemaLocation(String schemaLocation) {
-            //            this.schemaLocation = schemaLocation;
-            //            return this;
-            throw new UnsupportedOperationException();
+            return schemaLocation(SchemaLocation.parseURI(schemaLocation));
         }
 
         public Builder<S> schemaLocation(SchemaLocation location) {
-            throw new UnsupportedOperationException();
+            this.schemaLocation = location;
+            return this;
         }
 
         public Builder<S> defaultValue(Object defaultValue) {
@@ -107,7 +106,10 @@ public Builder<S> unprocessedProperties(Map<String, Object> unprocessedPropertie
 
     private final String id;
 
-    protected final SchemaLocation schemaLocation;
+    @Deprecated
+    protected final String schemaLocation;
+
+    private final SchemaLocation location;
 
     private final Object defaultValue;
 
@@ -129,7 +131,8 @@ protected Schema(Builder<?> builder) {
         this.title = builder.title;
         this.description = builder.description;
         this.id = builder.id;
-        this.schemaLocation = builder.schemaLocation;
+        this.schemaLocation = builder.schemaLocation == null ? null : builder.schemaLocation.toString();
+        this.location = builder.schemaLocation;
         this.defaultValue = builder.defaultValue;
         this.nullable = builder.nullable;
         this.readOnly = builder.readOnly;
@@ -234,14 +237,11 @@ public String getId() {
     }
 
     public String getSchemaLocation() {
-        if (schemaLocation == null) {
-            return null;
-        }
-        return schemaLocation.toString();
+        return schemaLocation;
     }
 
     public SchemaLocation getLocation() {
-        return schemaLocation;
+        return location;
     }
 
     public Object getDefaultValue() {
diff --git a/core/src/main/java/org/everit/json/schema/SchemaLocation.java b/core/src/main/java/org/everit/json/schema/SchemaLocation.java
@@ -1,27 +1,54 @@
 package org.everit.json.schema;
 
 import static java.util.Collections.emptyList;
+import static java.util.Objects.requireNonNull;
 
 import java.net.URI;
+import java.net.URISyntaxException;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Objects;
 
 public class SchemaLocation {
 
     public static final SchemaLocation empty() {
         return new SchemaLocation(null, emptyList());
     }
 
-    private URI rootDocumentURI;
+    public static final SchemaLocation parseURI(String uri) {
+        try {
+            int hashmarkIdx = uri.indexOf("#");
+            if (hashmarkIdx > -1) {
+                String rootDocumentURI;
+                String rawPointer;
+                if (hashmarkIdx == uri.length() - 1) {
+                    rootDocumentURI = uri;
+                    rawPointer = "";
+                } else {
+                    rootDocumentURI = uri.substring(0, hashmarkIdx);
+                    rawPointer = uri.substring(hashmarkIdx + 1);
+                }
+                URI documentURI = "".equals(rootDocumentURI) ? null : new URI(rootDocumentURI);
+                return new SchemaLocation(documentURI, new JSONPointer(rawPointer).getRefTokens());
+            } else {
+                return new SchemaLocation(new URI(uri), emptyList());
+            }
+        } catch (URISyntaxException e) {
+            throw new RuntimeException(e);
+        }
+    }
 
-    private List<String> pointerToLocation;
+    private final URI rootDocumentURI;
+
+    private final List<String> pointerToLocation;
 
     public SchemaLocation(URI rootDocumentURI, List<String> pointerToLocation) {
         this.rootDocumentURI = rootDocumentURI;
-        this.pointerToLocation = pointerToLocation;
+        this.pointerToLocation = new ArrayList<>(requireNonNull(pointerToLocation, "pointerToLocation cannot be null"));
     }
 
     public SchemaLocation(List<String> pointerToLocation) {
+        rootDocumentURI = null;
         this.pointerToLocation = pointerToLocation;
     }
 
@@ -32,6 +59,20 @@ public SchemaLocation addPointerSegment(String key) {
         return new SchemaLocation(rootDocumentURI, newPointer);
     }
 
+    @Override public boolean equals(Object o) {
+        if (this == o)
+            return true;
+        if (!(o instanceof SchemaLocation))
+            return false;
+        SchemaLocation that = (SchemaLocation) o;
+        return Objects.equals(rootDocumentURI, that.rootDocumentURI) &&
+                pointerToLocation.equals(that.pointerToLocation);
+    }
+
+    @Override public int hashCode() {
+        return Objects.hash(rootDocumentURI, pointerToLocation);
+    }
+
     @Override
     public String toString() {
         StringBuilder buffer = new StringBuilder();
diff --git a/core/src/main/java/org/everit/json/schema/loader/ReferenceLookup.java b/core/src/main/java/org/everit/json/schema/loader/ReferenceLookup.java
@@ -161,8 +161,7 @@ Schema.Builder<?> lookup(String relPointerString, JsonObject ctx) {
         JsonPointerEvaluator.QueryResult result = pointer.query();
 
         SchemaLoader childLoader = ls.initChildLoader()
-                //                .pointerToCurrentObj(asList(absPointerString))
-                .pointerToCurrentObj(SchemaLocation.empty())
+                .pointerToCurrentObj(SchemaLocation.parseURI(absPointerString))
                 .resolutionScope(!isInternal ? withoutFragment(absPointerString) : ls.id)
                 .schemaJson(result.getQueryResult())
                 .rootSchemaJson(result.getContainingDocument()).build();
diff --git a/core/src/test/java/org/everit/json/schema/ArraySchemaTest.java b/core/src/test/java/org/everit/json/schema/ArraySchemaTest.java
@@ -179,7 +179,7 @@ public void uniqueObjectValues() {
     public void equalsVerifier() {
         EqualsVerifier.forClass(ArraySchema.class)
                 .withRedefinedSuperclass()
-                .withIgnoredFields("schemaLocation")
+                .withIgnoredFields("schemaLocation", "location")
                 .suppress(Warning.STRICT_INHERITANCE)
                 .verify();
     }
diff --git a/core/src/test/java/org/everit/json/schema/CombinedSchemaTest.java b/core/src/test/java/org/everit/json/schema/CombinedSchemaTest.java
@@ -118,7 +118,7 @@ public void reportCauses() {
     public void equalsVerifier() {
         EqualsVerifier.forClass(CombinedSchema.class)
                 .withRedefinedSuperclass()
-                .withIgnoredFields("schemaLocation")
+                .withIgnoredFields("schemaLocation", "location")
                 .suppress(Warning.STRICT_INHERITANCE)
                 .verify();
     }
diff --git a/core/src/test/java/org/everit/json/schema/EmptySchemaTest.java b/core/src/test/java/org/everit/json/schema/EmptySchemaTest.java
@@ -15,12 +15,13 @@
  */
 package org.everit.json.schema;
 
-import nl.jqno.equalsverifier.EqualsVerifier;
-import nl.jqno.equalsverifier.Warning;
 import org.json.JSONObject;
 import org.junit.Assert;
 import org.junit.Test;
 
+import nl.jqno.equalsverifier.EqualsVerifier;
+import nl.jqno.equalsverifier.Warning;
+
 public class EmptySchemaTest {
 
     @Test
@@ -74,7 +75,7 @@ public void testAllGenericProps() {
     public void equalsVerifier() {
         EqualsVerifier.forClass(EmptySchema.class)
                 .withRedefinedSuperclass()
-                .withIgnoredFields("schemaLocation")
+                .withIgnoredFields("schemaLocation", "location")
                 .suppress(Warning.STRICT_INHERITANCE)
                 .verify();
     }
diff --git a/core/src/test/java/org/everit/json/schema/EnumSchemaTest.java b/core/src/test/java/org/everit/json/schema/EnumSchemaTest.java
@@ -77,7 +77,7 @@ public void objectInArrayMatches() {
         possibleValues.add(arr);
 
         EnumSchema subject = subject().build();
-        
+
         subject.validate(new JSONArray("[{\"a\":true}]"));
     }
 
@@ -101,7 +101,7 @@ public void toStringTest() {
     public void equalsVerifier() {
         EqualsVerifier.forClass(EnumSchema.class)
                 .withRedefinedSuperclass()
-                .withIgnoredFields("schemaLocation")
+                .withIgnoredFields("schemaLocation", "location")
                 .suppress(Warning.STRICT_INHERITANCE)
                 .verify();
     }
diff --git a/core/src/test/java/org/everit/json/schema/NotSchemaTest.java b/core/src/test/java/org/everit/json/schema/NotSchemaTest.java
@@ -15,13 +15,14 @@
  */
 package org.everit.json.schema;
 
-import nl.jqno.equalsverifier.EqualsVerifier;
-import nl.jqno.equalsverifier.Warning;
-import org.junit.Test;
-
 import static org.everit.json.schema.TestSupport.buildWithLocation;
 import static org.junit.Assert.assertEquals;
 
+import org.junit.Test;
+
+import nl.jqno.equalsverifier.EqualsVerifier;
+import nl.jqno.equalsverifier.Warning;
+
 public class NotSchemaTest {
 
     @Test
@@ -42,7 +43,7 @@ public void success() {
     public void equalsVerifier() {
         EqualsVerifier.forClass(NotSchema.class)
                 .withRedefinedSuperclass()
-                .withIgnoredFields("schemaLocation")
+                .withIgnoredFields("schemaLocation", "location")
                 .suppress(Warning.STRICT_INHERITANCE)
                 .verify();
     }
diff --git a/core/src/test/java/org/everit/json/schema/NullSchemaTest.java b/core/src/test/java/org/everit/json/schema/NullSchemaTest.java
@@ -15,12 +15,13 @@
  */
 package org.everit.json.schema;
 
-import nl.jqno.equalsverifier.EqualsVerifier;
-import nl.jqno.equalsverifier.Warning;
+import static org.junit.Assert.assertEquals;
+
 import org.json.JSONObject;
 import org.junit.Test;
 
-import static org.junit.Assert.assertEquals;
+import nl.jqno.equalsverifier.EqualsVerifier;
+import nl.jqno.equalsverifier.Warning;
 
 public class NullSchemaTest {
 
@@ -42,7 +43,7 @@ public void success() {
     public void equalsVerifier() {
         EqualsVerifier.forClass(NullSchema.class)
                 .withRedefinedSuperclass()
-                .withIgnoredFields("schemaLocation")
+                .withIgnoredFields("schemaLocation", "location")
                 .suppress(Warning.STRICT_INHERITANCE)
                 .verify();
     }
diff --git a/core/src/test/java/org/everit/json/schema/NumberSchemaTest.java b/core/src/test/java/org/everit/json/schema/NumberSchemaTest.java
@@ -173,7 +173,7 @@ public void longNumber() {
     public void equalsVerifier() {
         EqualsVerifier.forClass(NumberSchema.class)
                 .withRedefinedSuperclass()
-                .withIgnoredFields("schemaLocation")
+                .withIgnoredFields("schemaLocation", "location")
                 .suppress(Warning.STRICT_INHERITANCE)
                 .verify();
     }
diff --git a/core/src/test/java/org/everit/json/schema/ObjectSchemaTest.java b/core/src/test/java/org/everit/json/schema/ObjectSchemaTest.java
@@ -382,7 +382,7 @@ public void typeFailure() {
     public void equalsVerifier() {
         EqualsVerifier.forClass(ObjectSchema.class)
                 .withRedefinedSuperclass()
-                .withIgnoredFields("schemaLocation")
+                .withIgnoredFields("schemaLocation", "location")
                 .withPrefabValues(Pattern.class, Pattern.compile("red"), Pattern.compile("black"))
                 .suppress(Warning.STRICT_INHERITANCE)
                 .verify();
diff --git a/core/src/test/java/org/everit/json/schema/ReferenceSchemaTest.java b/core/src/test/java/org/everit/json/schema/ReferenceSchemaTest.java
@@ -70,7 +70,7 @@ public void definesPropertyThrowsExc_IfNoReferredSchemaIsSet() {
     public void equalsVerifier() {
         EqualsVerifier.forClass(ReferenceSchema.class)
                 .withRedefinedSuperclass()
-                .withIgnoredFields("schemaLocation")
+                .withIgnoredFields("schemaLocation", "location")
                 //there are specifically some non final fields for loading of recursive schemas
                 .suppress(Warning.NONFINAL_FIELDS)
                 .suppress(Warning.STRICT_INHERITANCE)
diff --git a/core/src/test/java/org/everit/json/schema/SchemaLocationTest.java b/core/src/test/java/org/everit/json/schema/SchemaLocationTest.java
@@ -7,9 +7,13 @@
 
 import java.net.URI;
 import java.net.URISyntaxException;
+import java.util.ArrayList;
 
 import org.junit.Test;
 
+import nl.jqno.equalsverifier.EqualsVerifier;
+import nl.jqno.equalsverifier.Warning;
+
 public class SchemaLocationTest {
 
     private static URI uri(String uri) {
@@ -57,4 +61,51 @@ public void toString_uri_noPointer() {
         assertEquals("http://example.com/hello", underTest.toString());
     }
 
+    @Test(expected = NullPointerException.class)
+    public void parseURI_null() {
+        SchemaLocation.parseURI(null);
+    }
+
+    @Test
+    public void parseURI_noHashmark() {
+        SchemaLocation actual = SchemaLocation.parseURI("http://example.org");
+        assertEquals(new SchemaLocation(uri("http://example.org"), emptyList()), actual);
+    }
+
+    @Test
+    public void parseURI_emptyFragment() {
+        SchemaLocation actual = SchemaLocation.parseURI("http://example.org#");
+        assertEquals(new SchemaLocation(uri("http://example.org#"), emptyList()), actual);
+    }
+
+    @Test
+    public void parseURI_singleSegmentPointer() {
+        SchemaLocation actual = SchemaLocation.parseURI("http://example.org#/key");
+        SchemaLocation expected = new SchemaLocation(uri("http://example.org"), new ArrayList<>(asList("key")));
+        assertEquals(expected, actual);
+    }
+
+    @Test
+    public void parseURI_onlyPointer() {
+        SchemaLocation actual = SchemaLocation.parseURI("#/key");
+        SchemaLocation expected = new SchemaLocation(null, new ArrayList<>(asList("key")));
+        assertEquals(expected, actual);
+    }
+
+    @Test
+    public void parseURI_multiSegmentPointer() {
+        SchemaLocation actual = SchemaLocation.parseURI("http://example.org#/key1/key2");
+        assertEquals(new SchemaLocation(uri("http://example.org"), asList("key1", "key2")), actual);
+    }
+
+    @Test
+    public void equalsVerifier() {
+        EqualsVerifier.forClass(SchemaLocation.class)
+                .withRedefinedSuperclass()
+                .withNonnullFields("pointerToLocation")
+                .suppress(Warning.NONFINAL_FIELDS)
+                .suppress(Warning.STRICT_INHERITANCE)
+                .verify();
+    }
+
 }
diff --git a/core/src/test/java/org/everit/json/schema/StringSchemaTest.java b/core/src/test/java/org/everit/json/schema/StringSchemaTest.java
@@ -107,7 +107,7 @@ public void issue38Pattern() {
     public void equalsVerifier() {
         EqualsVerifier.forClass(StringSchema.class)
                 .withRedefinedSuperclass()
-                .withIgnoredFields("schemaLocation")
+                .withIgnoredFields("schemaLocation", "location")
                 .withPrefabValues(Pattern.class, Pattern.compile("red"), Pattern.compile("black"))
                 .suppress(Warning.STRICT_INHERITANCE)
                 .verify();
diff --git a/core/src/test/java/org/everit/json/schema/loader/JsonPointerEvaluatorTest.java b/core/src/test/java/org/everit/json/schema/loader/JsonPointerEvaluatorTest.java
@@ -30,7 +30,7 @@ public void sameDocumentSuccess() {
         JsonObject actual = pointer.query().getQueryResult().requireObject();
         assertEquals("dummy schema at #/definitions/Bar", actual.require("description").requireString());
         assertEquals("http://localhost:1234/folder/", actual.ls.id.toString());
-        assertEquals(asList("definitions", "Bar"), actual.ls.pointerToCurrentObj);
+        assertEquals(new SchemaLocation(asList("definitions", "Bar")), actual.ls.pointerToCurrentObj);
     }
 
     @Test(expected = SchemaException.class)
@@ -39,7 +39,7 @@ public void sameDocumentNotFound() {
         JsonObject actual = pointer.query().getQueryResult().requireObject();
         assertEquals("dummy schema at #/definitions/Bar", actual.require("description").requireString());
         assertEquals("http://localhost:1234/folder/", actual.ls.id.toString());
-        assertEquals(asList("definitions", "Bar"), actual.ls.pointerToCurrentObj);
+        assertEquals(new SchemaLocation(asList("definitions", "Bar")), actual.ls.pointerToCurrentObj);
     }
 
     @Test
@@ -81,7 +81,7 @@ public void remoteDocumentSuccess() {
         JsonObject actual = pointer.query().getQueryResult().requireObject();
         assertEquals("dummy schema at #/definitions/Bar", actual.require("description").requireString());
         assertEquals("http://localhost:1234/folder/", actual.ls.id.toString());
-        assertEquals(asList("definitions", "Bar"), actual.ls.pointerToCurrentObj);
+        assertEquals(new SchemaLocation(asList("definitions", "Bar")), actual.ls.pointerToCurrentObj);
     }
 
     protected InputStream rootSchemaJsonAsStream() {
diff --git a/core/src/test/java/org/everit/json/schema/loader/LoadingStateTest.java b/core/src/test/java/org/everit/json/schema/loader/LoadingStateTest.java
diff --git a/tests/vanilla/src/main/java/org/everit/json/schema/IssueTest.java b/tests/vanilla/src/main/java/org/everit/json/schema/IssueTest.java

Original file line number	Diff line number	Diff line change
`@@ -285,6 +285,10 @@ private Object readByIndexToken(Object current, String indexToken) throws JSONPo`
`285`	`285`	`}`
`286`	`286`	`}`
`287`	`287`
	`288`	`+ List<String> getRefTokens() {`
	`289`	`+ return refTokens;`
	`290`	`+ }`
	`291`	`+`
`288`	`292`	`/**`
`289`	`293`	`* Returns a string representing the JSONPointer path value using string`
`290`	`294`	`* representation`
Original file line number	Diff line number	Diff line change
`@@ -179,7 +179,7 @@ public void uniqueObjectValues() {`
`179`	`179`	`public void equalsVerifier() {`
`180`	`180`	`EqualsVerifier.forClass(ArraySchema.class)`
`181`	`181`	`.withRedefinedSuperclass()`
`182`		`- .withIgnoredFields("schemaLocation")`
	`182`	`+ .withIgnoredFields("schemaLocation", "location")`
`183`	`183`	`.suppress(Warning.STRICT_INHERITANCE)`
`184`	`184`	`.verify();`
`185`	`185`	`}`
Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,7 @@ public void reportCauses() {`
`118`	`118`	`public void equalsVerifier() {`
`119`	`119`	`EqualsVerifier.forClass(CombinedSchema.class)`
`120`	`120`	`.withRedefinedSuperclass()`
`121`		`- .withIgnoredFields("schemaLocation")`
	`121`	`+ .withIgnoredFields("schemaLocation", "location")`
`122`	`122`	`.suppress(Warning.STRICT_INHERITANCE)`
`123`	`123`	`.verify();`
`124`	`124`	`}`