Move IIgnoreConfiguration::ToFilters method out of the interface/record, to an extension at the place of usage

Author: HHobeck

src/GitVersion.Core.Tests/Extensions/GitToolsTestingExtensions.cs

@@ -19,11 +19,11 @@ public static class GitToolsTestingExtensions
     public static ICommit CreateMockCommit()
     {
         var objectId = Substitute.For<IObjectId>();
-        objectId.Sha.Returns(Guid.NewGuid().ToString("n") + "00000000");
-
+        var sha = Guid.NewGuid().ToString("n") + "00000000";
+        objectId.Sha.Returns(sha);
         var commit = Substitute.For<ICommit>();
         commit.Id.Returns(objectId);
-        commit.Sha.Returns(objectId.Sha);
+        commit.Sha.Returns(sha);
         commit.Message.Returns("Commit " + commitCount++);
         commit.Parents.Returns(Enumerable.Empty<ICommit>());
         commit.When.Returns(when.AddSeconds(1));

src/GitVersion.Core.Tests/VersionCalculation/NextVersionCalculatorTests.cs

@@ -366,8 +366,7 @@ public void ShouldNotFilterVersion()
     {
         // Arrange
         var branchMock = GitToolsTestingExtensions.CreateMockBranch("main", GitToolsTestingExtensions.CreateMockCommit());
-        var fakeIgnoreConfig = new TestIgnoreConfig(new ExcludeSourcesContainingExclude());
-        var configuration = GitFlowConfigurationBuilder.New.WithIgnoreConfiguration(fakeIgnoreConfig).Build();
+        var configuration = GitFlowConfigurationBuilder.New.Build();
         var context = new GitVersionContext(branchMock, null, configuration, null, 0);
         var repositoryStoreMock = Substitute.For<IRepositoryStore>();
         var effectiveConfiguration = context.Configuration.GetEffectiveConfiguration(branchMock);
@@ -396,9 +395,10 @@ public void ShouldNotFilterVersion()
     public void ShouldFilterVersion()
     {
         // Arrange
+        var commitToExclude = GitToolsTestingExtensions.CreateMockCommit();
         var branchMock = GitToolsTestingExtensions.CreateMockBranch("main", GitToolsTestingExtensions.CreateMockCommit());
-        var fakeIgnoreConfig = new TestIgnoreConfig(new ExcludeSourcesContainingExclude());
-        var configuration = GitFlowConfigurationBuilder.New.WithIgnoreConfiguration(fakeIgnoreConfig).Build();
+        var ignoreConfiguration = IgnoreConfigurationBuilder.New.WithShas(commitToExclude.Sha).Build();
+        var configuration = GitFlowConfigurationBuilder.New.WithIgnoreConfiguration(ignoreConfiguration).Build();
         var context = new GitVersionContext(branchMock, null, configuration, null, 0);
         var repositoryStoreMock = Substitute.For<IRepositoryStore>();
         var effectiveConfiguration = context.Configuration.GetEffectiveConfiguration(branchMock);
@@ -407,7 +407,7 @@ public void ShouldFilterVersion()
         effectiveBranchConfigurationFinderMock.GetConfigurations(branchMock, configuration).Returns(new[] { effectiveBranchConfiguration });
         var incrementStrategyFinderMock = Substitute.For<IIncrementStrategyFinder>();
         repositoryStoreMock.GetSourceBranches(branchMock, configuration, Arg.Any<HashSet<IBranch>>()).Returns(Enumerable.Empty<IBranch>());
-        var higherVersion = new BaseVersion("exclude", false, new SemanticVersion(2), GitToolsTestingExtensions.CreateMockCommit(), null);
+        var higherVersion = new BaseVersion("exclude", false, new SemanticVersion(2), commitToExclude, null);
         var lowerVersion = new BaseVersion("dummy", false, new SemanticVersion(1), GitToolsTestingExtensions.CreateMockCommit(), null);
         var versionStrategies = new IVersionStrategy[] { new TestVersionStrategy(higherVersion, lowerVersion) };
         var mainlineVersionCalculatorMock = Substitute.For<IMainlineVersionCalculator>();
@@ -430,8 +430,7 @@ public void ShouldIgnorePreReleaseVersionInMainlineMode()
     {
         // Arrange
         var branchMock = GitToolsTestingExtensions.CreateMockBranch("main", GitToolsTestingExtensions.CreateMockCommit());
-        var fakeIgnoreConfig = new TestIgnoreConfig(new ExcludeSourcesContainingExclude());
-        var configuration = GitFlowConfigurationBuilder.New.WithIgnoreConfiguration(fakeIgnoreConfig)
+        var configuration = GitFlowConfigurationBuilder.New
             .WithBranch("main", builder => builder.WithVersioningMode(VersioningMode.Mainline))
             .Build();
         var context = new GitVersionContext(branchMock, null, configuration, null, 0);
@@ -473,34 +472,6 @@ public void ShouldIgnorePreReleaseVersionInMainlineMode()
         nextVersion.BaseVersion.SemanticVersion.ShouldBe(lowerVersion.SemanticVersion);
     }
 
-    private record TestIgnoreConfig : IgnoreConfiguration
-    {
-        private readonly IVersionFilter filter;
-
-        public override bool IsEmpty => false;
-
-        public TestIgnoreConfig(IVersionFilter filter) => this.filter = filter;
-
-        public override IEnumerable<IVersionFilter> ToFilters()
-        {
-            yield return this.filter;
-        }
-    }
-
-    private class ExcludeSourcesContainingExclude : IVersionFilter
-    {
-        public bool Exclude(BaseVersion version, out string? reason)
-        {
-            reason = null;
-
-            if (!version.Source.Contains("exclude"))
-                return false;
-
-            reason = "was excluded";
-            return true;
-        }
-    }
-
     private sealed class V1Strategy : IVersionStrategy
     {
         private readonly ICommit? when;

src/GitVersion.Core/Configuration/IIgnoreConfiguration.cs

@@ -1,15 +1,11 @@
-using GitVersion.VersionCalculation;
-
 namespace GitVersion.Configuration
 {
     public interface IIgnoreConfiguration
     {
         DateTimeOffset? Before { get; }
 
-        IReadOnlyList<string> Shas { get; }
-
-        IEnumerable<IVersionFilter> ToFilters();
+        IReadOnlyCollection<string> Shas { get; }
 
-        bool IsEmpty { get; }
+        public bool IsEmpty => Before == null && !Shas.Any();
     }
 }

src/GitVersion.Core/Configuration/IgnoreConfiguration.cs

@@ -1,5 +1,4 @@
 using GitVersion.Attributes;
-using GitVersion.VersionCalculation;
 
 namespace GitVersion.Configuration;
 
@@ -11,18 +10,9 @@ public record IgnoreConfiguration : IIgnoreConfiguration
     public DateTimeOffset? Before { get; init; }
 
     [JsonIgnore]
-    IReadOnlyList<string> IIgnoreConfiguration.Shas => Shas;
+    IReadOnlyCollection<string> IIgnoreConfiguration.Shas => Shas;
 
     [JsonPropertyName("sha")]
     [JsonPropertyDescription("A sequence of SHAs to be excluded from the version calculations.")]
-    public List<string> Shas { get; init; } = new();
-
-    [JsonIgnore]
-    public virtual bool IsEmpty => Before == null && !Shas.Any();
-
-    public virtual IEnumerable<IVersionFilter> ToFilters()
-    {
-        if (Shas.Any()) yield return new ShaVersionFilter(Shas);
-        if (Before.HasValue) yield return new MinDateVersionFilter(Before.Value);
-    }
+    public HashSet<string> Shas { get; init; } = new();
 }

src/GitVersion.Core/Configuration/IgnoreConfigurationBuilder.cs

@@ -0,0 +1,40 @@
+namespace GitVersion.Configuration;
+
+internal sealed class IgnoreConfigurationBuilder
+{
+    public static IgnoreConfigurationBuilder New => new();
+
+    private DateTimeOffset? before;
+
+    private HashSet<string> shas = new();
+
+    public IgnoreConfigurationBuilder WithBefore(DateTimeOffset? value)
+    {
+        this.before = value;
+        return this;
+    }
+
+    public IgnoreConfigurationBuilder WithShas(IEnumerable<string> values)
+    {
+        WithShas(new HashSet<string>(values));
+        return this;
+    }
+
+    public IgnoreConfigurationBuilder WithShas(params string[] values)
+    {
+        WithShas(new HashSet<string>(values));
+        return this;
+    }
+
+    public IgnoreConfigurationBuilder WithShas(HashSet<string> value)
+    {
+        this.shas = value;
+        return this;
+    }
+
+    public IgnoreConfiguration Build() => new()
+    {
+        Before = before,
+        Shas = shas
+    };
+}

src/GitVersion.Core/Configuration/IgnoreConfigurationExtensions.cs

@@ -0,0 +1,15 @@
+using GitVersion.Extensions;
+using GitVersion.VersionCalculation;
+
+namespace GitVersion.Configuration;
+
+public static class IgnoreConfigurationExtensions
+{
+    public static IEnumerable<IVersionFilter> ToFilters(this IIgnoreConfiguration source)
+    {
+        source.NotNull();
+
+        if (source.Shas.Any()) yield return new ShaVersionFilter(source.Shas);
+        if (source.Before.HasValue) yield return new MinDateVersionFilter(source.Before.Value);
+    }
+}

src/GitVersion.Core/PublicAPI.Unshipped.txt

@@ -239,13 +239,13 @@ GitVersion.Configuration.IGitVersionConfiguration.Workflow.get -> string?
 GitVersion.Configuration.IgnoreConfiguration
 GitVersion.Configuration.IgnoreConfiguration.Before.get -> System.DateTimeOffset?
 GitVersion.Configuration.IgnoreConfiguration.Before.init -> void
-GitVersion.Configuration.IgnoreConfiguration.Shas.get -> System.Collections.Generic.List<string!>!
+GitVersion.Configuration.IgnoreConfiguration.Shas.get -> System.Collections.Generic.HashSet<string!>!
 GitVersion.Configuration.IgnoreConfiguration.Shas.init -> void
+GitVersion.Configuration.IgnoreConfigurationExtensions
 GitVersion.Configuration.IIgnoreConfiguration
 GitVersion.Configuration.IIgnoreConfiguration.Before.get -> System.DateTimeOffset?
 GitVersion.Configuration.IIgnoreConfiguration.IsEmpty.get -> bool
-GitVersion.Configuration.IIgnoreConfiguration.Shas.get -> System.Collections.Generic.IReadOnlyList<string!>!
-GitVersion.Configuration.IIgnoreConfiguration.ToFilters() -> System.Collections.Generic.IEnumerable<GitVersion.VersionCalculation.IVersionFilter!>!
+GitVersion.Configuration.IIgnoreConfiguration.Shas.get -> System.Collections.Generic.IReadOnlyCollection<string!>!
 GitVersion.Configuration.Init.EditConfigStep
 GitVersion.Configuration.Init.EditConfigStep.EditConfigStep(GitVersion.Logging.IConsole! console, GitVersion.IFileSystem! fileSystem, GitVersion.Logging.ILog! log, GitVersion.Configuration.Init.Wizard.IConfigInitStepFactory! stepFactory) -> void
 GitVersion.Configuration.Init.GitVersionInitModule
@@ -1088,6 +1088,7 @@ static GitVersion.Configuration.ConfigurationSerializer.Deserialize<T>(string! i
 static GitVersion.Configuration.ConfigurationSerializer.Read(System.IO.TextReader! reader) -> GitVersion.Configuration.GitVersionConfiguration!
 static GitVersion.Configuration.ConfigurationSerializer.Serialize(object! graph) -> string!
 static GitVersion.Configuration.ConfigurationSerializer.Write(GitVersion.Configuration.IGitVersionConfiguration! configuration, System.IO.TextWriter! writer) -> void
+static GitVersion.Configuration.IgnoreConfigurationExtensions.ToFilters(this GitVersion.Configuration.IIgnoreConfiguration! source) -> System.Collections.Generic.IEnumerable<GitVersion.VersionCalculation.IVersionFilter!>!
 static GitVersion.Configuration.Init.StepResult.ExitWithoutSaving() -> GitVersion.Configuration.Init.StepResult!
 static GitVersion.Configuration.Init.StepResult.InvalidResponseSelected() -> GitVersion.Configuration.Init.StepResult!
 static GitVersion.Configuration.Init.StepResult.Ok() -> GitVersion.Configuration.Init.StepResult!
@@ -1224,8 +1225,6 @@ virtual GitVersion.Configuration.BranchConfigurationBuilder.WithTrackMergeMessag
 virtual GitVersion.Configuration.BranchConfigurationBuilder.WithTrackMergeTarget(bool? value) -> GitVersion.Configuration.BranchConfigurationBuilder!
 virtual GitVersion.Configuration.BranchConfigurationBuilder.WithTracksReleaseBranches(bool? value) -> GitVersion.Configuration.BranchConfigurationBuilder!
 virtual GitVersion.Configuration.BranchConfigurationBuilder.WithVersioningMode(GitVersion.VersionCalculation.VersioningMode? value) -> GitVersion.Configuration.BranchConfigurationBuilder!
-virtual GitVersion.Configuration.IgnoreConfiguration.IsEmpty.get -> bool
-virtual GitVersion.Configuration.IgnoreConfiguration.ToFilters() -> System.Collections.Generic.IEnumerable<GitVersion.VersionCalculation.IVersionFilter!>!
 virtual GitVersion.VersionCalculation.EffectiveBranchConfigurationFinder.GetConfigurations(GitVersion.IBranch! branch, GitVersion.Configuration.IGitVersionConfiguration! configuration) -> System.Collections.Generic.IEnumerable<GitVersion.Configuration.EffectiveBranchConfiguration!>!
 virtual GitVersion.VersionCalculation.FallbackVersionStrategy.GetBaseVersions(GitVersion.Configuration.EffectiveBranchConfiguration! configuration) -> System.Collections.Generic.IEnumerable<GitVersion.VersionCalculation.BaseVersion!>!
 virtual GitVersion.VersionCalculation.NextVersionCalculator.FindVersion() -> GitVersion.VersionCalculation.NextVersion!