Add more test to branch.GenerateName

Author: rm3l

main.go

@@ -4,11 +4,9 @@ import (
 	"flag"
 	"fmt"
 	"github.com/rm3l/gh-dev-branch/pkg/branch"
+	"github.com/rm3l/gh-dev-branch/pkg/issue"
 	"log"
 	"os"
-	"strconv"
-
-	"github.com/rm3l/gh-dev-branch/pkg/issue"
 )
 
 func main() {
@@ -30,30 +28,22 @@ func main() {
 		os.Exit(1)
 	}
 
-	var issueNum int
 	iss := os.Args[1]
 	if iss == "-h" || iss == "-help" || iss == "--help" {
 		flag.Usage()
 		os.Exit(1)
 	} else {
-		var err error
-		issueNum, err = strconv.Atoi(iss)
-		if err != nil {
-			//goland:noinspection GoUnhandledErrorResult
-			fmt.Fprintln(os.Stderr, "issue must be a number")
-			os.Exit(1)
-		}
-
 		// Ignore errors since flag.CommandLine is set for ExitOnError.
 		_ = flag.CommandLine.Parse(os.Args[2:])
 	}
 
-	issueInfo, err := issue.Lookup(os.Stderr, repo, issueNum)
+	ghIssueFinder := issue.NewGHIssueFinder()
+	issueInfo, err := ghIssueFinder.FindById(os.Stderr, repo, iss)
 	if err != nil {
 		log.Fatalln(err)
 	}
 
-	branchName, err := branch.GenerateName(issueInfo.Number, issueInfo.Title)
+	branchName, err := branch.GenerateName(issueInfo.Id, issueInfo.Title)
 	if err != nil {
 		log.Fatalln(err)
 	}

pkg/branch/branch.go

@@ -11,9 +11,9 @@ const _replacementCharacter = "-"
 
 var _regexp = regexp.MustCompile("[^A-Za-z0-9.]+")
 
-func GenerateName(index int, title string) (string, error) {
-	if index <= 0 {
-		return "", fmt.Errorf("invalid negative or zero index: %d", index)
+func GenerateName(id string, title string) (string, error) {
+	if id == "" || strings.TrimSpace(id) == "" {
+		return "", errors.New("id must not be blank")
 	}
 	if title == "" || strings.TrimSpace(title) == "" {
 		return "", errors.New("title must not be blank")
@@ -24,7 +24,7 @@ func GenerateName(index int, title string) (string, error) {
 	}
 	generatedName := strings.ToLower(
 		_regexp.ReplaceAllString(
-			fmt.Sprintf("%d-%s", index, titleWithoutDotSuffix),
+			fmt.Sprintf("%s-%s", id, titleWithoutDotSuffix),
 			_replacementCharacter))
-	return strings.TrimSuffix(generatedName, _replacementCharacter), nil
+	return strings.TrimPrefix(strings.TrimSuffix(generatedName, _replacementCharacter), _replacementCharacter), nil
 }

pkg/branch/branch_test.go

@@ -7,7 +7,7 @@ import (
 
 func TestGenerateName(t *testing.T) {
 	type args struct {
-		num   int
+		id    string
 		title string
 	}
 	for _, tt := range []struct {
@@ -18,27 +18,45 @@ func TestGenerateName(t *testing.T) {
 		want    string
 	}{
 		{
-			name: "negative index",
+			name: "id empty",
 			args: args{
-				num:   -1,
+				id:    "",
 				title: "a-title",
 			},
 			want:    "",
 			wantErr: true,
 		},
 		{
-			name: "zero index",
+			name: "id blank",
 			args: args{
-				num:   0,
+				id:    "       ",
 				title: "a-title",
 			},
 			want:    "",
 			wantErr: true,
 		},
+		{
+			name: "id starting with an hyphen -",
+			args: args{
+				id:    "-1",
+				title: "a-title",
+			},
+			want:    "1-a-title",
+			wantErr: false,
+		},
+		{
+			name: "any other id",
+			args: args{
+				id:    "myId",
+				title: "a-title",
+			},
+			want:    "myid-a-title",
+			wantErr: false,
+		},
 		{
 			name: "empty title",
 			args: args{
-				num:   33,
+				id:    "33",
 				title: "",
 			},
 			want:    "",
@@ -47,7 +65,7 @@ func TestGenerateName(t *testing.T) {
 		{
 			name: "blank title",
 			args: args{
-				num:   33,
+				id:    "33",
 				title: "   ",
 			},
 			want:    "",
@@ -56,7 +74,7 @@ func TestGenerateName(t *testing.T) {
 		{
 			name: "dot title",
 			args: args{
-				num:   33,
+				id:    "33",
 				title: ".",
 			},
 			want:    "",
@@ -65,7 +83,7 @@ func TestGenerateName(t *testing.T) {
 		{
 			name: "branch name should not end with replacement if title already ends with it",
 			args: args{
-				num:   1,
+				id:    "1",
 				title: "-",
 			},
 			want:    "1",
@@ -74,7 +92,7 @@ func TestGenerateName(t *testing.T) {
 		{
 			name: "branch name should not end with replacement if title already ends with it",
 			args: args{
-				num:   1,
+				id:    "1",
 				title: "something-ending-with-hyphen-",
 			},
 			want:    "1-something-ending-with-hyphen",
@@ -83,7 +101,7 @@ func TestGenerateName(t *testing.T) {
 		{
 			name: "branch name should not have non-alphanumeric character",
 			args: args{
-				num:   777,
+				id:    "777",
 				title: "[Feature request] an awesome feature for `tool`",
 			},
 			want:    "777-feature-request-an-awesome-feature-for-tool",
@@ -92,7 +110,7 @@ func TestGenerateName(t *testing.T) {
 		{
 			name: "ending dot should be ignored",
 			args: args{
-				num:   1234,
+				id:    "1234",
 				title: "Bug when running something.",
 			},
 			want:    "1234-bug-when-running-something",
@@ -101,15 +119,15 @@ func TestGenerateName(t *testing.T) {
 		{
 			name: "branch name should be all lowercase",
 			args: args{
-				num:   2345,
+				id:    "2345",
 				title: "THIS IS AN IMPROVEMENT SUGGESTION :-) !!!",
 			},
 			want:    "2345-this-is-an-improvement-suggestion",
 			wantErr: false,
 		},
 	} {
 		t.Run(tt.name, func(t *testing.T) {
-			got, err := GenerateName(tt.num, tt.title)
+			got, err := GenerateName(tt.id, tt.title)
 			if (err != nil) != tt.wantErr {
 				t.Errorf("got err: %v, but wanted err set to %v", err, tt.wantErr)
 			}

pkg/issue/github.go

@@ -0,0 +1,41 @@
+package issue
+
+import (
+	"encoding/json"
+	"fmt"
+	"github.com/cli/go-gh"
+	"io"
+	"strconv"
+)
+
+type GHIssueFinder struct{}
+
+type _GhIssueInfo struct {
+	Number int    `json:"number"`
+	Title  string `json:"title"`
+}
+
+func NewGHIssueFinder() *GHIssueFinder {
+	return &GHIssueFinder{}
+}
+
+func (g GHIssueFinder) FindById(w io.Writer, repo string, id string) (Info, error) {
+	args := []string{"issue", "view", id, "--json", "number,title"}
+	if repo != "" {
+		args = append(args, "-R", repo)
+	}
+	var issueInfo _GhIssueInfo
+	stdOut, stdErr, err := gh.Exec(args...)
+	if err != nil {
+		return Info{}, err
+	}
+	if stdErrStr := stdErr.String(); stdErrStr != "" {
+		//goland:noinspection GoUnhandledErrorResult
+		fmt.Fprintln(w, stdErrStr)
+	}
+	err = json.Unmarshal(stdOut.Bytes(), &issueInfo)
+	return Info{
+		Id:    strconv.Itoa(issueInfo.Number),
+		Title: issueInfo.Title,
+	}, err
+}

pkg/issue/issue.go

@@ -1,32 +1,12 @@
 package issue
 
-import (
-	"encoding/json"
-	"fmt"
-	"github.com/cli/go-gh"
-	"io"
-	"strconv"
-)
+import "io"
 
 type Info struct {
-	Number int    `json:"number"`
-	Title  string `json:"title"`
+	Id    string
+	Title string
 }
 
-func Lookup(w io.Writer, repo string, issue int) (Info, error) {
-	args := []string{"issue", "view", strconv.Itoa(issue), "--json", "number,title"}
-	if repo != "" {
-		args = append(args, "-R", repo)
-	}
-	var issueInfo Info
-	stdOut, stdErr, err := gh.Exec(args...)
-	if err != nil {
-		return issueInfo, err
-	}
-	if stdErrStr := stdErr.String(); stdErrStr != "" {
-		//goland:noinspection GoUnhandledErrorResult
-		fmt.Fprintln(w, stdErrStr)
-	}
-	err = json.Unmarshal(stdOut.Bytes(), &issueInfo)
-	return issueInfo, err
+type Finder interface {
+	FindById(w io.Writer, repo string, issue string) (Info, error)
 }