Fix writing dependencies, add JSchema.ToString settings overload (#202)

JamesNK · Dec 23, 2019 · 000a31d · 000a31d
1 parent a848c36
commit 000a31d
Show file tree

Hide file tree

Showing 9 changed files with 163 additions and 12 deletions.
diff --git a/Build/build.ps1 b/Build/build.ps1
@@ -13,8 +13,8 @@
   $treatWarningsAsErrors = $false
   $workingName = if ($workingName) {$workingName} else {"Working"}
   $assemblyVersion = if ($assemblyVersion) {$assemblyVersion} else {$majorVersion + '.0.0'}
-  $netCliChannel = "2.0"
-  $netCliVersion = "3.0.100-preview9-013927"
+  $netCliChannel = "Current"
+  $netCliVersion = "3.1.100"
   $nugetUrl = "https://dist.nuget.org/win-x86-commandline/latest/nuget.exe"
 
   $baseDir  = resolve-path ..
@@ -33,7 +33,7 @@
 
   $builds = @(
     @{Framework = "netstandard1.3"; TestsFunction = "NetCliTests"; TestFramework = "netcoreapp2.1"; Enabled=$true}
-    @{Framework = "netstandard2.0"; TestsFunction = "NetCliTests"; TestFramework = "netcoreapp3.0"; Enabled=$true}
+    @{Framework = "netstandard2.0"; TestsFunction = "NetCliTests"; TestFramework = "netcoreapp3.1"; Enabled=$true}
     @{Framework = "net45"; TestsFunction = "NUnitTests"; TestFramework = "net46"; NUnitFramework="net-4.0"; Enabled=$true},
     @{Framework = "net40"; TestsFunction = "NUnitTests"; NUnitFramework="net-4.0"; Enabled=$true},
     @{Framework = "net35"; TestsFunction = "NUnitTests"; NUnitFramework="net-2.0"; Enabled=$true}

diff --git a/Src/Newtonsoft.Json.Schema.Tests/Infrastructure/JSchemaReaderTests.cs b/Src/Newtonsoft.Json.Schema.Tests/Infrastructure/JSchemaReaderTests.cs
@@ -17,6 +17,7 @@
 using System.Reflection;
 using Newtonsoft.Json.Linq;
 using Newtonsoft.Json.Schema.Infrastructure;
+using System.Text;
 
 namespace Newtonsoft.Json.Schema.Tests.Infrastructure
 {
@@ -346,6 +347,17 @@ public void BadRegexPattern()
         [Test]
         public void ReadAllResourceSchemas()
         {
+            JSchemaPreloadedResolver resolver = new JSchemaPreloadedResolver();
+            resolver.Add(
+                new Uri("http://json-schema.org/draft-04/schema"),
+                Encoding.UTF8.GetBytes(TestHelpers.OpenFileText("Resources/Schemas/schema-draft-v4.json")));
+            resolver.Add(
+                new Uri("http://json.schemastore.org/grunt-task"),
+                Encoding.UTF8.GetBytes(TestHelpers.OpenFileText("Resources/Schemas/grunt-task.json")));
+            resolver.Add(
+                new Uri("http://json.schemastore.org/jshintrc"),
+                Encoding.UTF8.GetBytes(TestHelpers.OpenFileText("Resources/Schemas/jshintrc.json")));
+
             string schemaDir = TestHelpers.ResolveFilePath(@"resources\schemas");
 
             string[] schemaFilePaths = Directory.GetFiles(schemaDir, "*.json");
@@ -357,7 +369,7 @@ public void ReadAllResourceSchemas()
                     using (StreamReader sr = File.OpenText(schemaFilePath))
                     using (JsonTextReader reader = new JsonTextReader(sr))
                     {
-                        JSchema schema = JSchema.Load(reader, new JSchemaUrlResolver());
+                        JSchema schema = JSchema.Load(reader, resolver);
                     }
                 }
                 catch (Exception ex)

diff --git a/Src/Newtonsoft.Json.Schema.Tests/Issues/Issue0032Tests.cs b/Src/Newtonsoft.Json.Schema.Tests/Issues/Issue0032Tests.cs
@@ -26,7 +26,10 @@ public void Test()
         {
             string swaggerJson = TestHelpers.OpenFileText("Resources/Schemas/swagger-2.0.json");
 
-            JSchemaUrlResolver resolver = new JSchemaUrlResolver();
+            JSchemaPreloadedResolver resolver = new JSchemaPreloadedResolver();
+            resolver.Add(
+                new Uri("http://json-schema.org/draft-04/schema"),
+                Encoding.UTF8.GetBytes(TestHelpers.OpenFileText("Resources/Schemas/schema-draft-v4.json")));
 
             JSchema swagger = JSchema.Parse(swaggerJson, resolver);
 

diff --git a/Src/Newtonsoft.Json.Schema.Tests/Issues/Issue0200Tests.cs b/Src/Newtonsoft.Json.Schema.Tests/Issues/Issue0200Tests.cs
@@ -0,0 +1,102 @@
+#region License
+// Copyright (c) Newtonsoft. All Rights Reserved.
+// License: https://raw.github.com/JamesNK/Newtonsoft.Json.Schema/master/LICENSE.md
+#endregion
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using Newtonsoft.Json.Linq;
+#if DNXCORE50
+using Xunit;
+using Test = Xunit.FactAttribute;
+using Assert = Newtonsoft.Json.Schema.Tests.XUnitAssert;
+#else
+using NUnit.Framework;
+#endif
+
+namespace Newtonsoft.Json.Schema.Tests.Issues
+{
+    [TestFixture]
+    public class Issue0200Tests : TestFixtureBase
+    {
+        [Test]
+        public void Test()
+        {
+            // Arrange
+            string schemaJson = @"{
+  ""type"": ""object"",
+  ""definitions"": {
+    ""foo"": {
+      ""type"": ""object"",
+      ""properties"": {
+        ""bar"": {
+          ""$ref"": ""#/definitions/bar""
+        },
+        ""baz"": {
+          ""$ref"": ""#/definitions/bar""
+        }
+      }
+    },
+    ""bar"": {
+      ""type"": ""string"" 
+    }
+  },
+  ""dependencies"": {
+    ""foo"": {
+      ""oneOf"": [
+        {
+          ""properties"": {
+            ""foo"": {
+              ""$ref"": ""#/definitions/foo"" 
+            } 
+          } 
+        }
+      ] 
+    } 
+  } 
+}";
+
+            JSchema schema = JSchema.Parse(schemaJson);
+
+            // Act
+            string serialized = schema.ToString();
+
+            // Assert
+            StringAssert.AreEqual(@"{
+  ""definitions"": {
+    ""foo"": {
+      ""type"": ""object"",
+      ""properties"": {
+        ""bar"": {
+          ""$ref"": ""#/definitions/bar""
+        },
+        ""baz"": {
+          ""$ref"": ""#/definitions/bar""
+        }
+      }
+    },
+    ""bar"": {
+      ""type"": ""string""
+    }
+  },
+  ""type"": ""object"",
+  ""dependencies"": {
+    ""foo"": {
+      ""oneOf"": [
+        {
+          ""properties"": {
+            ""foo"": {
+              ""$ref"": ""#/definitions/foo""
+            }
+          }
+        }
+      ]
+    }
+  }
+}", serialized);
+        }
+    }
+}
diff --git a/Src/Newtonsoft.Json.Schema.Tests/JSchemaTests.cs b/Src/Newtonsoft.Json.Schema.Tests/JSchemaTests.cs
@@ -346,5 +346,27 @@ public void PatternProperties_Remove_NullKey()
 Parameter name: key",
                 "Value cannot be null. (Parameter 'key')");
         }
+
+        [Test]
+        public void ToString_JsonWriterSettings()
+        {
+            JSchema propertySchema = new JSchema();
+
+            JSchema s = new JSchema();
+            s.Properties["one"] = propertySchema;
+            s.Properties["two"] = propertySchema;
+
+            string json = s.ToString(new JSchemaWriterSettings
+            {
+                ReferenceHandling = JSchemaWriterReferenceHandling.Never
+            });
+
+            StringAssert.AreEqual(@"{
+  ""properties"": {
+    ""one"": {},
+    ""two"": {}
+  }
+}", json);
+        }
     }
 }
diff --git a/Src/Newtonsoft.Json.Schema.Tests/Newtonsoft.Json.Schema.Tests.csproj b/Src/Newtonsoft.Json.Schema.Tests/Newtonsoft.Json.Schema.Tests.csproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks Condition="'$(TestFrameworks)'==''">net46;net40;net35;netcoreapp2.1;netcoreapp3.0</TargetFrameworks>
+    <TargetFrameworks Condition="'$(TestFrameworks)'==''">net46;net40;net35;netcoreapp2.1;netcoreapp3.1</TargetFrameworks>
     <TargetFrameworks Condition="'$(TestFrameworks)'!=''">$(TestFrameworks)</TargetFrameworks>
     <VersionPrefix>1.0</VersionPrefix>
     <Authors>Newtonsoft</Authors>
@@ -12,7 +12,7 @@
     <AssemblyName>Newtonsoft.Json.Schema.Tests</AssemblyName>
     <IsPackable>false</IsPackable>
     <!-- Workaround for https://github.com/nunit/nunit3-vs-adapter/issues/296 -->
-    <DebugType Condition="'$(TargetFramework)' != '' AND '$(TargetFramework)' != 'netcoreapp2.1' AND '$(TargetFramework)' != 'netcoreapp3.0'">Full</DebugType>
+    <DebugType Condition="'$(TargetFramework)' != '' AND '$(TargetFramework)' != 'netcoreapp2.1' AND '$(TargetFramework)' != 'netcoreapp3.1'">Full</DebugType>
     <NoWarn>1685;1701;1702;1705</NoWarn>
     <!-- Disabled because SourceLink isn't referenced to calculate paths -->
     <DeterministicSourcePaths>false</DeterministicSourcePaths>
@@ -74,7 +74,7 @@
     <DefineConstants>NETSTANDARD1_3;DNXCORE50;PORTABLE;HAVE_BENCHMARKS;$(AdditionalConstants)</DefineConstants>
   </PropertyGroup>
 
-  <ItemGroup Condition="'$(TargetFramework)'=='netcoreapp3.0'">
+  <ItemGroup Condition="'$(TargetFramework)'=='netcoreapp3.1'">
     <PackageReference Include="BenchmarkDotNet" Version="0.10.9" />
     <PackageReference Include="FSharp.Core" Version="4.2.3" />
     <PackageReference Include="System.ComponentModel.Annotations" Version="4.3.0" />
@@ -83,7 +83,7 @@
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.9.0" />
   </ItemGroup>
 
-  <PropertyGroup Condition="'$(TargetFramework)'=='netcoreapp3.0'">
+  <PropertyGroup Condition="'$(TargetFramework)'=='netcoreapp3.1'">
     <AssemblyTitle>Json.NET Schema Tests .NET Standard 2.0</AssemblyTitle>
     <ReferringTargetFrameworkForProjectReferences>.NETStandard,Version=v2.0</ReferringTargetFrameworkForProjectReferences>
     <DefineConstants>NETSTANDARD1_3;DNXCORE50;PORTABLE;HAVE_BENCHMARKS;$(AdditionalConstants)</DefineConstants>

diff --git a/Src/Newtonsoft.Json.Schema/Infrastructure/JSchemaWriter.cs b/Src/Newtonsoft.Json.Schema/Infrastructure/JSchemaWriter.cs
@@ -400,13 +400,13 @@ private void WriteSchemaObjectInternal(JSchema schema)
                 _writer.WriteStartObject();
                 foreach (KeyValuePair<string, object> dependency in schema._dependencies)
                 {
-                    _writer.WritePropertyName(dependency.Key);
                     if (dependency.Value is JSchema s)
                     {
-                        s.WriteTo(_writer);
+                        ReferenceOrWriteSchema(schema, s, dependency.Key);
                     }
                     else if (dependency.Value is IList<string> a)
                     {
+                        _writer.WritePropertyName(dependency.Key);
                         _writer.WriteStartArray();
                         for (int i = 0; i < a.Count; i++)
                         {

diff --git a/Src/Newtonsoft.Json.Schema/JSchema.cs b/Src/Newtonsoft.Json.Schema/JSchema.cs
@@ -579,6 +579,18 @@ public string ToString(SchemaVersion version)
             return ToStringInternal(settings);
         }
 
+        /// <summary>
+        /// Returns the JSON for this schema using the specified <see cref="JSchemaWriterSettings"/>.
+        /// </summary>
+        /// <param name="settings">The settings used to write the schema.</param>
+        /// <returns>The JSON for this schema.</returns>
+        public string ToString(JSchemaWriterSettings settings)
+        {
+            ValidationUtils.ArgumentNotNull(settings, nameof(settings));
+
+            return ToStringInternal(settings);
+        }
+
         private string ToStringInternal(JSchemaWriterSettings settings)
         {
             StringWriter writer = new StringWriter(CultureInfo.InvariantCulture);

diff --git a/Src/global.json b/Src/global.json
@@ -1,5 +1,5 @@
 {
   "sdk": {
-    "version": "3.0.100-preview9-013927"
+    "version": "3.1.100"
   }
 }