Align naming: renamed isForTrackedBranchOnly and onlyEvaluateTrackedBranches to onlyTrackedBranches

crazycrank · crazycrank · commit 54baccd420a6 · 2020-01-19T14:17:17.000+01:00
diff --git a/src/GitVersionCore.Tests/GitToolsTestingExtensions.cs b/src/GitVersionCore.Tests/GitToolsTestingExtensions.cs
@@ -19,7 +19,7 @@ public static class GitToolsTestingExtensions
 
         static GitToolsTestingExtensions() => sp = ConfigureService();
 
-        public static VersionVariables GetVersion(this RepositoryFixtureBase fixture, Config configuration = null, IRepository repository = null, string commitId = null, bool isForTrackedBranchOnly = true, string targetBranch = null)
+        public static VersionVariables GetVersion(this RepositoryFixtureBase fixture, Config configuration = null, IRepository repository = null, string commitId = null, bool onlyTrackedBranches = true, string targetBranch = null)
         {
             if (configuration == null)
             {
@@ -31,7 +31,7 @@ public static VersionVariables GetVersion(this RepositoryFixtureBase fixture, Co
             var variableProvider = sp.GetService<IVariableProvider>();
             var versionFinder = sp.GetService<IGitVersionFinder>();
 
-            var gitVersionContext = new GitVersionContext(repository ?? fixture.Repository, log, targetBranch, configuration, isForTrackedBranchOnly, commitId);
+            var gitVersionContext = new GitVersionContext(repository ?? fixture.Repository, log, targetBranch, configuration, onlyTrackedBranches, commitId);
             var executeGitVersion = versionFinder.FindVersion(gitVersionContext);
             var variables = variableProvider.GetVariablesFor(executeGitVersion, gitVersionContext.Configuration, gitVersionContext.IsCurrentCommitTagged);
 
@@ -47,19 +47,19 @@ public static VersionVariables GetVersion(this RepositoryFixtureBase fixture, Co
             }
         }
 
-        public static void AssertFullSemver(this RepositoryFixtureBase fixture, string fullSemver, IRepository repository = null, string commitId = null, bool isForTrackedBranchOnly = true, string targetBranch = null)
+        public static void AssertFullSemver(this RepositoryFixtureBase fixture, string fullSemver, IRepository repository = null, string commitId = null, bool onlyTrackedBranches = true, string targetBranch = null)
         {
-            fixture.AssertFullSemver(new Config(), fullSemver, repository, commitId, isForTrackedBranchOnly, targetBranch);
+            fixture.AssertFullSemver(new Config(), fullSemver, repository, commitId, onlyTrackedBranches, targetBranch);
         }
 
-        public static void AssertFullSemver(this RepositoryFixtureBase fixture, Config configuration, string fullSemver, IRepository repository = null, string commitId = null, bool isForTrackedBranchOnly = true, string targetBranch = null)
+        public static void AssertFullSemver(this RepositoryFixtureBase fixture, Config configuration, string fullSemver, IRepository repository = null, string commitId = null, bool onlyTrackedBranches = true, string targetBranch = null)
         {
             configuration.Reset();
             Console.WriteLine("---------");
 
             try
             {
-                var variables = fixture.GetVersion(configuration, repository, commitId, isForTrackedBranchOnly, targetBranch);
+                var variables = fixture.GetVersion(configuration, repository, commitId, onlyTrackedBranches, targetBranch);
                 variables.FullSemVer.ShouldBe(fullSemver);
             }
             catch (Exception)
diff --git a/src/GitVersionCore.Tests/IntegrationTests/DevelopScenarios.cs b/src/GitVersionCore.Tests/IntegrationTests/DevelopScenarios.cs
@@ -143,7 +143,7 @@ public void WhenDevelopBranchedFromMasterDetachedHeadMinorIsIncreased()
             var commit = fixture.Repository.Head.Tip;
             fixture.Repository.MakeACommit();
             Commands.Checkout(fixture.Repository, commit);
-            fixture.AssertFullSemver("1.1.0-alpha.1", isForTrackedBranchOnly: false);
+            fixture.AssertFullSemver("1.1.0-alpha.1", onlyTrackedBranches: false);
         }
 
         [Test]
diff --git a/src/GitVersionCore.Tests/IntegrationTests/MasterScenarios.cs b/src/GitVersionCore.Tests/IntegrationTests/MasterScenarios.cs
@@ -93,7 +93,7 @@ public void GivenARepositoryWithCommitsButNoTagsWithDetachedHeadVersionShouldBe0
             Commands.Checkout(fixture.Repository, commit);
 
             // When
-            fixture.AssertFullSemver("0.1.0+2", isForTrackedBranchOnly: false);
+            fixture.AssertFullSemver("0.1.0+2", onlyTrackedBranches: false);
         }
 
         [Test]
diff --git a/src/GitVersionCore.Tests/IntegrationTests/RemoteRepositoryScenarios.cs b/src/GitVersionCore.Tests/IntegrationTests/RemoteRepositoryScenarios.cs
@@ -68,7 +68,7 @@ public void GivenARemoteGitRepositoryWhenCheckingOutDetachedheadUsingExistingImp
                 fixture.LocalRepositoryFixture.Repository,
                 fixture.LocalRepositoryFixture.Repository.Head.Tip);
 
-            Should.Throw<WarningException>(() => fixture.AssertFullSemver("0.1.0+4", fixture.LocalRepositoryFixture.Repository, isForTrackedBranchOnly: false),
+            Should.Throw<WarningException>(() => fixture.AssertFullSemver("0.1.0+4", fixture.LocalRepositoryFixture.Repository, onlyTrackedBranches: false),
                 $"It looks like the branch being examined is a detached Head pointing to commit '{fixture.LocalRepositoryFixture.Repository.Head.Tip.Id.ToString(7)}'. Without a proper branch name GitVersion cannot determine the build version.");
         }
 
diff --git a/src/GitVersionCore/GitVersionContext.cs b/src/GitVersionCore/GitVersionContext.cs
@@ -14,18 +14,18 @@ public class GitVersionContext
     {
         private readonly ILog log;
 
-        public GitVersionContext(IRepository repository, ILog log, string targetBranch, Config configuration, bool onlyEvaluateTrackedBranches = false, string commitId = null)
-             : this(repository, log, GetTargetBranch(repository, targetBranch), configuration, onlyEvaluateTrackedBranches, commitId)
+        public GitVersionContext(IRepository repository, ILog log, string targetBranch, Config configuration, bool onlyTrackedBranches = false, string commitId = null)
+             : this(repository, log, GetTargetBranch(repository, targetBranch), configuration, onlyTrackedBranches, commitId)
         {
         }
 
-        public GitVersionContext(IRepository repository, ILog log, Branch currentBranch, Config configuration, bool onlyEvaluateTrackedBranches = false, string commitId = null)
+        public GitVersionContext(IRepository repository, ILog log, Branch currentBranch, Config configuration, bool onlyTrackedBranches = false, string commitId = null)
         {
             this.log = log;
             Repository = repository;
             RepositoryMetadataProvider = new GitRepoMetadataProvider(repository, log, configuration);
             FullConfiguration = configuration;
-            OnlyEvaluateTrackedBranches = onlyEvaluateTrackedBranches;
+            OnlyTrackedBranches = onlyTrackedBranches;
 
             if (currentBranch == null)
                 throw new InvalidOperationException("Need a branch to operate on");
@@ -53,7 +53,7 @@ public GitVersionContext(IRepository repository, ILog log, Branch currentBranch,
 
             if (currentBranch.IsDetachedHead())
             {
-                CurrentBranch = RepositoryMetadataProvider.GetBranchesContainingCommit(CurrentCommit, repository.Branches.ToList(), OnlyEvaluateTrackedBranches).OnlyOrDefault() ?? currentBranch;
+                CurrentBranch = RepositoryMetadataProvider.GetBranchesContainingCommit(CurrentCommit, repository.Branches.ToList(), OnlyTrackedBranches).OnlyOrDefault() ?? currentBranch;
             }
             else
             {
@@ -78,7 +78,7 @@ public GitVersionContext(IRepository repository, ILog log, Branch currentBranch,
         /// </summary>
         public Config FullConfiguration { get; }
         public SemanticVersion CurrentCommitTaggedVersion { get; }
-        public bool OnlyEvaluateTrackedBranches { get; }
+        public bool OnlyTrackedBranches { get; }
         public EffectiveConfiguration Configuration { get; private set; }
         public IRepository Repository { get; }
         public Branch CurrentBranch { get; }

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ public static class GitToolsTestingExtensions`
`19`	`19`
`20`	`20`	`static GitToolsTestingExtensions() => sp = ConfigureService();`
`21`	`21`
`22`		`- public static VersionVariables GetVersion(this RepositoryFixtureBase fixture, Config configuration = null, IRepository repository = null, string commitId = null, bool isForTrackedBranchOnly = true, string targetBranch = null)`
	`22`	`+ public static VersionVariables GetVersion(this RepositoryFixtureBase fixture, Config configuration = null, IRepository repository = null, string commitId = null, bool onlyTrackedBranches = true, string targetBranch = null)`
`23`	`23`	`{`
`24`	`24`	`if (configuration == null)`
`25`	`25`	`{`
`@@ -31,7 +31,7 @@ public static VersionVariables GetVersion(this RepositoryFixtureBase fixture, Co`
`31`	`31`	`var variableProvider = sp.GetService<IVariableProvider>();`
`32`	`32`	`var versionFinder = sp.GetService<IGitVersionFinder>();`
`33`	`33`
`34`		`- var gitVersionContext = new GitVersionContext(repository ?? fixture.Repository, log, targetBranch, configuration, isForTrackedBranchOnly, commitId);`
	`34`	`+ var gitVersionContext = new GitVersionContext(repository ?? fixture.Repository, log, targetBranch, configuration, onlyTrackedBranches, commitId);`
`35`	`35`	`var executeGitVersion = versionFinder.FindVersion(gitVersionContext);`
`36`	`36`	`var variables = variableProvider.GetVariablesFor(executeGitVersion, gitVersionContext.Configuration, gitVersionContext.IsCurrentCommitTagged);`
`37`	`37`
`@@ -47,19 +47,19 @@ public static VersionVariables GetVersion(this RepositoryFixtureBase fixture, Co`
`47`	`47`	`}`
`48`	`48`	`}`
`49`	`49`
`50`		`- public static void AssertFullSemver(this RepositoryFixtureBase fixture, string fullSemver, IRepository repository = null, string commitId = null, bool isForTrackedBranchOnly = true, string targetBranch = null)`
	`50`	`+ public static void AssertFullSemver(this RepositoryFixtureBase fixture, string fullSemver, IRepository repository = null, string commitId = null, bool onlyTrackedBranches = true, string targetBranch = null)`
`51`	`51`	`{`
`52`		`- fixture.AssertFullSemver(new Config(), fullSemver, repository, commitId, isForTrackedBranchOnly, targetBranch);`
	`52`	`+ fixture.AssertFullSemver(new Config(), fullSemver, repository, commitId, onlyTrackedBranches, targetBranch);`
`53`	`53`	`}`
`54`	`54`
`55`		`- public static void AssertFullSemver(this RepositoryFixtureBase fixture, Config configuration, string fullSemver, IRepository repository = null, string commitId = null, bool isForTrackedBranchOnly = true, string targetBranch = null)`
	`55`	`+ public static void AssertFullSemver(this RepositoryFixtureBase fixture, Config configuration, string fullSemver, IRepository repository = null, string commitId = null, bool onlyTrackedBranches = true, string targetBranch = null)`
`56`	`56`	`{`
`57`	`57`	`configuration.Reset();`
`58`	`58`	`Console.WriteLine("---------");`
`59`	`59`
`60`	`60`	`try`
`61`	`61`	`{`
`62`		`- var variables = fixture.GetVersion(configuration, repository, commitId, isForTrackedBranchOnly, targetBranch);`
	`62`	`+ var variables = fixture.GetVersion(configuration, repository, commitId, onlyTrackedBranches, targetBranch);`
`63`	`63`	`variables.FullSemVer.ShouldBe(fullSemver);`
`64`	`64`	`}`
`65`	`65`	`catch (Exception)`
Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,7 @@ public void WhenDevelopBranchedFromMasterDetachedHeadMinorIsIncreased()`
`143`	`143`	`var commit = fixture.Repository.Head.Tip;`
`144`	`144`	`fixture.Repository.MakeACommit();`
`145`	`145`	`Commands.Checkout(fixture.Repository, commit);`
`146`		`- fixture.AssertFullSemver("1.1.0-alpha.1", isForTrackedBranchOnly: false);`
	`146`	`+ fixture.AssertFullSemver("1.1.0-alpha.1", onlyTrackedBranches: false);`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`[Test]`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ public void GivenARepositoryWithCommitsButNoTagsWithDetachedHeadVersionShouldBe0`
`93`	`93`	`Commands.Checkout(fixture.Repository, commit);`
`94`	`94`
`95`	`95`	`// When`
`96`		`- fixture.AssertFullSemver("0.1.0+2", isForTrackedBranchOnly: false);`
	`96`	`+ fixture.AssertFullSemver("0.1.0+2", onlyTrackedBranches: false);`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`[Test]`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ public void GivenARemoteGitRepositoryWhenCheckingOutDetachedheadUsingExistingImp`
`68`	`68`	`fixture.LocalRepositoryFixture.Repository,`
`69`	`69`	`fixture.LocalRepositoryFixture.Repository.Head.Tip);`
`70`	`70`
`71`		`- Should.Throw<WarningException>(() => fixture.AssertFullSemver("0.1.0+4", fixture.LocalRepositoryFixture.Repository, isForTrackedBranchOnly: false),`
	`71`	`+ Should.Throw<WarningException>(() => fixture.AssertFullSemver("0.1.0+4", fixture.LocalRepositoryFixture.Repository, onlyTrackedBranches: false),`
`72`	`72`	`$"It looks like the branch being examined is a detached Head pointing to commit '{fixture.LocalRepositoryFixture.Repository.Head.Tip.Id.ToString(7)}'. Without a proper branch name GitVersion cannot determine the build version.");`
`73`	`73`	`}`
`74`	`74`
Original file line number	Diff line number	Diff line change
`@@ -14,18 +14,18 @@ public class GitVersionContext`
`14`	`14`	`{`
`15`	`15`	`private readonly ILog log;`
`16`	`16`
`17`		`- public GitVersionContext(IRepository repository, ILog log, string targetBranch, Config configuration, bool onlyEvaluateTrackedBranches = false, string commitId = null)`
`18`		`- : this(repository, log, GetTargetBranch(repository, targetBranch), configuration, onlyEvaluateTrackedBranches, commitId)`
	`17`	`+ public GitVersionContext(IRepository repository, ILog log, string targetBranch, Config configuration, bool onlyTrackedBranches = false, string commitId = null)`
	`18`	`+ : this(repository, log, GetTargetBranch(repository, targetBranch), configuration, onlyTrackedBranches, commitId)`
`19`	`19`	`{`
`20`	`20`	`}`
`21`	`21`
`22`		`- public GitVersionContext(IRepository repository, ILog log, Branch currentBranch, Config configuration, bool onlyEvaluateTrackedBranches = false, string commitId = null)`
	`22`	`+ public GitVersionContext(IRepository repository, ILog log, Branch currentBranch, Config configuration, bool onlyTrackedBranches = false, string commitId = null)`
`23`	`23`	`{`
`24`	`24`	`this.log = log;`
`25`	`25`	`Repository = repository;`
`26`	`26`	`RepositoryMetadataProvider = new GitRepoMetadataProvider(repository, log, configuration);`
`27`	`27`	`FullConfiguration = configuration;`
`28`		`- OnlyEvaluateTrackedBranches = onlyEvaluateTrackedBranches;`
	`28`	`+ OnlyTrackedBranches = onlyTrackedBranches;`
`29`	`29`
`30`	`30`	`if (currentBranch == null)`
`31`	`31`	`throw new InvalidOperationException("Need a branch to operate on");`
`@@ -53,7 +53,7 @@ public GitVersionContext(IRepository repository, ILog log, Branch currentBranch,`
`53`	`53`
`54`	`54`	`if (currentBranch.IsDetachedHead())`
`55`	`55`	`{`
`56`		`- CurrentBranch = RepositoryMetadataProvider.GetBranchesContainingCommit(CurrentCommit, repository.Branches.ToList(), OnlyEvaluateTrackedBranches).OnlyOrDefault() ?? currentBranch;`
	`56`	`+ CurrentBranch = RepositoryMetadataProvider.GetBranchesContainingCommit(CurrentCommit, repository.Branches.ToList(), OnlyTrackedBranches).OnlyOrDefault() ?? currentBranch;`
`57`	`57`	`}`
`58`	`58`	`else`
`59`	`59`	`{`
`@@ -78,7 +78,7 @@ public GitVersionContext(IRepository repository, ILog log, Branch currentBranch,`
`78`	`78`	`/// </summary>`
`79`	`79`	`public Config FullConfiguration { get; }`
`80`	`80`	`public SemanticVersion CurrentCommitTaggedVersion { get; }`
`81`		`- public bool OnlyEvaluateTrackedBranches { get; }`
	`81`	`+ public bool OnlyTrackedBranches { get; }`
`82`	`82`	`public EffectiveConfiguration Configuration { get; private set; }`
`83`	`83`	`public IRepository Repository { get; }`
`84`	`84`	`public Branch CurrentBranch { get; }`