feat (Liquid): Add TemplateOptions as a configurable property.

Added test for complex object.
lukencode · Sep 19, 2021 · e10a74b · e10a74b
1 parent d3cddcb
commit e10a74b
Show file tree

Hide file tree

Showing 6 changed files with 105 additions and 2 deletions.
diff --git a/src/Renderers/FluentEmail.Liquid/LiquidRenderer.cs b/src/Renderers/FluentEmail.Liquid/LiquidRenderer.cs
@@ -34,7 +34,7 @@ public async Task<string> ParseAsync<T>(string template, T model, bool isHtml =
             var fileProvider = rendererOptions.FileProvider;
             var viewTemplate = ParseTemplate(template);
 
-            var context = new TemplateContext(model)
+            var context = new TemplateContext(model, rendererOptions.TemplateOptions)
             {
                 // provide some services to all statements
                 AmbientValues =
@@ -56,7 +56,7 @@ public async Task<string> ParseAsync<T>(string template, T model, bool isHtml =
             if (context.AmbientValues.TryGetValue("Layout", out var layoutPath))
             {
                 context.AmbientValues["Body"] = body;
-                var layoutTemplate = ParseLiquidFile((string) layoutPath, fileProvider!);
+                var layoutTemplate = ParseLiquidFile((string)layoutPath, fileProvider!);
 
                 return await layoutTemplate.RenderAsync(context, rendererOptions.TextEncoder);
             }

diff --git a/src/Renderers/FluentEmail.Liquid/LiquidRendererOptions.cs b/src/Renderers/FluentEmail.Liquid/LiquidRendererOptions.cs
@@ -25,5 +25,10 @@ public class LiquidRendererOptions
         /// File provider to use, used when resolving references in templates, like master layout.
         /// </summary>
         public IFileProvider? FileProvider { get; set; }
+
+        /// <summary>
+        /// Set custom Template Options for Fluid 
+        /// </summary>
+        public TemplateOptions TemplateOptions { get; set; } = new();
     }
 }
diff --git a/test/FluentEmail.Liquid.Tests/ComplexModel/ComplexModelRenderTests.cs b/test/FluentEmail.Liquid.Tests/ComplexModel/ComplexModelRenderTests.cs
@@ -0,0 +1,71 @@
+using System;
+using System.Collections.Generic;
+using FluentAssertions;
+using FluentEmail.Core;
+using Fluid;
+using Microsoft.Extensions.FileProviders;
+using Microsoft.Extensions.Options;
+using NUnit.Framework;
+
+namespace FluentEmail.Liquid.Tests.ComplexModel
+{
+    public class ComplexModelRenderTests
+    {
+        public ComplexModelRenderTests()
+        {
+            SetupRenderer();
+        }
+
+        [Test]
+        public void Can_Render_Complex_Model_Properties()
+        {
+            var model = new ParentModel
+            {
+                ParentName = new NameDetails { Firstname = "Luke", Surname = "Dinosaur" },
+                ChildrenNames = new List<NameDetails>
+                {
+                    new NameDetails { Firstname = "ChildFirstA", Surname = "ChildLastA" },
+                    new NameDetails { Firstname = "ChildFirstB", Surname = "ChildLastB" }
+                }
+            };
+
+            var expected = @"
+Parent: Luke
+Children:
+
+* ChildFirstA ChildLastA
+* ChildFirstB ChildLastB
+";
+
+            var email = Email
+                .From(TestData.FromEmail)
+                .To(TestData.ToEmail)
+                .Subject(TestData.Subject)
+                .UsingTemplate(Template(), model);
+            email.Data.Body.Should().Be(expected);
+        }
+
+        private string Template()
+        {
+            return @"
+Parent: {{ ParentName.Firstname }}
+Children:
+{% for Child in ChildrenNames %}
+* {{ Child.Firstname }} {{ Child.Surname }}{% endfor %}
+";
+        }
+
+        private static void SetupRenderer(
+            IFileProvider fileProvider = null,
+            Action<TemplateContext, object> configureTemplateContext = null)
+        {
+            var options = new LiquidRendererOptions
+            {
+                FileProvider = fileProvider,
+                ConfigureTemplateContext = configureTemplateContext,
+                TemplateOptions = new TemplateOptions { MemberAccessStrategy = new UnsafeMemberAccessStrategy() }
+            };
+            Email.DefaultRenderer = new LiquidRenderer(Options.Create(options));
+        }
+    }
+}
diff --git a/test/FluentEmail.Liquid.Tests/ComplexModel/ParentModel.cs b/test/FluentEmail.Liquid.Tests/ComplexModel/ParentModel.cs
@@ -0,0 +1,17 @@
+using System.Collections.Generic;
+
+namespace FluentEmail.Liquid.Tests
+{
+    public class ParentModel
+    {
+        public string Id { get; set; }
+        public NameDetails ParentName { get; set; }
+        public List<NameDetails> ChildrenNames { get; set; } = new List<NameDetails>();
+    }
+
+    public class NameDetails
+    {
+        public string Firstname { get; set; }
+        public string Surname { get; set; }
+    }
+}
diff --git a/test/FluentEmail.Liquid.Tests/ComplexModel/TestData.cs b/test/FluentEmail.Liquid.Tests/ComplexModel/TestData.cs
@@ -0,0 +1,9 @@
+namespace FluentEmail.Liquid.Tests
+{
+    public static class TestData
+    {
+        public const string ToEmail = "bob@test.com";
+        public const string FromEmail = "johno@test.com";
+        public const string Subject = "sup dawg";
+    }
+}
diff --git a/test/FluentEmail.Liquid.Tests/FluentEmail.Liquid.Tests.csproj b/test/FluentEmail.Liquid.Tests/FluentEmail.Liquid.Tests.csproj
@@ -21,6 +21,7 @@
 
 
   <ItemGroup>
+    <PackageReference Include="FluentAssertions" Version="6.1.0" />
     <PackageReference Include="Microsoft.Extensions.FileProviders.Embedded" Version="5.0.2" />
     <PackageReference Include="Microsoft.Extensions.FileProviders.Physical" Version="5.0.0" />
   </ItemGroup>