Add bulk display liquid filters.

Author: sarahelsaig

Lombiq.HelpfulExtensions/Extensions/Liquid/Readme.md

@@ -11,3 +11,13 @@ Adds various Liquid tags and filters. For more information about Liquid in Orcha
 ## Filters
 
 - `is_not_empty`: Returns `true` if the input is not null and not empty.
+- `shapes_build_display: 'Summary'`: Behaves the same way as the built-in `shape_build_display` filter, except both the input and output are arrays for bulk operation (e.g. from queries).
+- `shapes_render`: Behaves the same way as the built-in `shape_render` filter, except both the input and output are arrays for bulk operation (e.g. from queries).
+
+### Array filter example
+
+You can use `shapes_build_display` and `shapes_render` to easily display items from a query. For example, using the query in the "blog" recipe:
+
+```liquid
+{{ Queries['RecentBlogPosts'] | query | shapes_build_display: 'Summary' | shapes_render }}
+```

Lombiq.HelpfulExtensions/Extensions/Liquid/Services/ArrayFilterBase.cs

@@ -0,0 +1,57 @@
+using Fluid;
+using Fluid.Values;
+using OrchardCore.Liquid;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+
+namespace Lombiq.HelpfulExtensions.Extensions.Liquid.Services;
+
+public abstract class ArrayFilterBase : ILiquidFilter
+{
+    private readonly ILiquidFilter _filter;
+
+    protected ArrayFilterBase(ILiquidFilter filter) =>
+        _filter = filter;
+
+    public async ValueTask<FluidValue> ProcessAsync(
+        FluidValue input,
+        FilterArguments arguments,
+        LiquidTemplateContext context)
+    {
+        var results = new List<FluidValue>();
+
+        if (input.Type == FluidValues.Array && input is ArrayValue arrayValue)
+        {
+            foreach (var value in arrayValue.Values)
+            {
+                await AddAsync(results, value, arguments, context);
+            }
+        }
+        else if (input.Type == FluidValues.Object)
+        {
+            await AddAsync(results, input, arguments, context);
+        }
+
+        return await ThenAsync(results, input, arguments, context);
+    }
+
+    protected virtual ValueTask<FluidValue> ThenAsync(
+        IList<FluidValue> results,
+        FluidValue input,
+        FilterArguments arguments,
+        LiquidTemplateContext context) =>
+        ValueTask.FromResult(FluidValue.Create(results.ToArray(), context.Options));
+
+    private async ValueTask AddAsync(
+        List<FluidValue> results,
+        FluidValue value,
+        FilterArguments arguments,
+        LiquidTemplateContext context)
+    {
+        if (!value.ToBooleanValue()) return;
+
+        var result = await _filter.ProcessAsync(value, arguments, context);
+        if (result.ToBooleanValue()) results.Add(result);
+    }
+}

Lombiq.HelpfulExtensions/Extensions/Liquid/Services/ShapesBuildDisplayFilter.cs

@@ -0,0 +1,11 @@
+using OrchardCore.Contents.Liquid;
+
+namespace Lombiq.HelpfulExtensions.Extensions.Liquid.Services;
+
+public class ShapesBuildDisplayFilter : ArrayFilterBase
+{
+    public ShapesBuildDisplayFilter(BuildDisplayFilter buildDisplayFilter)
+        : base(buildDisplayFilter)
+    {
+    }
+}

Lombiq.HelpfulExtensions/Extensions/Liquid/Services/ShapesRenderFilter.cs

@@ -0,0 +1,43 @@
+using Fluid;
+using Fluid.Values;
+using Microsoft.AspNetCore.Html;
+using OrchardCore.DisplayManagement.Liquid;
+using OrchardCore.DisplayManagement.Liquid.Filters;
+using OrchardCore.Liquid;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+namespace Lombiq.HelpfulExtensions.Extensions.Liquid.Services;
+
+public class ShapesRenderFilter : ArrayFilterBase
+{
+    public ShapesRenderFilter(ShapeRenderFilter shapeRenderFilter)
+        : base(shapeRenderFilter)
+    {
+    }
+
+    protected override ValueTask<FluidValue> ThenAsync(
+        IList<FluidValue> results,
+        FluidValue input,
+        FilterArguments arguments,
+        LiquidTemplateContext context)
+    {
+        var combined = new HtmlContentBuilder();
+
+        foreach (var result in results)
+        {
+            if (result.ToObjectValue() is IHtmlContent htmlContent)
+            {
+                combined.AppendHtml(htmlContent);
+            }
+            else
+            {
+                combined.Append(result.ToStringValue());
+            }
+
+            combined.AppendHtml("\n");
+        }
+
+        return ValueTask.FromResult(FluidValue.Create(combined, context.Options));
+    }
+}

Lombiq.HelpfulExtensions/Extensions/Liquid/Startup.cs

@@ -1,3 +1,4 @@
+using Lombiq.HelpfulExtensions.Extensions.Liquid.Services;
 using Microsoft.Extensions.DependencyInjection;
 using OrchardCore.Liquid;
 using OrchardCore.Modules;
@@ -12,5 +13,7 @@ public override void ConfigureServices(IServiceCollection services)
         services.AddLiquidParserBlock<IfNotEmptyParserBlock>("ifnotempty");
         services.AddLiquidFilter<IsNotEmptyFilter>("is_not_empty");
         services.AddLiquidParserTag<AssignArrayParserBlock>("assign_array");
+        services.AddLiquidFilter<ShapesBuildDisplayFilter>("shapes_build_display");
+        services.AddLiquidFilter<ShapesRenderFilter>("shapes_render");
     }
 }