Turn aspectModelDocumentationGenerator into a standard Generator

I.e., have it inherit from Generator and use the same configuration approach as
the other generators

Author: atextor

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/JsonArtifact.java

@@ -13,6 +13,8 @@
 
 package org.eclipse.esmf.aspectmodel.generator;
 
+import java.nio.charset.StandardCharsets;
+
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
@@ -46,6 +48,11 @@ public String getContentAsYaml() {
       return jsonToYaml( getContent() );
    }
 
+   @Override
+   public byte[] serialize() {
+      return getContent().toPrettyString().getBytes( StandardCharsets.UTF_8 );
+   }
+
    protected String jsonToYaml( final JsonNode json ) {
       try {
          final YAMLFactory yamlFactory = YAMLFactory.builder()

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/JsonGenerator.java

@@ -100,9 +100,10 @@ public void generateJson( final Function<String, OutputStream> nameMapper ) {
    @Override
    protected void write( final Artifact<String, R> artifact, final Function<String, OutputStream> nameMapper ) {
       try ( final OutputStream output = nameMapper.apply( aspect.getName() ) ) {
-         output.write( artifact.getContent().toPrettyString().getBytes() );
+         output.write( artifact.serialize() );
+         output.flush();
       } catch ( final IOException exception ) {
-         throw new RuntimeException( exception );
+         throw new DocumentGenerationException( exception );
       }
    }
 }

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/docu/AspectModelDocumentationGenerator.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2024 Robert Bosch Manufacturing Solutions GmbH
+ *
+ * See the AUTHORS file(s) distributed with this work for additional
+ * information regarding authorship.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+package org.eclipse.esmf.aspectmodel.generator.docu;
+
+import org.eclipse.esmf.aspectmodel.generator.Artifact;
+
+public class DocumentationArtifact implements Artifact<String, String> {
+   private final String id;
+   private final String content;
+
+   public DocumentationArtifact( final String id, final String content ) {
+      this.id = id;
+      this.content = content;
+   }
+
+   @Override
+   public String getId() {
+      return "";
+   }
+
+   @Override
+   public String getContent() {
+      return "";
+   }
+}

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/docu/DocumentationArtifact.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2024 Robert Bosch Manufacturing Solutions GmbH
+ *
+ * See the AUTHORS file(s) distributed with this work for additional
+ * information regarding authorship.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+package org.eclipse.esmf.aspectmodel.generator.docu;
+
+import java.util.Locale;
+
+import org.eclipse.esmf.aspectmodel.generator.GenerationConfig;
+
+import io.soabase.recordbuilder.core.RecordBuilder;
+
+/**
+ * @param locale The target language to generate for
+ * @param stylesheet the CSS stylesheet to use in the generated HTML
+ */
+@RecordBuilder
+public record DocumentationGenerationConfig(
+      Locale locale,
+      String stylesheet
+) implements GenerationConfig {
+   public DocumentationGenerationConfig {
+      if ( locale == null ) {
+         locale = Locale.ENGLISH;
+      }
+   }
+}

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/docu/DocumentationGenerationConfig.java

@@ -26,7 +26,7 @@
 import org.slf4j.LoggerFactory;
 
 public class AspectModelToJsonLdGenerator extends JsonGenerator<JsonLdGenerationConfig, JsonNode, JsonLdArtifact> {
-   public static final JsonLdGenerationConfig DEFAULT_CONFIG = null;
+   public static final JsonLdGenerationConfig DEFAULT_CONFIG = JsonLdGenerationConfigBuilder.builder().build();
    private static final Logger LOG = LoggerFactory.getLogger( AspectModelToJsonLdGenerator.class );
 
    public AspectModelToJsonLdGenerator( final Aspect aspect ) {

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/jsonld/AspectModelToJsonLdGenerator.java

@@ -20,7 +20,6 @@
 import java.io.IOException;
 import java.io.PrintStream;
 import java.nio.charset.StandardCharsets;
-import java.util.Map;
 
 import org.eclipse.esmf.metamodel.Aspect;
 import org.eclipse.esmf.test.TestAspect;
@@ -186,7 +185,7 @@ private String generateHtmlDocumentation( final TestAspect testAspect ) throws I
       final AspectModelDocumentationGenerator aspectModelDocumentationGenerator = new AspectModelDocumentationGenerator( aspect );
 
       try ( final ByteArrayOutputStream result = new ByteArrayOutputStream() ) {
-         aspectModelDocumentationGenerator.generate( name -> result, Map.of() );
+         aspectModelDocumentationGenerator.generate();
          return result.toString( StandardCharsets.UTF_8 );
       }
    }

core/esmf-aspect-model-document-generators/src/test/java/org/eclipse/esmf/aspectmodel/generator/docu/AspectModelDocumentationGeneratorTest.java

@@ -13,6 +13,8 @@
 
 package org.eclipse.esmf.aspectmodel.generator;
 
+import java.nio.charset.StandardCharsets;
+
 /**
  * Represents an artifact during generation, for example a single generated class.
  *
@@ -23,4 +25,8 @@ public interface Artifact<I, T> {
    I getId();
 
    T getContent();
+
+   default byte[] serialize() {
+      return getContent().toString().getBytes( StandardCharsets.UTF_8 );
+   }
 }

core/esmf-aspect-model-generator/src/main/java/org/eclipse/esmf/aspectmodel/generator/Artifact.java

@@ -19,22 +19,26 @@
 import java.io.Writer;
 import java.nio.charset.StandardCharsets;
 import java.util.Comparator;
-import java.util.List;
 import java.util.function.Function;
 import java.util.stream.Stream;
 
 import org.eclipse.esmf.aspectmodel.visitor.AspectStreamTraversalVisitor;
 import org.eclipse.esmf.metamodel.Aspect;
 import org.eclipse.esmf.metamodel.ModelElement;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 /**
  * Base class for the generation of {@link Artifact}s.
  *
  * @param <I> the type that uniquely identifies the artifact in the scope of the generation process
  * @param <T> the artifact's content type, e.g. String or byte[]
  * @param <C> the config object for the genererator
+ * @param <A> the type of the artifact that is generated
  */
 public abstract class Generator<I, T, C extends GenerationConfig, A extends Artifact<I, T>> {
+   private static final Logger LOG = LoggerFactory.getLogger( Generator.class );
    protected final C config;
    protected final Aspect aspect;
    protected final Comparator<ModelElement> uniqueByModelElementIdentifier = ( modelElementOne, modelElementTwo ) -> {
@@ -83,8 +87,7 @@ protected void writeCharSequenceToOutputStream( final CharSequence charSequence,
     * @param nameMapper the callback function that maps artifact identifiers to OutputStreams
     */
    public void generate( final Function<I, OutputStream> nameMapper ) {
-      final List<A> artifacts = generate().toList();
-      artifacts.forEach( generationResult -> write( generationResult, nameMapper ) );
+      generate().toList().forEach( generationResult -> write( generationResult, nameMapper ) );
    }
 
    /**
@@ -120,5 +123,12 @@ public T getContent() {
     * @param artifact the artifact
     * @param nameMapper the function that provides the output stream for the artifact
     */
-   protected abstract void write( final Artifact<I, T> artifact, final Function<I, OutputStream> nameMapper );
+   protected void write( final Artifact<I, T> artifact, final Function<I, OutputStream> nameMapper ) {
+      try ( final OutputStream output = nameMapper.apply( artifact.getId() ) ) {
+         output.write( artifact.serialize() );
+         output.flush();
+      } catch ( final IOException exception ) {
+         LOG.error( "Failure during writing of generated artifact", exception );
+      }
+   }
 }

core/esmf-aspect-model-generator/src/main/java/org/eclipse/esmf/aspectmodel/generator/Generator.java

@@ -12,45 +12,15 @@
  */
 package org.eclipse.esmf.aspectmodel.java;
 
-import java.io.IOException;
-import java.io.OutputStream;
-import java.io.OutputStreamWriter;
-import java.io.Writer;
-import java.nio.charset.StandardCharsets;
-import java.util.function.Function;
-
 import org.eclipse.esmf.aspectmodel.generator.Artifact;
 import org.eclipse.esmf.aspectmodel.generator.Generator;
 import org.eclipse.esmf.metamodel.Aspect;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 /**
  * Base class for all generators that want to create Java source code.
  */
 public abstract class JavaGenerator extends Generator<QualifiedName, String, JavaCodeGenerationConfig, Artifact<QualifiedName, String>> {
-   private static final Logger LOG = LoggerFactory.getLogger( JavaGenerator.class );
-
    public JavaGenerator( final Aspect aspect, final JavaCodeGenerationConfig config ) {
       super( aspect, config );
    }
-
-   @Override
-   public void write( final Artifact<QualifiedName, String> artifact, final Function<QualifiedName, OutputStream> nameMapper ) {
-      final QualifiedName qualifiedName = artifact.getId();
-      final OutputStream outputStream = nameMapper.apply( qualifiedName );
-      final String content = artifact.getContent();
-
-      try {
-         try ( final Writer writer = new OutputStreamWriter( outputStream, StandardCharsets.UTF_8 ) ) {
-            for ( int i = 0; i < content.length(); i++ ) {
-               writer.write( content.charAt( i ) );
-            }
-            writer.flush();
-         }
-      } catch ( final IOException e ) {
-         LOG.error( "Failure during writing of generated code.", e );
-      }
-   }
 }