feat: introduce SwapStyle.Default

Author: egil

src/Htmxor/HtmxConfig.cs

@@ -8,6 +8,8 @@ namespace Htmxor;
 /// </summary>
 public partial record class HtmxConfig
 {
+    private SwapStyle? defaultSwapStyle;
+
     /// <summary>
     /// Defaults to <see langword="true" /> if this property is null. really only useful for testing
     /// </summary>
@@ -31,7 +33,11 @@ public partial record class HtmxConfig
     /// Defaults to <see cref="SwapStyle.InnerHTML"/> if this property is null.
     /// </summary>
     [JsonPropertyName("defaultSwapStyle")]
-    public SwapStyle? DefaultSwapStyle { get; set; }
+    public SwapStyle? DefaultSwapStyle
+    {
+        get => defaultSwapStyle;
+        set => defaultSwapStyle = value is SwapStyle.Default ? null : value;
+    }
 
     /// <summary>
     /// Defaults to <see langword="0"/> if this property is null.

src/Htmxor/Http/HtmxResponse.cs

@@ -144,7 +144,14 @@ public HtmxResponse ReplaceUrl(string url)
     /// <returns>This <see cref="HtmxResponse"/> object instance.</returns>
     public HtmxResponse Reswap(string modifier)
     {
-        headers[HtmxResponseHeaderNames.Reswap] = modifier;
+        if (string.IsNullOrWhiteSpace(modifier))
+        {
+            headers.Remove(HtmxResponseHeaderNames.Reswap);
+        }
+        else
+        {
+            headers[HtmxResponseHeaderNames.Reswap] = modifier;
+        }
 
         return this;
     }
@@ -159,37 +166,35 @@ public HtmxResponse Reswap(SwapStyle swapStyle, string? modifier = null)
     {
         AssertIsHtmxRequest();
 
-        var style = swapStyle switch
+        if (swapStyle is SwapStyle.Default)
         {
-            SwapStyle.InnerHTML => "innerHTML",
-            SwapStyle.OuterHTML => "outerHTML",
-            SwapStyle.BeforeBegin => "beforebegin",
-            SwapStyle.AfterBegin => "afterbegin",
-            SwapStyle.BeforeEnd => "beforeend",
-            SwapStyle.AfterEnd => "afterend",
-            SwapStyle.Delete => "delete",
-            SwapStyle.None => "none",
-            _ => throw new SwitchExpressionException(swapStyle),
-        };
+            Reswap(modifier);
+            return this;
+        }
 
-        var value = modifier != null ? $"{style} {modifier}" : style;
+        var style = swapStyle.ToHtmxString();
+        var value = !string.IsNullOrWhiteSpace(modifier)
+            ? $"{style} {modifier}"
+            : style;
 
         headers[HtmxResponseHeaderNames.Reswap] = value;
 
         return this;
     }
 
     /// <summary>
-    ///     Allows you to specify how the response will be swapped.
+    /// Allows you to specify how the response will be swapped.
     /// </summary>
     /// <param></param>
     /// <param name="swapStyle"></param>
-    /// <returns></returns>
+    /// <returns>This <see cref="HtmxResponse"/> object instance.</returns>
     public HtmxResponse Reswap(SwapStyleBuilder swapStyle)
     {
-	    var (style, modifier) = swapStyle.Build();
+        var (style, modifier) = swapStyle.Build();
 
-        return style is null ? Reswap(modifier) : Reswap((SwapStyle)style, modifier);
+        return style is SwapStyle.Default
+            ? Reswap(modifier)
+            : Reswap(style, modifier);
     }
 
     /// <summary>
@@ -224,11 +229,12 @@ public HtmxResponse Reselect(string selector)
     /// Sets response code to stop polling
     /// </summary>
     /// <returns></returns>
+    /// <returns>This <see cref="HtmxResponse"/> object instance.</returns>
     public HtmxResponse StopPolling()
     {
-	    context.Response.StatusCode = HtmxStatusCodes.StopPolling;
+        context.Response.StatusCode = HtmxStatusCodes.StopPolling;
 
-	    return this;
+        return this;
     }
 
     /// <summary>
@@ -314,7 +320,7 @@ public override string ToString()
 
     private void AssertIsHtmxRequest()
     {
-        if(!isHtmxRequest)
+        if (!isHtmxRequest)
         {
             throw new InvalidOperationException(
                 "The active request is not an htmx request. " +

src/Htmxor/Http/SwapStyleBuilder.cs

@@ -7,16 +7,16 @@ namespace Htmxor.Http;
 /// <summary>
 /// A builder class for constructing a swap style command string for HTMX responses.
 /// </summary>
-public sealed class SwapStyleBuilder 
+public sealed class SwapStyleBuilder
 {
-    private readonly SwapStyle? style;
-    private readonly OrderedDictionary modifiers = new();
+    private readonly SwapStyle style;
+    private readonly OrderedDictionary modifiers = new(StringComparer.Ordinal);
 
     /// <summary>
     /// Initializes a new instance of the SwapStyleBuilder with a specified swap style.
     /// </summary>
     /// <param name="style">The initial swap style to be applied.</param>
-    public SwapStyleBuilder(SwapStyle? style = null)
+    public SwapStyleBuilder(SwapStyle style = SwapStyle.Default)
     {
         this.style = style;
     }
@@ -314,14 +314,15 @@ public SwapStyleBuilder ShowNone()
     /// <summary>
     /// Builds the swap style command string with all specified modifiers.
     /// </summary>
-    /// <returns>A tuple containing the SwapStyle and the constructed command string.</returns>
-    internal (SwapStyle?, string) Build()
+    /// <returns>A tuple containing the <see cref="SwapStyle"/> and the constructed command string.</returns>
+    internal (SwapStyle, string) Build()
     {
         var value = string.Empty;
 
         if (modifiers.Count > 0)
         {
-            value = modifiers.Cast<DictionaryEntry>()
+            value = modifiers
+                .Cast<DictionaryEntry>()
                 .Select(entry => $"{entry.Key}:{entry.Value}")
                 .Aggregate((current, next) => $"{current} {next}");
         }

src/Htmxor/Http/SwapStyleExtensions.cs

@@ -0,0 +1,29 @@
+using System.Runtime.CompilerServices;
+
+namespace Htmxor.Http;
+
+public static class SwapStyleExtensions
+{
+    /// <summary>
+    /// Converts the <paramref name="swapStyle"/> to their string version expected by htmx.
+    /// </summary>
+    /// <param name="swapStyle">The style to convert.</param>
+    public static string ToHtmxString(this SwapStyle swapStyle)
+    {
+        var style = swapStyle switch
+        {
+            SwapStyle.InnerHTML => "innerHTML",
+            SwapStyle.OuterHTML => "outerHTML",
+            SwapStyle.BeforeBegin => "beforebegin",
+            SwapStyle.AfterBegin => "afterbegin",
+            SwapStyle.BeforeEnd => "beforeend",
+            SwapStyle.AfterEnd => "afterend",
+            SwapStyle.Delete => "delete",
+            SwapStyle.None => "none",
+            SwapStyle.Default => "",
+            _ => throw new SwitchExpressionException(swapStyle),
+        };
+
+        return style;
+    }
+}

src/Htmxor/SwapStyle.cs

@@ -5,6 +5,12 @@
 /// </summary>
 public enum SwapStyle
 {
+    /// <summary>
+    /// Default style is what is specified in <see cref="HtmxConfig.DefaultSwapStyle"/> for the application
+    /// or htmx's default, which is <see cref="InnerHTML"/>.
+    /// </summary>
+    Default,
+
     /// <summary>
     /// Replace the inner html of the target element.
     /// </summary>

test/Htmxor.Tests/Configuration/HtmxHeadOutletTest.cs

@@ -90,4 +90,15 @@ public void HtmxConfig_serializer()
             }
             """);
     }
+
+    [Fact]
+    public void HtmxConfig_default_swap_style_serializer()
+    {
+        var config = new HtmxConfig
+        {
+            DefaultSwapStyle = SwapStyle.Default,
+        };
+
+        config.DefaultSwapStyle.Should().BeNull();
+    }
 }

test/Htmxor.Tests/Http/SwapStyleBuilderTests.cs

@@ -191,11 +191,11 @@ public void SwapStyleBuilder_ShowWindow_BottomDirection_AddsCorrectModifier()
     public void SwapStyleBuilder_NullSwapStyle_ReturnsNullStyle()
     {
         // Arrange & Act
-        var builder = new SwapStyleBuilder(null);
+        var builder = new SwapStyleBuilder();
         var (style, _) = builder.Build();
 
         // Assert
-        style.Should().BeNull();
+        style.Should().Be(SwapStyle.Default);
     }
 
     [Fact]