fixup! Factor out CommitLoader.mainBranches into its own class, and store it in Model

Author: stefanhaller

pkg/commands/git_commands/commit_loader.go

@@ -66,7 +66,7 @@ type GetCommitsOptions struct {
 	All bool
 	// If non-empty, show divergence from this ref (left-right log)
 	RefToShowDivergenceFrom string
-	ExistingMainBranches    *ExistingMainBranches
+	MainBranches            *MainBranches
 }
 
 // GetCommits obtains the commits of the current branch
@@ -103,9 +103,9 @@ func (self *CommitLoader) GetCommits(opts GetCommitsOptions) ([]*models.Commit,
 	go utils.Safe(func() {
 		defer wg.Done()
 
-		ancestor = opts.ExistingMainBranches.GetMergeBase(opts.RefName)
+		ancestor = opts.MainBranches.GetMergeBase(opts.RefName)
 		if opts.RefToShowDivergenceFrom != "" {
-			remoteAncestor = opts.ExistingMainBranches.GetMergeBase(opts.RefToShowDivergenceFrom)
+			remoteAncestor = opts.MainBranches.GetMergeBase(opts.RefToShowDivergenceFrom)
 		}
 	})
 

pkg/commands/git_commands/commit_loader_test.go

@@ -324,7 +324,7 @@ func TestGetCommits(t *testing.T) {
 
 			common.UserConfig.Git.MainBranches = scenario.mainBranches
 			opts := scenario.opts
-			opts.ExistingMainBranches = NewExistingMainBranches(scenario.mainBranches, cmd)
+			opts.MainBranches = NewMainBranches(scenario.mainBranches, cmd)
 			commits, err := builder.GetCommits(opts)
 
 			assert.Equal(t, scenario.expectedCommits, commits)

pkg/commands/git_commands/existing_main_branches.go renamed to pkg/commands/git_commands/main_branches.go

@@ -10,39 +10,45 @@ import (
 	"github.com/sasha-s/go-deadlock"
 )
 
-type ExistingMainBranches struct {
+type MainBranches struct {
+	// List of main branches configured by the user. Just the bare names.
 	configuredMainBranches []string
-	existingBranches       []string
+	// Which of these actually exist in the repository. Full ref names, and it
+	// could be either "refs/heads/..." or "refs/remotes/origin/..." depending
+	// on which one exists for a given bare name.
+	existingMainBranches []string
 
 	cmd   oscommands.ICmdObjBuilder
 	mutex *deadlock.Mutex
 }
 
-func NewExistingMainBranches(
+func NewMainBranches(
 	configuredMainBranches []string,
 	cmd oscommands.ICmdObjBuilder,
-) *ExistingMainBranches {
-	return &ExistingMainBranches{
+) *MainBranches {
+	return &MainBranches{
 		configuredMainBranches: configuredMainBranches,
-		existingBranches:       nil,
+		existingMainBranches:   nil,
 		cmd:                    cmd,
 		mutex:                  &deadlock.Mutex{},
 	}
 }
 
-func (self *ExistingMainBranches) Get() []string {
+// Get the list of main branches that exist in the repository. This is a list of
+// full ref names.
+func (self *MainBranches) Get() []string {
 	self.mutex.Lock()
 	defer self.mutex.Unlock()
 
-	if self.existingBranches == nil {
-		self.existingBranches = self.determineMainBranches()
+	if self.existingMainBranches == nil {
+		self.existingMainBranches = self.determineMainBranches()
 	}
 
-	return self.existingBranches
+	return self.existingMainBranches
 }
 
 // Return the merge base of the given refName with the closest main branch.
-func (self *ExistingMainBranches) GetMergeBase(refName string) string {
+func (self *MainBranches) GetMergeBase(refName string) string {
 	mainBranches := self.Get()
 	if len(mainBranches) == 0 {
 		return ""
@@ -65,7 +71,7 @@ func (self *ExistingMainBranches) GetMergeBase(refName string) string {
 	return ignoringWarnings(output)
 }
 
-func (self *ExistingMainBranches) determineMainBranches() []string {
+func (self *MainBranches) determineMainBranches() []string {
 	var existingBranches []string
 	var wg sync.WaitGroup
 

pkg/gui/controllers/helpers/refresh_helper.go

@@ -331,7 +331,7 @@ func (self *RefreshHelper) refreshCommitsWithLimit() error {
 			RefName:              self.refForLog(),
 			RefForPushedStatus:   checkedOutBranchName,
 			All:                  self.c.Contexts().LocalCommits.GetShowWholeGitGraph(),
-			ExistingMainBranches: self.c.Model().ExistingMainBranches,
+			MainBranches:         self.c.Model().MainBranches,
 		},
 	)
 	if err != nil {
@@ -358,7 +358,7 @@ func (self *RefreshHelper) refreshSubCommitsWithLimit() error {
 			RefName:                 self.c.Contexts().SubCommits.GetRef().FullRefName(),
 			RefToShowDivergenceFrom: self.c.Contexts().SubCommits.GetRefToShowDivergenceFrom(),
 			RefForPushedStatus:      self.c.Contexts().SubCommits.GetRef().FullRefName(),
-			ExistingMainBranches:    self.c.Model().ExistingMainBranches,
+			MainBranches:            self.c.Model().MainBranches,
 		},
 	)
 	if err != nil {

pkg/gui/controllers/helpers/sub_commits_helper.go

@@ -44,7 +44,7 @@ func (self *SubCommitsHelper) ViewSubCommits(opts ViewSubCommitsOpts) error {
 			RefName:                 opts.Ref.FullRefName(),
 			RefForPushedStatus:      opts.Ref.FullRefName(),
 			RefToShowDivergenceFrom: opts.RefToShowDivergenceFrom,
-			ExistingMainBranches:    self.c.Model().ExistingMainBranches,
+			MainBranches:            self.c.Model().MainBranches,
 		},
 	)
 	if err != nil {

pkg/gui/gui.go

@@ -379,7 +379,7 @@ func (gui *Gui) resetState(startArgs appTypes.StartArgs) types.Context {
 			BisectInfo:            git_commands.NewNullBisectInfo(),
 			FilesTrie:             patricia.NewTrie(),
 			Authors:               map[string]*models.Author{},
-			ExistingMainBranches:  git_commands.NewExistingMainBranches(gui.UserConfig.Git.MainBranches, gui.os.Cmd),
+			MainBranches:          git_commands.NewMainBranches(gui.UserConfig.Git.MainBranches, gui.os.Cmd),
 		},
 		Modes: &types.Modes{
 			Filtering:        filtering.New(startArgs.FilterPath, ""),

pkg/gui/types/common.go

@@ -281,7 +281,7 @@ type Model struct {
 	// we're on a detached head because we're rebasing or bisecting.
 	CheckedOutBranch string
 
-	ExistingMainBranches *git_commands.ExistingMainBranches
+	MainBranches *git_commands.MainBranches
 
 	// for displaying suggestions while typing in a file name
 	FilesTrie *patricia.Trie