Simplified IConverter API. Added support for predefined output streams.

Author: eriadam

src/bcf-toolkit/Converter/Bcf21/Converter.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.IO.Compression;
 using System.Threading.Tasks;
 using BcfToolkit.Builder.Bcf21;
 using BcfToolkit.Utils;
@@ -15,7 +16,6 @@ namespace BcfToolkit.Converter.Bcf21;
 ///   JSON, and BCFzip.
 /// </summary>
 public class Converter : IConverter {
-
   private BcfBuilder _builder = new();
 
   /// <summary>
@@ -32,29 +32,42 @@ public class Converter : IConverter {
   ///   Defines the file writer function which must be used for write the BCF
   ///   object to the targeted version.
   /// </summary>
-  private readonly Dictionary<BcfVersionEnum, Func<IBcf, bool, Task<Stream>>> _writerFn =
-    new() {
-      [BcfVersionEnum.Bcf21] = FileWriter.SerializeAndWriteBcf,
-      [BcfVersionEnum.Bcf30] = Bcf30.FileWriter.SerializeAndWriteBcf
-    };
+  private readonly Dictionary<BcfVersionEnum, Func<IBcf, Task<Stream>>>
+    _writerFn =
+      new() {
+        [BcfVersionEnum.Bcf21] = FileWriter.SerializeAndWriteBcf,
+        [BcfVersionEnum.Bcf30] = Bcf30.FileWriter.SerializeAndWriteBcf
+      };
 
-  public async Task BcfZipToJson(Stream source, string targetPath) {
+  /// <summary>
+  ///   Defines the stream writer function which must be used for write the BCF
+  ///   object to the targeted version.
+  /// </summary>
+  private readonly Dictionary<BcfVersionEnum, Action<IBcf, ZipArchive>>
+    _streamWriterFn =
+      new() {
+        [BcfVersionEnum.Bcf21] = FileWriter.SerializeAndWriteBcfToStream,
+        [BcfVersionEnum.Bcf30] = Bcf30.FileWriter.SerializeAndWriteBcfToStream
+      };
+
+  public async Task BcfToJson(Stream source, string targetPath) {
     var bcf = await _builder.BuildFromStream(source);
     await FileWriter.WriteBcfToJson(bcf, targetPath);
   }
 
-  public async Task BcfZipToJson(string sourcePath, string targetPath) {
+  public async Task BcfToJson(string sourcePath, string targetPath) {
     try {
       await using var fileStream =
         new FileStream(sourcePath, FileMode.Open, FileAccess.Read);
-      await BcfZipToJson(fileStream, targetPath);
+      await BcfToJson(fileStream, targetPath);
     }
     catch (Exception ex) {
-      throw new ArgumentException($"Source path is not readable. {ex.Message}", ex);
+      throw new ArgumentException($"Source path is not readable. {ex.Message}",
+        ex);
     }
   }
 
-  public async Task JsonToBcfZip(string source, string target) {
+  public async Task JsonToBcf(string source, string target) {
     // Project is optional
     var projectPath = $"{source}/project.json";
     var project = Path.Exists(projectPath)
@@ -72,26 +85,32 @@ public async Task JsonToBcfZip(string source, string target) {
     await FileWriter.SerializeAndWriteBcfToFolder(bcf, target);
   }
 
-  public async Task<Stream> ToBcfStream(
-    IBcf bcf,
-    BcfVersionEnum targetVersion,
-    bool writeTmpFolder) {
+  public async Task<Stream> ToBcf(IBcf bcf, BcfVersionEnum targetVersion) {
     var converterFn = _converterFn[targetVersion];
     var convertedBcf = converterFn((Bcf)bcf);
 
     var writerFn = _writerFn[targetVersion];
-    return await writerFn(convertedBcf, writeTmpFolder);
+    return await writerFn(convertedBcf);
+  }
+
+  public void ToBcf(IBcf bcf, BcfVersionEnum targetVersion, Stream stream) {
+    var converterFn = _converterFn[targetVersion];
+    var convertedBcf = converterFn((Bcf)bcf);
+
+    var writerFn = _streamWriterFn[targetVersion];
+    var zip = new ZipArchive(stream, ZipArchiveMode.Create, true);
+    writerFn(convertedBcf, zip);
   }
 
-  public Task ToBcfZip(IBcf bcf, string target) {
+  public Task ToBcf(IBcf bcf, string target) {
     return FileWriter.SerializeAndWriteBcfToFolder((Bcf)bcf, target);
   }
 
   public Task ToJson(IBcf bcf, string target) {
     return FileWriter.WriteBcfToJson((Bcf)bcf, target);
   }
 
-  public async Task<T> BuildBcfFromStream<T>(Stream stream) {
+  public async Task<T> BcfFromStream<T>(Stream stream) {
     var bcf = await _builder.BuildFromStream(stream);
     var targetVersion = BcfVersion.TryParse(typeof(T));
     var converterFn = _converterFn[targetVersion];

src/bcf-toolkit/Converter/Bcf21/FileWriter.cs

@@ -57,48 +57,30 @@ public static Task WriteBcfToJson(Bcf bcf, string target) {
   ///   WARNING: Disposing the stream is the responsibility of the user!
   /// </summary>
   /// <param name="bcf">The `BCF` object that should be written.</param>
-  /// <param name="writeToTmp">Should the archive be saved in the tmp folder.</param>
   /// <returns>It returns a stream of the archive.</returns>
-  public static async Task<Stream> SerializeAndWriteBcf(
-    IBcf bcf,
-    bool writeToTmp) {
-
-    if (writeToTmp) {
-      var workingDir = Directory.GetCurrentDirectory();
-      var tmpBcfTargetPath = workingDir + $"/{Guid.NewGuid()}.bcfzip";
-      var tmpFolder = await SerializeAndWriteBcfToFolder(bcf, tmpBcfTargetPath, false);
-      var fileStream = new FileStream(tmpBcfTargetPath, FileMode.Open, FileAccess.Read);
-
-      Directory.Delete(tmpFolder, true);
-      File.Delete(tmpBcfTargetPath);
-
-      return fileStream;
-    }
-
-    // Memory stream for the zip archive
-    var ms = new MemoryStream();
-    var zip = new ZipArchive(ms, ZipArchiveMode.Create, true);
-
-    var zipStream = await SerializeAndWriteBcfToStream(bcf, ms, zip);
-    zip.Dispose();
-    return zipStream;
+  public static async Task<Stream> SerializeAndWriteBcf(IBcf bcf) {
+    var workingDir = Directory.GetCurrentDirectory();
+    var tmpBcfTargetPath = workingDir + $"/{Guid.NewGuid()}.bcfzip";
+    var tmpFolder =
+      await SerializeAndWriteBcfToFolder(bcf, tmpBcfTargetPath, false);
+    var fileStream =
+      new FileStream(tmpBcfTargetPath, FileMode.Open, FileAccess.Read);
+
+    Directory.Delete(tmpFolder, true);
+    File.Delete(tmpBcfTargetPath);
+
+    return fileStream;
   }
 
   /// <summary>
   ///   The method serializes the BCF content to xml from the given object,
-  ///   creates a zip entry from a memory stream and return a stream of the
-  ///   archive.
-  ///
-  ///   WARNING: Disposing the stream is the responsibility of the user!
+  ///   creates a zip entry from to the specified stream.
   /// </summary>
   /// <param name="bcf">The `Bcf` object that should be written.</param>
-  /// <param name="stream">The memory stream for the zip archive.</param>
   /// <param name="zip">The zip archive which the object is written in.</param>
   /// <returns>Generated stream from bcf zip.</returns>
   /// <exception cref="ApplicationException"></exception>
-  public static Task<Stream> SerializeAndWriteBcfToStream(
-    IBcf bcf,
-    MemoryStream stream,
+  public static void SerializeAndWriteBcfToStream(IBcf bcf,
     ZipArchive zip) {
     var bcfObject = (Bcf)bcf;
 
@@ -116,7 +98,8 @@ public static Task<Stream> SerializeAndWriteBcfToStream(
 
       zip.SerializeAndCreateEntry($"{topicFolder}/markup.bcf", markup);
 
-      var visInfo = (VisualizationInfo)markup.GetFirstViewPoint()?.GetVisualizationInfo()!;
+      var visInfo =
+        (VisualizationInfo)markup.GetFirstViewPoint()?.GetVisualizationInfo()!;
       zip.SerializeAndCreateEntry($"{topicFolder}/viewpoint.bcf", visInfo);
 
       var snapshotFileName = markup.GetFirstViewPoint()?.Snapshot;
@@ -129,8 +112,6 @@ public static Task<Stream> SerializeAndWriteBcfToStream(
     }
 
     zip.SerializeAndCreateEntry("project.bcfp", bcfObject.Project);
-
-    return Task.FromResult<Stream>(stream);
   }
 
   /// <summary>
@@ -152,7 +133,8 @@ public static async Task<string> SerializeAndWriteBcfToFolder(
         $"Target folder not found ${targetFolder}");
 
     // Creating a tmp folder for the intermediate files.
-    var tmpFolder = $"{targetFolder}/tmp{Path.GetFileNameWithoutExtension(target)}";
+    var tmpFolder =
+      $"{targetFolder}/tmp{Path.GetFileNameWithoutExtension(target)}";
     if (Directory.Exists(tmpFolder)) Directory.Delete(tmpFolder, true);
     Directory.CreateDirectory(tmpFolder);
 

src/bcf-toolkit/Converter/Bcf30/Converter.cs

@@ -1,12 +1,12 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.IO.Compression;
 using System.Threading.Tasks;
 using BcfToolkit.Builder.Bcf30;
 using BcfToolkit.Utils;
 using BcfToolkit.Model;
 using BcfToolkit.Model.Bcf30;
-using File = System.IO.File;
 using Version = BcfToolkit.Model.Bcf30.Version;
 
 namespace BcfToolkit.Converter.Bcf30;
@@ -16,8 +16,7 @@ namespace BcfToolkit.Converter.Bcf30;
 ///   and back.
 /// </summary>
 public class Converter : IConverter {
-
-  private BcfBuilder _builder = new();
+  private readonly BcfBuilder _builder = new();
 
   /// <summary>
   ///   Defines the converter function, which must be used for converting the
@@ -33,31 +32,45 @@ public class Converter : IConverter {
   ///   Defines the file writer function which must be used for write the BCF
   ///   object to the targeted version.
   /// </summary>
-  private readonly Dictionary<BcfVersionEnum, Func<IBcf, bool, Task<Stream>>> _writerFn =
-    new() {
-      [BcfVersionEnum.Bcf21] = Bcf21.FileWriter.SerializeAndWriteBcf,
-      [BcfVersionEnum.Bcf30] = FileWriter.SerializeAndWriteBcf
-    };
+  private readonly Dictionary<BcfVersionEnum, Func<IBcf, Task<Stream>>>
+    _fileWriterFn =
+      new() {
+        [BcfVersionEnum.Bcf21] = Bcf21.FileWriter.SerializeAndWriteBcf,
+        [BcfVersionEnum.Bcf30] = FileWriter.SerializeAndWriteBcf
+      };
+
+  /// <summary>
+  ///   Defines the stream writer function which must be used for write the BCF
+  ///   object to the targeted version.
+  /// </summary>
+  private readonly Dictionary<BcfVersionEnum, Action<IBcf, ZipArchive>>
+    _streamWriterFn =
+      new() {
+        [BcfVersionEnum.Bcf21] = Bcf21.FileWriter.SerializeAndWriteBcfToStream,
+        [BcfVersionEnum.Bcf30] = FileWriter.SerializeAndWriteBcfToStream
+      };
 
-  public async Task BcfZipToJson(Stream source, string target) {
+  public async Task BcfToJson(Stream source, string target) {
     var builder = new BcfBuilder();
     var bcf = await builder.BuildFromStream(source);
     await FileWriter.WriteJson(bcf, target);
   }
 
-  public async Task BcfZipToJson(string source, string target) {
-    await using var fileStream = new FileStream(source, FileMode.Open, FileAccess.Read);
-    await BcfZipToJson(fileStream, target);
+  public async Task BcfToJson(string source, string target) {
+    await using var fileStream =
+      new FileStream(source, FileMode.Open, FileAccess.Read);
+    await BcfToJson(fileStream, target);
   }
 
-  public async Task JsonToBcfZip(string source, string target) {
+  public async Task JsonToBcf(string source, string target) {
     // Project and DocumentInfo are optional
     var extensions =
       await JsonExtensions.ParseObject<Extensions>($"{source}/extensions.json");
     var project =
       await JsonExtensions.ParseObject<ProjectInfo>($"{source}/project.json");
     var documents =
-      await JsonExtensions.ParseObject<DocumentInfo>($"{source}/documents.json");
+      await JsonExtensions.ParseObject<DocumentInfo>(
+        $"{source}/documents.json");
     var markups = await JsonExtensions.ParseMarkups<Markup>(source);
 
     var bcf = new Bcf {
@@ -71,26 +84,32 @@ public async Task JsonToBcfZip(string source, string target) {
     await FileWriter.SerializeAndWriteBcfToFolder(bcf, target);
   }
 
-  public async Task<Stream> ToBcfStream(
-    IBcf bcf,
-    BcfVersionEnum targetVersion,
-    bool writeToTmp) {
+  public async Task<Stream> ToBcf(IBcf bcf, BcfVersionEnum targetVersion) {
+    var converterFn = _converterFn[targetVersion];
+    var convertedBcf = converterFn((Bcf)bcf);
+
+    var writerFn = _fileWriterFn[targetVersion];
+    return await writerFn(convertedBcf);
+  }
+
+  public void ToBcf(IBcf bcf, BcfVersionEnum targetVersion, Stream stream) {
     var converterFn = _converterFn[targetVersion];
     var convertedBcf = converterFn((Bcf)bcf);
 
-    var writerFn = _writerFn[targetVersion];
-    return await writerFn(convertedBcf, writeToTmp);
+    var writerFn = _streamWriterFn[targetVersion];
+    var zip = new ZipArchive(stream, ZipArchiveMode.Create, true);
+    writerFn(convertedBcf, zip);
   }
 
-  public Task ToBcfZip(IBcf bcf, string target) {
+  public Task ToBcf(IBcf bcf, string target) {
     return FileWriter.SerializeAndWriteBcfToFolder((Bcf)bcf, target);
   }
 
   public Task ToJson(IBcf bcf, string target) {
     return FileWriter.WriteJson((Bcf)bcf, target);
   }
 
-  public async Task<T> BuildBcfFromStream<T>(Stream stream) {
+  public async Task<T> BcfFromStream<T>(Stream stream) {
     var bcf = await _builder.BuildFromStream(stream);
     var targetVersion = BcfVersion.TryParse(typeof(T));
     var converterFn = _converterFn[targetVersion];