changed ConfigurationSerializer to implement IConfigurationSerializer

Author: arturcic

src/GitVersion.App/GitVersionExecutor.cs

@@ -11,6 +11,7 @@ internal class GitVersionExecutor(
     IConsole console,
     IConfigurationFileLocator configurationFileLocator,
     IConfigurationProvider configurationProvider,
+    IConfigurationSerializer configurationSerializer,
     IGitVersionCalculateTool gitVersionCalculateTool,
     IGitVersionOutputTool gitVersionOutputTool,
     IVersionWriter versionWriter,
@@ -22,6 +23,8 @@ internal class GitVersionExecutor(
     private readonly IConsole console = console.NotNull();
     private readonly IConfigurationFileLocator configurationFileLocator = configurationFileLocator.NotNull();
     private readonly IConfigurationProvider configurationProvider = configurationProvider.NotNull();
+    private readonly IConfigurationSerializer configurationSerializer = configurationSerializer.NotNull();
+
     private readonly IGitVersionCalculateTool gitVersionCalculateTool = gitVersionCalculateTool.NotNull();
     private readonly IGitVersionOutputTool gitVersionOutputTool = gitVersionOutputTool.NotNull();
     private readonly IVersionWriter versionWriter = versionWriter.NotNull();
@@ -144,7 +147,8 @@ private bool HandleNonMainCommand(GitVersionOptions gitVersionOptions, out int e
                 this.configurationFileLocator.Verify(workingDirectory, this.repositoryInfo.ProjectRootDirectory);
             }
             var configuration = this.configurationProvider.Provide();
-            this.console.WriteLine(configuration.ToJsonString());
+            var configurationString = configurationSerializer.Serialize(configuration);
+            this.console.WriteLine(configurationString);
             exitCode = 0;
             return true;
         }

src/GitVersion.Configuration.Tests/Configuration/ConfigurationProviderTests.cs

@@ -182,7 +182,7 @@ public void CanWriteOutEffectiveConfiguration()
     {
         var configuration = this.configurationProvider.ProvideForDirectory(this.repoPath);
 
-        configuration.ToJsonString().ShouldMatchApproved();
+        new ConfigurationSerializer().Serialize(configuration).ShouldMatchApproved();
     }
 
     [Test]

src/GitVersion.Configuration.Tests/Configuration/IgnoreConfigurationTests.cs

@@ -7,52 +7,54 @@ namespace GitVersion.Core.Tests.Configuration;
 [TestFixture]
 public class IgnoreConfigurationTests : TestBase
 {
+    private readonly ConfigurationSerializer serializer = new();
+
     [Test]
     public void CanDeserialize()
     {
-        const string yaml = @"
-ignore:
-    sha: [b6c0c9fda88830ebcd563e500a5a7da5a1658e98]
-    commits-before: 2015-10-23T12:23:15
-";
+        const string yaml =
+            """
+            ignore:
+                sha: [b6c0c9fda88830ebcd563e500a5a7da5a1658e98]
+                commits-before: 2015-10-23T12:23:15
+            """;
 
-        using var reader = new StringReader(yaml);
-        var configuration = ConfigurationSerializer.Read(reader);
+        var configuration = serializer.ReadConfiguration(yaml);
 
+        configuration.ShouldNotBeNull();
         configuration.Ignore.ShouldNotBeNull();
         configuration.Ignore.Shas.ShouldNotBeEmpty();
-        configuration.Ignore.Shas.ShouldBe(new[] { "b6c0c9fda88830ebcd563e500a5a7da5a1658e98" });
+        configuration.Ignore.Shas.ShouldBe(["b6c0c9fda88830ebcd563e500a5a7da5a1658e98"]);
         configuration.Ignore.Before.ShouldBe(DateTimeOffset.Parse("2015-10-23T12:23:15"));
     }
 
     [Test]
     public void ShouldSupportsOtherSequenceFormat()
     {
-        const string yaml = @"
-ignore:
-    sha:
-        - b6c0c9fda88830ebcd563e500a5a7da5a1658e98
-        - 6c19c7c219ecf8dbc468042baefa73a1b213e8b1
-";
+        const string yaml =
+            """
+            ignore:
+                sha:
+                    - b6c0c9fda88830ebcd563e500a5a7da5a1658e98
+                    - 6c19c7c219ecf8dbc468042baefa73a1b213e8b1
+            """;
 
-        using var reader = new StringReader(yaml);
-        var configuration = ConfigurationSerializer.Read(reader);
+        var configuration = serializer.ReadConfiguration(yaml);
 
+        configuration.ShouldNotBeNull();
         configuration.Ignore.ShouldNotBeNull();
         configuration.Ignore.Shas.ShouldNotBeEmpty();
-        configuration.Ignore.Shas.ShouldBe(new[] { "b6c0c9fda88830ebcd563e500a5a7da5a1658e98", "6c19c7c219ecf8dbc468042baefa73a1b213e8b1" });
+        configuration.Ignore.Shas.ShouldBe(["b6c0c9fda88830ebcd563e500a5a7da5a1658e98", "6c19c7c219ecf8dbc468042baefa73a1b213e8b1"]);
     }
 
     [Test]
     public void WhenNotInConfigShouldHaveDefaults()
     {
-        const string yaml = @"
-next-version: 1.0
-";
+        const string yaml = "next-version: 1.0";
 
-        using var reader = new StringReader(yaml);
-        var configuration = ConfigurationSerializer.Read(reader);
+        var configuration = serializer.ReadConfiguration(yaml);
 
+        configuration.ShouldNotBeNull();
         configuration.Ignore.ShouldNotBeNull();
         configuration.Ignore.Shas.ShouldBeEmpty();
         configuration.Ignore.Before.ShouldBe(null);
@@ -61,13 +63,13 @@ public void WhenNotInConfigShouldHaveDefaults()
     [Test]
     public void WhenBadDateFormatShouldFail()
     {
-        const string yaml = @"
-ignore:
-    commits-before: bad format date
-";
+        const string yaml =
+            """
+            ignore:
+                commits-before: bad format date
+            """;
 
-        using var reader = new StringReader(yaml);
-        Should.Throw<YamlException>(() => ConfigurationSerializer.Read(reader));
+        Should.Throw<YamlException>(() => serializer.ReadConfiguration(yaml));
     }
 
     [Test]

src/GitVersion.Configuration/ConfigurationFileLocator.cs

@@ -4,7 +4,7 @@
 
 namespace GitVersion.Configuration;
 
-internal class ConfigurationFileLocator(IFileSystem fileSystem, IOptions<GitVersionOptions> options)
+internal class ConfigurationFileLocator(IFileSystem fileSystem, IConfigurationSerializer configurationSerializer, IOptions<GitVersionOptions> options)
     : IConfigurationFileLocator
 {
     public const string DefaultFileName = "GitVersion.yml";
@@ -29,7 +29,9 @@ public IGitVersionConfiguration ReadConfiguration(string? configFilePath)
         if (configFilePath == null || !fileSystem.Exists(configFilePath)) return GitHubFlowConfigurationBuilder.New.Build();
 
         var readAllText = fileSystem.ReadAllText(configFilePath);
-        return ConfigurationSerializer.Read(new StringReader(readAllText));
+        var configuration = configurationSerializer.ReadConfiguration(readAllText)
+                            ?? GitHubFlowConfigurationBuilder.New.Build();
+        return configuration;
     }
 
     public IReadOnlyDictionary<object, object?>? ReadOverrideConfiguration(string? configFilePath)
@@ -38,7 +40,7 @@ public IGitVersionConfiguration ReadConfiguration(string? configFilePath)
 
         var readAllText = fileSystem.ReadAllText(configFilePath);
 
-        return ConfigurationSerializer.Deserialize<Dictionary<object, object?>>(readAllText);
+        return configurationSerializer.Deserialize<Dictionary<object, object?>>(readAllText);
     }
 
     private bool HasConfigurationFile(string? workingDirectory, out string? path)

src/GitVersion.Configuration/ConfigurationHelper.cs

@@ -4,31 +4,32 @@ namespace GitVersion.Configuration;
 
 internal class ConfigurationHelper
 {
-    private string Yaml => this._yaml ??= this._dictionary == null
-        ? ConfigurationSerializer.Serialize(this.configuration!)
-        : ConfigurationSerializer.Serialize(this._dictionary);
-    private string? _yaml;
+    private static ConfigurationSerializer Serializer => new();
+    private string Yaml => this.yaml ??= this.dictionary == null
+        ? Serializer.Serialize(this.configuration!)
+        : Serializer.Serialize(this.dictionary);
+    private string? yaml;
 
     internal IReadOnlyDictionary<object, object?> Dictionary
     {
         get
         {
-            if (this._dictionary == null)
+            if (this.dictionary == null)
             {
-                this._yaml ??= ConfigurationSerializer.Serialize(this.configuration!);
-                this._dictionary = ConfigurationSerializer.Deserialize<Dictionary<object, object?>>(this._yaml);
+                this.yaml ??= Serializer.Serialize(this.configuration!);
+                this.dictionary = Serializer.Deserialize<Dictionary<object, object?>>(this.yaml);
             }
-            return this._dictionary;
+            return this.dictionary;
         }
     }
-    private IReadOnlyDictionary<object, object?>? _dictionary;
+    private IReadOnlyDictionary<object, object?>? dictionary;
 
-    public IGitVersionConfiguration Configuration => this.configuration ??= ConfigurationSerializer.Deserialize<GitVersionConfiguration>(Yaml);
+    public IGitVersionConfiguration Configuration => this.configuration ??= Serializer.Deserialize<GitVersionConfiguration>(Yaml);
     private IGitVersionConfiguration? configuration;
 
-    internal ConfigurationHelper(string yaml) => this._yaml = yaml.NotNull();
+    internal ConfigurationHelper(string yaml) => this.yaml = yaml.NotNull();
 
-    internal ConfigurationHelper(IReadOnlyDictionary<object, object?> dictionary) => this._dictionary = dictionary.NotNull();
+    internal ConfigurationHelper(IReadOnlyDictionary<object, object?> dictionary) => this.dictionary = dictionary.NotNull();
 
     public ConfigurationHelper(IGitVersionConfiguration configuration) => this.configuration = configuration.NotNull();
 
@@ -38,10 +39,10 @@ public void Override(IReadOnlyDictionary<object, object?> value)
 
         if (value.Any())
         {
-            var dictionary = Dictionary.ToDictionary(element => element.Key, element => element.Value);
-            Merge(dictionary, value);
-            this._dictionary = dictionary;
-            this._yaml = null;
+            var map = Dictionary.ToDictionary(element => element.Key, element => element.Value);
+            Merge(map, value);
+            this.dictionary = map;
+            this.yaml = null;
             this.configuration = null;
         }
     }

src/GitVersion.Configuration/ConfigurationSerializer.cs

@@ -4,7 +4,7 @@
 
 namespace GitVersion.Configuration;
 
-internal static class ConfigurationSerializer
+internal class ConfigurationSerializer : IConfigurationSerializer
 {
     private static IDeserializer Deserializer => new DeserializerBuilder()
         .WithNamingConvention(HyphenatedNamingConvention.Instance)
@@ -16,18 +16,9 @@ internal static class ConfigurationSerializer
         .WithTypeInspector(inspector => new JsonPropertyNameInspector(inspector))
         .WithNamingConvention(HyphenatedNamingConvention.Instance).Build();
 
-    public static T Deserialize<T>(string input) => Deserializer.Deserialize<T>(input);
-
-    public static string Serialize(object graph) => Serializer.Serialize(graph);
-
-    public static IGitVersionConfiguration Read(TextReader reader)
-    {
-        var configuration = Deserializer.Deserialize<GitVersionConfiguration?>(reader);
-        return configuration ?? GitHubFlowConfigurationBuilder.New.Build();
-    }
-
-    public static void Write(IGitVersionConfiguration configuration, TextWriter writer)
-        => Serializer.Serialize(writer, configuration);
+    public T Deserialize<T>(string input) => Deserializer.Deserialize<T>(input);
+    public string Serialize(object graph) => Serializer.Serialize(graph);
+    public IGitVersionConfiguration? ReadConfiguration(string input) => Deserialize<GitVersionConfiguration?>(input);
 
     private sealed class JsonPropertyNameInspector(ITypeInspector innerTypeDescriptor) : TypeInspectorSkeleton
     {

src/GitVersion.Configuration/GitVersionConfiguration.cs

@@ -149,19 +149,10 @@ IReadOnlyDictionary<string, IBranchConfiguration> IGitVersionConfiguration.Branc
 
     public override IBranchConfiguration Inherit(IBranchConfiguration configuration) => throw new NotSupportedException();
 
-    public string ToJsonString()
-    {
-        var stringBuilder = new StringBuilder();
-        using var stream = new StringWriter(stringBuilder);
-        ConfigurationSerializer.Write(this, stream);
-        stream.Flush();
-        return stringBuilder.ToString();
-    }
-
     public IBranchConfiguration GetEmptyBranchConfiguration() => new BranchConfiguration
     {
         RegularExpression = string.Empty,
-        Label = ConfigurationConstants.BranchNamePlaceholder,
+        Label = BranchNamePlaceholder,
         Increment = IncrementStrategy.Inherit
     };
 }

src/GitVersion.Configuration/GitVersionConfigurationModule.cs

@@ -8,6 +8,7 @@ public class GitVersionConfigurationModule : IGitVersionModule
     public void RegisterTypes(IServiceCollection services)
     {
         services.AddSingleton<IGitVersionCacheKeyFactory, GitVersionCacheKeyFactory>();
+        services.AddSingleton<IConfigurationSerializer, ConfigurationSerializer>();
         services.AddSingleton<IConfigurationProvider, ConfigurationProvider>();
         services.AddSingleton<IConfigurationFileLocator, ConfigurationFileLocator>();
     }

src/GitVersion.Configuration/SupportedWorkflows/WorkflowManager.cs

@@ -5,6 +5,7 @@ namespace GitVersion.Configuration.SupportedWorkflows;
 internal static class WorkflowManager
 {
     private static readonly string ResourceNameTemplate = DetermineResourceNameTemplate();
+    private static ConfigurationSerializer Serializer => new();
 
     private static string DetermineResourceNameTemplate()
     {
@@ -19,7 +20,7 @@ private static string DetermineResourceNameTemplate()
 
         var resourceName = GetResourceName(workflow);
         var embeddedResource = resourceName.ReadAsStringFromEmbeddedResource(typeof(WorkflowManager).Assembly);
-        return ConfigurationSerializer.Deserialize<Dictionary<object, object?>>(embeddedResource);
+        return Serializer.Deserialize<Dictionary<object, object?>>(embeddedResource);
     }
 
     private static string GetResourceName(string workflow)

src/GitVersion.Core.Tests/Core/GitVersionExecutorTests.cs

@@ -17,7 +17,7 @@ public class GitVersionExecutorTests : TestBase
 {
     private IFileSystem fileSystem;
     private ILog log;
-    private GitVersionCache gitVersionCache;
+    private GitVersionCacheProvider gitVersionCacheProvider;
     private IServiceProvider sp;
 
     [Test]
@@ -80,7 +80,8 @@ public void CacheKeyForWorktree()
 
             var preparer = this.sp.GetRequiredService<IGitPreparer>();
             preparer.Prepare();
-            var cacheKey = this.sp.GetRequiredService<IGitVersionCacheKeyFactory>().Create(null);
+            var cacheKeyFactory = this.sp.GetRequiredService<IGitVersionCacheKeyFactory>();
+            var cacheKey = cacheKeyFactory.Create(null);
             cacheKey.Value.ShouldNotBeEmpty();
         }
         finally
@@ -140,7 +141,7 @@ public void CacheFileExistsOnDisk()
 
         var cacheKeyFactory = this.sp.GetRequiredService<IGitVersionCacheKeyFactory>();
         var cacheKey = cacheKeyFactory.Create(null);
-        var cacheFileName = this.gitVersionCache.GetCacheFileName(cacheKey);
+        var cacheFileName = this.gitVersionCacheProvider.GetCacheFileName(cacheKey);
 
         this.fileSystem.WriteAllText(cacheFileName, versionCacheFileContent);
         versionVariables = gitVersionCalculator.CalculateVersionVariables();
@@ -193,10 +194,10 @@ public void CacheFileExistsOnDiskWhenOverrideConfigIsSpecifiedVersionShouldBeDyn
 
         var cacheKeyFactory = this.sp.GetRequiredService<IGitVersionCacheKeyFactory>();
         var cacheKey = cacheKeyFactory.Create(null);
-        var cacheFileName = this.gitVersionCache.GetCacheFileName(cacheKey);
+        var cacheFileName = this.gitVersionCacheProvider.GetCacheFileName(cacheKey);
         this.fileSystem.WriteAllText(cacheFileName, versionCacheFileContent);
 
-        var cacheDirectory = this.gitVersionCache.GetCacheDirectory();
+        var cacheDirectory = this.gitVersionCacheProvider.GetCacheDirectory();
 
         var cacheDirectoryTimestamp = this.fileSystem.GetLastDirectoryWrite(cacheDirectory);
 
@@ -283,7 +284,7 @@ public void ConfigChangeInvalidatesCache(string configFileName)
 
         var cacheKeyFactory = this.sp.GetRequiredService<IGitVersionCacheKeyFactory>();
         var cacheKey = cacheKeyFactory.Create(null);
-        var cacheFileName = this.gitVersionCache.GetCacheFileName(cacheKey);
+        var cacheFileName = this.gitVersionCacheProvider.GetCacheFileName(cacheKey);
 
         this.fileSystem.WriteAllText(cacheFileName, versionCacheFileContent);
 
@@ -345,7 +346,7 @@ public void NoCacheBypassesCache()
 
         var cacheKeyFactory = this.sp.GetRequiredService<IGitVersionCacheKeyFactory>();
         var cacheKey = cacheKeyFactory.Create(null);
-        var cacheFileName = this.gitVersionCache.GetCacheFileName(cacheKey);
+        var cacheFileName = this.gitVersionCacheProvider.GetCacheFileName(cacheKey);
 
         this.fileSystem.WriteAllText(cacheFileName, versionCacheFileContent);
         versionVariables = gitVersionCalculator.CalculateVersionVariables();
@@ -580,7 +581,7 @@ private IGitVersionCalculateTool GetGitVersionCalculator(GitVersionOptions gitVe
 
         this.fileSystem = this.sp.GetRequiredService<IFileSystem>();
         this.log = this.sp.GetRequiredService<ILog>();
-        this.gitVersionCache = (GitVersionCache)this.sp.GetRequiredService<IGitVersionCache>();
+        this.gitVersionCacheProvider = (GitVersionCacheProvider)this.sp.GetRequiredService<IGitVersionCacheProvider>();
 
         return this.sp.GetRequiredService<IGitVersionCalculateTool>();
     }