close #258 clean deprecated code and fix cmd docs

Author: groenborg

cmd/cleanup.go

@@ -4,10 +4,8 @@ import (
 	"fmt"
 
 	"github.com/praqma/git-phlow/cmd/cmdperm"
-	"github.com/praqma/git-phlow/githandler"
 	"github.com/praqma/git-phlow/options"
 	"github.com/praqma/git-phlow/phlow"
-	"github.com/praqma/git-phlow/plugins"
 	"github.com/praqma/git-phlow/ui"
 	"github.com/spf13/cobra"
 )
@@ -24,10 +22,7 @@ It deletes safely by running 'git branch -d'. By default, both local and remote
 		cmdperm.RequiredCurDirRepository()
 	},
 	Run: func(cmd *cobra.Command, args []string) {
-		defaultBranch, _ := plugins.GitHub.Default()
-		remote := githandler.ConfigBranchRemote(defaultBranch)
-
-		phlow.Clean(remote)
+		phlow.CleanCaller(options.GlobalFlagTarget)
 	},
 }
 
@@ -40,4 +35,6 @@ func init() {
 	//Run clean forcefully
 	cleanCmd.Flags().BoolVarP(&options.GlobalFlagForce, "force", "f", false, "force remove delivered branches")
 
+	cleanCmd.Flags().StringVarP(&options.GlobalFlagTarget, "target", "t", "", "the name of the INI block in .gitconfig")
+
 }

cmd/deliver.go

@@ -11,7 +11,7 @@ import (
 
 // deliverCmd represents the deliver command
 var deliverCmd = &cobra.Command{
-	Use:   "deliver [test args]",
+	Use:   "deliver [args]",
 	Short: "deliver changes to remote master",
 	Long: fmt.Sprintf(`
 %s pushes your committed changes to the remote repository.

cmd/root.go

@@ -16,6 +16,9 @@ var RootCmd = &cobra.Command{
 	Long: fmt.Sprintf(`
 %s is a git extension that provides an extra set of commands, enabling you to:
 create, work on and deliver tasks.
+
+USAGE: git phlow COMMAND
+
 `, ui.Format.Bold("git-phlow")),
 	Run: func(cmd *cobra.Command, args []string) {
 		if options.GlobalFlagVersion != false {

cmd/upnext.go

@@ -5,10 +5,8 @@ import (
 	"os"
 
 	"github.com/praqma/git-phlow/cmd/cmdperm"
-	"github.com/praqma/git-phlow/githandler"
 	"github.com/praqma/git-phlow/options"
 	"github.com/praqma/git-phlow/phlow"
-	"github.com/praqma/git-phlow/plugins"
 	"github.com/praqma/git-phlow/ui"
 	"github.com/spf13/cobra"
 )
@@ -27,10 +25,7 @@ When no --prefix flag is set, the default prefix is 'ready/'.
 	},
 	Run: func(cmd *cobra.Command, args []string) {
 
-		defaultBranch, _ := plugins.GitHub.Default()
-		remote := githandler.ConfigBranchRemote(defaultBranch)
-
-		next := phlow.UpNext(remote, options.GlobalFlagPrefixForReady)
+		next := phlow.UpNext(options.GlobalFlagPrefixForReady)
 		fmt.Fprint(os.Stdout, next)
 	},
 }

cmd/workon.go

@@ -12,11 +12,12 @@ import (
 
 // workonCmd represents the workon command
 var workonCmd = &cobra.Command{
-	Use:   "workon [issue number]",
+	Use:   "workon [issue]",
 	Short: "create or change to an issue branch",
 	Long: fmt.Sprintf(`
-%s creates a new branch from an issue number fetched from GitHub.
+%s creates a new branch from an issue.
 A new branch will be created, based on your remote default branch and named after the issue title, e.g. "42-calculate-meaning-of-life".
+Workon can fetch issues from GitHub and Jira
 `, ui.Format.Bold("workon")),
 	PreRun: func(cmd *cobra.Command, args []string) {
 		cmdperm.RequiredCurDirRepository()

cmd/wrapup.go

@@ -14,7 +14,9 @@ var wrapupCmd = &cobra.Command{
 	Use:   "wrapup",
 	Short: "Add changes to index and auto commit",
 	Long: fmt.Sprintf(`
-%s adds the files in the workin directory to the index and makes a commit. The commit message is autogenerated and contains 'close issue', e.g. "close #42 fetch meaning of life". The issue number is fetched from the branch name, if the workon command have been used. When force is used on the message, the message will replace, the otherwice automatically generated commit message.
+%s adds the files in the workin directory to the index and makes a commit.
+The commit message generated from the branch name and prepends a smart commit function to close the issue.
+The smart commit work with GitHub and Jira.
 `, ui.Format.Bold("wrapup")),
 	PreRun: func(cmd *cobra.Command, args []string) {
 		cmdperm.RequiredCurDirRepository()

executor/executor.go

@@ -19,22 +19,6 @@ func verboseOutput(argv ...string) {
 	fmt.Println()
 }
 
-//Commander ...
-//interface for os executions
-type Commander interface {
-	Run() error
-}
-
-//ExecuteCommander ...
-//Run a function with control over stdout and stdin
-func ExecuteCommander(c Commander) error {
-	err := c.Run()
-	if err != nil {
-		return err
-	}
-	return nil
-}
-
 //Runner ...
 //Runner type for git executions
 type Runner func(command string, argv ...string) (string, error)

githandler/branch.go

@@ -57,13 +57,7 @@ func Ready(info *BranchInfo, remote string, prefix string) (remoteBranches []str
 	return
 }
 
-//DEPRECETED SECTION - USE GIT
-//BranchRename ...
-func BranchRename(name string) error {
-	_, err := executor.RunCommand("git", "branch", "-m", name, "delivered/"+name)
-	return err
-}
-
+//Deprecated
 //BranchTime ...
 func BranchTime(name string) (int, error) {
 	output, err := executor.RunCommand("git", "log", "-n 1", name, "--format=format:%ct")

githandler/remote.go

@@ -3,8 +3,6 @@ package githandler
 import (
 	"strings"
 	"regexp"
-	"fmt"
-	"github.com/praqma/git-phlow/executor"
 )
 
 //RemoteInfo ...
@@ -34,46 +32,3 @@ func OrgAndRepo(url string) *RemoteInfo {
 	//Clone from local repo
 	return &RemoteInfo{}
 }
-
-
-// -------------------------------- DEPRECATED SECTION ---------------------------------------------------
-//Remote
-//Deprecated
-func Remote() (*RemoteInfo, error) {
-	var res string
-	var err error
-	if res, err = executor.RunCommand("git", "ls-remote", "--get-url", "origin"); err != nil {
-		return nil, err
-	}
-	res = strings.Trim(res, "\n")
-	return remoteURLExtractor(res), nil
-}
-
-//Deprecated
-func remoteURLExtractor(url string) *RemoteInfo {
-	re := regexp.MustCompile(`.+:(\S+)\/(\S+)\.git`)
-
-	//Extracts repo and org from ssh url format
-	if strings.HasPrefix(url, "git@") {
-		match := re.FindStringSubmatch(url)
-		return &RemoteInfo{match[1], match[2]}
-	}
-	//Extracts repo and org from http url format
-	if strings.HasPrefix(url, "http") {
-		splitURL := strings.Split(strings.TrimSuffix(url, ".git"), "/")
-		org := splitURL[len(splitURL)-2]
-		repo := splitURL[len(splitURL)-1]
-		return &RemoteInfo{org, repo}
-	}
-
-	//Clone from local repo
-	return &RemoteInfo{}
-}
-
-//ConfigBranchRemote ... use setting.Project setting to get remote in stead
-//Deprecated
-func ConfigBranchRemote(branch string) string {
-	configArg := fmt.Sprintf("branch.%s.remote", branch)
-	output, _ := executor.RunCommand("git", "config", configArg)
-	return strings.Replace(output, "\n", "", -1)
-}

phlow/cleanup.go

@@ -10,10 +10,15 @@ import (
 	"github.com/praqma/git-phlow/setting"
 )
 
+//CleanCaller ...
+func CleanCaller(ini string) {
+	conf := setting.NewProjectStg(ini)
+	Clean(conf)
+}
+
 //Clean ...
-func Clean(remoteName string) {
+func Clean(conf *setting.ProjectSetting) {
 	git := githandler.Git{Run: executor.RunGit}
-	conf := setting.NewProjectStg("default")
 
 	out, err := git.Branch("-a")
 	if err != nil {