CR: Clean up naming within MergeMessage class

Kieranties · Kieranties · commit 629efffabb41 · 2019-05-11T10:14:41.000+01:00
diff --git a/src/GitVersionCore.Tests/MergeMessageTests.cs b/src/GitVersionCore.Tests/MergeMessageTests.cs
@@ -75,7 +75,7 @@ public void ParsesMergeMessage(
             var sut = new MergeMessage(message, _config);
 
             // Assert
-            sut.MatchDefinition.ShouldBe("Default");
+            sut.FormatName.ShouldBe("Default");
             sut.TargetBranch.ShouldBe(expectedTargetBranch);
             sut.MergedBranch.ShouldBe(expectedMergedBranch);
             sut.IsMergedPullRequest.ShouldBeFalse();
@@ -106,7 +106,7 @@ public void ParsesGitHubPullMergeMessage(
             var sut = new MergeMessage(message, _config);
 
             // Assert
-            sut.MatchDefinition.ShouldBe("GitHubPull");
+            sut.FormatName.ShouldBe("GitHubPull");
             sut.TargetBranch.ShouldBe(expectedTargetBranch);
             sut.MergedBranch.ShouldBe(expectedMergedBranch);
             sut.IsMergedPullRequest.ShouldBeTrue();
@@ -140,7 +140,7 @@ public void ParsesBitBucketPullMergeMessage(
             var sut = new MergeMessage(message, _config);
 
             // Assert
-            sut.MatchDefinition.ShouldBe("BitBucketPull");
+            sut.FormatName.ShouldBe("BitBucketPull");
             sut.TargetBranch.ShouldBe(expectedTargetBranch);
             sut.MergedBranch.ShouldBe(expectedMergedBranch);
             sut.IsMergedPullRequest.ShouldBeTrue();
@@ -171,7 +171,7 @@ public void ParsesSmartGitMergeMessage(
             var sut = new MergeMessage(message, _config);
 
             // Assert
-            sut.MatchDefinition.ShouldBe("SmartGit");
+            sut.FormatName.ShouldBe("SmartGit");
             sut.TargetBranch.ShouldBe(expectedTargetBranch);
             sut.MergedBranch.ShouldBe(expectedMergedBranch);
             sut.IsMergedPullRequest.ShouldBeFalse();
@@ -201,7 +201,7 @@ public void ParsesRemoteTrackingMergeMessage(
             var sut = new MergeMessage(message, _config);
 
             // Assert
-            sut.MatchDefinition.ShouldBe("RemoteTracking");
+            sut.FormatName.ShouldBe("RemoteTracking");
             sut.TargetBranch.ShouldBe(expectedTargetBranch);
             sut.MergedBranch.ShouldBe(expectedMergedBranch);
             sut.IsMergedPullRequest.ShouldBeFalse();
@@ -228,7 +228,7 @@ public void ParsesInvalidMergeMessage(
             var sut = new MergeMessage(message, _config);
 
             // Assert
-            sut.MatchDefinition.ShouldBeNull();
+            sut.FormatName.ShouldBeNull();
             sut.TargetBranch.ShouldBe(expectedTargetBranch);
             sut.MergedBranch.ShouldBe(expectedMergedBranch);
             sut.IsMergedPullRequest.ShouldBeFalse();
@@ -251,7 +251,7 @@ public void MatchesSingleCustomMessage()
             var sut = new MergeMessage(message, _config);
 
             // Assert
-            sut.MatchDefinition.ShouldBe(definition);
+            sut.FormatName.ShouldBe(definition);
             sut.TargetBranch.ShouldBeNull();
             sut.MergedBranch.ShouldBeEmpty();
             sut.IsMergedPullRequest.ShouldBeFalse();
@@ -276,7 +276,7 @@ public void MatchesMultipleCustomMessages()
             var sut = new MergeMessage(format, _config);
 
             // Assert
-            sut.MatchDefinition.ShouldBe(definition);
+            sut.FormatName.ShouldBe(definition);
             sut.TargetBranch.ShouldBeNull();
             sut.MergedBranch.ShouldBeEmpty();
             sut.IsMergedPullRequest.ShouldBeFalse();
@@ -303,7 +303,7 @@ public void MatchesCaptureGroupsFromCustomMessages()
             var sut = new MergeMessage($"Merged PR #{pr} into {target} from {source}", _config);
 
             // Assert
-            sut.MatchDefinition.ShouldBe(definition);
+            sut.FormatName.ShouldBe(definition);
             sut.TargetBranch.ShouldBe(target);
             sut.MergedBranch.ShouldBe(source);
             sut.IsMergedPullRequest.ShouldBeTrue();
@@ -328,7 +328,7 @@ public void ReturnsAfterFirstMatchingPattern()
             var sut = new MergeMessage("Merge branch 'this'", _config);
 
             // Assert
-            sut.MatchDefinition.ShouldBe(definition);
+            sut.FormatName.ShouldBe(definition);
             sut.TargetBranch.ShouldBeNull();
             sut.MergedBranch.ShouldBe("this");
             sut.IsMergedPullRequest.ShouldBeFalse();
diff --git a/src/GitVersionCore/MergeMessage.cs b/src/GitVersionCore/MergeMessage.cs
@@ -7,32 +7,32 @@ namespace GitVersion
 {
     public class MergeMessage
     {
-        private static readonly IList<MergeMessagePattern> DefaultPatterns = new List<MergeMessagePattern>
+        private static readonly IList<MergeMessageFormat> DefaultFormats = new List<MergeMessageFormat>
         {
-            new MergeMessagePattern("Default", @"^Merge (branch|tag) '(?<SourceBranch>[^']*)'(?: into (?<TargetBranch>[^\s]*))*"),
-            new MergeMessagePattern("SmartGit",  @"^Finish (?<SourceBranch>[^\s]*)(?: into (?<TargetBranch>[^\s]*))*"),
-            new MergeMessagePattern("BitBucketPull", @"^Merge pull request #(?<PullRequestNumber>\d+) (from|in) (?<Source>.*) from (?<SourceBranch>[^\s]*) to (?<TargetBranch>[^\s]*)"),
-            new MergeMessagePattern("GitHubPull", @"^Merge pull request #(?<PullRequestNumber>\d+) (from|in) (?:(?<SourceBranch>[^\s]*))(?: into (?<TargetBranch>[^\s]*))*"),
-            new MergeMessagePattern("RemoteTracking", @"^Merge remote-tracking branch '(?<SourceBranch>[^\s]*)'(?: into (?<TargetBranch>[^\s]*))*")
+            new MergeMessageFormat("Default", @"^Merge (branch|tag) '(?<SourceBranch>[^']*)'(?: into (?<TargetBranch>[^\s]*))*"),
+            new MergeMessageFormat("SmartGit",  @"^Finish (?<SourceBranch>[^\s]*)(?: into (?<TargetBranch>[^\s]*))*"),
+            new MergeMessageFormat("BitBucketPull", @"^Merge pull request #(?<PullRequestNumber>\d+) (from|in) (?<Source>.*) from (?<SourceBranch>[^\s]*) to (?<TargetBranch>[^\s]*)"),
+            new MergeMessageFormat("GitHubPull", @"^Merge pull request #(?<PullRequestNumber>\d+) (from|in) (?:(?<SourceBranch>[^\s]*))(?: into (?<TargetBranch>[^\s]*))*"),
+            new MergeMessageFormat("RemoteTracking", @"^Merge remote-tracking branch '(?<SourceBranch>[^\s]*)'(?: into (?<TargetBranch>[^\s]*))*")
         };
 
         public MergeMessage(string mergeMessage, Config config)
         {
             if (mergeMessage == null)
                 throw new NullReferenceException();
 
-            // Concat config messages with the defaults.
+            // Concat config formats with the defaults.
             // Ensure configs are processed first.
-            var allPatterns = config.MergeMessageFormats
-                .Select(x => new MergeMessagePattern(x.Key, x.Value))
-                .Concat(DefaultPatterns);
+            var allFormats = config.MergeMessageFormats
+                .Select(x => new MergeMessageFormat(x.Key, x.Value))
+                .Concat(DefaultFormats);
 
-            foreach (var pattern in allPatterns)
+            foreach (var format in allFormats)
             {
-                var match = pattern.Format.Match(mergeMessage);
+                var match = format.Pattern.Match(mergeMessage);
                 if (match.Success)
                 {
-                    MatchDefinition = pattern.DefinitionName;
+                    FormatName = format.Name;
                     MergedBranch = match.Groups["SourceBranch"].Value;
 
                     if (match.Groups["TargetBranch"].Success)
@@ -45,21 +45,21 @@ public MergeMessage(string mergeMessage, Config config)
                         PullRequestNumber = pullNumber;
                     }
 
-                    Version = ParseVersion(MergedBranch, config.TagPrefix);
+                    Version = ParseVersion(config.TagPrefix);
 
                     break;
                 }
             }
         }
 
-        public string MatchDefinition { get; }
+        public string FormatName { get; }
         public string TargetBranch { get; }
         public string MergedBranch { get; } = "";
         public bool IsMergedPullRequest => PullRequestNumber != null;
         public int? PullRequestNumber { get; }
         public SemanticVersion Version { get; }
 
-        private SemanticVersion ParseVersion(string branchName, string tagPrefix)
+        private SemanticVersion ParseVersion(string tagPrefix)
         {
             // Remove remotes and branch prefixes like release/ feature/ hotfix/ etc
             var toMatch = Regex.Replace(MergedBranch, @"^(\w+[-/])*", "", RegexOptions.IgnoreCase);
@@ -76,17 +76,17 @@ private SemanticVersion ParseVersion(string branchName, string tagPrefix)
             return null;
         }
 
-        private class MergeMessagePattern
+        private class MergeMessageFormat
         {
-            public MergeMessagePattern(string name, string format)
+            public MergeMessageFormat(string name, string pattern)
             {
-                DefinitionName = name;
-                Format = new Regex(format, RegexOptions.IgnoreCase | RegexOptions.Compiled);
+                Name = name;
+                Pattern = new Regex(pattern, RegexOptions.IgnoreCase | RegexOptions.Compiled);
             }
 
-            public string DefinitionName { get; }
+            public string Name { get; }
 
-            public Regex Format { get; }
+            public Regex Pattern { get; }
         }
     }
 }
diff --git a/src/GitVersionCore/VersionCalculation/BaseVersionCalculators/MergeMessageBaseVersionStrategy.cs b/src/GitVersionCore/VersionCalculation/BaseVersionCalculators/MergeMessageBaseVersionStrategy.cs
@@ -23,7 +23,7 @@ public override IEnumerable<BaseVersion> GetVersions(GitVersionContext context)
                         mergeMessage.Version != null &&
                         context.FullConfiguration.IsReleaseBranch(TrimRemote(mergeMessage.MergedBranch)))
                     {
-                        Logger.WriteInfo($"Found commit [{context.CurrentCommit.Sha}] matching merge message format: {mergeMessage.MatchDefinition}");
+                        Logger.WriteInfo($"Found commit [{context.CurrentCommit.Sha}] matching merge message format: {mergeMessage.FormatName}");
                         var shouldIncrement = !context.Configuration.PreventIncrementForMergedBranchVersion;
                         return new[]
                         {

Original file line number	Diff line number	Diff line change
`@@ -7,32 +7,32 @@ namespace GitVersion`
`7`	`7`	`{`
`8`	`8`	`public class MergeMessage`
`9`	`9`	`{`
`10`		`- private static readonly IList<MergeMessagePattern> DefaultPatterns = new List<MergeMessagePattern>`
	`10`	`+ private static readonly IList<MergeMessageFormat> DefaultFormats = new List<MergeMessageFormat>`
`11`	`11`	`{`
`12`		`- new MergeMessagePattern("Default", @"^Merge (branch\|tag) '(?<SourceBranch>[^'])'(?: into (?<TargetBranch>[^\s]))*"),`
`13`		`- new MergeMessagePattern("SmartGit", @"^Finish (?<SourceBranch>[^\s])(?: into (?<TargetBranch>[^\s]))*"),`
`14`		`- new MergeMessagePattern("BitBucketPull", @"^Merge pull request #(?<PullRequestNumber>\d+) (from\|in) (?<Source>.) from (?<SourceBranch>[^\s]) to (?<TargetBranch>[^\s]*)"),`
`15`		`- new MergeMessagePattern("GitHubPull", @"^Merge pull request #(?<PullRequestNumber>\d+) (from\|in) (?:(?<SourceBranch>[^\s]))(?: into (?<TargetBranch>[^\s]))*"),`
`16`		`- new MergeMessagePattern("RemoteTracking", @"^Merge remote-tracking branch '(?<SourceBranch>[^\s])'(?: into (?<TargetBranch>[^\s]))*")`
	`12`	`+ new MergeMessageFormat("Default", @"^Merge (branch\|tag) '(?<SourceBranch>[^'])'(?: into (?<TargetBranch>[^\s]))*"),`
	`13`	`+ new MergeMessageFormat("SmartGit", @"^Finish (?<SourceBranch>[^\s])(?: into (?<TargetBranch>[^\s]))*"),`
	`14`	`+ new MergeMessageFormat("BitBucketPull", @"^Merge pull request #(?<PullRequestNumber>\d+) (from\|in) (?<Source>.) from (?<SourceBranch>[^\s]) to (?<TargetBranch>[^\s]*)"),`
	`15`	`+ new MergeMessageFormat("GitHubPull", @"^Merge pull request #(?<PullRequestNumber>\d+) (from\|in) (?:(?<SourceBranch>[^\s]))(?: into (?<TargetBranch>[^\s]))*"),`
	`16`	`+ new MergeMessageFormat("RemoteTracking", @"^Merge remote-tracking branch '(?<SourceBranch>[^\s])'(?: into (?<TargetBranch>[^\s]))*")`
`17`	`17`	`};`
`18`	`18`
`19`	`19`	`public MergeMessage(string mergeMessage, Config config)`
`20`	`20`	`{`
`21`	`21`	`if (mergeMessage == null)`
`22`	`22`	`throw new NullReferenceException();`
`23`	`23`
`24`		`- // Concat config messages with the defaults.`
	`24`	`+ // Concat config formats with the defaults.`
`25`	`25`	`// Ensure configs are processed first.`
`26`		`- var allPatterns = config.MergeMessageFormats`
`27`		`- .Select(x => new MergeMessagePattern(x.Key, x.Value))`
`28`		`- .Concat(DefaultPatterns);`
	`26`	`+ var allFormats = config.MergeMessageFormats`
	`27`	`+ .Select(x => new MergeMessageFormat(x.Key, x.Value))`
	`28`	`+ .Concat(DefaultFormats);`
`29`	`29`
`30`		`- foreach (var pattern in allPatterns)`
	`30`	`+ foreach (var format in allFormats)`
`31`	`31`	`{`
`32`		`- var match = pattern.Format.Match(mergeMessage);`
	`32`	`+ var match = format.Pattern.Match(mergeMessage);`
`33`	`33`	`if (match.Success)`
`34`	`34`	`{`
`35`		`- MatchDefinition = pattern.DefinitionName;`
	`35`	`+ FormatName = format.Name;`
`36`	`36`	`MergedBranch = match.Groups["SourceBranch"].Value;`
`37`	`37`
`38`	`38`	`if (match.Groups["TargetBranch"].Success)`
`@@ -45,21 +45,21 @@ public MergeMessage(string mergeMessage, Config config)`
`45`	`45`	`PullRequestNumber = pullNumber;`
`46`	`46`	`}`
`47`	`47`
`48`		`- Version = ParseVersion(MergedBranch, config.TagPrefix);`
	`48`	`+ Version = ParseVersion(config.TagPrefix);`
`49`	`49`
`50`	`50`	`break;`
`51`	`51`	`}`
`52`	`52`	`}`
`53`	`53`	`}`
`54`	`54`
`55`		`- public string MatchDefinition { get; }`
	`55`	`+ public string FormatName { get; }`
`56`	`56`	`public string TargetBranch { get; }`
`57`	`57`	`public string MergedBranch { get; } = "";`
`58`	`58`	`public bool IsMergedPullRequest => PullRequestNumber != null;`
`59`	`59`	`public int? PullRequestNumber { get; }`
`60`	`60`	`public SemanticVersion Version { get; }`
`61`	`61`
`62`		`- private SemanticVersion ParseVersion(string branchName, string tagPrefix)`
	`62`	`+ private SemanticVersion ParseVersion(string tagPrefix)`
`63`	`63`	`{`
`64`	`64`	`// Remove remotes and branch prefixes like release/ feature/ hotfix/ etc`
`65`	`65`	`var toMatch = Regex.Replace(MergedBranch, @"^(\w+[-/])*", "", RegexOptions.IgnoreCase);`
`@@ -76,17 +76,17 @@ private SemanticVersion ParseVersion(string branchName, string tagPrefix)`
`76`	`76`	`return null;`
`77`	`77`	`}`
`78`	`78`
`79`		`- private class MergeMessagePattern`
	`79`	`+ private class MergeMessageFormat`
`80`	`80`	`{`
`81`		`- public MergeMessagePattern(string name, string format)`
	`81`	`+ public MergeMessageFormat(string name, string pattern)`
`82`	`82`	`{`
`83`		`- DefinitionName = name;`
`84`		`- Format = new Regex(format, RegexOptions.IgnoreCase \| RegexOptions.Compiled);`
	`83`	`+ Name = name;`
	`84`	`+ Pattern = new Regex(pattern, RegexOptions.IgnoreCase \| RegexOptions.Compiled);`
`85`	`85`	`}`
`86`	`86`
`87`		`- public string DefinitionName { get; }`
	`87`	`+ public string Name { get; }`
`88`	`88`
`89`		`- public Regex Format { get; }`
	`89`	`+ public Regex Pattern { get; }`
`90`	`90`	`}`
`91`	`91`	`}`
`92`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public override IEnumerable<BaseVersion> GetVersions(GitVersionContext context)`
`23`	`23`	`mergeMessage.Version != null &&`
`24`	`24`	`context.FullConfiguration.IsReleaseBranch(TrimRemote(mergeMessage.MergedBranch)))`
`25`	`25`	`{`
`26`		`- Logger.WriteInfo($"Found commit [{context.CurrentCommit.Sha}] matching merge message format: {mergeMessage.MatchDefinition}");`
	`26`	`+ Logger.WriteInfo($"Found commit [{context.CurrentCommit.Sha}] matching merge message format: {mergeMessage.FormatName}");`
`27`	`27`	`var shouldIncrement = !context.Configuration.PreventIncrementForMergedBranchVersion;`
`28`	`28`	`return new[]`
`29`	`29`	`{`