Merge branch 'master' of https://github.com/RicoSuter/NJsonSchema

RicoSuter · Jan 21, 2021 · b851592 · b851592
2 parents 6c2da5f + 16cf749
commit b851592
Show file tree

Hide file tree

Showing 13 changed files with 176 additions and 18 deletions.
diff --git a/src/NJsonSchema.CodeGeneration.CSharp.Tests/NullableReferenceTypesTests.cs b/src/NJsonSchema.CodeGeneration.CSharp.Tests/NullableReferenceTypesTests.cs
@@ -0,0 +1,152 @@
+using System.ComponentModel.DataAnnotations;
+using System.Threading.Tasks;
+using NJsonSchema.CodeGeneration.CSharp;
+using NJsonSchema.Generation;
+using Xunit;
+
+namespace NJsonSchema.CodeGeneration.Tests.CSharp
+{
+    public class NullableReferenceTypesTests
+    {
+        private class ClassWithRequiredObject
+        {
+            public object Property { get; set; }
+
+            [Required]
+            [Newtonsoft.Json.JsonProperty("property2", Required = Newtonsoft.Json.Required.Always)]
+            public object Property2 { get; set; }
+        }
+
+        [Fact]
+        public async Task When_property_is_optional_and_GenerateNullableReferenceTypes_is_not_set_then_CSharp_property_is_not_nullable()
+        {
+            //// Arrange
+            var schema = JsonSchema.FromType<ClassWithRequiredObject>(new JsonSchemaGeneratorSettings
+            {
+                SchemaType = SchemaType.OpenApi3
+            });
+            var schemaData = schema.ToJson();
+
+            //// Act
+            var generator = new CSharpGenerator(schema, new CSharpGeneratorSettings
+            {
+                ClassStyle = CSharpClassStyle.Poco,
+                SchemaType = SchemaType.OpenApi3,
+                GenerateNullableReferenceTypes = false
+            });
+            var code = generator.GenerateFile("MyClass");
+
+            //// Assert
+            Assert.Contains("public object Property { get; set; }", code);
+            Assert.Contains("public object Property2 { get; set; }", code);
+        }
+
+        [Fact]
+        public async Task When_property_is_optional_and_GenerateNullableOptionalProperties_is_set_then_CSharp_property_is_nullable()
+        {
+            //// Arrange
+            var schema = JsonSchema.FromType<ClassWithRequiredObject>(new JsonSchemaGeneratorSettings
+            {
+                SchemaType = SchemaType.OpenApi3
+            });
+            var schemaData = schema.ToJson();
+
+            //// Act
+            var generator = new CSharpGenerator(schema, new CSharpGeneratorSettings
+            {
+                ClassStyle = CSharpClassStyle.Poco,
+                SchemaType = SchemaType.OpenApi3,
+                GenerateNullableReferenceTypes = true
+            });
+            var code = generator.GenerateFile("MyClass");
+
+            //// Assert
+            Assert.Contains("public object? Property { get; set; }= default!;", code);
+            Assert.Contains("public object Property2 { get; set; }= default!;", code);
+        }
+
+        [Fact]
+        public async Task When_generating_from_json_schema_property_is_optional_and_GenerateNullableOptionalProperties_is_not_set_then_CSharp_property()
+        {
+            //// Arrange
+
+            // CSharpGenerator `new object()`  adds = new object() initializer to property only if it's explicitly marked
+            // as having `type: object` in json schema
+            var schemaJson = @" 
+            {
+                ""type"": ""object"",
+                ""required"": [
+                    ""property2""
+                ],
+                ""properties"": {
+                    ""Property"": {
+                        ""x-nullable"": true,
+                        ""type"": ""object""
+                    },
+                    ""property2"": {
+                        ""type"": ""object""
+                    }
+                }
+            }
+            ";
+
+            var schema = await JsonSchema.FromJsonAsync(schemaJson);
+            var schemaData = schema.ToJson();
+
+            //// Act
+            var generator = new CSharpGenerator(schema, new CSharpGeneratorSettings
+            {
+                ClassStyle = CSharpClassStyle.Poco,
+                SchemaType = SchemaType.OpenApi3,
+                GenerateNullableReferenceTypes = false
+            });
+            var code = generator.GenerateFile("MyClass");
+
+            //// Assert
+            Assert.Contains("public object Property { get; set; }", code);
+            Assert.Contains("public object Property2 { get; set; } = new object();", code);
+        }
+
+        [Fact]
+        public async Task When_generating_from_json_schema_property_is_optional_and_GenerateNullableOptionalProperties_is_set_then_CSharp_property()
+        {
+            //// Arrange
+
+            // CSharpGenerator `new object()`  adds = new object() initializer to property only if it's explicitly marked
+            // as having `type: object` in json schema
+            var schemaJson = @" 
+            {
+                ""type"": ""object"",
+                ""required"": [
+                    ""property2""
+                ],
+                ""properties"": {
+                    ""Property"": {
+                        ""x-nullable"": true,
+                        ""type"": ""object""
+                    },
+                    ""property2"": {
+                        ""type"": ""object""
+                    }
+                }
+            }
+            ";
+
+            var schema = await JsonSchema.FromJsonAsync(schemaJson);
+            var schemaData = schema.ToJson();
+
+            //// Act
+            var generator = new CSharpGenerator(schema, new CSharpGeneratorSettings
+            {
+                ClassStyle = CSharpClassStyle.Poco,
+                SchemaType = SchemaType.OpenApi3,
+                GenerateNullableReferenceTypes = true
+            });
+            var code = generator.GenerateFile("MyClass");
+
+            //// Assert
+            Assert.Contains("public object? Property { get; set; }= default!;", code);
+            Assert.Contains("public object Property2 { get; set; } = new object();", code);
+        }
+    }
+}
diff --git a/src/NJsonSchema.CodeGeneration.CSharp/CSharpTypeResolver.cs b/src/NJsonSchema.CodeGeneration.CSharp/CSharpTypeResolver.cs
@@ -75,13 +75,15 @@ schema is JsonSchemaProperty property &&
                 isNullable = true;
             }
 
+            var markAsNullableType = Settings.GenerateNullableReferenceTypes && isNullable;
+
             if (schema.ActualTypeSchema.IsAnyType &&
                 schema.InheritedSchema == null && // not in inheritance hierarchy
                 schema.AllOf.Count == 0 &&
                 !Types.Keys.Contains(schema) &&
                 !schema.HasReference)
             {
-                return Settings.AnyType;
+                return markAsNullableType ? Settings.AnyType + "?" : Settings.AnyType;
             }
 
             var type = schema.ActualTypeSchema.Type;
@@ -107,7 +109,8 @@ schema is JsonSchemaProperty property &&
                 return ResolveBoolean(isNullable);
             }
 
-            var nullableReferenceType = Settings.GenerateNullableReferenceTypes && isNullable ? "?" : string.Empty;
+
+            var nullableReferenceType = markAsNullableType ? "?" : string.Empty;
 
             if (schema.IsBinary)
             {

diff --git a/src/NJsonSchema.CodeGeneration.CSharp/NJsonSchema.CodeGeneration.CSharp.csproj b/src/NJsonSchema.CodeGeneration.CSharp/NJsonSchema.CodeGeneration.CSharp.csproj
@@ -2,7 +2,7 @@
   <PropertyGroup>
     <TargetFrameworks>netstandard1.3;netstandard2.0;net451</TargetFrameworks>
     <Description>JSON Schema reader, generator and validator for .NET</Description>
-    <Version>10.3.1</Version>
+    <Version>10.3.3</Version>
     <PackageTags>json schema validation generator .net</PackageTags>
     <Copyright>Copyright © Rico Suter, 2020</Copyright>
     <PackageLicenseUrl>https://github.com/rsuter/NJsonSchema/blob/master/LICENSE.md</PackageLicenseUrl>

diff --git a/src/NJsonSchema.CodeGeneration.TypeScript/NJsonSchema.CodeGeneration.TypeScript.csproj b/src/NJsonSchema.CodeGeneration.TypeScript/NJsonSchema.CodeGeneration.TypeScript.csproj
@@ -2,7 +2,7 @@
   <PropertyGroup>
     <TargetFrameworks>netstandard1.3;netstandard2.0;net451</TargetFrameworks>
     <Description>JSON Schema reader, generator and validator for .NET</Description>
-    <Version>10.3.1</Version>
+    <Version>10.3.3</Version>
     <PackageTags>json schema validation generator .net</PackageTags>
     <Copyright>Copyright © Rico Suter, 2020</Copyright>
     <PackageLicenseUrl>https://github.com/RicoSuter/NJsonSchema/blob/master/LICENSE.md</PackageLicenseUrl>

diff --git a/src/NJsonSchema.CodeGeneration.TypeScript/Templates/Class.liquid b/src/NJsonSchema.CodeGeneration.TypeScript/Templates/Class.liquid
@@ -93,7 +93,7 @@
 {% endif -%}
     }
 
-    static fromJS(data: any{% if HandleReferences %}, _mappings?: any{% endif %}): {{ ClassName }} {
+    static fromJS(data: any{% if HandleReferences %}, _mappings?: any{% endif %}): {{ ClassName }}{% if HandleReferences %} | null{% endif %} {
         data = typeof data === 'object' ? data : {};
 {% if HandleReferences -%}
 {%   if HasBaseDiscriminator -%}

diff --git a/src/NJsonSchema.CodeGeneration.TypeScript/Templates/File.ReferenceHandling.liquid b/src/NJsonSchema.CodeGeneration.TypeScript/Templates/File.ReferenceHandling.liquid
@@ -41,7 +41,7 @@
     return json;
 }
 
-function createInstance<T>(data: any, mappings: any, type: any): T {
+function createInstance<T>(data: any, mappings: any, type: any): T | null {
   if (!mappings)
     mappings = [];
   if (!data)

diff --git a/src/NJsonSchema.CodeGeneration.TypeScript/Templates/KnockoutClass.liquid b/src/NJsonSchema.CodeGeneration.TypeScript/Templates/KnockoutClass.liquid
@@ -37,7 +37,7 @@
         }
     }
 
-    static fromJS(data: any{% if HandleReferences %}, _mappings?: any{% endif %}): {{ ClassName }} {
+    static fromJS(data: any{% if HandleReferences %}, _mappings?: any{% endif %}): {{ ClassName }}{% if HandleReferences %} | null{% endif %} {
 {% if HandleReferences -%}
 {%   if HasBaseDiscriminator -%}
 {%     for derivedClass in DerivedClasses -%}

diff --git a/src/NJsonSchema.CodeGeneration/Models/PropertyModelBase.cs b/src/NJsonSchema.CodeGeneration/Models/PropertyModelBase.cs
@@ -70,6 +70,9 @@ protected PropertyModelBase(
         /// <summary>Gets the property extension data.</summary>
         public IDictionary<string, object> ExtensionData => _property.ExtensionData;
 
+        /// <summary>Gets the JSON Schema format property.</summary>
+        public string Format => _property.ActualSchema.Format;
+
         /// <summary>Gets the type name hint for the property.</summary>
         protected string GetTypeNameHint()
         {

diff --git a/src/NJsonSchema.CodeGeneration/NJsonSchema.CodeGeneration.csproj b/src/NJsonSchema.CodeGeneration/NJsonSchema.CodeGeneration.csproj
@@ -2,7 +2,7 @@
   <PropertyGroup>
     <TargetFrameworks>netstandard1.3;netstandard2.0;net451</TargetFrameworks>
     <Description>JSON Schema reader, generator and validator for .NET</Description>
-    <Version>10.3.1</Version>
+    <Version>10.3.3</Version>
     <PackageTags>json schema validation generator .net</PackageTags>
     <Copyright>Copyright © Rico Suter, 2020</Copyright>
     <PackageLicenseUrl>https://github.com/rsuter/NJsonSchema/blob/master/LICENSE.md</PackageLicenseUrl>

diff --git a/src/NJsonSchema.Tests/Generation/SampleJsonDataGeneratorTests.cs b/src/NJsonSchema.Tests/Generation/SampleJsonDataGeneratorTests.cs
@@ -141,7 +141,7 @@ public async Task PropertyWithIntegerMinimumDefiniton()
 
 
         [Fact]
-        public async Task PropertyWithFloatMinimumDefiniton()
+        public async Task PropertyWithFloatMinimumDefinition()
         {
             //// Arrange
             var data = @"{
@@ -172,8 +172,8 @@ public async Task PropertyWithFloatMinimumDefiniton()
                     ""properties"": {
                       ""value"": {
                         ""type"": ""number"",
-                        ""maximum"": 5.0,
-                        ""minimum"": 1.0
+                        ""maximum"": 5.00001,
+                        ""minimum"": 1.000012
                       }
                     }
                   }
@@ -188,7 +188,7 @@ public async Task PropertyWithFloatMinimumDefiniton()
             var validationResult = schema.Validate(testJson);
             Assert.NotNull(validationResult);
             Assert.Equal(0, validationResult.Count);
-            Assert.Equal(1.0, testJson.SelectToken("body.numberContent.value").Value<float>());
+            Assert.Equal(1.000012, testJson.SelectToken("body.numberContent.value").Value<double>());
         }
 
         [Fact]

diff --git a/src/NJsonSchema.Yaml/NJsonSchema.Yaml.csproj b/src/NJsonSchema.Yaml/NJsonSchema.Yaml.csproj
@@ -2,7 +2,7 @@
   <PropertyGroup>
     <TargetFrameworks>netstandard1.3;netstandard2.0;net45</TargetFrameworks>
     <Description>JSON Schema reader, generator and validator for .NET</Description>
-    <Version>10.3.1</Version>
+    <Version>10.3.3</Version>
     <PackageTags>json schema validation generator .net</PackageTags>
     <Copyright>Copyright © Rico Suter, 2020</Copyright>
     <PackageLicenseUrl>https://github.com/rsuter/NJsonSchema/blob/master/LICENSE.md</PackageLicenseUrl>

diff --git a/src/NJsonSchema/Generation/SampleJsonDataGenerator.cs b/src/NJsonSchema/Generation/SampleJsonDataGenerator.cs
@@ -102,15 +102,15 @@ private static JToken HandleNumberType(JsonSchema schema)
         {
             if (schema.ExclusiveMinimumRaw != null)
             {
-                return JToken.FromObject(float.Parse(schema.Minimum.ToString()) + 0.1);
+                return JToken.FromObject((decimal)(float.Parse(schema.Minimum.ToString()) + 0.1));
             }
             else if (schema.ExclusiveMinimum != null)
             {
-                return JToken.FromObject(float.Parse(schema.ExclusiveMinimum.ToString()));
+                return JToken.FromObject(decimal.Parse(schema.ExclusiveMinimum.ToString()));
             }
             else if (schema.Minimum.HasValue)
             {
-                return float.Parse(schema.Minimum.ToString());
+                return decimal.Parse(schema.Minimum.ToString());
             }
             return JToken.FromObject(0.0);
         }

diff --git a/src/NJsonSchema/NJsonSchema.csproj b/src/NJsonSchema/NJsonSchema.csproj
@@ -2,7 +2,7 @@
   <PropertyGroup>
     <TargetFrameworks>netstandard1.0;netstandard2.0;net40;net45</TargetFrameworks>
     <Description>JSON Schema reader, generator and validator for .NET</Description>
-    <Version>10.3.1</Version>
+    <Version>10.3.3</Version>
     <PackageTags>json schema validation generator .net</PackageTags>
     <Copyright>Copyright © Rico Suter, 2020</Copyright>
     <PackageLicenseUrl>https://github.com/RicoSuter/NJsonSchema/blob/master/LICENSE.md</PackageLicenseUrl>
@@ -28,7 +28,7 @@
     <WarningsAsErrors />
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Namotion.Reflection" Version="1.0.14" />
+    <PackageReference Include="Namotion.Reflection" Version="1.0.15" />
     <PackageReference Include="Newtonsoft.Json" Version="9.0.1" />
   </ItemGroup>
   <ItemGroup Condition="'$(TargetFramework)' == 'net40'">