Merge pull request #71 from kucharzyk/gh70

allow qute.html extension for templates
quarkiverse · Jan 9, 2024 · ba928a1 · ba928a1
2 parents 9be2349 + 1d1a08c
commit ba928a1
Show file tree

Hide file tree

Showing 4 changed files with 77 additions and 6 deletions.
diff --git a/deployment/src/test/java/io/quarkiverse/qute/web/test/CustomRootPathTest.java b/deployment/src/test/java/io/quarkiverse/qute/web/test/CustomRootPathTest.java
@@ -24,7 +24,13 @@ public class CustomRootPathTest {
                         "templates/pub/foo/index.html")
                 .addAsResource(new StringAsset(
                         "quarkus.qute.web.root-path=ping"),
-                        "application.properties");
+                        "application.properties")
+                .addAsResource(new StringAsset(
+                        "Index bar!"),
+                        "templates/pub/bar/index.qute.html")
+                .addAsResource(new StringAsset(
+                        "Index bar sub!"),
+                        "templates/pub/bar/sub.qute.html");
     });
 
     @Test
@@ -49,6 +55,35 @@ public void testTemplates() {
                 .then()
                 .statusCode(200)
                 .body(containsString("Index foo!"));
-
+        given()
+                .when().get("/ping/foo/index.html")
+                .then()
+                .statusCode(200)
+                .body(containsString("Index foo!"));
+        given()
+                .when().get("/ping/bar/")
+                .then()
+                .statusCode(200)
+                .body(containsString("Index bar!"));
+        given()
+                .when().get("/ping/bar/index")
+                .then()
+                .statusCode(200)
+                .body(containsString("Index bar!"));
+        given()
+                .when().get("/ping/bar/index.qute.html")
+                .then()
+                .statusCode(200)
+                .body(containsString("Index bar!"));
+        given()
+                .when().get("/ping/bar/sub")
+                .then()
+                .statusCode(200)
+                .body(containsString("Index bar sub!"));
+        given()
+                .when().get("/ping/bar/sub.qute.html")
+                .then()
+                .statusCode(200)
+                .body(containsString("Index bar sub!"));
     }
 }
diff --git a/deployment/src/test/java/io/quarkiverse/qute/web/test/DefaultRootPathTest.java b/deployment/src/test/java/io/quarkiverse/qute/web/test/DefaultRootPathTest.java
@@ -21,7 +21,13 @@ public class DefaultRootPathTest {
                         "templates/pub/index.html")
                 .addAsResource(new StringAsset(
                         "Index foo!"),
-                        "templates/pub/foo/index.html");
+                        "templates/pub/foo/index.html")
+                .addAsResource(new StringAsset(
+                        "Index bar!"),
+                        "templates/pub/bar/index.qute.html")
+                .addAsResource(new StringAsset(
+                        "Index bar sub!"),
+                        "templates/pub/bar/sub.qute.html");
     });
 
     @Test
@@ -46,5 +52,35 @@ public void testTemplates() {
                 .then()
                 .statusCode(200)
                 .body(containsString("Index foo!"));
+        given()
+                .when().get("/foo/index.html")
+                .then()
+                .statusCode(200)
+                .body(containsString("Index foo!"));
+        given()
+                .when().get("/bar/")
+                .then()
+                .statusCode(200)
+                .body(containsString("Index bar!"));
+        given()
+                .when().get("/bar/index")
+                .then()
+                .statusCode(200)
+                .body(containsString("Index bar!"));
+        given()
+                .when().get("/bar/index.qute.html")
+                .then()
+                .statusCode(200)
+                .body(containsString("Index bar!"));
+        given()
+                .when().get("/bar/sub")
+                .then()
+                .statusCode(200)
+                .body(containsString("Index bar sub!"));
+        given()
+                .when().get("/bar/sub.qute.html")
+                .then()
+                .statusCode(200)
+                .body(containsString("Index bar sub!"));
     }
 }
diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
@@ -6,7 +6,7 @@ The goal of this extension is to expose https://quarkus.io/guides/qute-reference
 Automatically, no controllers needed. 
 For example, the template `src/main/resource/templates/pub/foo.html` will be served from the paths `/foo` and `/foo.html` by default.
 
-NOTE: The `index.html` pages are handled specifically, i.e. they are also served as a "default page" of the containing directory. For example, the template `src/main/resource/templates/pub/index.html` will be served from the paths `/index`, `/index.html` and `/` by default.
+NOTE: The `index.html` and `index.qute.html` pages are handled specifically, i.e. they are also served as a "default page" of the containing directory. For example, the template `src/main/resource/templates/pub/index.html` will be served from the paths `/index`, `/index.html` and `/` by default.
 
 == Installation
 

diff --git a/runtime/src/main/java/io/quarkiverse/qute/web/runtime/QuteWebHandler.java b/runtime/src/main/java/io/quarkiverse/qute/web/runtime/QuteWebHandler.java
@@ -225,15 +225,15 @@ private Variant trySelectVariant(RoutingContext rc, TemplateInstance instance, L
      * <li>{@code /nested/item.html?foo=bar} => {@code web/nested/item}</li>
      * </ul>
      *
-     * Note that a path that ends with {@code /} is handled specifically. The {@code index.html} is appended to the path.
+     * Note that a path that ends with {@code /} is handled specifically. The {@code index} is appended to the path.
      *
      * @param path
      * @return the template path without suffix
      */
     private String extractTemplatePath(String path) {
         if (path.length() >= rootPath.length()) {
             if (path.endsWith("/")) {
-                path = path + "index.html";
+                path = path + "index";
             }
             path = path.substring(rootPath.length());
             if (path.startsWith("/")) {