Merge pull request #41 from TylerReid/optionToIgnoreProperties

add IgnoreMissingProperties to TomlModelOptions
xoofx · Jul 1, 2022 · 5605d7c · 5605d7c
2 parents e7b7629 + 443d20d
commit 5605d7c
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 2 deletions.
diff --git a/src/Tomlyn.Tests/ModelTests/ReflectionModelTests.cs b/src/Tomlyn.Tests/ModelTests/ReflectionModelTests.cs
@@ -424,6 +424,24 @@ public void TestModelWithFixedList()
             CollectionAssert.AreEqual(new List<string> { "1", "2", "3" }, model.Values);
         }
 
+        [Test]
+        public void TestModelWithMissingProperties()
+        {
+            var input = @"values = ['1', '2', '3']
+some_thing_that_doesnt_exist = true";
+
+            StandardTests.DisplayHeader("input");
+            Console.WriteLine(input);
+            var model = Toml.ToModel<SimpleModel>(input, options: new TomlModelOptions
+            {
+                IgnoreMissingProperties = true,
+            });
+            CollectionAssert.AreEqual(new List<string> { "1", "2", "3" }, model.Values);
+
+            Assert.Throws<TomlException>(() => Toml.ToModel<SimpleModel>(input));
+
+        }
+
         public class SimpleModel
         {
             public SimpleModel()

diff --git a/src/Tomlyn/Model/Accessors/DynamicModelReadContext.cs b/src/Tomlyn/Model/Accessors/DynamicModelReadContext.cs
@@ -18,6 +18,7 @@ public DynamicModelReadContext(TomlModelOptions options)
         ConvertPropertyName = options.ConvertPropertyName;
         CreateInstance = options.CreateInstance;
         ConvertToModel = options.ConvertToModel;
+        IgnoreMissingProperties = options.IgnoreMissingProperties;
         Diagnostics = new DiagnosticsBag();
         _accessors = new Dictionary<Type, DynamicAccessor>();
     }
@@ -31,6 +32,8 @@ public DynamicModelReadContext(TomlModelOptions options)
     public Func<object, Type, object?>? ConvertToModel { get; set; }
 
     public DiagnosticsBag Diagnostics { get; }
+
+    public bool IgnoreMissingProperties { get; set; }
 
     public DynamicAccessor GetAccessor(Type type)
     {

diff --git a/src/Tomlyn/Model/Accessors/StandardObjectDynamicAccessor.cs b/src/Tomlyn/Model/Accessors/StandardObjectDynamicAccessor.cs
@@ -165,8 +165,13 @@ public override bool TryGetPropertyType(SourceSpan span, string name, out Type?
             return true;
         }
 
-        // Otherwise, it's an error.
-        Context.Diagnostics.Error(span, $"The property `{name}` was not found on object type {TargetType.FullName}");
+        // If configured to ignore missing properties on the target type,
+        // return false to indicate it is missing but don't set an error
+        if (!Context.IgnoreMissingProperties)
+        {
+            // Otherwise, it's an error.
+            Context.Diagnostics.Error(span, $"The property `{name}` was not found on object type {TargetType.FullName}");
+        }
         return false;
     }
 

diff --git a/src/Tomlyn/TomlModelOptions.cs b/src/Tomlyn/TomlModelOptions.cs
@@ -24,6 +24,7 @@ public TomlModelOptions()
         GetPropertyName = DefaultGetPropertyNameImpl;
         CreateInstance = DefaultCreateInstance;
         ConvertPropertyName = DefaultConvertPropertyName;
+        IgnoreMissingProperties = false;
 
         AttributeListForIgnore = new List<string>()
         {
@@ -113,6 +114,14 @@ public TomlModelOptions()
     /// </remarks>
     public List<string> AttributeListForGetName { get; }
 
+    /// <summary>
+    /// Gets or sets the option to ignore properties in the TOML that are missing from a custom model
+    /// </summary>
+    /// <remarks>
+    /// By default this is false
+    /// </remarks>
+    public bool IgnoreMissingProperties { get; set; }
+
     /// <summary>
     /// Default implementation for getting the property name
     /// </summary>