Abstract output operations.

Author: pawchen

converter/generator/DocBookTransformer.cs

@@ -12,7 +12,8 @@ internal sealed class DocBookTransformer : DocToStaticPagesTransformer
     private readonly string BookDirName;
     private readonly (string url, string file, string titleEn, NavFiles navFiles)[] Pages;
 
-    public DocBookTransformer(DocToStaticPagesTransformerArgs args, IDocResourceResolver resourceResolver, ProblemRecorder problems) : base(args, resourceResolver, problems)
+    public DocBookTransformer(DocToStaticPagesTransformerArgs args, IDocResourceResolver resourceResolver, IOutputOperations output, ProblemRecorder problems)
+        : base(args, resourceResolver, output, problems)
     {
         AvailableLanguagesExpression = String.Join(',', AvailableLanguages);
         BookDirName = Path.GetFileName(Directory.EnumerateDirectories(Path.Combine(SourceFolder, "en")).Single());
@@ -98,7 +99,7 @@ protected override async Task TransformAsync(string language)
             var dstDir = Path.Combine(OutputFolder, url, language != "en" ? language : "");
             var nav = new Nav(navFiles, titles, i == 0);
 
-            Directory.CreateDirectory(dstDir);
+            Output.CreateDirectory(dstDir);
 
             var srcFile = Path.Combine(srcDir, file);
             var dstFile = Path.Combine(dstDir, "index.html");

converter/generator/DocIndexTransformer.cs

@@ -4,7 +4,8 @@ namespace OriginLab.DocumentGeneration;
 
 internal class DocIndexTransformer : DocToStaticPagesTransformer
 {
-    public DocIndexTransformer(DocToStaticPagesTransformerArgs args, IDocResourceResolver resourceResolver, ProblemRecorder problems) : base(args, resourceResolver, problems)
+    public DocIndexTransformer(DocToStaticPagesTransformerArgs args, IDocResourceResolver resourceResolver, IOutputOperations output, ProblemRecorder problems)
+        : base(args, resourceResolver, output, problems)
     {
     }
 
@@ -25,11 +26,11 @@ protected override async Task TransformAsync(string language)
                                                    : Path.GetFullPath(Path.Combine(OutputFolder, Path.GetDirectoryName(relativePath)!, "..", Path.GetFileName(relativePath)))
                                                    ;
             var destinationDir = Path.GetDirectoryName(destinationFile)!;
-            Directory.CreateDirectory(destinationDir);
+            Output.CreateDirectory(destinationDir);
 
             Transform(sourceFile, destinationFile);
         }
 
-        File.WriteAllText(Path.Combine(OutputFolder, language, "404.html"), await Template.Render404PageAsync(language));
+        Output.WriteAllText(Path.Combine(OutputFolder, language, "404.html"), await Template.Render404PageAsync(language));
     }
 }

converter/generator/DocToStaticPagesTransformer.cs

@@ -14,7 +14,8 @@ internal abstract partial class DocToStaticPagesTransformer : DocTransformer
 
     private INode[] LayoutNodes = null!;
 
-    protected DocToStaticPagesTransformer(DocToStaticPagesTransformerArgs args, IDocResourceResolver resourceResolver, ProblemRecorder problems) : base(args, resourceResolver, problems)
+    protected DocToStaticPagesTransformer(DocToStaticPagesTransformerArgs args, IDocResourceResolver resourceResolver, IOutputOperations output, ProblemRecorder problems)
+        : base(args, resourceResolver, output, problems)
     {
         BookUrlName = args.BookUrlName;
     }
@@ -23,17 +24,16 @@ public override async Task TransformAsync()
     {
         await base.TransformAsync();
 
-        File.WriteAllText(Path.Combine(OutputFolder, "404.html"), await Template.Render404PageAsync());
+        Output.WriteAllText(Path.Combine(OutputFolder, "404.html"), await Template.Render404PageAsync());
     }
 
     protected override async Task TransformAsync(string language)
     {
         var html = await InitializeLanguageLayoutAsync(language);
         var dir = Path.Combine(OutputFolder, language);
 
-        Directory.CreateDirectory(dir);
-
-        await File.WriteAllTextAsync(Path.Combine(dir, "layout.html"), html);
+        Output.CreateDirectory(dir);
+        Output.WriteAllText(Path.Combine(dir, "layout.html"), html);
     }
 
     internal async Task<string> InitializeLanguageLayoutAsync(string language)

converter/generator/DocTransformer.cs

@@ -25,9 +25,11 @@ protected string Language
 
     protected IDocResourceResolver ResourceResolver { get; }
 
+    protected IOutputOperations Output { get; }
+
     private readonly ProblemRecorder Problems;
 
-    protected DocTransformer(DocTransformerArgs args, IDocResourceResolver resourceResolver, ProblemRecorder problems)
+    protected DocTransformer(DocTransformerArgs args, IDocResourceResolver resourceResolver, IOutputOperations output, ProblemRecorder problems)
     {
         var sourceFolder = args.SourceFolder;
         SourceFolder = sourceFolder;
@@ -56,6 +58,7 @@ protected DocTransformer(DocTransformerArgs args, IDocResourceResolver resourceR
 
         AvailableLanguages = languages;
         ResourceResolver = resourceResolver;
+        Output = output;
     }
 
     public virtual async Task TransformAsync()
@@ -80,7 +83,7 @@ protected void Transform(string sourceFile, string destinationFile, Action<IHtml
         beforeTransform?.Invoke(document, head, body, sourceFile);
         Transform(document, head, body, sourceFile);
 
-        using var sw = new StreamWriter(destinationFile);
+        using var sw = Output.CreateStreamWriter(destinationFile);
         document.ToHtml(sw, HtmlMarkupFormatter.Instance);
     }
 
@@ -139,8 +142,8 @@ internal protected virtual void Transform(IHtmlDocument document, IHtmlHeadEleme
 
             if (copy is (string srcImg, string dstImg))
             {
-                Directory.CreateDirectory(Path.GetDirectoryName(dstImg)!);
-                File.Copy(srcImg, dstImg, overwrite: true);
+                Output.CreateDirectory(Path.GetDirectoryName(dstImg)!);
+                Output.CopyFile(srcImg, dstImg, overwrite: true);
             }
 
             return img;

converter/generator/IOutputOperations.cs

@@ -0,0 +1,12 @@
+namespace OriginLab.DocumentGeneration;
+
+public interface IOutputOperations
+{
+    void CreateDirectory(string path);
+
+    TextWriter CreateStreamWriter(string fileName);
+
+    void WriteAllText(string file, string? contents);
+
+    void CopyFile(string from, string to, bool overwrite);
+}

converter/generator/Program.cs

@@ -76,6 +76,7 @@ async static Task Main(string[] cmdArgs)
         }
 
         services.AddSingleton<DocTransformerArgs>(sp => sp.GetRequiredService<DocToStaticPagesTransformerArgs>());
+        services.AddSingleton<IOutputOperations, SystemOutputOperations>();
         services.AddSingleton<ProblemRecorder>();
 
         var serviceProvider = services.BuildServiceProvider();

converter/generator/SystemOutputOperations.cs

@@ -0,0 +1,16 @@
+namespace OriginLab.DocumentGeneration;
+
+internal sealed class SystemOutputOperations : IOutputOperations
+{
+    public void CopyFile(string from, string to, bool overwrite)
+        => File.Copy(from, to, overwrite);
+
+    public void CreateDirectory(string path)
+        => Directory.CreateDirectory(path);
+
+    public TextWriter CreateStreamWriter(string fileName)
+        => new StreamWriter(fileName);
+
+    public void WriteAllText(string file, string? contents)
+        => File.WriteAllText(file, contents);
+}