cleanup: remove all redundant top-level repo functions

This is a breaking change for v2 that removes all top-level functions
that take repoPath as the first parameter. These functions have been
consolidated into Repository methods.

**Removed top-level functions (use Repository methods instead):**

repo.go:
- Push(repoPath, ...) → repo.Push(...)
- Checkout(repoPath, ...) → repo.Checkout(...)
- Reset(repoPath, ...) → repo.Reset(...)
- Move(repoPath, ...) → repo.Move(...)
- Add(repoPath, ...) → repo.Add(...)
- CreateCommit(repoPath, ...) → repo.Commit(...)
- ShowNameStatus(repoPath, ...) → repo.ShowNameStatus(...)
- CountObjects(repoPath, ...) → repo.CountObjects(...)
- Fsck(repoPath, ...) → repo.Fsck(...)

repo_commit.go:
- Log(repoPath, ...) → repo.Log(...)
- DiffNameOnly(repoPath, ...) → repo.DiffNameOnly(...)

repo_pull.go:
- MergeBase(repoPath, ...) → repo.MergeBase(...)

repo_reference.go:
- ShowRefVerify(repoPath, ...) → repo.ShowRefVerify(...)
- SymbolicRef(repoPath, ...) → repo.SymbolicRef(...)
- DeleteBranch(repoPath, ...) → repo.DeleteBranch(...)
- HasReference(repoPath, ...) → repo.HasReference(...)
- HasBranch(repoPath, ...) → repo.HasBranch(...)
- HasTag(repoPath, ...) → repo.HasTag(...)

repo_remote.go:
- RemoteAdd(repoPath, ...) → repo.RemoteAdd(...)
- RemoteRemove(repoPath, ...) → repo.RemoteRemove(...)
- Remotes(repoPath, ...) → repo.Remotes(...)
- RemoteGetURL(repoPath, ...) → repo.RemoteGetURL(...)
- RemoteSetURL(repoPath, ...) → repo.RemoteSetURL(...)
- RemoteSetURLAdd(repoPath, ...) → repo.RemoteSetURLAdd(...)
- RemoteSetURLDelete(repoPath, ...) → repo.RemoteSetURLDelete(...)

repo_tag.go:
- Tags(repoPath, ...) → repo.Tags(...)

**Kept top-level functions (no repo required):**
- Init(path, ...) - creates new repo
- Clone(url, dst, ...) - clones repo
- Open(repoPath) - opens repo

**Stats:** 342 deletions, 80 insertions (-262 net lines)

All tests updated and passing.

Author: unknwon

repo.go

@@ -253,29 +253,18 @@ type PushOptions struct {
 	CommandOptions
 }
 
-// Push pushes local changes to given remote and branch for the repository in
-// given path.
-func Push(repoPath, remote, branch string, opts ...PushOptions) error {
+// Push pushes local changes to given remote and branch for the repository.
+func (r *Repository) Push(remote, branch string, opts ...PushOptions) error {
 	var opt PushOptions
 	if len(opts) > 0 {
 		opt = opts[0]
 	}
 
 	cmd := NewCommand("push").AddOptions(opt.CommandOptions).AddArgs("--end-of-options", remote, branch)
-	_, err := cmd.RunInDirWithTimeout(opt.Timeout, repoPath)
+	_, err := cmd.RunInDirWithTimeout(opt.Timeout, r.path)
 	return err
 }
 
-// Deprecated: Use Push instead.
-func RepoPush(repoPath, remote, branch string, opts ...PushOptions) error {
-	return Push(repoPath, remote, branch, opts...)
-}
-
-// Push pushes local changes to given remote and branch for the repository.
-func (r *Repository) Push(remote, branch string, opts ...PushOptions) error {
-	return Push(r.path, remote, branch, opts...)
-}
-
 // CheckoutOptions contains optional arguments for checking out to a branch.
 //
 // Docs: https://git-scm.com/docs/git-checkout
@@ -291,8 +280,8 @@ type CheckoutOptions struct {
 	CommandOptions
 }
 
-// Checkout checks out to given branch for the repository in given path.
-func Checkout(repoPath, branch string, opts ...CheckoutOptions) error {
+// Checkout checks out to given branch for the repository.
+func (r *Repository) Checkout(branch string, opts ...CheckoutOptions) error {
 	var opt CheckoutOptions
 	if len(opts) > 0 {
 		opt = opts[0]
@@ -307,20 +296,10 @@ func Checkout(repoPath, branch string, opts ...CheckoutOptions) error {
 		cmd.AddArgs(opt.BaseBranch)
 	}
 
-	_, err := cmd.RunInDirWithTimeout(opt.Timeout, repoPath)
+	_, err := cmd.RunInDirWithTimeout(opt.Timeout, r.path)
 	return err
 }
 
-// Deprecated: Use Checkout instead.
-func RepoCheckout(repoPath, branch string, opts ...CheckoutOptions) error {
-	return Checkout(repoPath, branch, opts...)
-}
-
-// Checkout checks out to given branch for the repository.
-func (r *Repository) Checkout(branch string, opts ...CheckoutOptions) error {
-	return Checkout(r.path, branch, opts...)
-}
-
 // ResetOptions contains optional arguments for resetting a branch.
 //
 // Docs: https://git-scm.com/docs/git-reset
@@ -336,8 +315,8 @@ type ResetOptions struct {
 	CommandOptions
 }
 
-// Reset resets working tree to given revision for the repository in given path.
-func Reset(repoPath, rev string, opts ...ResetOptions) error {
+// Reset resets working tree to given revision for the repository.
+func (r *Repository) Reset(rev string, opts ...ResetOptions) error {
 	var opt ResetOptions
 	if len(opts) > 0 {
 		opt = opts[0]
@@ -348,20 +327,10 @@ func Reset(repoPath, rev string, opts ...ResetOptions) error {
 		cmd.AddArgs("--hard")
 	}
 
-	_, err := cmd.AddOptions(opt.CommandOptions).AddArgs("--end-of-options", rev).RunInDir(repoPath)
+	_, err := cmd.AddOptions(opt.CommandOptions).AddArgs("--end-of-options", rev).RunInDir(r.path)
 	return err
 }
 
-// Deprecated: Use Reset instead.
-func RepoReset(repoPath, rev string, opts ...ResetOptions) error {
-	return Reset(repoPath, rev, opts...)
-}
-
-// Reset resets working tree to given revision for the repository.
-func (r *Repository) Reset(rev string, opts ...ResetOptions) error {
-	return Reset(r.path, rev, opts...)
-}
-
 // MoveOptions contains optional arguments for moving a file, a directory, or a
 // symlink.
 //
@@ -377,28 +346,17 @@ type MoveOptions struct {
 }
 
 // Move moves a file, a directory, or a symlink file or directory from source to
-// destination for the repository in given path.
-func Move(repoPath, src, dst string, opts ...MoveOptions) error {
+// destination for the repository.
+func (r *Repository) Move(src, dst string, opts ...MoveOptions) error {
 	var opt MoveOptions
 	if len(opts) > 0 {
 		opt = opts[0]
 	}
 
-	_, err := NewCommand("mv").AddOptions(opt.CommandOptions).AddArgs("--end-of-options", src, dst).RunInDirWithTimeout(opt.Timeout, repoPath)
+	_, err := NewCommand("mv").AddOptions(opt.CommandOptions).AddArgs("--end-of-options", src, dst).RunInDirWithTimeout(opt.Timeout, r.path)
 	return err
 }
 
-// Deprecated: Use Move instead.
-func RepoMove(repoPath, src, dst string, opts ...MoveOptions) error {
-	return Move(repoPath, src, dst, opts...)
-}
-
-// Move moves a file, a directory, or a symlink file or directory from source to
-// destination for the repository.
-func (r *Repository) Move(src, dst string, opts ...MoveOptions) error {
-	return Move(r.path, src, dst, opts...)
-}
-
 // AddOptions contains optional arguments for adding local changes.
 //
 // Docs: https://git-scm.com/docs/git-add
@@ -416,8 +374,8 @@ type AddOptions struct {
 	CommandOptions
 }
 
-// Add adds local changes to index for the repository in given path.
-func Add(repoPath string, opts ...AddOptions) error {
+// Add adds local changes to index for the repository.
+func (r *Repository) Add(opts ...AddOptions) error {
 	var opt AddOptions
 	if len(opts) > 0 {
 		opt = opts[0]
@@ -431,20 +389,10 @@ func Add(repoPath string, opts ...AddOptions) error {
 		cmd.AddArgs("--")
 		cmd.AddArgs(opt.Pathspecs...)
 	}
-	_, err := cmd.RunInDirWithTimeout(opt.Timeout, repoPath)
+	_, err := cmd.RunInDirWithTimeout(opt.Timeout, r.path)
 	return err
 }
 
-// Deprecated: Use Add instead.
-func RepoAdd(repoPath string, opts ...AddOptions) error {
-	return Add(repoPath, opts...)
-}
-
-// Add adds local changes to index for the repository.
-func (r *Repository) Add(opts ...AddOptions) error {
-	return Add(r.path, opts...)
-}
-
 // CommitOptions contains optional arguments to commit changes.
 //
 // Docs: https://git-scm.com/docs/git-commit
@@ -460,9 +408,9 @@ type CommitOptions struct {
 	CommandOptions
 }
 
-// CreateCommit commits local changes with given author, committer and message
-// for the repository in given path.
-func CreateCommit(repoPath string, committer *Signature, message string, opts ...CommitOptions) error {
+// Commit commits local changes with given author, committer and message for the
+// repository.
+func (r *Repository) Commit(committer *Signature, message string, opts ...CommitOptions) error {
 	var opt CommitOptions
 	if len(opts) > 0 {
 		opt = opts[0]
@@ -478,25 +426,14 @@ func CreateCommit(repoPath string, committer *Signature, message string, opts ..
 		AddArgs("-m", message).
 		AddOptions(opt.CommandOptions)
 
-	_, err := cmd.RunInDirWithTimeout(opt.Timeout, repoPath)
+	_, err := cmd.RunInDirWithTimeout(opt.Timeout, r.path)
 	// No stderr but exit status 1 means nothing to commit.
 	if err != nil && err.Error() == "exit status 1" {
 		return nil
 	}
 	return err
 }
 
-// Deprecated: Use CreateCommit instead.
-func RepoCommit(repoPath string, committer *Signature, message string, opts ...CommitOptions) error {
-	return CreateCommit(repoPath, committer, message, opts...)
-}
-
-// Commit commits local changes with given author, committer and message for the
-// repository.
-func (r *Repository) Commit(committer *Signature, message string, opts ...CommitOptions) error {
-	return CreateCommit(r.path, committer, message, opts...)
-}
-
 // NameStatus contains name status of a commit.
 type NameStatus struct {
 	Added    []string
@@ -517,9 +454,8 @@ type ShowNameStatusOptions struct {
 	CommandOptions
 }
 
-// ShowNameStatus returns name status of given revision of the repository in
-// given path.
-func ShowNameStatus(repoPath, rev string, opts ...ShowNameStatusOptions) (*NameStatus, error) {
+// ShowNameStatus returns name status of given revision of the repository.
+func (r *Repository) ShowNameStatus(rev string, opts ...ShowNameStatusOptions) (*NameStatus, error) {
 	var opt ShowNameStatusOptions
 	if len(opts) > 0 {
 		opt = opts[0]
@@ -552,7 +488,7 @@ func ShowNameStatus(repoPath, rev string, opts ...ShowNameStatusOptions) (*NameS
 	cmd := NewCommand("show", "--name-status", "--pretty=format:''").
 		AddOptions(opt.CommandOptions).
 		AddArgs("--end-of-options", rev)
-	err := cmd.RunInDirPipelineWithTimeout(opt.Timeout, w, stderr, repoPath)
+	err := cmd.RunInDirPipelineWithTimeout(opt.Timeout, w, stderr, r.path)
 	_ = w.Close() // Close writer to exit parsing goroutine
 	if err != nil {
 		return nil, concatenateError(err, stderr.String())
@@ -562,16 +498,6 @@ func ShowNameStatus(repoPath, rev string, opts ...ShowNameStatusOptions) (*NameS
 	return fileStatus, nil
 }
 
-// Deprecated: Use ShowNameStatus instead.
-func RepoShowNameStatus(repoPath, rev string, opts ...ShowNameStatusOptions) (*NameStatus, error) {
-	return ShowNameStatus(repoPath, rev, opts...)
-}
-
-// ShowNameStatus returns name status of given revision of the repository.
-func (r *Repository) ShowNameStatus(rev string, opts ...ShowNameStatusOptions) (*NameStatus, error) {
-	return ShowNameStatus(r.path, rev, opts...)
-}
-
 // RevParseOptions contains optional arguments for parsing revision.
 //
 // Docs: https://git-scm.com/docs/git-rev-parse
@@ -631,16 +557,16 @@ type CountObjectsOptions struct {
 	CommandOptions
 }
 
-// CountObjects returns disk usage report of the repository in given path.
-func CountObjects(repoPath string, opts ...CountObjectsOptions) (*CountObject, error) {
+// CountObjects returns disk usage report of the repository.
+func (r *Repository) CountObjects(opts ...CountObjectsOptions) (*CountObject, error) {
 	var opt CountObjectsOptions
 	if len(opts) > 0 {
 		opt = opts[0]
 	}
 
 	stdout, err := NewCommand("count-objects", "-v").
 		AddOptions(opt.CommandOptions).
-		RunInDirWithTimeout(opt.Timeout, repoPath)
+		RunInDirWithTimeout(opt.Timeout, r.path)
 	if err != nil {
 		return nil, err
 	}
@@ -675,16 +601,6 @@ func CountObjects(repoPath string, opts ...CountObjectsOptions) (*CountObject, e
 	return countObject, nil
 }
 
-// Deprecated: Use CountObjects instead.
-func RepoCountObjects(repoPath string, opts ...CountObjectsOptions) (*CountObject, error) {
-	return CountObjects(repoPath, opts...)
-}
-
-// CountObjects returns disk usage report of the repository.
-func (r *Repository) CountObjects(opts ...CountObjectsOptions) (*CountObject, error) {
-	return CountObjects(r.path, opts...)
-}
-
 // FsckOptions contains optional arguments for verifying the objects.
 //
 // Docs: https://git-scm.com/docs/git-fsck
@@ -699,25 +615,14 @@ type FsckOptions struct {
 }
 
 // Fsck verifies the connectivity and validity of the objects in the database
-// for the repository in given path.
-func Fsck(repoPath string, opts ...FsckOptions) error {
+// for the repository.
+func (r *Repository) Fsck(opts ...FsckOptions) error {
 	var opt FsckOptions
 	if len(opts) > 0 {
 		opt = opts[0]
 	}
 
 	cmd := NewCommand("fsck").AddOptions(opt.CommandOptions)
-	_, err := cmd.RunInDirWithTimeout(opt.Timeout, repoPath)
+	_, err := cmd.RunInDirWithTimeout(opt.Timeout, r.path)
 	return err
 }
-
-// Deprecated: Use Fsck instead.
-func RepoFsck(repoPath string, opts ...FsckOptions) error {
-	return Fsck(repoPath, opts...)
-}
-
-// Fsck verifies the connectivity and validity of the objects in the database
-// for the repository.
-func (r *Repository) Fsck(opts ...FsckOptions) error {
-	return Fsck(r.path, opts...)
-}

repo_commit.go

@@ -7,7 +7,6 @@ package git
 import (
 	"bytes"
 	"errors"
-	"fmt"
 	"strconv"
 	"strings"
 	"time"
@@ -194,23 +193,6 @@ func escapePath(path string) string {
 	return path
 }
 
-// Log returns a list of commits in the state of given revision of the
-// repository in given path. The returned list is in reverse chronological
-// order.
-func Log(repoPath, rev string, opts ...LogOptions) ([]*Commit, error) {
-	r, err := Open(repoPath)
-	if err != nil {
-		return nil, fmt.Errorf("open: %v", err)
-	}
-
-	return r.Log(rev, opts...)
-}
-
-// Deprecated: Use Log instead.
-func RepoLog(repoPath, rev string, opts ...LogOptions) ([]*Commit, error) {
-	return Log(repoPath, rev, opts...)
-}
-
 // Log returns a list of commits in the state of given revision of the repository.
 // The returned list is in reverse chronological order.
 func (r *Repository) Log(rev string, opts ...LogOptions) ([]*Commit, error) {
@@ -395,9 +377,9 @@ type DiffNameOnlyOptions struct {
 	CommandOptions
 }
 
-// DiffNameOnly returns a list of changed files between base and head revisions
-// of the repository in given path.
-func DiffNameOnly(repoPath, base, head string, opts ...DiffNameOnlyOptions) ([]string, error) {
+// DiffNameOnly returns a list of changed files between base and head revisions of the
+// repository.
+func (r *Repository) DiffNameOnly(base, head string, opts ...DiffNameOnlyOptions) ([]string, error) {
 	var opt DiffNameOnlyOptions
 	if len(opts) > 0 {
 		opt = opts[0]
@@ -417,7 +399,7 @@ func DiffNameOnly(repoPath, base, head string, opts ...DiffNameOnlyOptions) ([]s
 		cmd.AddArgs(escapePath(opt.Path))
 	}
 
-	stdout, err := cmd.RunInDirWithTimeout(opt.Timeout, repoPath)
+	stdout, err := cmd.RunInDirWithTimeout(opt.Timeout, r.path)
 	if err != nil {
 		return nil, err
 	}
@@ -434,17 +416,6 @@ func DiffNameOnly(repoPath, base, head string, opts ...DiffNameOnlyOptions) ([]s
 	return names, nil
 }
 
-// Deprecated: Use DiffNameOnly instead.
-func RepoDiffNameOnly(repoPath, base, head string, opts ...DiffNameOnlyOptions) ([]string, error) {
-	return DiffNameOnly(repoPath, base, head, opts...)
-}
-
-// DiffNameOnly returns a list of changed files between base and head revisions of the
-// repository.
-func (r *Repository) DiffNameOnly(base, head string, opts ...DiffNameOnlyOptions) ([]string, error) {
-	return DiffNameOnly(r.path, base, head, opts...)
-}
-
 // RevListCountOptions contains optional arguments for counting commits.
 //
 // Docs: https://git-scm.com/docs/git-rev-list#Documentation/git-rev-list.txt---count

repo_commit_test.go

@@ -117,13 +117,6 @@ func TestRepository_Log(t *testing.T) {
 			}
 
 			assert.Equal(t, test.expCommitIDs, commitsToIDs(commits))
-
-			commits, err = Log(testrepo.path, test.rev, test.opt)
-			if err != nil {
-				t.Fatal(err)
-			}
-
-			assert.Equal(t, test.expCommitIDs, commitsToIDs(commits))
 		})
 	}
 }