Merge pull request #19 from rm3l/allow_specifying_a_max_length_for_generated_branch_names

Author: rm3l

main.go

@@ -13,8 +13,10 @@ import (
 func main() {
 
 	var repo string
+	var maxLen int
 
 	flag.StringVar(&repo, "repo", "", "repository to use for finding the issue")
+	flag.IntVar(&maxLen, "max-length", -1, "max length of generated branch name")
 
 	flag.Usage = func() {
 		//goland:noinspection GoUnhandledErrorResult
@@ -44,7 +46,7 @@ func main() {
 		log.Fatalln(err)
 	}
 
-	branchName, err := branch.GenerateName(issueInfo.Id, issueInfo.Title)
+	branchName, err := branch.GenerateName(issueInfo.Id, issueInfo.Title, maxLen)
 	if err != nil {
 		log.Fatalln(err)
 	}

pkg/branch/branch.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"regexp"
 	"strings"
+	"unicode/utf8"
 )
 
 const _replacementCharacter = "-"
@@ -14,7 +15,7 @@ var _regexp = regexp.MustCompile("[^A-Za-z0-9.]+")
 // GenerateName generates a new branch name off of the identifier and title specified.
 // Both the identifier and title must not be blank.
 // Leading hyphens (prefix and suffix) are removed from the name returned.
-func GenerateName(id string, title string) (string, error) {
+func GenerateName(id string, title string, maxLen int) (string, error) {
 	if id == "" || strings.TrimSpace(id) == "" {
 		return "", errors.New("id must not be blank")
 	}
@@ -29,5 +30,13 @@ func GenerateName(id string, title string) (string, error) {
 		_regexp.ReplaceAllString(
 			fmt.Sprintf("%s-%s", id, titleWithoutDotSuffix),
 			_replacementCharacter))
-	return strings.TrimPrefix(strings.TrimSuffix(generatedName, _replacementCharacter), _replacementCharacter), nil
+	generatedName = strings.TrimSuffix(generatedName, _replacementCharacter)
+	generatedName = strings.TrimPrefix(generatedName, _replacementCharacter)
+	if maxLen <= 0 {
+		return generatedName, nil
+	}
+	if utf8.RuneCountInString(generatedName) < maxLen {
+		return generatedName, nil
+	}
+	return string([]rune(generatedName)[:maxLen]), nil
 }

pkg/branch/branch_test.go

@@ -8,11 +8,12 @@ import (
 
 func TestGenerateName(t *testing.T) {
 	type args struct {
-		id    string
-		title string
+		id     string
+		title  string
+		maxLen int
 	}
 	for _, tt := range []struct {
-		args
+		args args
 
 		name    string
 		wantErr bool
@@ -126,9 +127,39 @@ func TestGenerateName(t *testing.T) {
 			want:    "2345-this-is-an-improvement-suggestion",
 			wantErr: false,
 		},
+		{
+			name: "branch name should not exceed maxLen - negative max length",
+			args: args{
+				id:     "2345",
+				title:  "THIS IS AN IMPROVEMENT SUGGESTION :-) !!!",
+				maxLen: -10,
+			},
+			want:    "2345-this-is-an-improvement-suggestion",
+			wantErr: false,
+		},
+		{
+			name: "branch name should not exceed maxLen - zero max length",
+			args: args{
+				id:     "2345",
+				title:  "THIS IS AN IMPROVEMENT SUGGESTION :-) !!!",
+				maxLen: 0,
+			},
+			want:    "2345-this-is-an-improvement-suggestion",
+			wantErr: false,
+		},
+		{
+			name: "branch name should not exceed maxLen",
+			args: args{
+				id:     "2345",
+				title:  "THIS IS AN IMPROVEMENT SUGGESTION :-) !!!",
+				maxLen: 27,
+			},
+			want:    "2345-this-is-an-improvement",
+			wantErr: false,
+		},
 	} {
 		t.Run(tt.name, func(t *testing.T) {
-			got, err := GenerateName(tt.id, tt.title)
+			got, err := GenerateName(tt.args.id, tt.args.title, tt.args.maxLen)
 			if (err != nil) != tt.wantErr {
 				t.Errorf("got err: %v, but wanted err set to %v", err, tt.wantErr)
 			}