add hx-params support to TriggerDsl (#85)

Author: wakingrufus

spring-funk-htmx/src/main/kotlin/com/github/wakingrufus/funk/htmx/HtmlExtensions.kt

@@ -15,6 +15,11 @@ fun HTMLTag.hxSelect(selector: String) {
     attributes["hx-select"] = selector
 }
 
+@SpringDslMarker
+fun HTMLTag.hxParams(params: String) {
+    attributes["hx-params"] = params
+}
+
 @SpringDslMarker
 fun HTMLTag.hxPushUrl(value: Boolean) {
     attributes["hx-push-url"] = value.toString()

spring-funk-htmx/src/main/kotlin/com/github/wakingrufus/funk/htmx/TriggerDsl.kt

@@ -9,15 +9,13 @@ import com.github.wakingrufus.funk.htmx.trigger.HxTriggerDsl
 import kotlinx.html.HTMLTag
 
 @SpringDslMarker
-class TriggerDsl(
-    val verb: HttpVerb,
-    val path: String,
-    var target: String? = null,
-    var hxPushUrl: Boolean? = null,
-    var hxSelect: String? = null
-) {
+class TriggerDsl(val verb: HttpVerb, val path: String) {
     private var swap: HxSwap? = null
     private var trigger: HxTrigger? = null
+    private var hxParams: String? = null
+    private var target: String? = null
+    private var hxPushUrl: Boolean? = null
+    private var hxSelect: String? = null
 
     @SpringDslMarker
     fun swap(type: HxSwapType, dsl: HxSwapDsl.() -> Unit = {}) {
@@ -29,6 +27,25 @@ class TriggerDsl(
         trigger = HxTriggerDsl().apply(dsl)()
     }
 
+    @SpringDslMarker
+    fun allParams() {
+        hxParams = "*"
+    }
+
+    @SpringDslMarker
+    fun noParams() {
+        hxParams = "none"
+    }
+
+    @SpringDslMarker
+    fun excludeParams(vararg params: String) {
+        hxParams = "not " + params.joinToString(",")
+    }
+
+    @SpringDslMarker
+    fun includeParams(vararg params: String) {
+        hxParams = params.joinToString(",")
+    }
 
     operator fun invoke(element: HTMLTag) {
         element.apply {
@@ -38,6 +55,7 @@ class TriggerDsl(
             target?.let { hxTarget(it) }
             hxPushUrl?.let { hxPushUrl(it) }
             hxSelect?.let { hxSelect(it) }
+            hxParams?.let { hxParams(it) }
         }
     }
 }

spring-funk-htmx/src/test/kotlin/com/github/wakingrufus/funk/htmx/TriggerDslTest.kt

@@ -0,0 +1,66 @@
+package com.github.wakingrufus.funk.htmx
+
+import kotlinx.html.div
+import kotlinx.html.stream.appendHTML
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.jupiter.api.Test
+
+class TriggerDslTest {
+    @Test
+    fun `test default params`() {
+        val actual = buildString {
+            appendHTML(false).div {
+                TriggerDsl(HttpVerb.GET, "/")(this)
+            }
+        }
+        assertThat(actual).isEqualTo("""<div hx-get="/"></div>""")
+    }
+
+    @Test
+    fun `test no params`() {
+        val actual = buildString {
+            appendHTML(false).div {
+                TriggerDsl(HttpVerb.GET, "/").apply {
+                    noParams()
+                }(this)
+            }
+        }
+        assertThat(actual).isEqualTo("""<div hx-get="/" hx-params="none"></div>""")
+    }
+
+    @Test
+    fun `test all params`() {
+        val actual = buildString {
+            appendHTML(false).div {
+                TriggerDsl(HttpVerb.GET, "/").apply {
+                    allParams()
+                }(this)
+            }
+        }
+        assertThat(actual).isEqualTo("""<div hx-get="/" hx-params="*"></div>""")
+    }
+
+    @Test
+    fun `test include params`() {
+        val actual = buildString {
+            appendHTML(false).div {
+                TriggerDsl(HttpVerb.GET, "/").apply {
+                    includeParams("1", "2")
+                }(this)
+            }
+        }
+        assertThat(actual).isEqualTo("""<div hx-get="/" hx-params="1,2"></div>""")
+    }
+
+    @Test
+    fun `test exclude params`() {
+        val actual = buildString {
+            appendHTML(false).div {
+                TriggerDsl(HttpVerb.GET, "/").apply {
+                    excludeParams("1", "2")
+                }(this)
+            }
+        }
+        assertThat(actual).isEqualTo("""<div hx-get="/" hx-params="not 1,2"></div>""")
+    }
+}