Rename quarkus-qute-resteasy to quarkus-resteasy-qute

- plus other fixes

Author: mkouba

bom/deployment/pom.xml

@@ -521,7 +521,7 @@
             </dependency>
             <dependency>
                 <groupId>io.quarkus</groupId>
-                <artifactId>quarkus-qute-resteasy-deployment</artifactId>
+                <artifactId>quarkus-resteasy-qute-deployment</artifactId>
                 <version>${project.version}</version>
             </dependency>
 

bom/runtime/pom.xml

@@ -744,7 +744,7 @@
             </dependency>
             <dependency>
                 <groupId>io.quarkus</groupId>
-                <artifactId>quarkus-qute-resteasy</artifactId>
+                <artifactId>quarkus-resteasy-qute</artifactId>
                 <version>${project.version}</version>
             </dependency>
 

core/deployment/src/main/java/io/quarkus/runner/RuntimeClassLoader.java

@@ -12,7 +12,6 @@
 import java.io.Writer;
 import java.net.MalformedURLException;
 import java.net.URI;
-import java.net.URISyntaxException;
 import java.net.URL;
 import java.net.URLConnection;
 import java.net.URLStreamHandler;
@@ -527,20 +526,22 @@ private ProtectionDomain createDefaultProtectionDomain(Path applicationClasspath
         URL url = null;
         if (applicationClasspath != null) {
             try {
-                String path = applicationClasspath.toString();
-                if (File.separatorChar != '/') {
-                    // Note that windows separator is always quoted in the URI constructor
-                    path = path.replace('/', File.separatorChar);
-                }
-                URI uri = new URI("file", null, path, null);
+                // String path = applicationClasspath.toString();
+                //if (File.separatorChar != '/') {
+                //    // Note that windows separator is always quoted in the URI constructor
+                //    path = path.replace(File.separatorChar, '/');
+                //}
+                //URI uri = new URI("file", null, path, null);
+                URI uri = applicationClasspath.toUri();
                 url = uri.toURL();
-            } catch (URISyntaxException | MalformedURLException e) {
+                //} catch (URISyntaxException | MalformedURLException e) {
+            } catch (MalformedURLException e) {
                 log.error("URL codeSource location for path " + applicationClasspath + " could not be created.", e);
             }
         }
         CodeSource codesource = new CodeSource(url, (Certificate[]) null);
         ProtectionDomain protectionDomain = new ProtectionDomain(codesource, null, this, null);
         return protectionDomain;
     }
-    
+
 }

docs/src/main/asciidoc/qute.adoc

@@ -30,7 +30,7 @@ In your `pom.xml` file, add:
 ----
 <dependency>
     <groupId>io.quarkus</groupId>
-    <artifactId>quarkus-qute-resteasy</artifactId>
+    <artifactId>quarkus-resteasy-qute</artifactId>
 </dependency>
 ----
 
@@ -72,12 +72,13 @@ public class HelloResource {
     }
 }
 ----
-<1> If there is no `@ResourcePath` qualifier provided the field name is used to locate the template. In this particular case, we're injecting a template with path `templates/hello.txt`.
+<1> If there is no `@ResourcePath` qualifier provided, the field name is used to locate the template. In this particular case, we're injecting a template with path `templates/hello.txt`.
 <2> `Template.data()` returns a new template instance that can be customized before the actual rendering is triggered. In this case, we put the name value under the key `name`. The data map is accessible during rendering. 
 <3> Note that we don't trigger the rendering - this is done automatically by a special `ContainerResponseFilter` implementation.
 
-If running your application, you can request the endpoint:
+If your application is running, you can request the endpoint:
 
+[source, shell]
 ```
 $ curl -w "\n" http://localhost:8080/hello?name=Martin
 Hello Martin!
@@ -176,7 +177,7 @@ public class ItemResource {
 == Rendering Periodic Reports
 
 Templating engine could be also very useful when rendering periodic reports.
-You'll need to add `quarkus-scheduler` and `quarkus-qute` extensions first.
+You'll need to add the `quarkus-scheduler` and `quarkus-qute` extensions first.
 In your `pom.xml` file, add:
 
 [source,xml]
@@ -230,7 +231,7 @@ The template is simple:
 </html>
 ----
 <1> The loop section makes it possible to iterate over iterables, maps and streams.
-<2> This value expression is using https://en.wikipedia.org/wiki/Elvis_operator[elvis operator] - if the name is null the default value is used.
+<2> This value expression is using the https://en.wikipedia.org/wiki/Elvis_operator[elvis operator] - if the name is null the default value is used.
 
 [source,java]
 .ReportGenerator.java

extensions/pom.xml

@@ -45,6 +45,7 @@
         <module>resteasy-jsonb</module>
         <module>resteasy-jackson</module>
         <module>resteasy-jaxb</module>
+        <module>resteasy-qute</module>
         <module>rest-client</module>
         <module>smallrye-openapi-common</module>
         <module>smallrye-openapi</module>
@@ -135,7 +136,6 @@
 
         <!-- Templating -->
         <module>qute</module>
-        <module>qute-resteasy</module>
     </modules>
 
     <!-- Unfortunately the config below introduces a build dependency on the maven plugin

extensions/qute/deployment/src/main/java/io/quarkus/qute/deployment/GeneratedValueResolverBuildItem.java

@@ -2,6 +2,9 @@
 
 import io.quarkus.builder.item.MultiBuildItem;
 
+/**
+ * Holds a name of a generated {@link io.quarkus.qute.ValueResolver} class.
+ */
 public final class GeneratedValueResolverBuildItem extends MultiBuildItem {
 
     private final String className;

extensions/qute/deployment/src/main/java/io/quarkus/qute/deployment/QuteProcessor.java

@@ -36,8 +36,7 @@
 import org.jboss.jandex.MethodInfo;
 import org.jboss.jandex.ParameterizedType;
 import org.jboss.jandex.Type;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.jboss.logging.Logger;
 
 import io.quarkus.arc.deployment.AdditionalBeanBuildItem;
 import io.quarkus.arc.deployment.BeanArchiveIndexBuildItem;
@@ -87,7 +86,7 @@
 
 public class QuteProcessor {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(QuteProcessor.class);
+    private static final Logger LOGGER = Logger.getLogger(QuteProcessor.class);
 
     public static final DotName RESOURCE_PATH = DotName.createSimple(ResourcePath.class.getName());
     public static final DotName TEMPLATE = DotName.createSimple(Template.class.getName());
@@ -147,7 +146,9 @@ TemplatesAnalysisBuildItem analyzeTemplates(List<TemplatePathBuildItem> template
         long start = System.currentTimeMillis();
         List<TemplateAnalysis> analysis = new ArrayList<>();
 
+        // A dummy engine instance is used to parse and validate all templates during the build. The real engine instance is created at startup.
         Engine dummyEngine = Engine.builder().addDefaultSectionHelpers().computeSectionHelper(name -> {
+            // Create a dummy section helper factory for an uknown section that could be potentially registered at runtime 
             return new SectionHelperFactory<SectionHelper>() {
                 @Override
                 public SectionHelper initialize(SectionInitContext context) {
@@ -169,7 +170,7 @@ public CompletionStage<ResultNode> resolve(SectionResolutionContext context) {
                 LOGGER.warn("Unable to analyze the template from path: " + path.getFullPath(), e);
             }
         }
-        LOGGER.debug("Finished analysis of {} templates  in {} ms",
+        LOGGER.debugf("Finished analysis of %s templates  in %s ms",
                 analysis.size(), System.currentTimeMillis() - start);
         return new TemplatesAnalysisBuildItem(analysis);
     }
@@ -216,7 +217,7 @@ void validateExpressions(TemplatesAnalysisBuildItem templatesAnalysis, BeanArchi
                             member = findTemplateExtensionMethod(name, match.clazz, templateExtensionMethods);
                         }
                         if (member == null && excludes.stream().anyMatch(e -> e.getPredicate().test(name, match.clazz))) {
-                            LOGGER.debug("No property found for {} in [{}] but it is intentionally ignored", name,
+                            LOGGER.debugf("No property found for %s in [%s] but it is intentionally ignored", name,
                                     expression.toOriginalString(), match.clazz);
                             break;
                         }
@@ -324,7 +325,7 @@ void validateInjectedBeans(ApplicationArchivesBuildItem applicationArchivesBuild
                             }
                             if (member == null
                                     && excludes.stream().anyMatch(e -> e.getPredicate().test(name, match.clazz))) {
-                                LOGGER.debug("No property found for {} in [{}] but it is intentionally ignored", name,
+                                LOGGER.debugf("No property found for %s in [%s] but it is intentionally ignored", name,
                                         expression.toOriginalString(), match.clazz);
                                 break;
                             }
@@ -409,7 +410,7 @@ public void write(String name, byte[] data) {
                 }
                 String className = name.substring(0, idx).replace("/", ".");
                 boolean appClass = appClassPredicate.test(className);
-                LOGGER.debug("Writing {} [appClass={}]", name, appClass);
+                LOGGER.debugf("Writing %s [appClass=%s]", name, appClass);
                 generatedClass.produce(new GeneratedClassBuildItem(appClass, name, data));
             }
         };
@@ -443,18 +444,18 @@ public void write(String name, byte[] data) {
             generator.generate(data);
         }
 
-        Set<String> generateTypes = new HashSet<>();
-        generateTypes.addAll(generator.getGeneratedTypes());
+        Set<String> generatedTypes = new HashSet<>();
+        generatedTypes.addAll(generator.getGeneratedTypes());
 
         ExtensionMethodGenerator extensionMethodGenerator = new ExtensionMethodGenerator(classOutput);
         for (TemplateExtensionMethodBuildItem templateExtension : templateExtensionMethods) {
             extensionMethodGenerator.generate(templateExtension.getMethod());
         }
-        generateTypes.addAll(extensionMethodGenerator.getGeneratedTypes());
+        generatedTypes.addAll(extensionMethodGenerator.getGeneratedTypes());
 
-        LOGGER.debug("Generated types: {}", generateTypes);
+        LOGGER.debugf("Generated types: %s", generatedTypes);
 
-        for (String generateType : generateTypes) {
+        for (String generateType : generatedTypes) {
             generatedResolvers.produce(new GeneratedValueResolverBuildItem(generateType));
             reflectiveClass.produce(new ReflectiveClassBuildItem(false, false, generateType));
         }
@@ -477,15 +478,18 @@ void collectTemplates(QuteConfig config, ApplicationArchivesBuildItem applicatio
         String tagBasePath = basePath + "tags/";
         Path tagsPath = applicationArchive.getChildPath(tagBasePath);
         if (tagsPath != null) {
-            Iterator<Path> tagFiles = Files.list(tagsPath)
-                    .filter(Files::isRegularFile)
-                    .iterator();
-            while (tagFiles.hasNext()) {
-                Path path = tagFiles.next();
-                String tagPath = path.getFileName().toString();
-                LOGGER.debug("Found tag: {}", path);
-                produceTemplateBuildItems(templatePaths, watchedPaths, nativeImageResources, tagBasePath, tagPath, path, true);
+            try (Stream<Path> tagFiles = Files.list(tagsPath)) {
+                Iterator<Path> iter = tagFiles.filter(Files::isRegularFile)
+                        .iterator();
+                while (iter.hasNext()) {
+                    Path path = iter.next();
+                    String tagPath = path.getFileName().toString();
+                    LOGGER.debugf("Found tag: %s", path);
+                    produceTemplateBuildItems(templatePaths, watchedPaths, nativeImageResources, tagBasePath, tagPath, path,
+                            true);
+                }
             }
+
         }
     }
 
@@ -563,7 +567,7 @@ void processInjectionPoints(QuteConfig config, ApplicationArchivesBuildItem appl
             Map<String, List<String>> variants = new HashMap<>();
             scanVariants(basePath, templatesPath, templatesPath, variantBases, variants);
             templateVariants.produce(new TemplateVariantsBuildItem(variants));
-            LOGGER.debug("Variant templates found: {}", variants);
+            LOGGER.debugf("Variant templates found: %s", variants);
         }
     }
 
@@ -749,7 +753,7 @@ private void processsTemplateData(IndexView index, AnnotationInstance templateDa
                             new AnnotationValue[] { ignoreValue, propertiesValue });
                 });
             } else {
-                LOGGER.warn("@TemplateData#target() not available: {}", annotationTarget.asClass().name());
+                LOGGER.warnf("@TemplateData#target() not available: %s", annotationTarget.asClass().name());
             }
         }
     }
@@ -804,37 +808,40 @@ private void scan(Path root, Path directory, String basePath, BuildProducer<HotD
             BuildProducer<TemplatePathBuildItem> templatePaths,
             BuildProducer<NativeImageResourceBuildItem> nativeImageResources)
             throws IOException {
-        Iterator<Path> files = Files.list(directory).iterator();
-        while (files.hasNext()) {
-            Path path = files.next();
-            if (Files.isRegularFile(path)) {
-                LOGGER.debug("Found template: {}", path);
-                String templatePath = root.relativize(path).toString();
-                produceTemplateBuildItems(templatePaths, watchedPaths, nativeImageResources, basePath, templatePath, path,
-                        false);
-            } else if (Files.isDirectory(path) && !path.getFileName().toString().equals("tags")) {
-                LOGGER.debug("Scan directory: {}", path);
-                scan(root, path, basePath, watchedPaths, templatePaths, nativeImageResources);
+        try (Stream<Path> files = Files.list(directory)) {
+            Iterator<Path> iter = files.iterator();
+            while (iter.hasNext()) {
+                Path path = iter.next();
+                if (Files.isRegularFile(path)) {
+                    LOGGER.debugf("Found template: %s", path);
+                    String templatePath = root.relativize(path).toString();
+                    produceTemplateBuildItems(templatePaths, watchedPaths, nativeImageResources, basePath, templatePath, path,
+                            false);
+                } else if (Files.isDirectory(path) && !path.getFileName().toString().equals("tags")) {
+                    LOGGER.debugf("Scan directory: %s", path);
+                    scan(root, path, basePath, watchedPaths, templatePaths, nativeImageResources);
+                }
             }
         }
     }
 
     void scanVariants(String basePath, Path root, Path directory, Set<String> variantBases, Map<String, List<String>> variants)
             throws IOException {
-        Iterator<Path> files = Files.list(directory)
-                .iterator();
-        while (files.hasNext()) {
-            Path path = files.next();
-            if (Files.isRegularFile(path)) {
-                for (String base : variantBases) {
-                    if (path.toAbsolutePath().toString().contains(base)) {
-                        // Variants are relative paths to base, e.g. "detail/item2"
-                        variants.computeIfAbsent(base, i -> new ArrayList<>())
-                                .add(root.relativize(path).toString());
+        try (Stream<Path> files = Files.list(directory)) {
+            Iterator<Path> iter = files.iterator();
+            while (iter.hasNext()) {
+                Path path = iter.next();
+                if (Files.isRegularFile(path)) {
+                    for (String base : variantBases) {
+                        if (path.toAbsolutePath().toString().contains(base)) {
+                            // Variants are relative paths to base, e.g. "detail/item2"
+                            variants.computeIfAbsent(base, i -> new ArrayList<>())
+                                    .add(root.relativize(path).toString());
+                        }
                     }
+                } else if (Files.isDirectory(path)) {
+                    scanVariants(basePath, root, path, variantBases, variants);
                 }
-            } else if (Files.isDirectory(path)) {
-                scanVariants(basePath, root, path, variantBases, variants);
             }
         }
     }

extensions/qute/deployment/src/main/java/io/quarkus/qute/deployment/TemplateExtensionMethodBuildItem.java

@@ -6,6 +6,11 @@
 import io.quarkus.builder.item.MultiBuildItem;
 import io.quarkus.qute.TemplateExtension;
 
+/**
+ * Represents a template extension method.
+ * 
+ * @see TemplateExtension
+ */
 public final class TemplateExtensionMethodBuildItem extends MultiBuildItem {
 
     private final MethodInfo method;

extensions/qute/deployment/src/main/java/io/quarkus/qute/deployment/TemplatePathBuildItem.java

@@ -4,6 +4,9 @@
 
 import io.quarkus.builder.item.MultiBuildItem;
 
+/**
+ * Represents a template path.
+ */
 public final class TemplatePathBuildItem extends MultiBuildItem {
 
     private final String path;

extensions/qute/deployment/src/main/java/io/quarkus/qute/deployment/TemplateVariantsBuildItem.java

@@ -5,6 +5,9 @@
 
 import io.quarkus.builder.item.SimpleBuildItem;
 
+/**
+ * Holds all template variants found.
+ */
 public final class TemplateVariantsBuildItem extends SimpleBuildItem {
 
     private final Map<String, List<String>> variants;