refactor: update withAutomaticProvenance method to accept ProvenanceManager instance

This allows disabling provenance management with null, but also enable to implement derived or completely new implementations.

Author: Pfeil

src/main/java/edu/kit/datamanager/ro_crate/preview/CratePreview.java

@@ -41,7 +41,7 @@ default void generate(Crate crate, File targetDir) throws IOException {
         // (including preview)
         new CrateWriter<>(new WriteFolderStrategy().disablePreview())
                 // We assume the caller (e.g. a writer) already stored the provenance.
-                .withAutomaticProvenance(false)
+                .withAutomaticProvenance(null)
                 .save(crate, targetDir.getAbsolutePath());
         this.saveAllToFolder(targetDir);
         try (var stream = Files.list(targetDir.toPath())) {

src/main/java/edu/kit/datamanager/ro_crate/writer/CrateWriter.java

@@ -15,14 +15,21 @@
 public class CrateWriter<DESTINATION_TYPE> {
 
     private final GenericWriterStrategy<DESTINATION_TYPE> strategy;
-    protected boolean automaticProvenance = true;
+    protected ProvenanceManager provenanceManager = new ProvenanceManager();
 
     public CrateWriter(GenericWriterStrategy<DESTINATION_TYPE> strategy) {
         this.strategy = strategy;
     }
 
-    public CrateWriter<DESTINATION_TYPE> withAutomaticProvenance(boolean automaticProvenance) {
-        this.automaticProvenance = automaticProvenance;
+    /**
+     * Sets the ProvenanceManager to be used for automatic provenance information
+     * generation when saving the crate.
+     *
+     * @param provenanceManager the ProvenanceManager to use. Using null will disable provenance management.
+     * @return this CrateWriter instance for method chaining.
+     */
+    public CrateWriter<DESTINATION_TYPE> withAutomaticProvenance(ProvenanceManager provenanceManager) {
+        this.provenanceManager = provenanceManager;
         return this;
     }
 
@@ -35,7 +42,7 @@ public CrateWriter<DESTINATION_TYPE> withAutomaticProvenance(boolean automaticPr
     public void save(Crate crate, DESTINATION_TYPE destination) throws IOException {
         Validator defaultValidation = new Validator(new JsonSchemaValidation());
         defaultValidation.validate(crate);
-        if (automaticProvenance) {
+        if (this.provenanceManager != null) {
             new ProvenanceManager().addProvenanceInformation(crate);
         }
         this.strategy.save(crate, destination);

src/main/java/edu/kit/datamanager/ro_crate/writer/ProvenanceManager.java

@@ -13,7 +13,7 @@
  * Manages provenance information for RO-Crates.
  * Handles the creation and updating of ro-crate-java entity and its actions.
  */
-class ProvenanceManager {
+public class ProvenanceManager {
     protected record IdPrefix(String prefix) {
         public String withSuffix(String suffix) {
             return prefix + "-" + suffix;
@@ -49,7 +49,7 @@ public String getLibraryId() {
         return RO_CRATE_JAVA_ID_PREFIX.withSuffix(versionProvider.getVersion().toLowerCase());
     }
 
-    void addProvenanceInformation(Crate crate) {
+    protected void addProvenanceInformation(Crate crate) {
         // Determine if this is the first write
         boolean isFirstWrite = crate.getAllContextualEntities().stream().noneMatch(
                 entity -> entity.getId().startsWith(RO_CRATE_JAVA_ID_PREFIX.toString()))
@@ -68,7 +68,7 @@ void addProvenanceInformation(Crate crate) {
         crate.addContextualEntity(actionEntity);
     }
 
-    private ContextualEntity createActionEntity(boolean isFirstWrite, String libraryId) {
+    protected ContextualEntity createActionEntity(boolean isFirstWrite, String libraryId) {
         return new ContextualEntityBuilder()
                 .addType(isFirstWrite ? "CreateAction" : "UpdateAction")
                 .addIdProperty("result", "./")
@@ -77,7 +77,7 @@ private ContextualEntity createActionEntity(boolean isFirstWrite, String library
                 .build();
     }
 
-    private ContextualEntity buildRoCrateJavaEntity(
+    protected ContextualEntity buildRoCrateJavaEntity(
             Crate crate,
             String newActionId,
             String libraryId
@@ -86,19 +86,17 @@ private ContextualEntity buildRoCrateJavaEntity(
         ContextualEntity self = crate.getAllContextualEntities().stream()
                 .filter(contextualEntity -> libraryId.equals(contextualEntity.getId()))
                 .findFirst()
-                .orElseGet(() -> {
-                            return new ContextualEntityBuilder()
-                                    .setId(libraryId)
-                                    .addType("SoftwareApplication")
-                                    .addProperty("name", "ro-crate-java")
-                                    .addProperty("url", "https://github.com/kit-data-manager/ro-crate-java")
-                                    .addProperty("version", version)
-                                    .addProperty("softwareVersion", version)
-                                    .addProperty("license", "Apache-2.0")
-                                    .addProperty("description", "A Java library for creating and manipulating RO-Crates")
-                                    .addIdProperty("Action", newActionId)
-                                    .build();
-                        }
+                .orElseGet(() -> new ContextualEntityBuilder()
+                        .setId(libraryId)
+                        .addType("SoftwareApplication")
+                        .addProperty("name", "ro-crate-java")
+                        .addProperty("url", "https://github.com/kit-data-manager/ro-crate-java")
+                        .addProperty("version", version)
+                        .addProperty("softwareVersion", version)
+                        .addProperty("license", "Apache-2.0")
+                        .addProperty("description", "A Java library for creating and manipulating RO-Crates")
+                        .addIdProperty("Action", newActionId)
+                        .build()
                 );
         self.addIdProperty("Action", newActionId);
         return self;

src/test/java/edu/kit/datamanager/ro_crate/reader/CommonReaderTest.java

@@ -128,10 +128,10 @@ default void TestWithFileWithLocation(@TempDir Path temp) throws IOException {
             // write raw crate and imported crate to two different directories
             CrateWriter<String> writer = Writers.newFolderWriter();
             writer
-                    .withAutomaticProvenance(false)
+                    .withAutomaticProvenance(null)
                     .save(rawCrate, rawCrateTarget.toString());
             writer
-                    .withAutomaticProvenance(false)
+                    .withAutomaticProvenance(null)
                     .save(importedCrate, importedCrateTarget.toString());
         }
 

src/test/java/edu/kit/datamanager/ro_crate/reader/FolderReaderTest.java

@@ -22,7 +22,7 @@ class FolderReaderTest implements CommonReaderTest<String, ReadFolderStrategy>
   @Override
   public void saveCrate(Crate crate, Path target) throws IOException {
     Writers.newFolderWriter()
-            .withAutomaticProvenance(false)
+            .withAutomaticProvenance(null)
             .save(crate, target.toAbsolutePath().toString());
     assertTrue(target.toFile().isDirectory());
   }

src/test/java/edu/kit/datamanager/ro_crate/reader/ZipReaderTest.java

@@ -15,7 +15,7 @@ class ZipReaderTest implements
     @Override
     public void saveCrate(Crate crate, Path target) throws IOException {
         Writers.newZipPathWriter()
-                .withAutomaticProvenance(false)
+                .withAutomaticProvenance(null)
                 .save(crate, target.toAbsolutePath().toString());
         assertTrue(target.toFile().isFile());
     }

src/test/java/edu/kit/datamanager/ro_crate/reader/ZipStreamReaderTest.java

@@ -34,7 +34,7 @@ public void saveCrate(Crate crate, Path target) throws IOException {
                 FileOutputStream fos = new FileOutputStream(target_file)
         ) {
             Writers.newZipStreamWriter()
-                    .withAutomaticProvenance(false)
+                    .withAutomaticProvenance(null)
                     .save(crate, fos);
         }
         assertTrue(target_file.isFile());

src/test/java/edu/kit/datamanager/ro_crate/writer/FolderWriterTest.java

@@ -16,7 +16,7 @@ class FolderWriterTest implements CommonWriterTest {
     @Override
     public void saveCrate(Crate crate, Path target) throws IOException {
         Writers.newFolderWriter()
-                .withAutomaticProvenance(false)
+                .withAutomaticProvenance(null)
                 .save(crate, target.toAbsolutePath().toString());
     }
 

src/test/java/edu/kit/datamanager/ro_crate/writer/RoCrateMetadataGenerationTest.java

@@ -294,7 +294,7 @@ void should_AddProvenanceInfo_When_ModifyingExistingCrateWithoutProvenance(@Temp
 
         // Use writer with disabled provenance (not implemented yet)
         Writers.newFolderWriter()
-                .withAutomaticProvenance(false)
+                .withAutomaticProvenance(null)
                 .save(originalCrate, outputPath.toString());
 
         // Verify the original crate has no provenance information

src/test/java/edu/kit/datamanager/ro_crate/writer/RoCrateWriterSpec12Test.java

@@ -30,7 +30,7 @@ void writeDoesNotModifyTest(@TempDir Path tempDir) throws IOException, URISyntax
         Path targetDir = tempDir.resolve("spec12writeUnmodified");
 
         Writers.newFolderWriter()
-                .withAutomaticProvenance(false)
+                .withAutomaticProvenance(null)
                 .save(crate, targetDir.toAbsolutePath().toString());
 
         // compare directories