44: Add possibility to check if field exists in schema

Viktor Buldakov · Viktor Buldakov · commit 089140b81e8b · 2016-08-05T12:20:27.000+02:00
diff --git a/core/src/main/java/org/everit/json/schema/ArraySchema.java b/core/src/main/java/org/everit/json/schema/ArraySchema.java
@@ -15,6 +15,8 @@
  */
 package org.everit.json.schema;
 
+import org.json.JSONArray;
+
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
@@ -24,8 +26,6 @@
 import java.util.function.IntFunction;
 import java.util.stream.IntStream;
 
-import org.json.JSONArray;
-
 /**
  * Array schema validator.
  */
@@ -291,4 +291,9 @@ public void validate(final Object subject) {
     ValidationException.throwFor(this, failures);
   }
 
+  @Override
+  public boolean hasField(String field) {
+    return false;
+  }
+
 }
diff --git a/core/src/main/java/org/everit/json/schema/BooleanSchema.java b/core/src/main/java/org/everit/json/schema/BooleanSchema.java
@@ -49,4 +49,9 @@ public void validate(final Object subject) {
     }
   }
 
+  @Override
+  public boolean hasField(String field) {
+    return false;
+  }
+
 }
diff --git a/core/src/main/java/org/everit/json/schema/CombinedSchema.java b/core/src/main/java/org/everit/json/schema/CombinedSchema.java
@@ -178,4 +178,17 @@ public void validate(final Object subject) {
           e.getKeyword());
     }
   }
+
+  @Override
+  public boolean hasField(String field) {
+    List<Schema> matching = subschemas.stream()
+            .filter(schema -> schema.hasField(field))
+            .collect(Collectors.toList());
+    try {
+      criterion.validate(subschemas.size(), matching.size());
+    } catch (ValidationException e) {
+      return false;
+    }
+    return true;
+  }
 }
diff --git a/core/src/main/java/org/everit/json/schema/EmptySchema.java b/core/src/main/java/org/everit/json/schema/EmptySchema.java
@@ -47,4 +47,9 @@ public void validate(final Object subject) {
     // always passing
   }
 
+  @Override
+  public boolean hasField(String field) {
+    return false;
+  }
+
 }
diff --git a/core/src/main/java/org/everit/json/schema/EnumSchema.java b/core/src/main/java/org/everit/json/schema/EnumSchema.java
@@ -74,4 +74,9 @@ public void validate(final Object subject) {
                 subject), "enum"));
   }
 
+  @Override
+  public boolean hasField(String field) {
+    return false;
+  }
+
 }
diff --git a/core/src/main/java/org/everit/json/schema/NotSchema.java b/core/src/main/java/org/everit/json/schema/NotSchema.java
@@ -61,4 +61,9 @@ public void validate(final Object subject) {
     }
     throw new ValidationException(this, "subject must not be valid agains schema " + mustNotMatch);
   }
+
+  @Override
+  public boolean hasField(String field) {
+    return !mustNotMatch.hasField(field);
+  }
 }
diff --git a/core/src/main/java/org/everit/json/schema/NullSchema.java b/core/src/main/java/org/everit/json/schema/NullSchema.java
@@ -50,4 +50,9 @@ public void validate(final Object subject) {
           + subject.getClass().getSimpleName());
     }
   }
+
+  @Override
+  public boolean hasField(String field) {
+    return false;
+  }
 }
diff --git a/core/src/main/java/org/everit/json/schema/NumberSchema.java b/core/src/main/java/org/everit/json/schema/NumberSchema.java
@@ -198,4 +198,9 @@ public void validate(final Object subject) {
     }
   }
 
+  @Override
+  public boolean hasField(String field) {
+    return false;
+  }
+
 }
diff --git a/core/src/main/java/org/everit/json/schema/ObjectSchema.java b/core/src/main/java/org/everit/json/schema/ObjectSchema.java
@@ -15,6 +15,10 @@
  */
 package org.everit.json.schema;
 
+import com.google.common.base.Splitter;
+import com.google.common.collect.Lists;
+import org.json.JSONObject;
+
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -30,8 +34,6 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import org.json.JSONObject;
-
 /**
  * Object schema validator.
  */
@@ -392,4 +394,28 @@ public void validate(final Object subject) {
     }
   }
 
+  @Override
+  public boolean hasField(String field) {
+    if (field.isEmpty()) {
+      return false;
+    }
+    for (Entry<Pattern, Schema> entry : patternProperties.entrySet()) {
+      if (entry.getKey().matcher(field).matches()) {
+        return true;
+      }
+    }
+    List<String> fields = Lists.newArrayList(Splitter.on(".").limit(2).split(field));
+    String current = fields.get(0);
+    boolean hasSuffix = fields.size() > 1;
+    if (propertySchemas.containsKey(current)) {
+      if (hasSuffix) {
+        String suffix = fields.get(1);
+        return propertySchemas.get(current).hasField(suffix);
+      } else {
+        return true;
+      }
+    }
+    return false;
+  }
+
 }
diff --git a/core/src/main/java/org/everit/json/schema/ReferenceSchema.java b/core/src/main/java/org/everit/json/schema/ReferenceSchema.java
@@ -61,6 +61,14 @@ public void validate(final Object subject) {
     referredSchema.validate(subject);
   }
 
+  @Override
+  public boolean hasField(String field) {
+    if (referredSchema == null) {
+      throw new IllegalStateException("referredSchema must be injected before validation");
+    }
+    return referredSchema.hasField(field);
+  }
+
   public Schema getReferredSchema() {
     return referredSchema;
   }
diff --git a/core/src/main/java/org/everit/json/schema/Schema.java b/core/src/main/java/org/everit/json/schema/Schema.java
@@ -85,6 +85,8 @@ protected Schema(final Builder<?> builder) {
    */
   public abstract void validate(final Object subject);
 
+  public abstract boolean hasField(final String field);
+
   @Override
   public int hashCode() {
     final int prime = 31;
diff --git a/core/src/main/java/org/everit/json/schema/StringSchema.java b/core/src/main/java/org/everit/json/schema/StringSchema.java
@@ -173,4 +173,9 @@ public void validate(final Object subject) {
       ValidationException.throwFor(this, rval);
     }
   }
+
+  @Override
+  public boolean hasField(String field) {
+    return false;
+  }
 }
diff --git a/core/src/test/java/org/everit/json/schema/loader/HasFieldTest.java b/core/src/test/java/org/everit/json/schema/loader/HasFieldTest.java
@@ -0,0 +1,80 @@
+/*
+ * Copyright (C) 2011 Everit Kft. (http://www.everit.org)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.everit.json.schema.loader;
+
+import org.everit.json.schema.ObjectSchema;
+import org.everit.json.schema.Schema;
+import org.json.JSONObject;
+import org.json.JSONTokener;
+import org.junit.Assert;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+import java.io.InputStream;
+
+public class HasFieldTest {
+
+  private static JSONObject ALL_SCHEMAS;
+
+  @BeforeClass
+  public static void before() {
+    InputStream stream = HasFieldTest.class.getResourceAsStream(
+            "/org/everit/jsonvalidator/testschemas.json");
+    ALL_SCHEMAS = new JSONObject(new JSONTokener(stream));
+  }
+
+  private JSONObject get(final String schemaName) {
+    return ALL_SCHEMAS.getJSONObject(schemaName);
+  }
+
+  @Test
+  public void objectSchemaHasField() {
+    ObjectSchema actual = (ObjectSchema) SchemaLoader.load(get("pointerResolution"));
+    Assert.assertTrue(actual.hasField("rectangle"));
+    Assert.assertTrue(actual.hasField("rectangle.a"));
+    Assert.assertTrue(actual.hasField("rectangle.b"));
+
+    Assert.assertFalse(actual.hasField("rectangle.c"));
+    Assert.assertFalse(actual.hasField("rectangle."));
+    Assert.assertFalse(actual.hasField("."));
+    Assert.assertFalse(actual.hasField(".a"));
+    Assert.assertFalse(actual.hasField(""));
+    Assert.assertFalse(actual.hasField("rectangle.a.d"));
+  }
+
+  @Test
+  public void recursiveSchemaHasField() {
+    Schema recursiveSchema = SchemaLoader.load(get("recursiveSchema"));
+
+    Assert.assertTrue(recursiveSchema.hasField("prop"));
+    Assert.assertTrue(recursiveSchema.hasField("prop.subprop"));
+    Assert.assertTrue(recursiveSchema.hasField("prop.subprop.subprop"));
+    Assert.assertTrue(recursiveSchema.hasField("prop.subprop.subprop.subprop"));
+  }
+
+  @Test
+  public void patternPropertiesHasField() {
+    ObjectSchema actual = (ObjectSchema) SchemaLoader.load(get("patternProperties"));
+    Assert.assertTrue(actual.hasField("a"));
+    Assert.assertTrue(actual.hasField("aa"));
+    Assert.assertTrue(actual.hasField("aaa"));
+    Assert.assertTrue(actual.hasField("aaaa"));
+    Assert.assertTrue(actual.hasField("aaaaa"));
+
+    Assert.assertFalse(actual.hasField("b"));
+  }
+
+}

Original file line number	Diff line number	Diff line change
`@@ -49,4 +49,9 @@ public void validate(final Object subject) {`
`49`	`49`	`}`
`50`	`50`	`}`
`51`	`51`
	`52`	`+ @Override`
	`53`	`+ public boolean hasField(String field) {`
	`54`	`+ return false;`
	`55`	`+ }`
	`56`	`+`
`52`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -178,4 +178,17 @@ public void validate(final Object subject) {`
`178`	`178`	`e.getKeyword());`
`179`	`179`	`}`
`180`	`180`	`}`
	`181`	`+`
	`182`	`+ @Override`
	`183`	`+ public boolean hasField(String field) {`
	`184`	`+ List<Schema> matching = subschemas.stream()`
	`185`	`+ .filter(schema -> schema.hasField(field))`
	`186`	`+ .collect(Collectors.toList());`
	`187`	`+ try {`
	`188`	`+ criterion.validate(subschemas.size(), matching.size());`
	`189`	`+ } catch (ValidationException e) {`
	`190`	`+ return false;`
	`191`	`+ }`
	`192`	`+ return true;`
	`193`	`+ }`
`181`	`194`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,4 +47,9 @@ public void validate(final Object subject) {`
`47`	`47`	`// always passing`
`48`	`48`	`}`
`49`	`49`
	`50`	`+ @Override`
	`51`	`+ public boolean hasField(String field) {`
	`52`	`+ return false;`
	`53`	`+ }`
	`54`	`+`
`50`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -74,4 +74,9 @@ public void validate(final Object subject) {`
`74`	`74`	`subject), "enum"));`
`75`	`75`	`}`
`76`	`76`
	`77`	`+ @Override`
	`78`	`+ public boolean hasField(String field) {`
	`79`	`+ return false;`
	`80`	`+ }`
	`81`	`+`
`77`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,4 +61,9 @@ public void validate(final Object subject) {`
`61`	`61`	`}`
`62`	`62`	`throw new ValidationException(this, "subject must not be valid agains schema " + mustNotMatch);`
`63`	`63`	`}`
	`64`	`+`
	`65`	`+ @Override`
	`66`	`+ public boolean hasField(String field) {`
	`67`	`+ return !mustNotMatch.hasField(field);`
	`68`	`+ }`
`64`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,4 +50,9 @@ public void validate(final Object subject) {`
`50`	`50`	`+ subject.getClass().getSimpleName());`
`51`	`51`	`}`
`52`	`52`	`}`
	`53`	`+`
	`54`	`+ @Override`
	`55`	`+ public boolean hasField(String field) {`
	`56`	`+ return false;`
	`57`	`+ }`
`53`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -198,4 +198,9 @@ public void validate(final Object subject) {`
`198`	`198`	`}`
`199`	`199`	`}`
`200`	`200`
	`201`	`+ @Override`
	`202`	`+ public boolean hasField(String field) {`
	`203`	`+ return false;`
	`204`	`+ }`
	`205`	`+`
`201`	`206`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,14 @@ public void validate(final Object subject) {`
`61`	`61`	`referredSchema.validate(subject);`
`62`	`62`	`}`
`63`	`63`
	`64`	`+ @Override`
	`65`	`+ public boolean hasField(String field) {`
	`66`	`+ if (referredSchema == null) {`
	`67`	`+ throw new IllegalStateException("referredSchema must be injected before validation");`
	`68`	`+ }`
	`69`	`+ return referredSchema.hasField(field);`
	`70`	`+ }`
	`71`	`+`
`64`	`72`	`public Schema getReferredSchema() {`
`65`	`73`	`return referredSchema;`
`66`	`74`	`}`