implementation of ReferenceSchema#describePropertiesTo()

Author: erosb

core/src/main/java/org/everit/json/schema/ReferenceSchema.java

@@ -15,8 +15,12 @@
  */
 package org.everit.json.schema;
 
+import org.everit.json.schema.internal.JSONPrinter;
+
 import java.util.Objects;
 
+import static java.util.Objects.requireNonNull;
+
 /**
  * This class is used by {@link org.everit.json.schema.loader.SchemaLoader} to resolve JSON pointers
  * during the construction of the schema. This class has been made mutable to permit the loading of
@@ -31,6 +35,11 @@ public static class Builder extends Schema.Builder<ReferenceSchema> {
 
         private ReferenceSchema retval;
 
+        /**
+         * The value of {@code "$ref"}
+         */
+        private String refValue = "";
+
         /**
          * This method caches its result, so multiple invocations will return referentially the same
          * {@link ReferenceSchema} instance.
@@ -43,6 +52,10 @@ public ReferenceSchema build() {
             return retval;
         }
 
+        public Builder refValue(String refValue) {
+            this.refValue = refValue;
+            return this;
+        }
     }
 
     public static Builder builder() {
@@ -51,8 +64,11 @@ public static Builder builder() {
 
     private Schema referredSchema;
 
+    private final String refValue;
+
     public ReferenceSchema(final Builder builder) {
         super(builder);
+        this.refValue = requireNonNull(builder.refValue, "refValue cannot be null");
     }
 
     @Override
@@ -95,6 +111,7 @@ public boolean equals(Object o) {
         if (o instanceof ReferenceSchema) {
             ReferenceSchema that = (ReferenceSchema) o;
             return that.canEqual(this) &&
+                    Objects.equals(refValue, that.refValue) &&
                     Objects.equals(referredSchema, that.referredSchema) &&
                     super.equals(that);
         } else {
@@ -104,11 +121,16 @@ public boolean equals(Object o) {
 
     @Override
     public int hashCode() {
-        return Objects.hash(super.hashCode(), referredSchema);
+        return Objects.hash(super.hashCode(), referredSchema, refValue);
     }
 
     @Override
     protected boolean canEqual(Object other) {
         return other instanceof ReferenceSchema;
     }
+
+    @Override void describePropertiesTo(JSONPrinter writer) {
+        writer.key("$ref");
+        writer.value(refValue);
+    }
 }

core/src/main/java/org/everit/json/schema/loader/SchemaLoader.java

@@ -84,13 +84,11 @@ public SchemaLoaderBuilder addFormatValidator(FormatValidator formatValidator) {
         }
 
         /**
-         * @param formatName
-         *      the name which will be used in the schema JSON files to refer to this {@code formatValidator}
-         * @param formatValidator
-         *      the object performing the validation for schemas which use the {@code formatName} format
+         * @param formatName      the name which will be used in the schema JSON files to refer to this {@code formatValidator}
+         * @param formatValidator the object performing the validation for schemas which use the {@code formatName} format
          * @return {@code this}
          * @deprecated instead it is better to override {@link FormatValidator#formatName()}
-         *      and use {@link #addFormatValidator(FormatValidator)}
+         * and use {@link #addFormatValidator(FormatValidator)}
          */
         @Deprecated
         public SchemaLoaderBuilder addFormatValidator(final String formatName,
@@ -299,8 +297,7 @@ private void addDependency(final Builder builder, final String ifPresent, final
         typeMultiplexer(deps)
                 .ifObject().then(obj -> {
             builder.schemaDependency(ifPresent, loadChild(obj).build());
-        })
-                .ifIs(JSONArray.class).then(propNames -> {
+        }).ifIs(JSONArray.class).then(propNames -> {
             IntStream.range(0, propNames.length())
                     .mapToObj(i -> propNames.getString(i))
                     .forEach(dependency -> builder.propertyDependency(ifPresent, dependency));
@@ -560,7 +557,8 @@ private Schema.Builder<?> lookupReference(final String relPointerString, final J
         JSONPointer pointer = isExternal
                 ? JSONPointer.forURL(httpClient, absPointerString)
                 : JSONPointer.forDocument(rootSchemaJson, absPointerString);
-        ReferenceSchema.Builder refBuilder = ReferenceSchema.builder();
+        ReferenceSchema.Builder refBuilder = ReferenceSchema.builder()
+                .refValue(relPointerString);
         pointerSchemas.put(absPointerString, refBuilder);
         QueryResult result = pointer.query();
         JSONObject resultObject = extend(withoutRef(ctx), result.getQueryResult());

core/src/test/java/org/everit/json/schema/ReferenceSchemaTest.java

@@ -18,9 +18,13 @@
 import nl.jqno.equalsverifier.EqualsVerifier;
 import nl.jqno.equalsverifier.Warning;
 import org.everit.json.schema.ReferenceSchema.Builder;
+import org.everit.json.schema.loader.SchemaLoader;
+import org.json.JSONObject;
 import org.junit.Assert;
 import org.junit.Test;
 
+import static org.junit.Assert.assertTrue;
+
 public class ReferenceSchemaTest {
 
     @Test
@@ -45,4 +49,14 @@ public void equalsVerifier() {
                 .suppress(Warning.STRICT_INHERITANCE)
                 .verify();
     }
+
+    @Test
+    public void toStringTest() {
+        JSONObject rawSchemaJson = ResourceLoader.DEFAULT.readObj("tostring/ref.json");
+        String actual = SchemaLoader.load(rawSchemaJson).toString();
+        System.out.println(actual);
+        assertTrue(ObjectComparator.deepEquals(rawSchemaJson.query("/properties"),
+                new JSONObject(actual).query("/properties")));
+    }
+
 }

core/src/test/resources/org/everit/jsonvalidator/tostring/ref.json

@@ -0,0 +1,12 @@
+{
+  "properties": {
+    "prop": {
+      "$ref" : "#/definitions/Ref"
+    }
+  },
+  "definitions" : {
+    "Ref" : {
+      "type" : "number"
+    }
+  }
+}