Merge pull request #960 from RicoSuter/master

Release v9.13.37
RicoSuter · May 2, 2019 · e442b6e · e442b6e
2 parents da99fed + c10d51d
commit e442b6e
Show file tree

Hide file tree

Showing 10 changed files with 40 additions and 29 deletions.
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>9.13.36</Version>
+    <Version>9.13.37</Version>
     <PackageTags>json schema validation generator .net</PackageTags>
     <Copyright>Copyright © Rico Suter, 2018</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>9.13.36</Version>
+    <Version>9.13.37</Version>
     <PackageTags>json schema validation generator .net</PackageTags>
     <Copyright>Copyright © Rico Suter, 2018</Copyright>
     <PackageLicenseUrl>https://github.com/rsuter/NJsonSchema/blob/master/LICENSE.md</PackageLicenseUrl>

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>9.13.36</Version>
+    <Version>9.13.37</Version>
     <PackageTags>json schema validation generator .net</PackageTags>
     <Copyright>Copyright © Rico Suter, 2018</Copyright>
     <PackageLicenseUrl>https://github.com/rsuter/NJsonSchema/blob/master/LICENSE.md</PackageLicenseUrl>

diff --git a/src/NJsonSchema.Tests/Generation/DefaultReflectionServiceTests.cs b/src/NJsonSchema.Tests/Generation/DefaultReflectionServiceTests.cs
@@ -34,17 +34,12 @@ public void When_ReferenceTypeNullHandling_is_Null_then_nullability_is_correct()
                 { typeof(Dictionary<string, string>), true },
             };
 
-            var settings = new JsonSchemaGeneratorSettings
-            {
-                DefaultReferenceTypeNullHandling = ReferenceTypeNullHandling.Null
-            };
-
             //// Act
             var svc = new DefaultReflectionService();
 
             //// Assert
             foreach (var check in checks)
-                Assert.Equal(check.Value, svc.IsNullable(check.Key, null, settings));
+                Assert.Equal(check.Value, svc.IsNullable(check.Key, null, ReferenceTypeNullHandling.Null));
         }
 
         [Fact]
@@ -74,17 +69,12 @@ public void When_ReferenceTypeNullHandling_is_NotNull_then_nullability_is_correc
                 { typeof(Dictionary<string, string>), false },
             };
 
-            var settings = new JsonSchemaGeneratorSettings
-            {
-                DefaultReferenceTypeNullHandling = ReferenceTypeNullHandling.NotNull
-            };
-
             //// Act
             var svc = new DefaultReflectionService();
 
             //// Assert
             foreach (var check in checks)
-                Assert.Equal(check.Value, svc.IsNullable(check.Key, null, settings));
+                Assert.Equal(check.Value, svc.IsNullable(check.Key, null, ReferenceTypeNullHandling.NotNull));
         }
     }
 }
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>9.13.36</Version>
+    <Version>9.13.37</Version>
     <PackageTags>json schema validation generator .net</PackageTags>
     <Copyright>Copyright © Rico Suter, 2018</Copyright>
     <PackageLicenseUrl>https://github.com/rsuter/NJsonSchema/blob/master/LICENSE.md</PackageLicenseUrl>

diff --git a/src/NJsonSchema/Generation/DefaultReflectionService.cs b/src/NJsonSchema/Generation/DefaultReflectionService.cs
@@ -28,9 +28,21 @@ public class DefaultReflectionService : IReflectionService
         /// <param name="parentAttributes">The parent's attributes (i.e. parameter or property attributes).</param>
         /// <param name="settings">The settings.</param>
         /// <returns>The <see cref="JsonTypeDescription"/>. </returns>
-        public virtual JsonTypeDescription GetDescription(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaGeneratorSettings settings)
+        public JsonTypeDescription GetDescription(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaGeneratorSettings settings)
         {
-            var isNullable = IsNullable(type, parentAttributes, settings);
+            return GetDescription(type, parentAttributes, settings.DefaultReferenceTypeNullHandling, settings);
+        }
+
+        /// <summary>Creates a <see cref="JsonTypeDescription"/> from a <see cref="Type"/>. </summary>
+        /// <param name="type">The type. </param>
+        /// <param name="parentAttributes">The parent's attributes (i.e. parameter or property attributes).</param>
+        /// <param name="defaultReferenceTypeNullHandling">The default reference type null handling used when no nullability information is available.</param>
+        /// <param name="settings">The settings.</param>
+        /// <returns>The <see cref="JsonTypeDescription"/>. </returns>
+        public virtual JsonTypeDescription GetDescription(Type type, IEnumerable<Attribute> parentAttributes,
+            ReferenceTypeNullHandling defaultReferenceTypeNullHandling, JsonSchemaGeneratorSettings settings)
+        {
+            var isNullable = IsNullable(type, parentAttributes, defaultReferenceTypeNullHandling);
 
             var jsonSchemaTypeAttribute = type.GetTypeInfo().GetCustomAttribute<JsonSchemaTypeAttribute>() ??
                                           parentAttributes?.OfType<JsonSchemaTypeAttribute>().SingleOrDefault();
@@ -151,9 +163,9 @@ public virtual JsonTypeDescription GetDescription(Type type, IEnumerable<Attribu
             {
 #if !LEGACY
                 // Remove JsonSchemaTypeAttributes to avoid stack overflows
-                var typeDescription = GetDescription(type.GenericTypeArguments[0], parentAttributes?.Where(a => !(a is JsonSchemaTypeAttribute)), settings);
+                var typeDescription = GetDescription(type.GenericTypeArguments[0], parentAttributes?.Where(a => !(a is JsonSchemaTypeAttribute)), defaultReferenceTypeNullHandling, settings);
 #else
-                var typeDescription = GetDescription(type.GetGenericArguments()[0], parentAttributes?.Where(a => !(a is JsonSchemaTypeAttribute)), settings);
+                var typeDescription = GetDescription(type.GetGenericArguments()[0], parentAttributes?.Where(a => !(a is JsonSchemaTypeAttribute)), defaultReferenceTypeNullHandling, settings);
 #endif
                 typeDescription.IsNullable = true;
                 return typeDescription;
@@ -168,9 +180,9 @@ public virtual JsonTypeDescription GetDescription(Type type, IEnumerable<Attribu
         /// <summary>Checks whether a type is nullable.</summary>
         /// <param name="type">The type.</param>
         /// <param name="parentAttributes">The parent attributes (e.g. property or parameter attributes).</param>
-        /// <param name="settings">The settings</param>
+        /// <param name="defaultReferenceTypeNullHandling">The default reference type null handling used when no nullability information is available.</param>
         /// <returns>true if the type can be null.</returns>
-        public virtual bool IsNullable(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaGeneratorSettings settings)
+        public virtual bool IsNullable(Type type, IEnumerable<Attribute> parentAttributes, ReferenceTypeNullHandling defaultReferenceTypeNullHandling)
         {
             var jsonPropertyAttribute = parentAttributes?.OfType<JsonPropertyAttribute>().SingleOrDefault();
             if (jsonPropertyAttribute != null && jsonPropertyAttribute.Required == Required.DisallowNull)
@@ -186,7 +198,7 @@ public virtual bool IsNullable(Type type, IEnumerable<Attribute> parentAttribute
                 return true;
 
             var isValueType = type != typeof(string) && type.GetTypeInfo().IsValueType;
-            return isValueType == false && settings.DefaultReferenceTypeNullHandling == ReferenceTypeNullHandling.Null;
+            return isValueType == false && defaultReferenceTypeNullHandling == ReferenceTypeNullHandling.Null;
         }
 
         /// <summary>Checks whether the given type is a file/binary type.</summary>

diff --git a/src/NJsonSchema/Generation/IReflectionService.cs b/src/NJsonSchema/Generation/IReflectionService.cs
@@ -14,6 +14,15 @@ namespace NJsonSchema.Generation
     /// <summary>Provides methods to reflect on types.</summary>
     public interface IReflectionService
     {
+        /// <summary>Creates a <see cref="JsonTypeDescription"/> from a <see cref="Type"/>. </summary>
+        /// <param name="type">The type. </param>
+        /// <param name="parentAttributes">The parent's attributes (i.e. parameter or property attributes).</param>
+        /// <param name="defaultReferenceTypeNullHandling">The default reference type null handling.</param>
+        /// <param name="settings">The settings.</param>
+        /// <returns>The <see cref="JsonTypeDescription"/>. </returns>
+        JsonTypeDescription GetDescription(Type type, IEnumerable<Attribute> parentAttributes,
+            ReferenceTypeNullHandling defaultReferenceTypeNullHandling, JsonSchemaGeneratorSettings settings);
+
         /// <summary>Creates a <see cref="JsonTypeDescription"/> from a <see cref="Type"/>. </summary>
         /// <param name="type">The type. </param>
         /// <param name="parentAttributes">The parent's attributes (i.e. parameter or property attributes).</param>
@@ -24,8 +33,8 @@ public interface IReflectionService
         /// <summary>Checks whether a type is nullable.</summary>
         /// <param name="type">The type.</param>
         /// <param name="parentAttributes">The parent attributes (e.g. property or parameter attributes).</param>
-        /// <param name="settings">The settings</param>
+        /// <param name="defaultReferenceTypeNullHandling">The default reference type null handling used when no nullability information is available.</param>
         /// <returns>true if the type can be null.</returns>
-        bool IsNullable(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaGeneratorSettings settings);
+        bool IsNullable(Type type, IEnumerable<Attribute> parentAttributes, ReferenceTypeNullHandling defaultReferenceTypeNullHandling);
     }
 }
diff --git a/src/NJsonSchema/Generation/JsonSchemaGeneratorSettings.cs b/src/NJsonSchema/Generation/JsonSchemaGeneratorSettings.cs
@@ -44,7 +44,7 @@ public JsonSchemaGeneratorSettings()
             ExcludedTypeNames = new string[0];
         }
 
-        /// <summary>Gets or sets the default null handling (if NotNullAttribute and CanBeNullAttribute are missing, default: Null).</summary>
+        /// <summary>Gets or sets the default reference type null handling when no nullability information is available (if NotNullAttribute and CanBeNullAttribute are missing, default: Null).</summary>
         public ReferenceTypeNullHandling DefaultReferenceTypeNullHandling { get; set; }
 
         /// <summary>Gets or sets a value indicating whether to generate abstract properties (i.e. interface and abstract properties. Properties may defined multiple times in a inheritance hierarchy, default: false).</summary>

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>9.13.36</Version>
+    <Version>9.13.37</Version>
     <PackageTags>json schema validation generator .net</PackageTags>
     <Copyright>Copyright © Rico Suter, 2018</Copyright>
     <PackageLicenseUrl>https://github.com/rsuter/NJsonSchema/blob/master/LICENSE.md</PackageLicenseUrl>

diff --git a/src/NJsonSchema/ReferenceTypeNullHandling.cs b/src/NJsonSchema/ReferenceTypeNullHandling.cs
@@ -8,10 +8,10 @@
 
 namespace NJsonSchema
 {
-    /// <summary>Specifies the default null handling for reference types.</summary>
+    /// <summary>Specifies the default null handling for reference types when no nullability information is available.</summary>
     public enum ReferenceTypeNullHandling
     {
-        /// <summary>Reference types can be null by default (C# default).</summary>
+        /// <summary>Reference types are nullable by default (C# default).</summary>
         Null,
 
         /// <summary>Reference types cannot be null by default.</summary>