Merge pull request #140 from xmlet/development

New workflow action and new fragments support in htmlflow-kotlin

Author: fmcarvalho

.github/workflows/format-check.yml

@@ -0,0 +1,32 @@
+name: Spotless Check
+
+on:
+  push:
+    branches:
+      - master
+      - development
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  format-check:
+    name: Spotless Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up JDK 17
+        uses: actions/setup-java@v1
+        with:
+          java-version: 17
+      - name: Check code formatting with Spotless
+        run: mvn spotless:check -B
+      - name: Comment on failed formatting
+        if: failure() && github.event_name == 'pull_request'
+        uses: thollander/actions-comment-pull-request@v1
+        with:
+          message: |
+            Please run `mvn spotless:apply` locally to fix the formatting issues, then commit and push the changes.
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

flowifier/src/test/java/htmlflow/flowifier/FlowifierTest.java

@@ -60,11 +60,6 @@ public CharSequence getCharContent(boolean ignoreEncodingErrors) {
         }
     }
 
-    @Test
-    public void testFlowifierTuerSourceforgeHomepage() throws Exception {
-        testFlowifier("https://tuer.sourceforge.io/en/");
-    }
-
     @Test
     public void testFlowifierWithGamboa() throws Exception {
         testFlowifier("https://gamboa.pt/");

htmlflow-core/src/main/java/htmlflow/HtmlPage.java

@@ -36,6 +36,7 @@
 import org.xmlet.htmlapifaster.Div;
 import org.xmlet.htmlapifaster.Element;
 import org.xmlet.htmlapifaster.Html;
+import org.xmlet.htmlapifaster.Span;
 import org.xmlet.htmlapifaster.Tr;
 
 /**
@@ -85,6 +86,10 @@ public final Tr<HtmlPage> tr() {
         return new Tr<>(this);
     }
 
+    public final Span<HtmlPage> span() {
+        return new Span<>(this);
+    }
+
     /**
      * Returns a new instance of HtmlFlow with the same properties of this object but with indented
      * set to the value of isIndented parameter.

htmlflow-core/src/main/java/htmlflow/visitor/PreprocessingVisitorAsync.java

@@ -64,5 +64,4 @@ public <M, E extends Element> void visitAwait(
          */
         indentAndAdvanceStaticBlockIndex();
     }
-
 }

htmlflow-core/src/test/java/htmlflow/test/TestDivDetails.java

@@ -105,7 +105,7 @@ public void testDivDetailsWithoutBinding() {
     public void testDivDetailsBinding() {
         ByteArrayOutputStream mem = new ByteArrayOutputStream();
         HtmlView view = HtmlFlow
-            .view(new PrintStream(mem), HtmlLists::taskDetailsTemplate);
+                .view(new PrintStream(mem), HtmlLists::taskDetailsTemplate);
 
         expectedTaskViews
                 .keySet()
@@ -120,33 +120,21 @@ public void testDivDetailsBinding() {
                     expectedTaskViews
                             .get(taskHtml.obj)
                             .forEach(
-                                line ->
-                                    assertEquals(line,
-                                        actual.next()));
+                                    line ->
+                                            assertEquals(line,
+                                                    actual.next()));
                 });
     }
 
-    private static class TaskHtml {
-        final Task obj;
-        final Stream<String> html;
-        public TaskHtml(Task obj, Stream<String> html) {
-            this.obj = obj;
-            this.html = html;
-        }
-        static TaskHtml of(Task t, Stream<String> html) {
-            return new TaskHtml(t, html);
-        }
-    }
-
     @Test
     public void testWritePartialViewToPrintStream() {
         ByteArrayOutputStream mem = new ByteArrayOutputStream();
         HtmlTables
-            .taskListViewHeader(HtmlFlow.doc(new PrintStream(mem)));
+                .taskListViewHeader(HtmlFlow.doc(new PrintStream(mem)));
 
         Iterator<String> iter = NEWLINE
-            .splitAsStream(mem.toString())
-            .iterator();
+                .splitAsStream(mem.toString())
+                .iterator();
 
         Utils
                 .loadLines("partialViewHeader.html")
@@ -156,4 +144,32 @@ public void testWritePartialViewToPrintStream() {
                     assertEquals(expected, actual);
                 });
     }
+
+    @Test
+    public void testThatSpanElementCanBeUsedOnHtmlDocAsRootElement() {
+        StringBuilder mem = new StringBuilder();
+        HtmlFlow.doc(mem).span().text("I am the root element of an HTML fragment!").__();
+        Iterator<String> actual = NEWLINE
+                .splitAsStream(mem.toString().trim())
+                .iterator();
+        Stream
+                .of("<span>", "I am the root element of an HTML fragment!", "</span>")
+                .forEach(expected -> {
+                    assertEquals(expected, actual.next().trim());
+                });
+    }
+
+    private static class TaskHtml {
+        final Task obj;
+        final Stream<String> html;
+
+        public TaskHtml(Task obj, Stream<String> html) {
+            this.obj = obj;
+            this.html = html;
+        }
+
+        static TaskHtml of(Task t, Stream<String> html) {
+            return new TaskHtml(t, html);
+        }
+    }
 }

htmlflow-kotlin/src/main/kotlin/htmlflow/HtmlFlowExtensions.kt

@@ -4,9 +4,12 @@ package htmlflow
 import htmlflow.continuations.HtmlContinuationSuspendableTerminationNode
 import htmlflow.visitor.HtmlVisitor
 import htmlflow.visitor.PreprocessingVisitor
+import org.xmlet.htmlapifaster.Div
 import org.xmlet.htmlapifaster.Element
 import org.xmlet.htmlapifaster.Html
+import org.xmlet.htmlapifaster.Span
 import org.xmlet.htmlapifaster.Text
+import org.xmlet.htmlapifaster.Tr
 
 /** Alternative close tag function for `__()`. */
 inline val <T : Element<*, Z>, Z : Element<*, *>> T.l: Z
@@ -20,10 +23,13 @@ inline val HtmlPage.html: Html<HtmlPage>
     }
 
 /** Root builder of HTML element with lambda with receiver. */
-inline fun HtmlPage.html(block: Html<HtmlPage>.() -> Unit): HtmlPage {
-    (this.visitor as HtmlVisitor).write(HtmlPage.HEADER)
-    return Html(self()).also { it.block() }.l
-}
+inline fun HtmlPage.html(block: Html<HtmlPage>.() -> Unit): HtmlPage = this.html().apply(block).l
+
+inline fun HtmlPage.div(block: Div<HtmlPage>.() -> Unit): HtmlPage = this.div().apply(block).l
+
+inline fun HtmlPage.tr(block: Tr<HtmlPage>.() -> Unit): HtmlPage = this.tr().apply(block).l
+
+inline fun HtmlPage.span(block: Span<HtmlPage>.() -> Unit): HtmlPage = this.span().apply(block).l
 
 /** Text node property. */
 inline var <T : Element<T, Z>, Z : Element<*, *>> T.text: T

htmlflow-kotlin/src/main/kotlin/htmlflow/HtmlViewVisitorSuspend.kt

@@ -4,7 +4,6 @@ import htmlflow.continuations.HtmlContinuationSuspendable
 import htmlflow.visitor.HtmlVisitorSuspending
 import java.util.function.BiConsumer
 import org.xmlet.htmlapifaster.Element
-import org.xmlet.htmlapifaster.SuspendConsumer
 import org.xmlet.htmlapifaster.async.AwaitConsumer
 
 /**

htmlflow-kotlin/src/main/kotlin/htmlflow/HtmlViewVisitorSuspendHot.kt

@@ -3,7 +3,6 @@ package htmlflow
 import htmlflow.visitor.HtmlVisitorSuspending
 import java.util.function.BiConsumer
 import org.xmlet.htmlapifaster.Element
-import org.xmlet.htmlapifaster.SuspendConsumer
 import org.xmlet.htmlapifaster.async.AwaitConsumer
 
 /**

htmlflow-kotlin/src/main/kotlin/htmlflow/PreprocessingVisitorSuspend.kt

@@ -83,13 +83,10 @@ class PreprocessingVisitorSuspend(isIndented: Boolean) : PreprocessingVisitorAsy
     }
 
     /**
-     * Follows a different visit approach not inherited from the parent class, because
-     * it is a Java class that we want to keep free of kotlin dependencies like suspend functions.
+     * Follows a different visit approach not inherited from the parent class, because it is a Java
+     * class that we want to keep free of kotlin dependencies like suspend functions.
      */
-    fun <E : Element<*, *>, M> visitSuspending(
-        element: E,
-        suspendAction: SuspendConsumer<E, M>,
-    ) {
+    fun <E : Element<*, *>, M> visitSuspending(element: E, suspendAction: SuspendConsumer<E, M>) {
         /** Creates an HtmlContinuation for a suspending block. */
         val suspCont: HtmlContinuation =
             HtmlContinuationSuspending(