Merge pull request #162 from ia3andy/other-extensions

Allow other extensions such as json, yaml, xml, ...
quarkiverse · Oct 9, 2024 · e29d590 · e29d590
2 parents 7fae938 + 99b3a50
commit e29d590
Show file tree

Hide file tree

Showing 19 changed files with 204 additions and 88 deletions.
diff --git a/common/runtime/src/main/java/io/quarkiverse/roq/util/PathUtils.java b/common/runtime/src/main/java/io/quarkiverse/roq/util/PathUtils.java
@@ -45,6 +45,11 @@ public static String removeExtension(String path) {
         return i > 0 ? path.substring(0, i) : path;
     }
 
+    public static String getExtension(String path) {
+        final int i = path.lastIndexOf(".");
+        return i > 0 ? path.substring(i + 1) : null;
+    }
+
     public static String fileName(String path) {
         final int i = path.lastIndexOf("/");
         if (i == -1) {

diff --git a/...src/main/java/io/quarkiverse/roq/plugin/aliases/deployment/RoqPluginAliasesProcessor.java b/...src/main/java/io/quarkiverse/roq/plugin/aliases/deployment/RoqPluginAliasesProcessor.java
@@ -1,12 +1,8 @@
 package io.quarkiverse.roq.plugin.aliases.deployment;
 
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
+import java.util.*;
 
-import io.quarkiverse.roq.frontmatter.deployment.Link;
+import io.quarkiverse.roq.frontmatter.deployment.TemplateLink;
 import io.quarkiverse.roq.frontmatter.deployment.data.RoqFrontMatterTemplateBuildItem;
 import io.quarkiverse.roq.frontmatter.runtime.RoqSiteConfig;
 import io.quarkiverse.roq.frontmatter.runtime.model.RoqUrl;
@@ -59,8 +55,8 @@ public void consumeTemplates(
             }
             RoqUrl url = item.url();
             for (String alias : aliasesName) {
-                String aliasLink = Link.pageLink(config.rootPath(), alias, new Link.PageLinkData(
-                        item.raw().info().baseFileName(), item.raw().info().date(), item.raw().collection(), item.data()));
+                String aliasLink = TemplateLink.pageLink(config.rootPath(), alias, new TemplateLink.PageLinkData(
+                        item.raw().info(), item.raw().collection(), item.data()));
                 aliasMap.put(aliasLink, url.path());
             }
         }

diff --git a/...src/main/java/io/quarkiverse/roq/plugin/tagging/deployment/RoqPluginTaggingProcessor.java b/...src/main/java/io/quarkiverse/roq/plugin/tagging/deployment/RoqPluginTaggingProcessor.java
@@ -9,9 +9,9 @@
 import java.util.List;
 import java.util.Map;
 
-import io.quarkiverse.roq.frontmatter.deployment.Link;
-import io.quarkiverse.roq.frontmatter.deployment.Link.PageLinkData;
 import io.quarkiverse.roq.frontmatter.deployment.RoqFrontMatterRootUrlBuildItem;
+import io.quarkiverse.roq.frontmatter.deployment.TemplateLink;
+import io.quarkiverse.roq.frontmatter.deployment.TemplateLink.PageLinkData;
 import io.quarkiverse.roq.frontmatter.deployment.data.RoqFrontMatterDocumentTemplateBuildItem;
 import io.quarkiverse.roq.frontmatter.deployment.data.RoqFrontMatterPaginateTemplateBuildItem;
 import io.quarkiverse.roq.frontmatter.deployment.publish.RoqFrontMatterPublishDerivedCollectionBuildItem;
@@ -67,7 +67,7 @@ void publishTagPages(
                 // For all the tags we create a derivation: tag -> document ids
                 for (String tag : tags) {
                     derived.computeIfAbsent(tag, k -> new ArrayList<>())
-                            .add(document.raw().id());
+                            .add(document.raw().resolvedPath());
                 }
             }
 
@@ -81,9 +81,9 @@ void publishTagPages(
                 derivedCollectionProducer
                         .produce(new RoqFrontMatterPublishDerivedCollectionBuildItem(tagCollection, e.getValue(), data));
 
-                final String link = Link.pageLink(config.rootPath(),
+                final String link = TemplateLink.pageLink(config.rootPath(),
                         data.getString(LINK_KEY, DEFAULT_TAGGING_COLLECTION_LINK_TEMPLATE),
-                        new PageLinkData(item.info().baseFileName(), item.info().date(), tagCollection, data));
+                        new PageLinkData(item.info(), tagCollection, data));
                 final RoqUrl url = rootUrl.rootUrl().resolve(link);
                 // Dealing with pagination is as simple as those two lines:
                 if (data.containsKey(PAGINATE_KEY)) {

diff --git a/...ment/src/main/java/io/quarkiverse/roq/frontmatter/deployment/RoqFrontMatterProcessor.java b/...ment/src/main/java/io/quarkiverse/roq/frontmatter/deployment/RoqFrontMatterProcessor.java
@@ -41,6 +41,7 @@ void bindQuteTemplates(
         }
         final Set<String> docTemplates = new HashSet<>();
         final Set<String> pageTemplates = new HashSet<>();
+        final Set<String> layoutTemplates = new HashSet<>();
         // Produce generated Qute templates
         for (RoqFrontMatterRawTemplateBuildItem item : roqFrontMatterTemplates) {
             templatePathProducer
@@ -52,6 +53,8 @@ void bindQuteTemplates(
                 } else {
                     pageTemplates.add(item.info().generatedTemplatePath());
                 }
+            } else {
+                layoutTemplates.add(item.info().generatedTemplatePath());
             }
         }
 
@@ -63,8 +66,10 @@ void bindQuteTemplates(
             } else if (pageTemplates.contains(c.getTemplateId())) {
                 c.addParameter("page", NormalPage.class.getName());
                 c.addParameter("site", Site.class.getName());
+            } else if (layoutTemplates.contains(c.getTemplateId())) {
+                c.addParameter("page", Page.class.getName());
+                c.addParameter("site", Site.class.getName());
             }
-
         }));
     }
 

diff --git a/...erse/roq/frontmatter/deployment/Link.java → .../frontmatter/deployment/TemplateLink.java b/...erse/roq/frontmatter/deployment/Link.java → .../frontmatter/deployment/TemplateLink.java
@@ -12,42 +12,49 @@
 import java.util.Optional;
 import java.util.function.Supplier;
 
+import io.quarkiverse.roq.frontmatter.runtime.model.PageInfo;
 import io.quarkiverse.roq.util.PathUtils;
 import io.vertx.core.json.JsonObject;
 
-public class Link {
+public class TemplateLink {
     public static final String DEFAULT_PAGE_LINK_TEMPLATE = "/:name";
     public static final String DEFAULT_PAGINATE_LINK_TEMPLATE = "/:collection/page:page";
     private static final DateTimeFormatter YEAR_FORMAT = DateTimeFormatter.ofPattern("yyyy");
     private static final DateTimeFormatter MONTH_FORMAT = DateTimeFormatter.ofPattern("MM");
     private static final DateTimeFormatter DAY_FORMAT = DateTimeFormatter.ofPattern("dd");
 
     public interface LinkData {
-        String baseFileName();
+        PageInfo pageInfo();
 
         String collection();
 
-        ZonedDateTime date();
-
         JsonObject data();
     }
 
-    public record PageLinkData(String baseFileName, ZonedDateTime date, String collection,
+    public record PageLinkData(PageInfo pageInfo, String collection,
             JsonObject data) implements LinkData {
     }
 
-    public record PaginateLinkData(String baseFileName, ZonedDateTime date, String collection, String page,
+    public record PaginateLinkData(PageInfo pageInfo, String collection, String page,
             JsonObject data) implements LinkData {
     }
 
     private static Map<String, Supplier<String>> withBasePlaceHolders(LinkData data, Map<String, Supplier<String>> other) {
         Map<String, Supplier<String>> result = new HashMap<>(Map.ofEntries(
                 Map.entry(":collection", data::collection),
-                Map.entry(":year", () -> Optional.ofNullable(data.date()).orElse(ZonedDateTime.now()).format(YEAR_FORMAT)),
-                Map.entry(":month", () -> Optional.ofNullable(data.date()).orElse(ZonedDateTime.now()).format(MONTH_FORMAT)),
-                Map.entry(":day", () -> Optional.ofNullable(data.date()).orElse(ZonedDateTime.now()).format(DAY_FORMAT)),
-                Map.entry(":name", () -> slugify(data.baseFileName())),
-                Map.entry(":title", () -> data.data().getString("slug", slugify(data.baseFileName())))));
+                Map.entry(":year",
+                        () -> Optional.ofNullable(data.pageInfo().date()).orElse(ZonedDateTime.now()).format(YEAR_FORMAT)),
+                Map.entry(":month",
+                        () -> Optional.ofNullable(data.pageInfo().date()).orElse(ZonedDateTime.now()).format(MONTH_FORMAT)),
+                Map.entry(":day",
+                        () -> Optional.ofNullable(data.pageInfo().date()).orElse(ZonedDateTime.now()).format(DAY_FORMAT)),
+                Map.entry(":name", () -> {
+                    if (data.pageInfo().isHtml()) {
+                        return slugify(data.pageInfo().baseFileName());
+                    }
+                    return slugify(data.pageInfo().baseFileName()) + "." + data.pageInfo().getExtension();
+                }),
+                Map.entry(":title", () -> data.data().getString("slug", slugify(data.pageInfo().baseFileName())))));
         if (other != null) {
             result.putAll(other);
         }

diff --git a/.../quarkiverse/roq/frontmatter/deployment/data/RoqFrontMatterDataModificationBuildItem.java b/.../quarkiverse/roq/frontmatter/deployment/data/RoqFrontMatterDataModificationBuildItem.java
@@ -34,6 +34,6 @@ public int order() {
 
     public interface DataModifier {
 
-        JsonObject modify(String id, String templatePath, JsonObject fm);
+        JsonObject modify(String resolvedPath, String sourcePath, JsonObject fm);
     }
 }
diff --git a/...main/java/io/quarkiverse/roq/frontmatter/deployment/data/RoqFrontMatterDataProcessor.java b/...main/java/io/quarkiverse/roq/frontmatter/deployment/data/RoqFrontMatterDataProcessor.java
@@ -1,15 +1,15 @@
 package io.quarkiverse.roq.frontmatter.deployment.data;
 
-import static io.quarkiverse.roq.frontmatter.deployment.Link.DEFAULT_PAGE_LINK_TEMPLATE;
+import static io.quarkiverse.roq.frontmatter.deployment.TemplateLink.DEFAULT_PAGE_LINK_TEMPLATE;
 
 import java.util.List;
 import java.util.Map;
 import java.util.Stack;
 import java.util.function.Function;
 import java.util.stream.Collectors;
 
-import io.quarkiverse.roq.frontmatter.deployment.Link;
 import io.quarkiverse.roq.frontmatter.deployment.RoqFrontMatterRootUrlBuildItem;
+import io.quarkiverse.roq.frontmatter.deployment.TemplateLink;
 import io.quarkiverse.roq.frontmatter.deployment.publish.RoqFrontMatterPublishPageBuildItem;
 import io.quarkiverse.roq.frontmatter.deployment.scan.RoqFrontMatterRawTemplateBuildItem;
 import io.quarkiverse.roq.frontmatter.runtime.RoqSiteConfig;
@@ -35,14 +35,14 @@ void prepareData(HttpBuildTimeConfig httpConfig,
         }
 
         final var byKey = roqFrontMatterTemplates.stream()
-                .collect(Collectors.toMap(RoqFrontMatterRawTemplateBuildItem::id, Function.identity()));
+                .collect(Collectors.toMap(RoqFrontMatterRawTemplateBuildItem::resolvedPath, Function.identity()));
         final RootUrl rootUrl = new RootUrl(config.urlOptional().orElse(""), httpConfig.rootPath);
         rootUrlProducer.produce(new RoqFrontMatterRootUrlBuildItem(rootUrl));
 
         for (RoqFrontMatterRawTemplateBuildItem item : roqFrontMatterTemplates) {
             JsonObject data = mergeParents(item, byKey);
-            final String link = Link.pageLink(config.rootPath(), data.getString(LINK_KEY, DEFAULT_PAGE_LINK_TEMPLATE),
-                    new Link.PageLinkData(item.info().baseFileName(), item.info().date(), item.collection(), data));
+            final String link = TemplateLink.pageLink(config.rootPath(), data.getString(LINK_KEY, DEFAULT_PAGE_LINK_TEMPLATE),
+                    new TemplateLink.PageLinkData(item.info(), item.collection(), data));
             RoqFrontMatterTemplateBuildItem templateItem = new RoqFrontMatterTemplateBuildItem(item, rootUrl.resolve(link),
                     data);
             templatesProducer.produce(templateItem);
@@ -86,7 +86,11 @@ public static JsonObject mergeParents(RoqFrontMatterRawTemplateBuildItem item,
         String parent = item.layout();
         fms.add(item.data());
         while (parent != null) {
-            if (byPath.containsKey(parent)) {
+            if (byPath.containsKey(parent + ".html")) {
+                final RoqFrontMatterRawTemplateBuildItem parentItem = byPath.get(parent + ".html");
+                parent = parentItem.layout();
+                fms.push(parentItem.data());
+            } else if (byPath.containsKey(parent)) {
                 final RoqFrontMatterRawTemplateBuildItem parentItem = byPath.get(parent);
                 parent = parentItem.layout();
                 fms.push(parentItem.data());

diff --git a/...ava/io/quarkiverse/roq/frontmatter/deployment/publish/RoqFrontMatterPublishProcessor.java b/...ava/io/quarkiverse/roq/frontmatter/deployment/publish/RoqFrontMatterPublishProcessor.java
@@ -1,6 +1,6 @@
 package io.quarkiverse.roq.frontmatter.deployment.publish;
 
-import static io.quarkiverse.roq.frontmatter.deployment.Link.DEFAULT_PAGINATE_LINK_TEMPLATE;
+import static io.quarkiverse.roq.frontmatter.deployment.TemplateLink.DEFAULT_PAGINATE_LINK_TEMPLATE;
 import static io.quarkiverse.roq.frontmatter.deployment.data.RoqFrontMatterDataProcessor.PAGINATE_KEY;
 
 import java.util.ArrayList;
@@ -11,9 +11,9 @@
 
 import org.jboss.logging.Logger;
 
-import io.quarkiverse.roq.frontmatter.deployment.Link;
 import io.quarkiverse.roq.frontmatter.deployment.Paginate;
 import io.quarkiverse.roq.frontmatter.deployment.RoqFrontMatterRootUrlBuildItem;
+import io.quarkiverse.roq.frontmatter.deployment.TemplateLink;
 import io.quarkiverse.roq.frontmatter.deployment.data.RoqFrontMatterDocumentTemplateBuildItem;
 import io.quarkiverse.roq.frontmatter.deployment.data.RoqFrontMatterPaginateTemplateBuildItem;
 import io.quarkiverse.roq.frontmatter.deployment.scan.RoqFrontMatterRawTemplateBuildItem;
@@ -66,11 +66,11 @@ public void paginatePublish(RoqSiteConfig config,
         for (RoqFrontMatterPaginateTemplateBuildItem pagination : paginationList) {
             final RoqFrontMatterRawTemplateBuildItem item = pagination.raw();
             final JsonObject data = pagination.data();
-            Paginate paginate = readPaginate(item.id(), data, pagination.defaultPaginatedCollection());
+            Paginate paginate = readPaginate(item.resolvedPath(), data, pagination.defaultPaginatedCollection());
             AtomicInteger collectionSize = sizeByCollection.get(paginate.collection());
             if (collectionSize == null) {
                 throw new ConfigurationException(
-                        "Paginate collection not found '" + paginate.collection() + "' in " + item.id());
+                        "Paginate collection not found '" + paginate.collection() + "' in " + item.resolvedPath());
             }
             final int total = collectionSize.get();
             if (paginate.size() <= 0) {
@@ -85,14 +85,14 @@ public void paginatePublish(RoqSiteConfig config,
                 if (i == 1) {
                     paginatedUrl = pagination.url();
                 } else {
-                    final String link = Link.paginateLink(config.rootPath(), linkTemplate,
-                            new Link.PaginateLinkData(item.info().baseFileName(), item.info().date(),
+                    final String link = TemplateLink.paginateLink(config.rootPath(), linkTemplate,
+                            new TemplateLink.PaginateLinkData(item.info(),
                                     paginate.collection(), Integer.toString(i), data));
                     paginatedUrl = rootUrl.resolve(link);
                 }
                 PageInfo info = item.info();
                 if (i > 1) {
-                    info = info.changeId(paginatedUrl.path());
+                    info = info.changeResolvedPath(paginatedUrl.path());
                 }
                 paginatedPages.add(new PageToPublish(paginatedUrl, info, data));
             }

diff --git a/...in/java/io/quarkiverse/roq/frontmatter/deployment/record/RoqFrontMatterInitProcessor.java b/...in/java/io/quarkiverse/roq/frontmatter/deployment/record/RoqFrontMatterInitProcessor.java
@@ -57,8 +57,8 @@ void bindCollections(
                 final Supplier<DocumentPage> document = recorder.createDocument(item.collection(),
                         url,
                         item.info(), item.data());
-                documentsById.put(item.info().id(), document);
-                pagesProducer.produce(new RoqFrontMatterPageBuildItem(item.info().id(), url, document));
+                documentsById.put(item.info().resolvedPath(), document);
+                pagesProducer.produce(new RoqFrontMatterPageBuildItem(item.info().resolvedPath(), url, document));
                 docs.add(document);
             }
             collectionsProducer.produce(new RoqFrontMatterCollectionBuildItem(e.getKey(), docs));
@@ -70,7 +70,7 @@ void bindCollections(
             for (String id : i.documentIds()) {
                 final Supplier<DocumentPage> doc = documentsById.get(id);
                 if (doc == null) {
-                    throw new IllegalStateException("No document found for id " + id);
+                    throw new IllegalStateException("No document found for resolvedPath " + id);
                 }
                 docs.add(doc);
             }
@@ -93,9 +93,10 @@ void bindPages(
         for (RoqFrontMatterPublishPageBuildItem page : pages) {
             final Supplier<NormalPage> recordedPage = recorder.createPage(page.url(),
                     page.info(), page.data(), page.paginator());
-            pagesProducer.produce(new RoqFrontMatterPageBuildItem(page.info().id(), page.url(), recordedPage));
-            normalPagesProducer.produce(new RoqFrontMatterNormalPageBuildItem(page.info().id(), page.url(), recordedPage));
-            if (page.info().id().equals("index")) {
+            pagesProducer.produce(new RoqFrontMatterPageBuildItem(page.info().resolvedPath(), page.url(), recordedPage));
+            normalPagesProducer
+                    .produce(new RoqFrontMatterNormalPageBuildItem(page.info().resolvedPath(), page.url(), recordedPage));
+            if (page.info().resolvedPath().equals("index.html")) {
                 indexPageProducer.produce(new RoqFrontMatterIndexPageBuildItem(recordedPage));
             }
         }

diff --git a/...va/io/quarkiverse/roq/frontmatter/deployment/scan/RoqFrontMatterRawTemplateBuildItem.java b/...va/io/quarkiverse/roq/frontmatter/deployment/scan/RoqFrontMatterRawTemplateBuildItem.java
@@ -64,8 +64,8 @@ public boolean isPage() {
         return isPage;
     }
 
-    public String id() {
-        return info.id();
+    public String resolvedPath() {
+        return info.resolvedPath();
     }
 
     public PageInfo info() {