can ignore or rename a field

Author: mikebridge

Liquid.NET.Tests/Utils/LiquidValueConverterTests.cs

@@ -219,7 +219,38 @@ public void It_Should_Convert_An_Object_With_Null_Field()
 
             // Assert
             Assert.That(objAsHash["objfield1"].HasValue, Is.False);
+        }
+
+        [Test]
+        public void It_Should_Rename_A_Field()
+        {
+            // Act
+            var testClass = new ClassWithAttributes { Ignored = "ignored", Ok = "ok", Renamed="renamed"};
+
+            var result = _converter.Convert(testClass);
+
+            Assert.That(result.HasValue);
+            var objAsHash = (LiquidHash)result.Value;
+
+            // Assert
+            Assert.That(objAsHash["somethingelse"].HasValue);
+            Assert.That(objAsHash["somethingelse"].Value, Is.EqualTo(LiquidString.Create("renamed")));
+        }
+
+        [Test]
+        public void It_Should_Ignore_A_Field()
+        {
+            // Act
+            var testClass = new ClassWithAttributes { Ignored = "ignored", Ok = "ok", Renamed = "renamed" };
+
+            var result = _converter.Convert(testClass);
+
+            Assert.That(result.HasValue);
+            var objAsHash = (LiquidHash)result.Value;
 
+            // Assert
+            Assert.That(objAsHash.ContainsKey("ignored"), Is.False);
+            Assert.That(objAsHash.ContainsKey("ok"), Is.True);
         }
 
         public class TestClass
@@ -230,8 +261,18 @@ public class TestClass
             public Object ObjField1 {get; set;}
 
         }
-        
 
+        public class ClassWithAttributes
+        {
+            [LiquidIgnore]
+            public String Ignored { get; set; }
+
+            [LiquidName("somethingelse")]
+            public String Renamed { get; set; }
+
+            public String Ok { get; set; }
+
+        }
 
     }
 }

Liquid.NET/Liquid.NET.csproj

@@ -215,6 +215,7 @@
     <Compile Include="src\TemplateContext.cs" />
     <Compile Include="src\Symbols\IASTVisitor.cs" />
     <Compile Include="src\Utils\Either.cs" />
+    <Compile Include="src\Utils\LiquidValueConverterAttributes.cs" />
     <Compile Include="src\Utils\LiquidExpressionResult.cs" />
     <Compile Include="src\Utils\LiquidVersionAttribute.cs" />
     <Compile Include="src\Utils\Option.cs" />

Liquid.NET/src/Utils/LiquidValueConverter.cs

@@ -1,5 +1,4 @@
 using System;
-using System.CodeDom;
 using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
@@ -38,8 +37,9 @@ private Option<ILiquidValue> FromObject(Object obj)
             var newHash = new LiquidHash();
             var kvps = obj.GetType()
                 .GetProperties()
+                .Where(property => !property.GetCustomAttributes<LiquidIgnoreAttribute>().Any())
                 .Select(property => new KeyValuePair<String, Option<ILiquidValue>> (
-                    property.Name.ToLower(),
+                    GetPropertyName(property),
                     GetPropertyValue(obj, property)));
 
             foreach (var kvp in kvps)
@@ -57,6 +57,14 @@ private Option<ILiquidValue> FromObject(Object obj)
             return newHash;
         }
 
+        private string GetPropertyName(PropertyInfo property)
+        {
+            var overriddenName = property.GetCustomAttributes<LiquidNameAttribute>().FirstOrDefault();
+
+            return overriddenName == null ? property.Name.ToLowerInvariant() : overriddenName.Key.ToLowerInvariant();
+            
+        }
+
         private Option<ILiquidValue> GetPropertyValue(Object obj, PropertyInfo property)
         {
             var val = property.GetGetMethod().Invoke(obj, null);

Liquid.NET/src/Utils/LiquidValueConverterAttributes.cs

@@ -0,0 +1,22 @@
+using System;
+
+namespace Liquid.NET.Utils
+{
+    [AttributeUsage(AttributeTargets.Property, AllowMultiple = false)]
+    public class LiquidIgnoreAttribute : Attribute
+    {
+    }
+
+    [AttributeUsage(AttributeTargets.Property, AllowMultiple = false)]
+    public class LiquidNameAttribute : Attribute
+    {
+        private readonly string _key;
+        public String Key { get { return _key; }}
+
+        public LiquidNameAttribute(String key)
+        {
+            _key = key;
+        }
+    }
+
+}