Merge pull request #49 from cloudflightio/48

48: preserve the order of templates inside the HtmxResponse
wimdeblauwe · Jul 20, 2023 · 79f21bd · 79f21bd
2 parents 4b0bd2b + 64f3902
commit 79f21bd
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 10 deletions.
diff --git a/src/main/java/io/github/wimdeblauwe/hsbt/mvc/HtmxResponse.java b/src/main/java/io/github/wimdeblauwe/hsbt/mvc/HtmxResponse.java
@@ -25,12 +25,12 @@ final public class HtmxResponse {
     private String headerPushHistory;
 
     public HtmxResponse() {
-        this.templates = new HashSet<>();
+        this.templates = new LinkedHashSet<>();
         this.triggers = new HashMap<>();
         this.triggersAfterSettle = new HashMap<>();
         this.triggersAfterSwap = new HashMap<>();
 	}
-	
+
 	/**
 	 * Append the rendered template or fragment.
 	 *
@@ -179,8 +179,8 @@ private void mergeMapAndLog(HxTriggerLifecycle receive, Map<String, String> trig
     }
 
 
-	Set<String> getTemplates() {
-		return new HashSet<>(templates);
+	Collection<String> getTemplates() {
+		return Collections.unmodifiableCollection(templates);
 	}
 
     Map<String, String> getTriggers() {

diff --git a/src/test/java/io/github/wimdeblauwe/hsbt/mvc/HtmxResponseTest.java b/src/test/java/io/github/wimdeblauwe/hsbt/mvc/HtmxResponseTest.java
@@ -38,7 +38,7 @@ public void addingTheSameTemplateASecondTimeShouldIgnoreDuplicates() {
         sut.addTemplate(myTemplateAndFragment);
         sut.addTemplate(myTemplate);
 
-        assertThat(sut.getTemplates()).containsExactlyInAnyOrder(myTemplate, myTemplateAndFragment);
+        assertThat(sut.getTemplates()).containsExactly(myTemplate, myTemplateAndFragment);
     }
 
     @Test
@@ -60,8 +60,8 @@ public void addingAResponseToExistingMergesTemplatesAndTriggers() {
 
         sut.and(new HtmxResponse().addTemplate("myTemplate2")
                                   .addTrigger("myEvent2")
-                        .addTrigger(myTrigger)
-                        .addTemplate(myTemplate));
+                                  .addTrigger(myTrigger)
+                                  .addTemplate(myTemplate));
 
         assertThat(sut.getTriggers()).hasSize(2);
         assertThat(sut.getTemplates()).hasSize(2);
@@ -70,14 +70,45 @@ public void addingAResponseToExistingMergesTemplatesAndTriggers() {
     @Test
     public void extraHxHeaders() {
         sut.pushHistory("/a/history")
-                .browserRedirect("/a/new/page")
-                .browserRefresh(true)
-                .retarget("#theThing");
+           .browserRedirect("/a/new/page")
+           .browserRefresh(true)
+           .retarget("#theThing");
 
         assertThat(sut.getHeaderPushHistory()).isEqualTo("/a/history");
         assertThat(sut.getHeaderRedirect()).isEqualTo("/a/new/page");
         assertThat(sut.getHeaderRefresh()).isTrue();
         assertThat(sut.getHeaderRetarget()).isEqualTo("#theThing");
     }
 
+    /**
+     * The order of templates can play a role in some scenarios in HTMX,
+     * see https://github.com/bigskysoftware/htmx/issues/1198
+     */
+    @Test
+    public void addedTemplatesPreserveTheirOrder() {
+        String template1 = "form-validation-fragments :: person-list-item";
+        String template2 = "form-validation-fragments :: form";
+        sut.addTemplate(template1);
+        sut.addTemplate(template2);
+
+        assertThat(sut.getTemplates()).containsExactly(template1, template2);
+    }
+
+    @Test
+    public void mergingResponsesPreserveTemplateOrder() {
+        HtmxResponse response1 = new HtmxResponse().addTemplate("response1 :: template 11")
+                                                   .addTemplate("response1 :: template 12");
+        HtmxResponse response2 = new HtmxResponse().addTemplate("response2 :: template 21")
+                                                   .addTemplate("response2 :: template 22");
+
+        response1.and(response2);
+
+        assertThat(response1.getTemplates())
+                .hasSize(4)
+                .containsExactly("response1 :: template 11",
+                                 "response1 :: template 12",
+                                 "response2 :: template 21",
+                                 "response2 :: template 22");
+
+    }
 }