Removed special $ref handling as Newtonsoft $ref handling is turned o…

…ff anyway, closes #1186
RicoSuter · Sep 28, 2020 · 1ae0fdd · 1ae0fdd
1 parent f2f4b8b
commit 1ae0fdd
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 28 deletions.
diff --git a/...JsonSchema.Tests/Infrastructure/PropertyRenameAndIgnoreSerializerContractResolverTests.cs b/...JsonSchema.Tests/Infrastructure/PropertyRenameAndIgnoreSerializerContractResolverTests.cs
@@ -86,7 +86,6 @@ public void When_property_is_ignored_then_refs_ignore_it()
             //// Act
             JsonSchemaReferenceUtilities.UpdateSchemaReferencePaths(foo, false, contractResolver);
             var json = JsonConvert.SerializeObject(foo, Formatting.Indented, new JsonSerializerSettings { ContractResolver = contractResolver });
-            json = JsonSchemaReferenceUtilities.ConvertPropertyReferences(json);
 
             //// Assert
             Assert.Contains("#/definitions2/Bar", json);

diff --git a/src/NJsonSchema.Tests/Validation/SchemaTests.cs b/src/NJsonSchema.Tests/Validation/SchemaTests.cs
@@ -411,5 +411,50 @@ public async Task When_datetime_with_regex_validation_then_datetime_is_not_alter
             //// Assert
             Assert.Equal(0, errors.Count);
         }
+
+        [Fact]
+        public async Task When_property_name_is_ref_then_validation_works()
+        {
+            //// Arrange
+            var jsonSchema = @"{
+    ""$schema"": ""http://json-schema.org/draft-07/schema"",  
+    ""$ref"": ""#/definitions/reference_to_other_object"",
+    ""definitions"": {
+        ""reference_to_other_object"": {
+            ""type"": ""object"",
+            ""required"": [
+                ""$ref""
+            ],
+            ""additionalProperties"": false,
+            ""properties"": {
+                ""$ref"": {
+                    ""type"": ""string"",
+                    ""allOf"": [
+                        {
+                            ""format"": ""uri-reference""
+                        },
+                        {
+                            ""pattern"": ""^.*#/datatypes/.*$""
+                        }
+                    ]
+                }
+            }
+        }
+    }
+}";
+
+            //// Act
+            var jsonContent = @"{
+  ""$ref"": ""#/datatypes/MyCustomDataType""
+}";
+
+            //// Arrange
+            var validator = new JsonSchemaValidator();
+            var schema = await JsonSchema.FromJsonAsync(jsonSchema);
+            var result = validator.Validate(jsonContent, schema);
+
+            //// Assert
+            Assert.Empty(result);
+        }
     }
 }
diff --git a/src/NJsonSchema/Converters/JsonReferenceConverter.cs b/src/NJsonSchema/Converters/JsonReferenceConverter.cs
@@ -53,8 +53,6 @@ public override void WriteJson(JsonWriter writer, object value, JsonSerializer s
                 _isWriting = true;
 
                 var json = JsonConvert.SerializeObject(value, serializer.Formatting);
-                json = JsonSchemaReferenceUtilities.ConvertPropertyReferences(json);
-
                 if (writer.WriteState == WriteState.Property)
                 {
                     writer.WriteRawValue(json);

diff --git a/src/NJsonSchema/Infrastructure/JsonSchemaSerialization.cs b/src/NJsonSchema/Infrastructure/JsonSchemaSerialization.cs
@@ -72,7 +72,7 @@ public static string ToJson(object obj, SchemaType schemaType, IContractResolver
             CurrentSerializerSettings = null;
             CurrentSchemaType = SchemaType.JsonSchema;
 
-            return JsonSchemaReferenceUtilities.ConvertPropertyReferences(json);
+            return json;
         }
 
         /// <summary>Deserializes JSON data to a schema with reference handling.</summary>
@@ -124,8 +124,6 @@ public static T FromJson<T>(string json, IContractResolver contractResolver)
                 PreserveReferencesHandling = PreserveReferencesHandling.None
             };
 
-            json = JsonSchemaReferenceUtilities.ConvertJsonReferences(json);
-
             var obj = JsonConvert.DeserializeObject<T>(json, CurrentSerializerSettings);
             CurrentSerializerSettings = null;
 

diff --git a/src/NJsonSchema/JsonPathUtilities.cs b/src/NJsonSchema/JsonPathUtilities.cs
@@ -19,9 +19,6 @@ namespace NJsonSchema
     /// <summary>Utilities to work with JSON paths.</summary>
     public static class JsonPathUtilities
     {
-        /// <summary>Gets the $ref replacement string.</summary>
-        public const string ReferenceReplaceString = "__referencePath";
-
         /// <summary>Gets the JSON path of the given object.</summary>
         /// <param name="rootObject">The root object.</param>
         /// <param name="searchedObject">The object to search.</param>

diff --git a/src/NJsonSchema/JsonSchemaReferenceUtilities.cs b/src/NJsonSchema/JsonSchemaReferenceUtilities.cs
@@ -11,7 +11,6 @@
 using System.Linq;
 using System.Threading.Tasks;
 using Newtonsoft.Json.Serialization;
-using NJsonSchema.Infrastructure;
 using NJsonSchema.References;
 using NJsonSchema.Visitors;
 
@@ -38,22 +37,6 @@ public static async Task UpdateSchemaReferencesAsync(object rootObject, JsonRefe
             await updater.VisitAsync(rootObject).ConfigureAwait(false);
         }
 
-        /// <summary>Converts JSON references ($ref) to property references.</summary>
-        /// <param name="data">The data.</param>
-        /// <returns>The data.</returns>
-        public static string ConvertJsonReferences(string data)
-        {
-            return data.Replace("$ref", JsonPathUtilities.ReferenceReplaceString);
-        }
-
-        /// <summary>Converts property references to JSON references ($ref).</summary>
-        /// <param name="data">The data.</param>
-        /// <returns></returns>
-        public static string ConvertPropertyReferences(string data)
-        {
-            return data.Replace(JsonPathUtilities.ReferenceReplaceString, "$ref");
-        }
-
         /// <summary>Updates the <see cref="IJsonReferenceBase.Reference" /> properties
         /// from the available <see cref="IJsonReferenceBase.Reference" /> properties with inlining external references.</summary>
         /// <param name="rootObject">The root object.</param>

diff --git a/src/NJsonSchema/References/IJsonReferenceBase.cs b/src/NJsonSchema/References/IJsonReferenceBase.cs
@@ -14,7 +14,7 @@ namespace NJsonSchema.References
     public interface IJsonReferenceBase : IDocumentPathProvider
     {
         /// <summary>Gets or sets the type reference path ($ref). </summary>
-        [JsonProperty(JsonPathUtilities.ReferenceReplaceString, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
+        [JsonProperty("$ref", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
         string ReferencePath { get; set; }
 
         /// <summary>Gets or sets the referenced object.</summary>

diff --git a/src/NJsonSchema/References/JsonReferenceBase.cs b/src/NJsonSchema/References/JsonReferenceBase.cs
@@ -22,7 +22,7 @@ public abstract class JsonReferenceBase<T> : IJsonReferenceBase
         public string DocumentPath { get; set; }
 
         /// <summary>Gets or sets the type reference path ($ref). </summary>
-        [JsonProperty(JsonPathUtilities.ReferenceReplaceString, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
+        [JsonProperty("$ref", DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
         string IJsonReferenceBase.ReferencePath { get; set; }
 
         /// <summary>Gets or sets the referenced object.</summary>