Merge pull request #1 from outillage/migration

fallion · web-flow · commit ada61301c2d2 · 2019-12-04T15:32:16.000+01:00
feat: migrate over files from release-notary
diff --git a/commit.go b/commit.go
@@ -0,0 +1,20 @@
+package quoad
+
+import "encoding/hex"
+
+// Commit is a parsed commit that contains information about category, scope and heading
+type Commit struct {
+	Category string
+	Heading  string
+	Body     string
+	Scope    string
+	Hash     Hash
+	Issues   []int
+}
+
+// Hash describes a commit hash
+type Hash [20]byte
+
+func (h Hash) String() string {
+	return hex.EncodeToString(h[:])
+}
diff --git a/go.mod b/go.mod
@@ -1,3 +1,5 @@
 module github.com/outillage/quoad
 
 go 1.13
+
+require github.com/stretchr/testify v1.4.0
diff --git a/go.sum b/go.sum
@@ -0,0 +1,11 @@
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
+github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
diff --git a/main.go b/main.go
diff --git a/parse_commit.go b/parse_commit.go
@@ -0,0 +1,64 @@
+package quoad
+
+import (
+	"fmt"
+	"regexp"
+	"strconv"
+	"strings"
+)
+
+var (
+	referenceFormatRegex   = regexp.MustCompile(`Refs:?[^\r\n]*`)
+	referenceIDFormatRegex = regexp.MustCompile(`\#([0-9]+)`)
+	expectedFormatRegex    = regexp.MustCompile(`(?s)^(?P<category>\S+?)?(?P<scope>\(\S+\))?(?P<breaking>!?)?: (?P<heading>[^\n\r]+)?([\n\r]{2}(?P<body>.*))?`)
+)
+
+// GetIssueNumbers converts the matches from the reference regular expression to integers
+func GetIssueNumbers(matches []string) []int {
+	var issueNumbers []int
+	for _, match := range matches {
+		for _, refID := range referenceIDFormatRegex.FindAllStringSubmatch(match, -1) {
+			issueNumber, err := strconv.Atoi(refID[1])
+
+			if err != nil {
+				fmt.Println("couldn't convert reference ID to number")
+				continue
+			}
+
+			issueNumbers = append(issueNumbers, issueNumber)
+		}
+	}
+
+	return issueNumbers
+}
+
+// ParseCommitMessage creates a slice of Commits that contain information about category and scope parsed from commit message
+func ParseCommitMessage(commitMessage string) Commit {
+	references := referenceFormatRegex.FindAllString(commitMessage, -1)
+
+	commitMessage = referenceFormatRegex.ReplaceAllString(commitMessage, "")
+
+	match := expectedFormatRegex.FindStringSubmatch(commitMessage)
+
+	if len(match) > 0 {
+		result := make(map[string]string)
+
+		for i, name := range expectedFormatRegex.SubexpNames() {
+			if i != 0 && name != "" {
+				result[name] = match[i]
+			}
+		}
+
+		category := result["category"]
+		scope := result["scope"]
+		heading := result["heading"]
+		body := result["body"]
+
+		scope = strings.Replace(scope, "(", "", 1)
+		scope = strings.Replace(scope, ")", "", 1)
+
+		return Commit{Category: category, Heading: heading, Scope: scope, Body: strings.TrimRight(body, "\r\n\t "), Issues: GetIssueNumbers(references)}
+	}
+
+	return Commit{Category: "other", Heading: commitMessage, Scope: ""}
+}
diff --git a/parse_commit_test.go b/parse_commit_test.go
@@ -0,0 +1,28 @@
+package quoad
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestParseCommitMessage(t *testing.T) {
+
+	tests := map[string]Commit{
+		"chore: testing\n":                                         Commit{Category: "chore", Scope: "", Heading: "testing"},
+		"feat(ci): ci test\n":                                      Commit{Category: "feat", Scope: "ci", Heading: "ci test"},
+		"merge master in something\n":                              Commit{Category: "other", Scope: "", Heading: "merge master in something\n"},
+		"chore: test\n\nsomething more here":                       Commit{Category: "chore", Scope: "", Heading: "test", Body: "something more here"},
+		"chore: test\n\nsomething more here\nRefs: #12":            Commit{Category: "chore", Scope: "", Heading: "test", Body: "something more here", Issues: []int{12}},
+		"chore: test\n\nsomething more here\n\tRefs: #12":          Commit{Category: "chore", Scope: "", Heading: "test", Body: "something more here", Issues: []int{12}},
+		"chore: test\n\nsomething more here\n\t Refs: #12":         Commit{Category: "chore", Scope: "", Heading: "test", Body: "something more here", Issues: []int{12}},
+		"chore: test\n\nsomething more here\nRefs: #12\nRefs: #13": Commit{Category: "chore", Scope: "", Heading: "test", Body: "something more here", Issues: []int{12, 13}},
+		"chore: test\n\nsomething more here\nRefs: #12, #13":       Commit{Category: "chore", Scope: "", Heading: "test", Body: "something more here", Issues: []int{12, 13}},
+		"chore: test\n\nsomething more here\nRefs: #12 and #13":    Commit{Category: "chore", Scope: "", Heading: "test", Body: "something more here", Issues: []int{12, 13}},
+	}
+
+	for test, expected := range tests {
+		err := ParseCommitMessage(test)
+		assert.Equal(t, expected, err)
+	}
+}
