Use standard generator arch for AspectModelNamespacePackageCreator

Author: atextor

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

@@ -1,45 +1,78 @@
 package org.eclipse.esmf.aspectmodel.generator.zip;
 
 import java.io.BufferedOutputStream;
-import java.io.FileOutputStream;
+import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.OutputStream;
 import java.io.OutputStreamWriter;
 import java.io.Writer;
+import java.util.stream.Stream;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipOutputStream;
 
 import org.eclipse.esmf.aspectmodel.AspectModelFile;
+import org.eclipse.esmf.aspectmodel.generator.GenerationException;
+import org.eclipse.esmf.aspectmodel.generator.Generator;
 import org.eclipse.esmf.aspectmodel.serializer.AspectSerializer;
 import org.eclipse.esmf.metamodel.AspectModel;
 
-import org.apache.commons.lang3.function.TriConsumer;
+public class AspectModelNamespacePackageCreator
+      extends Generator<AspectModel, String, byte[], NamespacePackageGenerationConfig, NamespacePackageArtifact> {
+   public static final NamespacePackageGenerationConfig DEFAULT_CONFIG = NamespacePackageGenerationConfigBuilder.builder().build();
+   @Deprecated( forRemoval = true )
+   public static final AspectModelNamespacePackageCreator INSTANCE = new AspectModelNamespacePackageCreator( null );
+   private static final String BASE_ARCHIVE_FORMAT_PATH = "aspect-models/";
 
-public class AspectModelNamespacePackageCreator implements TriConsumer<AspectModel, OutputStream, String> {
+   public AspectModelNamespacePackageCreator( final AspectModel aspectModel ) {
+      this( aspectModel, DEFAULT_CONFIG );
+   }
 
-   private static final String BASE_ARCHIVE_FORMAT_PATH = "aspect-models/";
+   public AspectModelNamespacePackageCreator( final AspectModel aspectModel, final NamespacePackageGenerationConfig config ) {
+      super( aspectModel, config );
+   }
 
-   public static final AspectModelNamespacePackageCreator INSTANCE = new AspectModelNamespacePackageCreator();
+   private AspectModel aspectModel() {
+      return focus;
+   }
 
-   private AspectModelNamespacePackageCreator() {
+   /**
+    * @deprecated Use {@link #AspectModelNamespacePackageCreator(AspectModel, NamespacePackageGenerationConfig)} instead
+    */
+   @Deprecated( forRemoval = true )
+   public void accept( final AspectModel aspectModel, final OutputStream outputStream, final String rootPath ) {
+      final NamespacePackageGenerationConfig config = NamespacePackageGenerationConfigBuilder.builder()
+            .rootPath( rootPath )
+            .build();
+      final NamespacePackageArtifact artifact = new AspectModelNamespacePackageCreator( aspectModel, config ).singleResult();
+      write( artifact, x -> outputStream );
+   }
+
+   /**
+    * Figures out a fitting name for the generated namespace package
+    *
+    * @return a name for the generated namespace package
+    */
+   private String packageName() {
+      if ( aspectModel().aspects().size() == 1 ) {
+         return aspectModel().aspect().getName() + ".zip";
+      }
+      return "package" + aspectModel().hashCode() + ".zip"; // 🤷
    }
 
    @Override
-   public void accept( final AspectModel aspectModel, final OutputStream outputStream, final String rootPath ) {
-      try ( final FileOutputStream fos = (FileOutputStream) outputStream;
-            final BufferedOutputStream bos = new BufferedOutputStream( fos );
+   public Stream<NamespacePackageArtifact> generate() {
+      final ByteArrayOutputStream out = new ByteArrayOutputStream();
+      try ( final BufferedOutputStream bos = new BufferedOutputStream( out );
             final ZipOutputStream zos = new ZipOutputStream( bos ) ) {
-
-         for ( final AspectModelFile aspectModelFile : aspectModel.files() ) {
-            addFileToArchive( aspectModelFile, zos, rootPath );
-         }
-      } catch ( final IOException e ) {
-         try {
-            throw new IOException( "Error creating zip archive!", e );
-         } catch ( final IOException ex ) {
-            throw new RuntimeException( ex );
+         for ( final AspectModelFile aspectModelFile : aspectModel().files() ) {
+            addFileToArchive( aspectModelFile, zos, config.rootPath() );
          }
+         out.close();
+      } catch ( final IOException exception ) {
+         throw new GenerationException( "Could not creat namespace package for Aspect Model", exception );
       }
+
+      return Stream.of( new NamespacePackageArtifact( packageName(), out.toByteArray() ) );
    }
 
    private static void addFileToArchive( final AspectModelFile file, final ZipOutputStream zos, final String rootPath )

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

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) 2024 Bosch Software Innovations GmbH. All rights reserved.
+ */
+
+package org.eclipse.esmf.aspectmodel.generator.zip;
+
+import org.eclipse.esmf.aspectmodel.generator.BinaryArtifact;
+
+public class NamespacePackageArtifact extends BinaryArtifact {
+   public NamespacePackageArtifact( final String id, final byte[] content ) {
+      super( id, content );
+   }
+}

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

@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) 2024 Bosch Software Innovations GmbH. All rights reserved.
+ */
+
+package org.eclipse.esmf.aspectmodel.generator.zip;
+
+import org.eclipse.esmf.aspectmodel.generator.GenerationConfig;
+
+import io.soabase.recordbuilder.core.RecordBuilder;
+
+@RecordBuilder
+public record NamespacePackageGenerationConfig(
+      String rootPath
+) implements GenerationConfig {
+   public NamespacePackageGenerationConfig {
+      if ( rootPath == null ) {
+         rootPath = "";
+      }
+   }
+}

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

@@ -42,8 +42,10 @@ void beforeEach() throws IOException {
    void testAspectModelArchiveGeneration() throws IOException {
       final AspectModel aspectModel = TestResources.load( TestAspect.ASPECT_WITH_PROPERTY );
       final String outputFileName = String.format( "%s/%s", outputDirectory.toString(), "/test_zip.zip" );
-
-      AspectModelNamespacePackageCreator.INSTANCE.accept( aspectModel, new FileOutputStream( Paths.get( outputFileName ).toFile() ), "" );
+      try ( final FileOutputStream fileOutputStream = new FileOutputStream( Paths.get( outputFileName ).toFile() ) ) {
+         new AspectModelNamespacePackageCreator( aspectModel, AspectModelNamespacePackageCreator.DEFAULT_CONFIG )
+               .generate( x -> fileOutputStream );
+      }
 
       assertThat( new File( outputFileName ) ).exists();