Merge pull request #309 from Subhajitdas298/master

Updated documentation

Author: stevehu

README.md

@@ -45,21 +45,23 @@ Following the design principle of the Light Platform, this library has minimum d
 Here are the dependencies. 
 
 ```
-        <dependency>
-            <groupId>com.fasterxml.jackson.core</groupId>
-            <artifactId>jackson-databind</artifactId>
-            <version>${version.jackson}</version>
-        </dependency>
-        <dependency>
-            <groupId>org.slf4j</groupId>
-            <artifactId>slf4j-api</artifactId>
-            <version>${version.slf4j}</version>
-        </dependency>
-        <dependency>
-            <groupId>org.apache.commons</groupId>
-            <artifactId>commons-lang3</artifactId>
-            <version>${version.common-lang3}</version>
-        </dependency>
+<dependency>
+    <groupId>com.fasterxml.jackson.core</groupId>
+    <artifactId>jackson-databind</artifactId>
+    <version>${version.jackson}</version>
+</dependency>
+
+<dependency>
+    <groupId>org.slf4j</groupId>
+    <artifactId>slf4j-api</artifactId>
+    <version>${version.slf4j}</version>
+</dependency>
+
+<dependency>
+    <groupId>org.apache.commons</groupId>
+    <artifactId>commons-lang3</artifactId>
+    <version>${version.common-lang3}</version>
+</dependency>
 ```
 
 #### Community
@@ -110,7 +112,7 @@ For the latest version, please check the [release](https://github.com/networknt/
 
 ## [Customized MetaSchema](doc/cust-meta.md)
 
-## [Collector Context](doc/collector_context.md)
+## [Collector Context](doc/collector-context.md)
 
 ## [ECMA-262 Regex](doc/ecma-262.md)
 

doc/collector_context.md renamed to doc/collector-context.md

@@ -13,9 +13,9 @@ Most of the configuration flags are used to control the difference between Swagg
 When you create a JsonSchema instance from the JsonSchemaFactory, you can pass an object of SchemaValidatorsConfig as the second parameter. 
 
 ```
-    SchemaValidatorsConfig config = new SchemaValidatorsConfig();
-    config.setTypeLoose(false);
-    JsonSchema jsonSchema = JsonSchemaFactory.getInstance().getSchema(schema, config);
+SchemaValidatorsConfig config = new SchemaValidatorsConfig();
+config.setTypeLoose(false);
+JsonSchema jsonSchema = JsonSchemaFactory.getInstance().getSchema(schema, config);
 ```
 
 #### Configurations

doc/config.md

@@ -13,17 +13,17 @@ If you want to ensure full compliance, use the org.jruby.joni. It is 1.5 times s
 Here is the test case that shows how to pass a config object to use the ECMA-262 library.
 
 ```
-    @Test(expected = JsonSchemaException.class)
-    public void testInvalidPatternPropertiesValidatorECMA262() throws Exception {
-        SchemaValidatorsConfig config = new SchemaValidatorsConfig();
-        config.setEcma262Validator(true);
-        JsonSchemaFactory factory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V4);
-        JsonSchema schema = factory.getSchema("{\"patternProperties\":6}", config);
-
-        JsonNode node = getJsonNodeFromStringContent("");
-        Set<ValidationMessage> errors = schema.validate(node);
-        Assert.assertEquals(errors.size(), 0);
-    }
+@Test(expected = JsonSchemaException.class)
+public void testInvalidPatternPropertiesValidatorECMA262() throws Exception {
+    SchemaValidatorsConfig config = new SchemaValidatorsConfig();
+    config.setEcma262Validator(true);
+    JsonSchemaFactory factory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V4);
+    JsonSchema schema = factory.getSchema("{\"patternProperties\":6}", config);
+
+    JsonNode node = getJsonNodeFromStringContent("");
+    Set<ValidationMessage> errors = schema.validate(node);
+    Assert.assertEquals(errors.size(), 0);
+}
 ```
 
 

doc/cust_fetcher.md renamed to doc/cust-fetcher.md

@@ -1,92 +1,79 @@
 ## Quick Start
 
-To use the validator, you need to have both the JsonSchema object and JsonNode object constructed, and there are many ways to do that. Here is my base test class that shows you several ways to construct these from String, Stream, Url, and JsonNode. Pay attention to the JsonSchemaFactory class as it is the way to construct the JsonSchema object.
+To use the validator, we need to have both the JsonSchema object and JsonNode object constructed. 
+There are many ways to do that. 
+Here is base test class, that shows several ways to construct these from String, Stream, Url, and JsonNode. 
+Please pay attention to the JsonSchemaFactory class as it is the way to construct the JsonSchema object.
 
 ```java
-/*
- * Copyright (c) 2016 Network New Technologies Inc.
- *
- * 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 com.networknt.schema;
-
-import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
-
-import java.io.InputStream;
-import java.net.URL;
-
-/**
- * Created by steve on 22/10/16.
- */
 public class BaseJsonSchemaValidatorTest {
-    protected JsonNode getJsonNodeFromClasspath(String name) throws Exception {
+
+    private ObjectMapper mapper = new ObjectMapper();
+
+    protected JsonNode getJsonNodeFromClasspath(String name) throws IOException {
         InputStream is1 = Thread.currentThread().getContextClassLoader()
                 .getResourceAsStream(name);
-
-        ObjectMapper mapper = new ObjectMapper();
-        JsonNode node = mapper.readTree(is1);
-        return node;
+        return mapper.readTree(is1);
     }
 
-    protected JsonNode getJsonNodeFromStringContent(String content) throws Exception {
-        ObjectMapper mapper = new ObjectMapper();
-        JsonNode node = mapper.readTree(content);
-        return node;
+    protected JsonNode getJsonNodeFromStringContent(String content) throws IOException {
+        return mapper.readTree(content);
     }
 
-    protected JsonNode getJsonNodeFromUrl(String url) throws Exception {
-        ObjectMapper mapper = new ObjectMapper();
-        JsonNode node = mapper.readTree(new URL(url));
-        return node;
+    protected JsonNode getJsonNodeFromUrl(String url) throws IOException {
+        return mapper.readTree(new URL(url));
     }
 
-    protected JsonSchema getJsonSchemaFromClasspath(String name) throws Exception {
-        JsonSchemaFactory factory = JsonSchemaFactory.getInstance();
+    protected JsonSchema getJsonSchemaFromClasspath(String name) {
+        JsonSchemaFactory factory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V4);
         InputStream is = Thread.currentThread().getContextClassLoader()
                 .getResourceAsStream(name);
-        JsonSchema schema = factory.getSchema(is);
-        return schema;
+        return factory.getSchema(is);
     }
 
+    protected JsonSchema getJsonSchemaFromStringContent(String schemaContent) {
+        JsonSchemaFactory factory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V4);
+        return factory.getSchema(schemaContent);
+    }
 
-    protected JsonSchema getJsonSchemaFromStringContent(String schemaContent) throws Exception {
-        JsonSchemaFactory factory = JsonSchemaFactory.getInstance();
-        JsonSchema schema = factory.getSchema(schemaContent);
-        return schema;
+    protected JsonSchema getJsonSchemaFromUrl(String uri) throws URISyntaxException {
+        JsonSchemaFactory factory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V4);
+        return factory.getSchema(new URI(uri));
     }
 
-    protected JsonSchema getJsonSchemaFromUrl(String url) throws Exception {
-        JsonSchemaFactory factory = JsonSchemaFactory.getInstance();
-        JsonSchema schema = factory.getSchema(new URL(url));
-        return schema;
+    protected JsonSchema getJsonSchemaFromJsonNode(JsonNode jsonNode) {
+        JsonSchemaFactory factory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V4);
+        return factory.getSchema(jsonNode);
     }
 
-    protected JsonSchema getJsonSchemaFromJsonNode(JsonNode jsonNode) throws Exception {
-        JsonSchemaFactory factory = JsonSchemaFactory.getInstance();
-        JsonSchema schema = factory.getSchema(jsonNode);
-        return schema;
+    // Automatically detect version for given JsonNode
+    protected JsonSchema getJsonSchemaFromJsonNodeAutomaticVersion(JsonNode jsonNode) {
+        JsonSchemaFactory factory = JsonSchemaFactory.getInstance(SpecVersionDetector.detect(jsonNode));
+        return factory.getSchema(jsonNode);
     }
-}
 
+}
 ```
 And the following is one of the test cases in one of the test classes that extend from the above base class. As you can see, it constructs JsonSchema and JsonNode from String.
 
 ```java
-		JsonSchema schema = getJsonSchemaFromStringContent("{\"enum\":[1, 2, 3, 4],\"enumErrorCode\":\"Not in the list\"}");
-		JsonNode node = getJsonNodeFromStringContent("7");
-		Set<ValidationMessage> errors = schema.validate(node);
-		assertThat(errors.size(), is(1));
+class Sample extends BaseJsonSchemaValidatorTest {
+
+    void test() {    
+        JsonSchema schema = getJsonSchemaFromStringContent("{\"enum\":[1, 2, 3, 4],\"enumErrorCode\":\"Not in the list\"}");
+        JsonNode node = getJsonNodeFromStringContent("7");
+        Set<ValidationMessage> errors = schema.validate(node);
+        assertThat(errors.size(), is(1));
+    
+        // With automatic version detection
+        JsonNode schemaNode = getJsonNodeFromStringContent(
+            "{\"$schema\": \"http://json-schema.org/draft-06/schema#\", \"properties\": { \"id\": {\"type\": \"number\"}}}");
+        JsonSchema schema = getJsonSchemaFromJsonNodeAutomaticVersion(schemaNode);
+        JsonNode node = getJsonNodeFromStringContent("{\"id\": \"2\"}");
+        Set<ValidationMessage> errors = schema.validate(node);
+        assertThat(errors.size(), is(1));
+    }
+
+}
 
 ```