Merge pull request #970 from RicoSuter/master

Release v10.0.0-preview.01
RicoSuter · May 20, 2019 · 913ee00 · 913ee00
2 parents c110c30 + a878082
commit 913ee00
Show file tree

Hide file tree

Showing 206 changed files with 3,405 additions and 4,773 deletions.
diff --git a/README.md b/README.md
@@ -27,9 +27,9 @@ CI NuGet Feed: https://www.myget.org/gallery/njsonschema-ci
 
 **Features:**
 
-- [Read existing JSON Schemas](https://github.com/RSuter/NJsonSchema/wiki/JsonSchema4) and [validate JSON data](https://github.com/RSuter/NJsonSchema/wiki/JsonSchemaValidator) (`JsonSchema4.FromJsonAsync()`)
-- [Generate JSON Schema from .NET type via reflection](https://github.com/RSuter/NJsonSchema/wiki/JsonSchemaGenerator) (with support for many attributes/annotations) (`JsonSchema4.FromTypeAsync<MyType>()`)
-- [Generate JSON Schema from sample JSON data](https://github.com/RSuter/NJsonSchema/wiki/SampleJsonSchemaGenerator) (`JsonSchema4.FromSampleJson()`)
+- [Read existing JSON Schemas](https://github.com/RSuter/NJsonSchema/wiki/JsonSchema) and [validate JSON data](https://github.com/RSuter/NJsonSchema/wiki/JsonSchemaValidator) (`JsonSchema.FromJsonAsync()`)
+- [Generate JSON Schema from .NET type via reflection](https://github.com/RSuter/NJsonSchema/wiki/JsonSchemaGenerator) (with support for many attributes/annotations) (`JsonSchema.FromTypeAsync<MyType>()`)
+- [Generate JSON Schema from sample JSON data](https://github.com/RSuter/NJsonSchema/wiki/SampleJsonSchemaGenerator) (`JsonSchema.FromSampleJson()`)
 - Support for schema references ($ref) (relative, URL and file)
 - Generate C# and TypeScript code from JSON Schema
 - Support for .NET Core (via PCL 259 / .NET Standard 1.0, also see [XML Documentation](https://github.com/NJsonSchema/NJsonSchema/wiki/XML-Documentation))
@@ -41,17 +41,17 @@ The project is developed and maintained by [Rico Suter](http://rsuter.com) and o
 
 ## NJsonSchema usage
 
-The [JsonSchema4](https://github.com/NJsonSchema/NJsonSchema/wiki/JsonSchema4) class can be used as follows: 
+The [JsonSchema](https://github.com/NJsonSchema/NJsonSchema/wiki/JsonSchema) class can be used as follows: 
 
 ```csharp
-var schema = await JsonSchema4.FromTypeAsync<Person>();
+var schema = await JsonSchema.FromTypeAsync<Person>();
 var schemaData = schema.ToJson();
 var errors = schema.Validate("{...}");
 
 foreach (var error in errors)
     Console.WriteLine(error.Path + ": " + error.Kind);
 
-schema = await JsonSchema4.FromJsonAsync(schemaData);
+schema = await JsonSchema.FromJsonAsync(schemaData);
 ```
 
 The `Person` class: 

diff --git a/src/NJsonSchema.Benchmark/GeneratorPerformance.cs b/src/NJsonSchema.Benchmark/GeneratorPerformance.cs
diff --git a/src/NJsonSchema.Benchmark/GeneratorPerformanceTests.cs b/src/NJsonSchema.Benchmark/GeneratorPerformanceTests.cs
diff --git a/src/NJsonSchema.Benchmark/NJsonSchema.Benchmark.csproj b/src/NJsonSchema.Benchmark/NJsonSchema.Benchmark.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFrameworks>netcoreapp2.0</TargetFrameworks>

diff --git a/src/NJsonSchema.Benchmark/SchemaGenerationPerformanceTests.cs b/src/NJsonSchema.Benchmark/SchemaGenerationPerformanceTests.cs
@@ -0,0 +1,92 @@
+using System;
+using System.Diagnostics;
+using System.Runtime.Serialization;
+using NBench;
+using Pro.NBench.xUnit.XunitExtensions;
+using Xunit.Abstractions;
+
+namespace NJsonSchema.Benchmark
+{
+    public class SchemaGenerationPerformanceTests
+    {
+        private Counter _counter;
+
+        public SchemaGenerationPerformanceTests(ITestOutputHelper output)
+        {
+            Trace.Listeners.Clear();
+            Trace.Listeners.Add(new XunitTraceListener(output));
+        }
+
+        [PerfSetup]
+#pragma warning disable xUnit1013 // Public method should be marked as test
+        public void Setup(BenchmarkContext context)
+#pragma warning restore xUnit1013 // Public method should be marked as test
+        {
+            _counter = context.GetCounter("Iterations");
+        }
+
+        /// <summary>
+        /// Ensure that we can serialise at least 200 times per second (5ms).
+        /// </summary>
+        [NBenchFact]
+        [PerfBenchmark(
+            Description = "Ensure schema generation doesn't take too long",
+            NumberOfIterations = 3,
+            RunTimeMilliseconds = 1000,
+            RunMode = RunMode.Throughput,
+            TestMode = TestMode.Test)]
+        [CounterThroughputAssertion("Iterations", MustBe.GreaterThan, 100)]
+        public void GenerateSchema()
+        {
+            var schema = JsonSchema.FromTypeAsync<Container>().GetAwaiter().GetResult();
+            _counter.Increment();
+        }
+
+        public class SpecialTeacher : Teacher
+        {
+            public string Foo { get; set; }
+        }
+
+        [KnownType(typeof(SpecialTeacher))]
+        public class Teacher
+        {
+            public string Bar { get; set; }
+        }
+
+        [KnownType(typeof(Teacher))]
+        public class Person
+        {
+            public string Baz { get; set; }
+        }
+
+        public class Pen : WritingInstrument
+        {
+            public string Foo { get; set; }
+        }
+
+        public class Pencil : WritingInstrument
+        {
+            public string Bar { get; set; }
+        }
+
+        [KnownType("GetKnownTypes")]
+        public class WritingInstrument
+        {
+            public static Type[] GetKnownTypes()
+            {
+                return new[] { typeof(Pen), typeof(Pencil) };
+            }
+
+            public string Baz { get; set; }
+        }
+
+        public class Container
+        {
+            public Person Person { get; set; }
+
+            public Teacher Teacher { get; set; }
+
+            public WritingInstrument WritingInstrument { get; set; }
+        }
+    }
+}
diff --git a/src/NJsonSchema.Benchmark/SerializationPerformance.cs b/src/NJsonSchema.Benchmark/SerializationPerformance.cs
@@ -7,7 +7,7 @@ namespace NJsonSchema.Benchmark
     public class SerializationPerformance
     {
         private readonly string _json;
-        private readonly JsonSchema4 _schema;
+        private readonly JsonSchema _schema;
 
         public SerializationPerformance()
         {
@@ -22,7 +22,7 @@ public SerializationPerformance()
                 _json = reader.ReadToEnd();
             }
 
-            _schema = JsonSchema4.FromJsonAsync(_json).Result;
+            _schema = JsonSchema.FromJsonAsync(_json).Result;
         }
 
         [Benchmark]
@@ -32,9 +32,9 @@ public string ToJson()
         }
 
         [Benchmark]
-        public JsonSchema4 FromJson()
+        public JsonSchema FromJson()
         {
-            return JsonSchema4.FromJsonAsync(_json).Result;
+            return JsonSchema.FromJsonAsync(_json).Result;
         }
     }
 }
diff --git a/src/NJsonSchema.CodeGeneration.CSharp.Tests/AbstractSchemaTests.cs b/src/NJsonSchema.CodeGeneration.CSharp.Tests/AbstractSchemaTests.cs
@@ -15,7 +15,7 @@ public abstract class AbstractClass
         public async Task When_class_is_abstract_then_is_abstract_CSharp_keyword_is_generated()
         {
             /// Arrange
-            var schema = await JsonSchema4.FromTypeAsync<AbstractClass>();
+            var schema = await JsonSchema.FromTypeAsync<AbstractClass>();
 
             /// Act
             var generator = new CSharpGenerator(schema, new CSharpGeneratorSettings());

diff --git a/src/NJsonSchema.CodeGeneration.CSharp.Tests/AdditionalPropertiesTests.cs b/src/NJsonSchema.CodeGeneration.CSharp.Tests/AdditionalPropertiesTests.cs
@@ -30,7 +30,7 @@ public async Task When_additionalProperties_schema_is_set_for_object_then_specia
         }
     }
 }";
-            var schema = await JsonSchema4.FromJsonAsync(json);
+            var schema = await JsonSchema.FromJsonAsync(json);
 
             //// Act
             var generator = new CSharpGenerator(schema, new CSharpGeneratorSettings());

diff --git a/src/NJsonSchema.CodeGeneration.CSharp.Tests/AllOfTests.cs b/src/NJsonSchema.CodeGeneration.CSharp.Tests/AllOfTests.cs
@@ -43,7 +43,7 @@ public async Task When_allOf_has_two_schemas_then_referenced_schema_is_inherited
         }
     }
 }";
-            var schema = await JsonSchema4.FromJsonAsync(json);
+            var schema = await JsonSchema.FromJsonAsync(json);
 
             //// Act
             var generator = new CSharpGenerator(schema, new CSharpGeneratorSettings());
@@ -95,7 +95,7 @@ public async Task When_allOf_has_one_schema_then_it_is_inherited()
         }
     }
 }";
-            var schema = await JsonSchema4.FromJsonAsync(json);
+            var schema = await JsonSchema.FromJsonAsync(json);
 
             //// Act
             var generator = new CSharpGenerator(schema, new CSharpGeneratorSettings());
@@ -150,7 +150,7 @@ public async Task When_all_of_has_multiple_refs_then_the_properties_should_expan
             }";
 
             //// Act
-            var schema = await JsonSchema4.FromJsonAsync(json);
+            var schema = await JsonSchema.FromJsonAsync(json);
             var settings = new CSharpGeneratorSettings { ClassStyle = CSharpClassStyle.Poco, Namespace = "ns" };
             var generator = new CSharpGenerator(schema, settings);
             var output = generator.GenerateFile("Foo");
@@ -188,7 +188,7 @@ public async Task When_more_properties_are_defined_in_allOf_and_type_none_then_a
             }";
 
             //// Act
-            var schema = await JsonSchema4.FromJsonAsync(json);
+            var schema = await JsonSchema.FromJsonAsync(json);
             var generator = new CSharpGenerator(schema, new CSharpGeneratorSettings { ClassStyle = CSharpClassStyle.Poco });
             var code = generator.GenerateFile("Foo").Replace("\r\n", "\n");
 
@@ -231,7 +231,7 @@ public async Task When_allOf_schema_is_object_type_then_it_is_an_inherited_class
             }";
 
             //// Act
-            var schema = await JsonSchema4.FromJsonAsync(json);
+            var schema = await JsonSchema.FromJsonAsync(json);
             var generator = new CSharpGenerator(schema, new CSharpGeneratorSettings { ClassStyle = CSharpClassStyle.Poco });
             var code = generator.GenerateFile("Foo");
 

diff --git a/src/NJsonSchema.CodeGeneration.CSharp.Tests/AnnotationsTests.cs b/src/NJsonSchema.CodeGeneration.CSharp.Tests/AnnotationsTests.cs
@@ -23,7 +23,7 @@ public class MyRequiredTest
         public async Task When_array_property_is_not_nullable_then_it_does_not_have_a_setter()
         {
             //// Arrange
-            var schema = await JsonSchema4.FromTypeAsync<MyRequiredTest>();
+            var schema = await JsonSchema.FromTypeAsync<MyRequiredTest>();
             var generator = new CSharpGenerator(schema, new CSharpGeneratorSettings
             {
                 ClassStyle = CSharpClassStyle.Poco, 
@@ -36,8 +36,8 @@ public async Task When_array_property_is_not_nullable_then_it_does_not_have_a_se
             var code = generator.GenerateFile();
 
             //// Assert
-            Assert.Contains("public System.Collections.ObjectModel.ObservableCollection<string> Collection { get; } = new System.Collections.ObjectModel.ObservableCollection<string>();", code);
-            Assert.Contains("public System.Collections.Generic.Dictionary<string, object> Dictionary { get; } = new System.Collections.Generic.Dictionary<string, object>();", code);
+            Assert.Contains("public System.Collections.Generic.ICollection<string> Collection { get; } = new System.Collections.ObjectModel.Collection<string>();", code);
+            Assert.Contains("public System.Collections.Generic.IDictionary<string, object> Dictionary { get; } = new System.Collections.Generic.Dictionary<string, object>();", code);
         }
     }
 }
diff --git a/src/NJsonSchema.CodeGeneration.CSharp.Tests/ArrayTests.cs b/src/NJsonSchema.CodeGeneration.CSharp.Tests/ArrayTests.cs
@@ -18,7 +18,7 @@ public class ArrayTest
         public async Task When_array_property_is_required_then_array_instance_can_be_changed()
         {
             //// Arrange
-            var schema = await JsonSchema4.FromTypeAsync<ArrayTest>();
+            var schema = await JsonSchema.FromTypeAsync<ArrayTest>();
             var data = schema.ToJson();
 
             //// Act
@@ -45,7 +45,7 @@ public class ClassWithNullableArrayItems
         public async Task When_array_item_is_nullable_then_generated_CSharp_is_correct()
         {
             // Arrange
-            var schema = await JsonSchema4.FromTypeAsync<ClassWithNullableArrayItems>();
+            var schema = await JsonSchema.FromTypeAsync<ClassWithNullableArrayItems>();
             var json = schema.ToJson();
             var generator = new CSharpGenerator(schema, new CSharpGeneratorSettings());
 
@@ -54,7 +54,7 @@ public async Task When_array_item_is_nullable_then_generated_CSharp_is_correct()
 
             // Assert
             Assert.True(schema.Properties["Items"].Item.IsNullable(SchemaType.JsonSchema));
-            Assert.Contains("System.Collections.ObjectModel.ObservableCollection<int?> Items", output);
+            Assert.Contains("System.Collections.Generic.ICollection<int?> Items", output);
         }
     }
 }
diff --git a/src/NJsonSchema.CodeGeneration.CSharp.Tests/DefaultPropertyTests.cs b/src/NJsonSchema.CodeGeneration.CSharp.Tests/DefaultPropertyTests.cs
@@ -16,7 +16,7 @@ public async Task When_property_has_interger_default_it_is_reflected_in_the_poco
                                  }
                              }}";
 
-            var schema = await JsonSchema4.FromJsonAsync(data);
+            var schema = await JsonSchema.FromJsonAsync(data);
             var settings = new CSharpGeneratorSettings
             {
                 ClassStyle = CSharpClassStyle.Poco,
@@ -39,7 +39,7 @@ public async Task When_property_has_boolean_default_it_is_reflected_in_the_poco(
                                  }
                              }}";
 
-            var schema = await JsonSchema4.FromJsonAsync(data);
+            var schema = await JsonSchema.FromJsonAsync(data);
             var settings = new CSharpGeneratorSettings
             {
                 ClassStyle = CSharpClassStyle.Poco,
@@ -62,7 +62,7 @@ public async Task When_property_has_boolean_default_and_default_value_generation
                                  }
                              }}";
 
-            var schema = await JsonSchema4.FromJsonAsync(data);
+            var schema = await JsonSchema.FromJsonAsync(data);
             var settings = new CSharpGeneratorSettings
             {
                 ClassStyle = CSharpClassStyle.Poco,