Refactor GitVersion.Core for clear, maintainable methods

arturcic · arturcic · commit 0342ba154889 · 2023-11-27T12:54:32.000+01:00
This commit refactors several methods within GitVersion.Core and its associated test files for better clarity and maintainability. Apart from renaming variables for clearer intent, it also streamlines the use of JsonSerializerOptions and simplifies the use of the 'toJson' method throughout the codebase. Moreover, it adjusts the accessibility of certain methods, modifying them from public to internal where appropriate.
diff --git a/src/GitVersion.App.Tests/Helpers/ExecutionResults.cs b/src/GitVersion.App.Tests/Helpers/ExecutionResults.cs
@@ -19,8 +19,8 @@ public virtual GitVersionVariables OutputVariables
     {
         get
         {
-            var jsonStartIndex = Output.IndexOf("{", StringComparison.Ordinal);
-            var jsonEndIndex = Output.IndexOf("}", StringComparison.Ordinal);
+            var jsonStartIndex = Output.IndexOf('{');
+            var jsonEndIndex = Output.IndexOf('}');
             var json = Output.Substring(jsonStartIndex, jsonEndIndex - jsonStartIndex + 1);
 
             return VersionVariablesHelper.FromJson(json);
diff --git a/src/GitVersion.Core.Tests/Core/GitVersionExecutorTests.cs b/src/GitVersion.Core.Tests/Core/GitVersionExecutorTests.cs
@@ -16,7 +16,7 @@ public class GitVersionExecutorTests : TestBase
 {
     private IFileSystem fileSystem;
     private ILog log;
-    private IGitVersionCache gitVersionCache;
+    private GitVersionCache gitVersionCache;
     private IServiceProvider sp;
 
     [Test]
@@ -571,7 +571,7 @@ private IGitVersionCalculateTool GetGitVersionCalculator(GitVersionOptions gitVe
 
         this.fileSystem = this.sp.GetRequiredService<IFileSystem>();
         this.log = this.sp.GetRequiredService<ILog>();
-        this.gitVersionCache = this.sp.GetRequiredService<IGitVersionCache>();
+        this.gitVersionCache = (GitVersionCache)this.sp.GetRequiredService<IGitVersionCache>();
 
         return this.sp.GetRequiredService<IGitVersionCalculateTool>();
     }
diff --git a/src/GitVersion.Core.Tests/Extensions/GitToolsTestingExtensions.cs b/src/GitVersion.Core.Tests/Extensions/GitToolsTestingExtensions.cs
@@ -108,7 +108,7 @@ public static void WriteVersionVariables(this RepositoryFixtureBase fixture, str
 
         using var stream = File.Open(versionFile, FileMode.Create, FileAccess.ReadWrite, FileShare.ReadWrite);
         using var writer = new StreamWriter(stream);
-        writer.Write(versionVariables.ToJsonString());
+        writer.Write(versionVariables.ToJson());
     }
 
     public static void AssertFullSemver(this RepositoryFixtureBase fixture, string fullSemver,
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/JsonVersionBuilderTests.cs b/src/GitVersion.Core.Tests/VersionCalculation/JsonVersionBuilderTests.cs
@@ -29,6 +29,6 @@ public void Json()
 
         var variableProvider = serviceProvider.GetRequiredService<IVariableProvider>();
         var variables = variableProvider.GetVariablesFor(semanticVersion, configuration, null);
-        variables.ToJsonString().ShouldMatchApproved(c => c.SubFolder("Approved"));
+        variables.ToJson().ShouldMatchApproved(c => c.SubFolder("Approved"));
     }
 }
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/VariableProviderTests.cs b/src/GitVersion.Core.Tests/VersionCalculation/VariableProviderTests.cs
@@ -51,7 +51,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForPreRelease()
             .GetEffectiveConfiguration(ReferenceName.FromBranchName("unstable"));
         var variables = this.variableProvider.GetVariablesFor(semanticVersion, configuration, null);
 
-        variables.ToJsonString().ShouldMatchApproved(c => c.SubFolder("Approved"));
+        variables.ToJson().ShouldMatchApproved(c => c.SubFolder("Approved"));
     }
 
     [Test]
@@ -77,7 +77,7 @@ public void ProvidesVariablesInContinuousDeploymentModeForPreRelease()
             .GetEffectiveConfiguration(ReferenceName.FromBranchName("unstable"));
         var variables = this.variableProvider.GetVariablesFor(semanticVersion, configuration, null);
 
-        variables.ToJsonString().ShouldMatchApproved(c => c.SubFolder("Approved"));
+        variables.ToJson().ShouldMatchApproved(c => c.SubFolder("Approved"));
     }
 
     [Test]
@@ -101,7 +101,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForStable()
             .GetEffectiveConfiguration(ReferenceName.FromBranchName("develop"));
         var variables = this.variableProvider.GetVariablesFor(semanticVersion, configuration, null);
 
-        variables.ToJsonString().ShouldMatchApproved(c => c.SubFolder("Approved"));
+        variables.ToJson().ShouldMatchApproved(c => c.SubFolder("Approved"));
     }
 
     [Test]
@@ -127,7 +127,7 @@ public void ProvidesVariablesInContinuousDeploymentModeForStable()
             .GetEffectiveConfiguration(ReferenceName.FromBranchName("develop"));
         var variables = this.variableProvider.GetVariablesFor(semanticVersion, configuration, null);
 
-        variables.ToJsonString().ShouldMatchApproved(c => c.SubFolder("Approved"));
+        variables.ToJson().ShouldMatchApproved(c => c.SubFolder("Approved"));
     }
 
     [Test]
@@ -153,7 +153,7 @@ public void ProvidesVariablesInContinuousDeploymentModeForStableWhenCurrentCommi
             .GetEffectiveConfiguration(ReferenceName.FromBranchName("develop"));
         var variables = this.variableProvider.GetVariablesFor(semanticVersion, configuration, SemanticVersion.Empty);
 
-        variables.ToJsonString().ShouldMatchApproved(c => c.SubFolder("Approved"));
+        variables.ToJson().ShouldMatchApproved(c => c.SubFolder("Approved"));
     }
 
     [Test]
@@ -228,7 +228,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForFeatureBranch()
             .GetEffectiveConfiguration(ReferenceName.FromBranchName("develop"));
         var variables = this.variableProvider.GetVariablesFor(semanticVersion, configuration, null);
 
-        variables.ToJsonString().ShouldMatchApproved(c => c.SubFolder("Approved"));
+        variables.ToJson().ShouldMatchApproved(c => c.SubFolder("Approved"));
     }
 
     [Test]
@@ -254,7 +254,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForFeatureBranchWithCustomA
             .Build().GetEffectiveConfiguration(ReferenceName.FromBranchName("develop"));
         var variables = this.variableProvider.GetVariablesFor(semanticVersion, configuration, null);
 
-        variables.ToJsonString().ShouldMatchApproved(c => c.SubFolder("Approved"));
+        variables.ToJson().ShouldMatchApproved(c => c.SubFolder("Approved"));
     }
 
     [Test]
@@ -281,6 +281,6 @@ public void ProvidesVariablesInContinuousDeploymentModeForMainBranchWithEmptyLab
             .GetEffectiveConfiguration(ReferenceName.FromBranchName("main"));
         var variables = this.variableProvider.GetVariablesFor(semanticVersion, configuration, null);
 
-        variables.ToJsonString().ShouldMatchApproved(_ => _.SubFolder("Approved"));
+        variables.ToJson().ShouldMatchApproved(_ => _.SubFolder("Approved"));
     }
 }
diff --git a/src/GitVersion.Core/OutputVariables/VersionVariablesHelper.cs b/src/GitVersion.Core/OutputVariables/VersionVariablesHelper.cs
@@ -14,6 +14,22 @@ public static GitVersionVariables FromJson(string json)
         return FromDictionary(variablePairs);
     }
 
+    public static string ToJson(this GitVersionVariables gitVersionVariables)
+    {
+        var variablesType = typeof(VersionVariablesJsonModel);
+        var variables = new VersionVariablesJsonModel();
+
+        foreach (var (key, value) in gitVersionVariables.OrderBy(x => x.Key))
+        {
+            var propertyInfo = variablesType.GetProperty(key);
+            propertyInfo?.SetValue(variables, ChangeType(value, propertyInfo.PropertyType));
+        }
+
+        var serializeOptions = JsonSerializerOptions();
+
+        return JsonSerializer.Serialize(variables, serializeOptions);
+    }
+
     public static GitVersionVariables FromFile(string filePath, IFileSystem fileSystem)
     {
         try
@@ -33,22 +49,6 @@ public static GitVersionVariables FromFile(string filePath, IFileSystem fileSyst
         }
     }
 
-    public static string ToJsonString(this GitVersionVariables gitVersionVariables)
-    {
-        var variablesType = typeof(VersionVariablesJsonModel);
-        var variables = new VersionVariablesJsonModel();
-
-        foreach (var (key, value) in gitVersionVariables.OrderBy(x => x.Key))
-        {
-            var propertyInfo = variablesType.GetProperty(key);
-            propertyInfo?.SetValue(variables, ChangeType(value, propertyInfo.PropertyType));
-        }
-
-        var serializeOptions = JsonSerializerOptions();
-
-        return JsonSerializer.Serialize(variables, serializeOptions);
-    }
-
     private static GitVersionVariables FromDictionary(IEnumerable<KeyValuePair<string, string>>? properties)
     {
         var type = typeof(GitVersionVariables);
@@ -72,11 +72,7 @@ private static GitVersionVariables FromFileInternal(string filePath, IFileSystem
         return versionVariables;
     }
 
-    private static JsonSerializerOptions JsonSerializerOptions()
-    {
-        var serializeOptions = new JsonSerializerOptions { WriteIndented = true, Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping, Converters = { new VersionVariablesJsonStringConverter() } };
-        return serializeOptions;
-    }
+    private static JsonSerializerOptions JsonSerializerOptions() => new() { WriteIndented = true, Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping, Converters = { new VersionVariablesJsonStringConverter() } };
 
     private static object? ChangeType(object? value, Type type)
     {
diff --git a/src/GitVersion.Core/PublicAPI.Unshipped.txt b/src/GitVersion.Core/PublicAPI.Unshipped.txt
@@ -688,19 +688,15 @@ GitVersion.VersionCalculation.BaseVersion.ShouldIncrement.init -> void
 GitVersion.VersionCalculation.BaseVersion.Source.get -> string!
 GitVersion.VersionCalculation.BaseVersion.Source.init -> void
 GitVersion.VersionCalculation.Caching.GitVersionCache
-GitVersion.VersionCalculation.Caching.GitVersionCache.GetCacheDirectory() -> string!
-GitVersion.VersionCalculation.Caching.GitVersionCache.GetCacheFileName(GitVersion.VersionCalculation.Caching.GitVersionCacheKey! cacheKey) -> string!
 GitVersion.VersionCalculation.Caching.GitVersionCache.GitVersionCache(GitVersion.IFileSystem! fileSystem, GitVersion.Logging.ILog! log, GitVersion.IGitRepositoryInfo! repositoryInfo) -> void
-GitVersion.VersionCalculation.Caching.GitVersionCache.LoadVersionVariablesFromDiskCache(GitVersion.VersionCalculation.Caching.GitVersionCacheKey! key) -> GitVersion.OutputVariables.GitVersionVariables?
-GitVersion.VersionCalculation.Caching.GitVersionCache.WriteVariablesToDiskCache(GitVersion.VersionCalculation.Caching.GitVersionCacheKey! cacheKey, GitVersion.OutputVariables.GitVersionVariables! variablesFromCache) -> void
+GitVersion.VersionCalculation.Caching.GitVersionCache.LoadVersionVariablesFromDiskCache(GitVersion.VersionCalculation.Caching.GitVersionCacheKey! cacheKey) -> GitVersion.OutputVariables.GitVersionVariables?
+GitVersion.VersionCalculation.Caching.GitVersionCache.WriteVariablesToDiskCache(GitVersion.VersionCalculation.Caching.GitVersionCacheKey! cacheKey, GitVersion.OutputVariables.GitVersionVariables! versionVariables) -> void
 GitVersion.VersionCalculation.Caching.GitVersionCacheKey
 GitVersion.VersionCalculation.Caching.GitVersionCacheKey.GitVersionCacheKey(string! value) -> void
 GitVersion.VersionCalculation.Caching.GitVersionCacheKey.Value.get -> string!
 GitVersion.VersionCalculation.Caching.IGitVersionCache
-GitVersion.VersionCalculation.Caching.IGitVersionCache.GetCacheDirectory() -> string!
-GitVersion.VersionCalculation.Caching.IGitVersionCache.GetCacheFileName(GitVersion.VersionCalculation.Caching.GitVersionCacheKey! cacheKey) -> string!
-GitVersion.VersionCalculation.Caching.IGitVersionCache.LoadVersionVariablesFromDiskCache(GitVersion.VersionCalculation.Caching.GitVersionCacheKey! key) -> GitVersion.OutputVariables.GitVersionVariables?
-GitVersion.VersionCalculation.Caching.IGitVersionCache.WriteVariablesToDiskCache(GitVersion.VersionCalculation.Caching.GitVersionCacheKey! cacheKey, GitVersion.OutputVariables.GitVersionVariables! variablesFromCache) -> void
+GitVersion.VersionCalculation.Caching.IGitVersionCache.LoadVersionVariablesFromDiskCache(GitVersion.VersionCalculation.Caching.GitVersionCacheKey! cacheKey) -> GitVersion.OutputVariables.GitVersionVariables?
+GitVersion.VersionCalculation.Caching.IGitVersionCache.WriteVariablesToDiskCache(GitVersion.VersionCalculation.Caching.GitVersionCacheKey! cacheKey, GitVersion.OutputVariables.GitVersionVariables! versionVariables) -> void
 GitVersion.VersionCalculation.CommitMessageIncrementMode
 GitVersion.VersionCalculation.CommitMessageIncrementMode.Disabled = 1 -> GitVersion.VersionCalculation.CommitMessageIncrementMode
 GitVersion.VersionCalculation.CommitMessageIncrementMode.Enabled = 0 -> GitVersion.VersionCalculation.CommitMessageIncrementMode
@@ -869,7 +865,7 @@ static GitVersion.Logging.LogExtensions.Warning(this GitVersion.Logging.ILog! lo
 static GitVersion.Logging.LogExtensions.Write(this GitVersion.Logging.ILog! log, GitVersion.Logging.LogLevel level, string! format, params object![]! args) -> void
 static GitVersion.OutputVariables.VersionVariablesHelper.FromFile(string! filePath, GitVersion.IFileSystem! fileSystem) -> GitVersion.OutputVariables.GitVersionVariables!
 static GitVersion.OutputVariables.VersionVariablesHelper.FromJson(string! json) -> GitVersion.OutputVariables.GitVersionVariables!
-static GitVersion.OutputVariables.VersionVariablesHelper.ToJsonString(this GitVersion.OutputVariables.GitVersionVariables! gitVersionVariables) -> string!
+static GitVersion.OutputVariables.VersionVariablesHelper.ToJson(this GitVersion.OutputVariables.GitVersionVariables! gitVersionVariables) -> string!
 static GitVersion.ReferenceName.FromBranchName(string! branchName) -> GitVersion.ReferenceName!
 static GitVersion.ReferenceName.Parse(string! canonicalName) -> GitVersion.ReferenceName!
 static GitVersion.ReferenceName.TryParse(out GitVersion.ReferenceName? value, string! canonicalName) -> bool
diff --git a/src/GitVersion.Core/VersionCalculation/Caching/GitVersionCache.cs b/src/GitVersion.Core/VersionCalculation/Caching/GitVersionCache.cs
@@ -19,14 +19,14 @@ public GitVersionCache(IFileSystem fileSystem, ILog log, IGitRepositoryInfo repo
         this.repositoryInfo = repositoryInfo.NotNull();
     }
 
-    public void WriteVariablesToDiskCache(GitVersionCacheKey cacheKey, GitVersionVariables variablesFromCache)
+    public void WriteVariablesToDiskCache(GitVersionCacheKey cacheKey, GitVersionVariables versionVariables)
     {
         var cacheFileName = GetCacheFileName(cacheKey);
 
         Dictionary<string, string?> dictionary;
         using (this.log.IndentLog("Creating dictionary"))
         {
-            dictionary = variablesFromCache.ToDictionary(x => x.Key, x => x.Value);
+            dictionary = versionVariables.ToDictionary(x => x.Key, x => x.Value);
         }
 
         void WriteCacheOperation()
@@ -44,26 +44,11 @@ void WriteCacheOperation()
         retryOperation.Execute(WriteCacheOperation);
     }
 
-    public string GetCacheFileName(GitVersionCacheKey cacheKey)
-    {
-        var cacheDir = PrepareCacheDirectory();
-        var cacheFileName = GetCacheFileName(cacheKey, cacheDir);
-        return cacheFileName;
-    }
-
-    public string GetCacheDirectory()
-    {
-        var gitDir = this.repositoryInfo.DotGitDirectory;
-        return PathHelper.Combine(gitDir, "gitversion_cache");
-    }
-
-    public GitVersionVariables? LoadVersionVariablesFromDiskCache(GitVersionCacheKey key)
+    public GitVersionVariables? LoadVersionVariablesFromDiskCache(GitVersionCacheKey cacheKey)
     {
         using (this.log.IndentLog("Loading version variables from disk cache"))
         {
-            var cacheDir = PrepareCacheDirectory();
-
-            var cacheFileName = GetCacheFileName(key, cacheDir);
+            var cacheFileName = GetCacheFileName(cacheKey);
             if (!this.fileSystem.Exists(cacheFileName))
             {
                 this.log.Info("Cache file " + cacheFileName + " not found.");
@@ -96,6 +81,18 @@ public string GetCacheDirectory()
         }
     }
 
+    internal string GetCacheFileName(GitVersionCacheKey cacheKey)
+    {
+        var cacheDir = PrepareCacheDirectory();
+        return GetCacheFileName(cacheKey, cacheDir);
+    }
+
+    internal string GetCacheDirectory()
+    {
+        var gitDir = this.repositoryInfo.DotGitDirectory;
+        return PathHelper.Combine(gitDir, "gitversion_cache");
+    }
+
     private string PrepareCacheDirectory()
     {
         var cacheDir = GetCacheDirectory();
diff --git a/src/GitVersion.Core/VersionCalculation/Caching/IGitVersionCache.cs b/src/GitVersion.Core/VersionCalculation/Caching/IGitVersionCache.cs
@@ -4,8 +4,6 @@ namespace GitVersion.VersionCalculation.Caching;
 
 public interface IGitVersionCache
 {
-    void WriteVariablesToDiskCache(GitVersionCacheKey cacheKey, GitVersionVariables variablesFromCache);
-    string GetCacheDirectory();
-    GitVersionVariables? LoadVersionVariablesFromDiskCache(GitVersionCacheKey key);
-    string GetCacheFileName(GitVersionCacheKey cacheKey);
+    void WriteVariablesToDiskCache(GitVersionCacheKey cacheKey, GitVersionVariables versionVariables);
+    GitVersionVariables? LoadVersionVariablesFromDiskCache(GitVersionCacheKey cacheKey);
 }
diff --git a/src/GitVersion.MsBuild/GitVersionTaskExecutor.cs b/src/GitVersion.MsBuild/GitVersionTaskExecutor.cs
@@ -25,7 +25,7 @@ public GitVersionTaskExecutor(IFileSystem fileSystem, IGitVersionOutputTool gitV
 
     public void GetVersion(GetVersion task)
     {
-        var versionVariables = VersionVariablesHelper.FromFile(task.VersionFile, fileSystem);
+        var versionVariables = GitVersionVariables(task);
         var outputType = typeof(GetVersion);
         foreach (var (key, value) in versionVariables)
         {
@@ -35,7 +35,7 @@ public void GetVersion(GetVersion task)
 
     public void UpdateAssemblyInfo(UpdateAssemblyInfo task)
     {
-        var versionVariables = VersionVariablesHelper.FromFile(task.VersionFile, fileSystem);
+        var versionVariables = GitVersionVariables(task);
         FileHelper.DeleteTempFiles();
         FileHelper.CheckForInvalidFiles(task.CompileFiles, task.ProjectFile);
 
@@ -59,7 +59,7 @@ public void UpdateAssemblyInfo(UpdateAssemblyInfo task)
 
     public void GenerateGitVersionInformation(GenerateGitVersionInformation task)
     {
-        var versionVariables = VersionVariablesHelper.FromFile(task.VersionFile, fileSystem);
+        var versionVariables = GitVersionVariables(task);
 
         if (!string.IsNullOrEmpty(task.IntermediateOutputPath))
         {
@@ -72,13 +72,14 @@ public void GenerateGitVersionInformation(GenerateGitVersionInformation task)
 
         var gitVersionOptions = this.options.Value;
         gitVersionOptions.WorkingDirectory = fileWriteInfo.WorkingDirectory;
-        var targetNamespace = getTargetNamespace(task);
+        var targetNamespace = GetTargetNamespace(task);
         gitVersionOutputTool.GenerateGitVersionInformation(versionVariables, fileWriteInfo, targetNamespace);
+        return;
 
-        static string? getTargetNamespace(GenerateGitVersionInformation task)
+        static string? GetTargetNamespace(GenerateGitVersionInformation task)
         {
             string? targetNamespace = null;
-            if (string.Equals(task.UseProjectNamespaceForGitVersionInformation, "true", StringComparison.OrdinalIgnoreCase))
+            if (bool.TryParse(task.UseProjectNamespaceForGitVersionInformation, out var useTargetPathAsRootNamespace) && useTargetPathAsRootNamespace)
             {
                 targetNamespace = task.RootNamespace;
                 if (string.IsNullOrWhiteSpace(targetNamespace))
@@ -93,11 +94,17 @@ public void GenerateGitVersionInformation(GenerateGitVersionInformation task)
 
     public void WriteVersionInfoToBuildLog(WriteVersionInfoToBuildLog task)
     {
-        var versionVariables = VersionVariablesHelper.FromFile(task.VersionFile, fileSystem);
+        var versionVariables = GitVersionVariables(task);
 
         var gitVersionOptions = this.options.Value;
         var configuration = this.configurationProvider.Provide(gitVersionOptions.ConfigurationInfo.OverrideConfiguration);
 
         gitVersionOutputTool.OutputVariables(versionVariables, configuration.UpdateBuildNumber);
     }
+
+    private GitVersionVariables GitVersionVariables(GitVersionTaskBase task)
+    {
+        var versionVariables = VersionVariablesHelper.FromFile(task.VersionFile, this.fileSystem);
+        return versionVariables;
+    }
 }
diff --git a/src/GitVersion.Output/OutputGenerator/OutputGenerator.cs b/src/GitVersion.Output/OutputGenerator/OutputGenerator.cs
@@ -38,14 +38,14 @@ public void Execute(GitVersionVariables variables, OutputContext context)
         if (gitVersionOptions.Output.Contains(OutputType.File))
         {
             var retryOperation = new RetryAction<IOException>();
-            retryOperation.Execute(() => this.fileSystem.WriteAllText(context.OutputFile, variables.ToJsonString()));
+            retryOperation.Execute(() => this.fileSystem.WriteAllText(context.OutputFile, variables.ToJson()));
         }
 
         if (!gitVersionOptions.Output.Contains(OutputType.Json)) return;
 
         if (gitVersionOptions.ShowVariable is null && gitVersionOptions.Format is null)
         {
-            this.console.WriteLine(variables.ToJsonString());
+            this.console.WriteLine(variables.ToJson());
             return;
         }
 
diff --git a/src/GitVersion.sln.DotSettings b/src/GitVersion.sln.DotSettings

Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,8 @@ public virtual GitVersionVariables OutputVariables`
`19`	`19`	`{`
`20`	`20`	`get`
`21`	`21`	`{`
`22`		`- var jsonStartIndex = Output.IndexOf("{", StringComparison.Ordinal);`
`23`		`- var jsonEndIndex = Output.IndexOf("}", StringComparison.Ordinal);`
	`22`	`+ var jsonStartIndex = Output.IndexOf('{');`
	`23`	`+ var jsonEndIndex = Output.IndexOf('}');`
`24`	`24`	`var json = Output.Substring(jsonStartIndex, jsonEndIndex - jsonStartIndex + 1);`
`25`	`25`
`26`	`26`	`return VersionVariablesHelper.FromJson(json);`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ public class GitVersionExecutorTests : TestBase`
`16`	`16`	`{`
`17`	`17`	`private IFileSystem fileSystem;`
`18`	`18`	`private ILog log;`
`19`		`- private IGitVersionCache gitVersionCache;`
	`19`	`+ private GitVersionCache gitVersionCache;`
`20`	`20`	`private IServiceProvider sp;`
`21`	`21`
`22`	`22`	`[Test]`
`@@ -571,7 +571,7 @@ private IGitVersionCalculateTool GetGitVersionCalculator(GitVersionOptions gitVe`
`571`	`571`
`572`	`572`	`this.fileSystem = this.sp.GetRequiredService<IFileSystem>();`
`573`	`573`	`this.log = this.sp.GetRequiredService<ILog>();`
`574`		`- this.gitVersionCache = this.sp.GetRequiredService<IGitVersionCache>();`
	`574`	`+ this.gitVersionCache = (GitVersionCache)this.sp.GetRequiredService<IGitVersionCache>();`
`575`	`575`
`576`	`576`	`return this.sp.GetRequiredService<IGitVersionCalculateTool>();`
`577`	`577`	`}`
Original file line number	Diff line number	Diff line change
`@@ -108,7 +108,7 @@ public static void WriteVersionVariables(this RepositoryFixtureBase fixture, str`
`108`	`108`
`109`	`109`	`using var stream = File.Open(versionFile, FileMode.Create, FileAccess.ReadWrite, FileShare.ReadWrite);`
`110`	`110`	`using var writer = new StreamWriter(stream);`
`111`		`- writer.Write(versionVariables.ToJsonString());`
	`111`	`+ writer.Write(versionVariables.ToJson());`
`112`	`112`	`}`
`113`	`113`
`114`	`114`	`public static void AssertFullSemver(this RepositoryFixtureBase fixture, string fullSemver,`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,6 @@ public void Json()`
`29`	`29`
`30`	`30`	`var variableProvider = serviceProvider.GetRequiredService<IVariableProvider>();`
`31`	`31`	`var variables = variableProvider.GetVariablesFor(semanticVersion, configuration, null);`
`32`		`- variables.ToJsonString().ShouldMatchApproved(c => c.SubFolder("Approved"));`
	`32`	`+ variables.ToJson().ShouldMatchApproved(c => c.SubFolder("Approved"));`
`33`	`33`	`}`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForPreRelease()`
`51`	`51`	`.GetEffectiveConfiguration(ReferenceName.FromBranchName("unstable"));`
`52`	`52`	`var variables = this.variableProvider.GetVariablesFor(semanticVersion, configuration, null);`
`53`	`53`
`54`		`- variables.ToJsonString().ShouldMatchApproved(c => c.SubFolder("Approved"));`
	`54`	`+ variables.ToJson().ShouldMatchApproved(c => c.SubFolder("Approved"));`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`[Test]`
`@@ -77,7 +77,7 @@ public void ProvidesVariablesInContinuousDeploymentModeForPreRelease()`
`77`	`77`	`.GetEffectiveConfiguration(ReferenceName.FromBranchName("unstable"));`
`78`	`78`	`var variables = this.variableProvider.GetVariablesFor(semanticVersion, configuration, null);`
`79`	`79`
`80`		`- variables.ToJsonString().ShouldMatchApproved(c => c.SubFolder("Approved"));`
	`80`	`+ variables.ToJson().ShouldMatchApproved(c => c.SubFolder("Approved"));`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`[Test]`
`@@ -101,7 +101,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForStable()`
`101`	`101`	`.GetEffectiveConfiguration(ReferenceName.FromBranchName("develop"));`
`102`	`102`	`var variables = this.variableProvider.GetVariablesFor(semanticVersion, configuration, null);`
`103`	`103`
`104`		`- variables.ToJsonString().ShouldMatchApproved(c => c.SubFolder("Approved"));`
	`104`	`+ variables.ToJson().ShouldMatchApproved(c => c.SubFolder("Approved"));`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`[Test]`
`@@ -127,7 +127,7 @@ public void ProvidesVariablesInContinuousDeploymentModeForStable()`
`127`	`127`	`.GetEffectiveConfiguration(ReferenceName.FromBranchName("develop"));`
`128`	`128`	`var variables = this.variableProvider.GetVariablesFor(semanticVersion, configuration, null);`
`129`	`129`
`130`		`- variables.ToJsonString().ShouldMatchApproved(c => c.SubFolder("Approved"));`
	`130`	`+ variables.ToJson().ShouldMatchApproved(c => c.SubFolder("Approved"));`
`131`	`131`	`}`
`132`	`132`
`133`	`133`	`[Test]`
`@@ -153,7 +153,7 @@ public void ProvidesVariablesInContinuousDeploymentModeForStableWhenCurrentCommi`
`153`	`153`	`.GetEffectiveConfiguration(ReferenceName.FromBranchName("develop"));`
`154`	`154`	`var variables = this.variableProvider.GetVariablesFor(semanticVersion, configuration, SemanticVersion.Empty);`
`155`	`155`
`156`		`- variables.ToJsonString().ShouldMatchApproved(c => c.SubFolder("Approved"));`
	`156`	`+ variables.ToJson().ShouldMatchApproved(c => c.SubFolder("Approved"));`
`157`	`157`	`}`
`158`	`158`
`159`	`159`	`[Test]`
`@@ -228,7 +228,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForFeatureBranch()`
`228`	`228`	`.GetEffectiveConfiguration(ReferenceName.FromBranchName("develop"));`
`229`	`229`	`var variables = this.variableProvider.GetVariablesFor(semanticVersion, configuration, null);`
`230`	`230`
`231`		`- variables.ToJsonString().ShouldMatchApproved(c => c.SubFolder("Approved"));`
	`231`	`+ variables.ToJson().ShouldMatchApproved(c => c.SubFolder("Approved"));`
`232`	`232`	`}`
`233`	`233`
`234`	`234`	`[Test]`
`@@ -254,7 +254,7 @@ public void ProvidesVariablesInContinuousDeliveryModeForFeatureBranchWithCustomA`
`254`	`254`	`.Build().GetEffectiveConfiguration(ReferenceName.FromBranchName("develop"));`
`255`	`255`	`var variables = this.variableProvider.GetVariablesFor(semanticVersion, configuration, null);`
`256`	`256`
`257`		`- variables.ToJsonString().ShouldMatchApproved(c => c.SubFolder("Approved"));`
	`257`	`+ variables.ToJson().ShouldMatchApproved(c => c.SubFolder("Approved"));`
`258`	`258`	`}`
`259`	`259`
`260`	`260`	`[Test]`
`@@ -281,6 +281,6 @@ public void ProvidesVariablesInContinuousDeploymentModeForMainBranchWithEmptyLab`
`281`	`281`	`.GetEffectiveConfiguration(ReferenceName.FromBranchName("main"));`
`282`	`282`	`var variables = this.variableProvider.GetVariablesFor(semanticVersion, configuration, null);`
`283`	`283`
`284`		`- variables.ToJsonString().ShouldMatchApproved(_ => _.SubFolder("Approved"));`
	`284`	`+ variables.ToJson().ShouldMatchApproved(_ => _.SubFolder("Approved"));`
`285`	`285`	`}`
`286`	`286`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,14 +19,14 @@ public GitVersionCache(IFileSystem fileSystem, ILog log, IGitRepositoryInfo repo`
`19`	`19`	`this.repositoryInfo = repositoryInfo.NotNull();`
`20`	`20`	`}`
`21`	`21`
`22`		`- public void WriteVariablesToDiskCache(GitVersionCacheKey cacheKey, GitVersionVariables variablesFromCache)`
	`22`	`+ public void WriteVariablesToDiskCache(GitVersionCacheKey cacheKey, GitVersionVariables versionVariables)`
`23`	`23`	`{`
`24`	`24`	`var cacheFileName = GetCacheFileName(cacheKey);`
`25`	`25`
`26`	`26`	`Dictionary<string, string?> dictionary;`
`27`	`27`	`using (this.log.IndentLog("Creating dictionary"))`
`28`	`28`	`{`
`29`		`- dictionary = variablesFromCache.ToDictionary(x => x.Key, x => x.Value);`
	`29`	`+ dictionary = versionVariables.ToDictionary(x => x.Key, x => x.Value);`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`void WriteCacheOperation()`
`@@ -44,26 +44,11 @@ void WriteCacheOperation()`
`44`	`44`	`retryOperation.Execute(WriteCacheOperation);`
`45`	`45`	`}`
`46`	`46`
`47`		`- public string GetCacheFileName(GitVersionCacheKey cacheKey)`
`48`		`- {`
`49`		`- var cacheDir = PrepareCacheDirectory();`
`50`		`- var cacheFileName = GetCacheFileName(cacheKey, cacheDir);`
`51`		`- return cacheFileName;`
`52`		`- }`
`53`		`-`
`54`		`- public string GetCacheDirectory()`
`55`		`- {`
`56`		`- var gitDir = this.repositoryInfo.DotGitDirectory;`
`57`		`- return PathHelper.Combine(gitDir, "gitversion_cache");`
`58`		`- }`
`59`		`-`
`60`		`- public GitVersionVariables? LoadVersionVariablesFromDiskCache(GitVersionCacheKey key)`
	`47`	`+ public GitVersionVariables? LoadVersionVariablesFromDiskCache(GitVersionCacheKey cacheKey)`
`61`	`48`	`{`
`62`	`49`	`using (this.log.IndentLog("Loading version variables from disk cache"))`
`63`	`50`	`{`
`64`		`- var cacheDir = PrepareCacheDirectory();`
`65`		`-`
`66`		`- var cacheFileName = GetCacheFileName(key, cacheDir);`
	`51`	`+ var cacheFileName = GetCacheFileName(cacheKey);`
`67`	`52`	`if (!this.fileSystem.Exists(cacheFileName))`
`68`	`53`	`{`
`69`	`54`	`this.log.Info("Cache file " + cacheFileName + " not found.");`
`@@ -96,6 +81,18 @@ public string GetCacheDirectory()`
`96`	`81`	`}`
`97`	`82`	`}`
`98`	`83`
	`84`	`+ internal string GetCacheFileName(GitVersionCacheKey cacheKey)`
	`85`	`+ {`
	`86`	`+ var cacheDir = PrepareCacheDirectory();`
	`87`	`+ return GetCacheFileName(cacheKey, cacheDir);`
	`88`	`+ }`
	`89`	`+`
	`90`	`+ internal string GetCacheDirectory()`
	`91`	`+ {`
	`92`	`+ var gitDir = this.repositoryInfo.DotGitDirectory;`
	`93`	`+ return PathHelper.Combine(gitDir, "gitversion_cache");`
	`94`	`+ }`
	`95`	`+`
`99`	`96`	`private string PrepareCacheDirectory()`
`100`	`97`	`{`
`101`	`98`	`var cacheDir = GetCacheDirectory();`
Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,6 @@ namespace GitVersion.VersionCalculation.Caching;`
`4`	`4`
`5`	`5`	`public interface IGitVersionCache`
`6`	`6`	`{`
`7`		`- void WriteVariablesToDiskCache(GitVersionCacheKey cacheKey, GitVersionVariables variablesFromCache);`
`8`		`- string GetCacheDirectory();`
`9`		`- GitVersionVariables? LoadVersionVariablesFromDiskCache(GitVersionCacheKey key);`
`10`		`- string GetCacheFileName(GitVersionCacheKey cacheKey);`
	`7`	`+ void WriteVariablesToDiskCache(GitVersionCacheKey cacheKey, GitVersionVariables versionVariables);`
	`8`	`+ GitVersionVariables? LoadVersionVariablesFromDiskCache(GitVersionCacheKey cacheKey);`
`11`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ public GitVersionTaskExecutor(IFileSystem fileSystem, IGitVersionOutputTool gitV`
`25`	`25`
`26`	`26`	`public void GetVersion(GetVersion task)`
`27`	`27`	`{`
`28`		`- var versionVariables = VersionVariablesHelper.FromFile(task.VersionFile, fileSystem);`
	`28`	`+ var versionVariables = GitVersionVariables(task);`
`29`	`29`	`var outputType = typeof(GetVersion);`
`30`	`30`	`foreach (var (key, value) in versionVariables)`
`31`	`31`	`{`
`@@ -35,7 +35,7 @@ public void GetVersion(GetVersion task)`
`35`	`35`
`36`	`36`	`public void UpdateAssemblyInfo(UpdateAssemblyInfo task)`
`37`	`37`	`{`
`38`		`- var versionVariables = VersionVariablesHelper.FromFile(task.VersionFile, fileSystem);`
	`38`	`+ var versionVariables = GitVersionVariables(task);`
`39`	`39`	`FileHelper.DeleteTempFiles();`
`40`	`40`	`FileHelper.CheckForInvalidFiles(task.CompileFiles, task.ProjectFile);`
`41`	`41`
`@@ -59,7 +59,7 @@ public void UpdateAssemblyInfo(UpdateAssemblyInfo task)`
`59`	`59`
`60`	`60`	`public void GenerateGitVersionInformation(GenerateGitVersionInformation task)`
`61`	`61`	`{`
`62`		`- var versionVariables = VersionVariablesHelper.FromFile(task.VersionFile, fileSystem);`
	`62`	`+ var versionVariables = GitVersionVariables(task);`
`63`	`63`
`64`	`64`	`if (!string.IsNullOrEmpty(task.IntermediateOutputPath))`
`65`	`65`	`{`
`@@ -72,13 +72,14 @@ public void GenerateGitVersionInformation(GenerateGitVersionInformation task)`
`72`	`72`
`73`	`73`	`var gitVersionOptions = this.options.Value;`
`74`	`74`	`gitVersionOptions.WorkingDirectory = fileWriteInfo.WorkingDirectory;`
`75`		`- var targetNamespace = getTargetNamespace(task);`
	`75`	`+ var targetNamespace = GetTargetNamespace(task);`
`76`	`76`	`gitVersionOutputTool.GenerateGitVersionInformation(versionVariables, fileWriteInfo, targetNamespace);`
	`77`	`+ return;`
`77`	`78`
`78`		`- static string? getTargetNamespace(GenerateGitVersionInformation task)`
	`79`	`+ static string? GetTargetNamespace(GenerateGitVersionInformation task)`
`79`	`80`	`{`
`80`	`81`	`string? targetNamespace = null;`
`81`		`- if (string.Equals(task.UseProjectNamespaceForGitVersionInformation, "true", StringComparison.OrdinalIgnoreCase))`
	`82`	`+ if (bool.TryParse(task.UseProjectNamespaceForGitVersionInformation, out var useTargetPathAsRootNamespace) && useTargetPathAsRootNamespace)`
`82`	`83`	`{`
`83`	`84`	`targetNamespace = task.RootNamespace;`
`84`	`85`	`if (string.IsNullOrWhiteSpace(targetNamespace))`
`@@ -93,11 +94,17 @@ public void GenerateGitVersionInformation(GenerateGitVersionInformation task)`
`93`	`94`
`94`	`95`	`public void WriteVersionInfoToBuildLog(WriteVersionInfoToBuildLog task)`
`95`	`96`	`{`
`96`		`- var versionVariables = VersionVariablesHelper.FromFile(task.VersionFile, fileSystem);`
	`97`	`+ var versionVariables = GitVersionVariables(task);`
`97`	`98`
`98`	`99`	`var gitVersionOptions = this.options.Value;`
`99`	`100`	`var configuration = this.configurationProvider.Provide(gitVersionOptions.ConfigurationInfo.OverrideConfiguration);`
`100`	`101`
`101`	`102`	`gitVersionOutputTool.OutputVariables(versionVariables, configuration.UpdateBuildNumber);`
`102`	`103`	`}`
	`104`	`+`
	`105`	`+ private GitVersionVariables GitVersionVariables(GitVersionTaskBase task)`
	`106`	`+ {`
	`107`	`+ var versionVariables = VersionVariablesHelper.FromFile(task.VersionFile, this.fileSystem);`
	`108`	`+ return versionVariables;`
	`109`	`+ }`
`103`	`110`	`}`