Move credentials and options to json config file so that driver/example program can be

atiq-cs · atiq-cs · commit f20e9b95dda3 · 2023-02-03T15:27:29.000-08:00
published to public repositories i.e., github In doing so, - provide a list of patterns in config so that internal / confidential strings can be put there - add namespace 'WPExportApp' to share it with JsonConfig class - add unicode examples: weird char replacements And, - comment 'CustomMetadata' out, for actual applications In addition, - update framework to 7.0 - add Nullable Annotations for System.Linq (ref, https://stackoverflow.com/questions/58670909/nullable-reference-type-information-not-exposed-from-firstordefault) Nits - update Copyright - update dep nuget packages Build status, nullable warnings, $ cd ..\Goodbye.WordPress\ $ dotnet build MSBuild version 17.4.0+18d5aef85 for .NET Determining projects to restore... All projects are up-to-date for restore. PackageVersion: 0.0.0 Goodbye.WordPress -> D:\Code\ws\WPExport\Goodbye.WordPress\bin\Debug\net7.0\Goodbye.WordPress.dll Build succeeded. 0 Warning(s) 0 Error(s) Time Elapsed 00:00:01.03 $ cd ..\Goodbye.WordPress.Example $ dotnet build MSBuild version 17.4.0+18d5aef85 for .NET Determining projects to restore... All projects are up-to-date for restore. PackageVersion: 0.0.0 Goodbye.WordPress -> D:\Code\ws\WPExport\Goodbye.WordPress\bin\Debug\net7.0\Goodbye.WordPress.dll PackageVersion: 0.0.0 Goobye.WordPress.Example -> D:\Code\ws\WPExport\Goodbye.WordPress.Example\bin\Debug\net7.0\Goobye.WordPress.Example.dll Build succeeded. 0 Warning(s) 0 Error(s) Time Elapsed 00:00:02.02 // Initial PR Date: 11-21-2021
diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml
@@ -20,7 +20,7 @@ jobs:
     - name: Setup .NET
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: '6.0.x'
+        dotnet-version: '7.0.x'
     - name: NuGet Restore
       run: dotnet restore
     - name: Build
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,14 +1,14 @@
 <Project>
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net7.0</TargetFramework>
     <LangVersion>latest</LangVersion>
     <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <PropertyGroup>
     <PackageOutputPath>$(MSBuildThisFileDirectory)_artifacts</PackageOutputPath>
     <Authors>Aaron Bockover</Authors>
-    <Copyright>Copyright 2020-2021 Aaron Bockover</Copyright>
+    <Copyright>Copyright 2020-2023 Aaron Bockover</Copyright>
     <RepositoryUrl>https://github.com/abock/goodbye-wordpress</RepositoryUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageTags>
diff --git a/Goodbye.WordPress.CommandLineTool/Goodbye.WordPress.CommandLineTool.csproj b/Goodbye.WordPress.CommandLineTool/Goodbye.WordPress.CommandLineTool.csproj
@@ -10,7 +10,7 @@
     <PackageDescription>
       $(PackageDescription)
       
-      Note, there is a .NET 6.0 library ("Goodbye.WordPress") that
+      Note, there is a .NET 7.0 library ("Goodbye.WordPress") that
       can be integrated easily into a new .NET console application that
       allows heavy customization through overriding pieces of the export
       pipeline in WordPressExporterDelegate.
@@ -23,5 +23,7 @@
 
   <ItemGroup>
     <PackageReference Include="Mono.Options" Version="6.12.0.148" />
+    <PackageReference Include="TunnelVisionLabs.ReferenceAssemblyAnnotator" Version="1.0.0-alpha.160" PrivateAssets="all" />
+    <PackageDownload Include="Microsoft.NETCore.App.Ref" Version="[5.0.0]" />
   </ItemGroup>
 </Project>
diff --git a/Goodbye.WordPress.Example/JsonConfig.cs b/Goodbye.WordPress.Example/JsonConfig.cs
@@ -0,0 +1,74 @@
+namespace WPExportApp {
+  using System;
+  using System.Threading.Tasks;
+
+  /// <summary>
+  /// Credentials Related
+  /// Provides
+  /// - Credentials
+  /// - Additional options i.e., for SSL
+  /// - Patterns for substitution/pre-processing content
+  /// </summary>
+  class JsonConfig {
+    public WPExpJsonConfig? Options { get; set; }
+
+    /// <summary>
+    /// Config file path
+    /// </summary>
+    private string JsonConfigFilePath { get; set; }
+
+    /// <remarks>
+    /// <see href="https://docs.microsoft.com/en-us/dotnet/api/system.environment.specialfolder">
+    /// Accessing Local App Data via Environment
+    /// </see>
+    /// </remarks>
+    public JsonConfig() {
+      JsonConfigFilePath = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData)
+        + @"\WPExportConfig.json";
+
+      if (!System.IO.File.Exists(JsonConfigFilePath)) {
+        throw new InvalidOperationException($"Required config: {JsonConfigFilePath} not found!" + 
+          "Please create the config file and run this application again.");
+      }
+    }
+
+    public class ReplacePattern {
+      public string Needle { get; set; }
+      public string Substitute { get; set; }
+    }
+
+    /// <summary>
+    /// Structure to read records from config file (json format)
+    /// Self explanatory props
+    /// </summary>
+    public class WPExpJsonConfig {
+      public string Host { get; set; }
+      public string Database { get; set; }
+      public string Username { get; set; }
+      public string Password { get; set; }
+      public string TlsVersion { get; set; }
+      public string ContentOutputDirectory { get; set; }
+      public string ArchiveOutputFilePath { get; set; }
+      /// <summary>
+      /// Some of the patterns might be internal only and should not be published online
+      /// Therefore, it might be good idea to keep them in the json config file.
+      /// </summary>
+      public ReplacePattern[] Patterns { get; set; }
+    }
+
+
+    /// <summary>
+    /// Read and Parse Config file
+    /// </summary>
+    public async Task Load() {
+      using System.IO.FileStream openStream = System.IO.File.OpenRead(JsonConfigFilePath);
+      Options = await System.Text.Json.JsonSerializer.DeserializeAsync<WPExpJsonConfig>(openStream);
+
+      if (Options == null || string.IsNullOrEmpty(Options.Host) || string.IsNullOrEmpty(
+        Options.Database) || string.IsNullOrEmpty(Options.Username) || string.IsNullOrEmpty(
+          Options.Password)) {
+            throw new NullReferenceException("Database Credentials are empty in Json config file!");
+      }
+    }
+  }
+}
diff --git a/Goodbye.WordPress.Example/Program.cs b/Goodbye.WordPress.Example/Program.cs
@@ -1,41 +1,82 @@
-using Goodbye.WordPress;
+namespace WPExportApp {
+  using System.Threading.Tasks;
+  using Goodbye.WordPress;
 
-var exporter = WordPressExporter.Create(
-  postReader: new MysqlPostReader(new ConnectionStringBuilder
+  class WPExportMain {
+    /// <summary>
+    /// Entry Point
+    /// </summary>
+    /// <param name="args">CLA</param>
+    static async Task Main(string[] args)
+    {
+      var config = new JsonConfig();
+      await config.Load();
+      if (config.Options == null)
+        throw new System.NullReferenceException();
+
+      var exporter = WordPressExporter.Create(
+      postReader: new MysqlPostReader(
+        new ConnectionStringBuilder {
+          Host = config.Options.Host,
+          Database = config.Options.Database,
+          Username = config.Options.Username,
+          Password = config.Options.Password
+          // , TlsVersion = config.Options.TlsVersion
+        }),
+        contentOutputDirectory: config.Options.ContentOutputDirectory,
+        archiveOutputFilePath: config.Options.ArchiveOutputFilePath,
+        // And now the delegate...
+        @delegate: new CustomExporterDelegate(config.Options.Patterns)
+      );
+
+      await exporter.ExportAsync();
+    }
+  }
+
+
+  sealed class CustomExporterDelegate : WordPressExporterDelegate
   {
-    Host = "localhost",
-    Username = "user",
-    Password = "***",
-    Database = "wordpressdb"
-  }),
-  contentOutputDirectory: "exported-posts",
-  archiveOutputFilePath: "exported-posts/archive.json",
-
-  // And now the delegate...
-  @delegate: new CustomExporterDelegate());
-
-await exporter.ExportAsync();
-
-sealed class CustomExporterDelegate : WordPressExporterDelegate
-{
-  /// <summary>Process post contents</summary>
-  public override Post ProcessPost(
-    WordPressExporter exporter,
-    Post post)
+    JsonConfig.ReplacePattern[] StrPatterns;
+
+    public CustomExporterDelegate(JsonConfig.ReplacePattern[] patterns)
+    {
+        StrPatterns = patterns;
+    }
+
+    // Replace weird unicode chars
+    private string SubstituteCommon(string str) =>
+      str.Replace("‘", "'").Replace("’", "'")
+        .Replace("“", "\"").Replace("”", "\"");
+
+    private string ProcessContent(string content) {
+      content = SubstituteCommon(content)
+        .Replace("http://", "https://");
+
+      if (StrPatterns != null && StrPatterns.Length > 0)
+        foreach( var pattern in StrPatterns)
+          content = content.Replace(pattern.Needle, pattern.Substitute);
+      
+      return content;
+    }
+
+    /// <summary>Process post contents</summary>
+    public override Post ProcessPost(
+      WordPressExporter exporter,
+      Post post)
     // Perform the default post processing first by calling base
     => base.ProcessPost(exporter, post) with
     {
-      // Then replace '--' with Unicode em dash '—'
-      Content = post.Content.Replace("--", "—")
+      Content = ProcessContent(post.Content)
     };
 
-  /// <summary>Add 'CustomMetadata' to each post's YAML front matter</summary>
-  public override void PopulatePostYamlFrontMatter(
-    WordPressExporter exporter,
-    Post post,
-    SharpYaml.Serialization.YamlMappingNode rootNode)
-  {
-    base.PopulatePostYamlFrontMatter(exporter, post, rootNode);
-    rootNode.Add("CustomMetadata", "Some Value");
+    /// <summary>Add 'CustomMetadata' to each post's YAML front matter</summary>
+    public override void PopulatePostYamlFrontMatter(
+      WordPressExporter exporter,
+      Post post,
+      SharpYaml.Serialization.YamlMappingNode rootNode)
+    {
+      base.PopulatePostYamlFrontMatter(exporter, post, rootNode);
+      // rootNode.Add("CustomMetadata", "Some Value");
+    }
   }
-}
+}
diff --git a/Goodbye.WordPress.Example/README.md b/Goodbye.WordPress.Example/README.md
@@ -0,0 +1,24 @@
+## Example Json Config
+Default config path: "$Env:LocalAppData\WPExportConfig.json"
+
+For example, `C:\Users\UserName\AppData\Local\WPExportConfig.json`
+
+An example config looks like following,
+
+    {
+      "Host": "localhost",
+      "Username": "user",
+      "Password": "your_password",
+      "Database": "wordpress_db_name",
+      "ContentOutputDirectory": "posts",
+      "ArchiveOutputFilePath": "posts/archive.json",
+      "Patterns": [
+        {
+          "Needle": "old-domain.com",
+          "Substitute": "new-domain.com"
+        }
+      ]
+    }
+
+
+For example without json config, please have a look at [primary ReadMe](https://github.com/abock/goodbye-wordpress#example-programcs).
diff --git a/Goodbye.WordPress/Goodbye.WordPress.csproj b/Goodbye.WordPress/Goodbye.WordPress.csproj
@@ -10,10 +10,10 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="MySqlConnector" Version="2.0.0" />
-    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
-    <PackageReference Include="ReverseMarkdown" Version="3.20.0" />
-    <PackageReference Include="Serilog.Sinks.Console" Version="4.0.1-dev-00879" />
-    <PackageReference Include="SharpYaml" Version="1.8.0" />
+    <PackageReference Include="MySqlConnector" Version="2.3.0-beta.1" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.2" />
+    <PackageReference Include="ReverseMarkdown" Version="3.24.0" />
+    <PackageReference Include="Serilog.Sinks.Console" Version="4.1.1-dev-00907" />
+    <PackageReference Include="SharpYaml" Version="2.1.0" />
   </ItemGroup>
 </Project>
diff --git a/README.md b/README.md
@@ -87,45 +87,86 @@ Note that with the exception of `ConnectionStringBuilder` and `WordPressExporter
 Creating the exporter via API here is equivalent to the command line invocation above, with the exception of providing a custom exporter delegate that will perform additional processing steps.
 
 ```csharp
-using Goodbye.WordPress;
+namespace WPExportApp {
+  using System.Threading.Tasks;
+  using Goodbye.WordPress;
+
+  class WPExportMain {
+    /// <summary>
+    /// Entry Point
+    /// </summary>
+    /// <param name="args">CLA</param>
+    static async Task Main(string[] args)
+    {
+      var config = new JsonConfig();
+      await config.Load();
+      if (config.Options == null)
+        throw new System.NullReferenceException();
+
+      var exporter = WordPressExporter.Create(
+      postReader: new MysqlPostReader(
+        new ConnectionStringBuilder {
+          Host = config.Options.Host,
+          Database = config.Options.Database,
+          Username = config.Options.Username,
+          Password = config.Options.Password
+          // , TlsVersion = config.Options.TlsVersion
+        }),
+        contentOutputDirectory: config.Options.ContentOutputDirectory,
+        archiveOutputFilePath: config.Options.ArchiveOutputFilePath,
+        // And now the delegate...
+        @delegate: new CustomExporterDelegate(config.Options.Patterns)
+      );
+
+      await exporter.ExportAsync();
+    }
+  }
 
-var exporter = WordPressExporter.Create(
-  postReader: new MysqlPostReader(new ConnectionStringBuilder
+
+  sealed class CustomExporterDelegate : WordPressExporterDelegate
   {
-    Host = "localhost",
-    Username = "user",
-    Password = "***",
-    Database = "wordpressdb"
-  }),
-  contentOutputDirectory: "exported-posts",
-  archiveOutputFilePath: "exported-posts/archive.json",
-
-  // And now the delegate...
-  @delegate: new CustomExporterDelegate());
-
-await exporter.ExportAsync();
-
-sealed class CustomExporterDelegate : WordPressExporterDelegate
-{
-  /// <summary>Process post contents</summary>
-  public override Post ProcessPost(
-    WordPressExporter exporter,
-    Post post)
+    JsonConfig.ReplacePattern[] StrPatterns;
+
+    public CustomExporterDelegate(JsonConfig.ReplacePattern[] patterns)
+    {
+        StrPatterns = patterns;
+    }
+
+    // Replace weird unicode chars
+    private string SubstituteCommon(string str) =>
+      str.Replace("‘", "'").Replace("’", "'")
+        .Replace("“", "\"").Replace("”", "\"");
+
+    private string ProcessContent(string content) {
+      content = SubstituteCommon(content)
+        .Replace("http://", "https://");
+
+      if (StrPatterns != null && StrPatterns.Length > 0)
+        foreach( var pattern in StrPatterns)
+          content = content.Replace(pattern.Needle, pattern.Substitute);
+      
+      return content;
+    }
+
+    /// <summary>Process post contents</summary>
+    public override Post ProcessPost(
+      WordPressExporter exporter,
+      Post post)
     // Perform the default post processing first by calling base
     => base.ProcessPost(exporter, post) with
     {
-      // Then replace '--' with Unicode em dash '—'
-      Content = post.Content.Replace("--", "—")
+      Content = ProcessContent(post.Content)
     };
 
-  /// <summary>Add 'CustomMetadata' to each post's YAML front matter</summary>
-  public override void PopulatePostYamlFrontMatter(
-    WordPressExporter exporter,
-    Post post,
-    SharpYaml.Serialization.YamlMappingNode rootNode)
-  {
-    base.PopulatePostYamlFrontMatter(exporter, post, rootNode);
-    rootNode.Add("CustomMetadata", "Some Value");
+    /// <summary>Add 'CustomMetadata' to each post's YAML front matter</summary>
+    public override void PopulatePostYamlFrontMatter(
+      WordPressExporter exporter,
+      Post post,
+      SharpYaml.Serialization.YamlMappingNode rootNode)
+    {
+      base.PopulatePostYamlFrontMatter(exporter, post, rootNode);
+      // rootNode.Add("CustomMetadata", "Some Value");
+    }
   }
 }
 ```
