POC to get svg into javadoc

Author: Torsten-Mumme

pom.xml

@@ -96,13 +96,35 @@
                 </executions>
                 <configuration>
                     <additionalparam>-Xdoclint:none</additionalparam>
+                    <javadocDirectory>${project.basedir}/target/generated-sources/apidocs</javadocDirectory>
                 </configuration>
             </plugin>
             <plugin>
                 <groupId>org.pitest</groupId>
                 <artifactId>pitest-maven</artifactId>
                 <version>1.2.2</version>
             </plugin>
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>exec-maven-plugin</artifactId>
+                <version>1.2.1</version>
+                <executions>
+                    <execution>
+                        <id>compress-facelets</id>
+                        <phase>prepare-package</phase>
+                        <goals>
+                            <goal>java</goal>
+                        </goals>
+                        <configuration>
+                            <mainClass>net.itarray.automotion.JavadocImageGenerator</mainClass>
+                            <arguments>
+                                <argument>${project.basedir}/target</argument>
+                            </arguments>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+
         </plugins>
     </build>
 

src/main/java/net/itarray/automotion/JavadocImageGenerator.java

@@ -0,0 +1,38 @@
+package net.itarray.automotion;
+
+import com.google.common.collect.Lists;
+import net.itarray.automotion.validation.ChunkUIElementValidator;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.charset.Charset;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.List;
+import java.util.stream.Stream;
+
+public class JavadocImageGenerator {
+
+    public static void main(String[] args) throws IOException {
+        File targetDir = new File(args[0]);
+        File generatedSourcesDir = new File(targetDir, "generated-sources");
+        File apidocs = new File(generatedSourcesDir, "apidocs");
+        String packageName = ChunkUIElementValidator.class.getPackage().getName();
+        final File[] target = {apidocs};
+        Stream.of(packageName.split("\\.")).forEach(n -> target[0] =new File(target[0], n));
+        System.out.println("JavadocImageGenerator.main " +args[0]);
+        System.out.println(target[0]);
+        File docFiles = new File(target[0], "doc-files");
+        docFiles.mkdirs();
+        Path path = new File(docFiles, "sample.svg").toPath();
+        List<String> lines = Lists.newArrayList(
+                "<svg xmlns=\"http://www.w3.org/2000/svg\" \n" +
+                        "          xmlns:xlink=\"http://www.w3.org/1999/xlink\" \n" +
+                        "          version=\"1.1\" width=\"400\" height=\"110\">",
+                  "<rect width=\"300\" height=\"100\" style=\"fill:rgb(0,0,255);stroke-width:3;stroke:rgb(0,0,0)\" />",
+                "</svg>"
+        );
+        Charset charset = Charset.forName("UTF-8");
+        Files.write(path, lines, charset);
+    }
+}

src/main/java/net/itarray/automotion/validation/ChunkUIElementValidator.java

@@ -13,6 +13,13 @@ public interface ChunkUIElementValidator {
     // areAlignedInColumnsAndRows(numberOfColumns)
     ChunkUIElementValidator alignedAsGrid(int horizontalGridSize, int verticalGridSize);
 
+    /**
+     * Validate that this chunks elements are aligned in a grid of cells (not areas).
+     *
+     * <img src="./doc-files/sample.svg" style="display: block"></img>
+     *
+     * @return this
+     */
     ChunkUIElementValidator areAlignedAsGridCells();
 
     // area