TIL-28 Properly parse the commit message

Closes #28

Signed-off-by: Chris Cummer <[email protected]>

Author: senorprogrammer

til.go

@@ -25,6 +25,8 @@ const (
 	tilConfigDir  = "~/.config/til/"
 	tilConfigFile = "config.yml"
 
+	defaultCommitMsg = "build, save, push"
+
 	defaultConfig = `--- 
 commitMessage: "build, save, push"
 committerEmail: [email protected]
@@ -124,7 +126,7 @@ func main() {
 	}
 
 	if saveFlag {
-		commitMsg := strings.Join(os.Args[2:], " ")
+		commitMsg := determineCommitMessage(globalConfig, os.Args)
 
 		buildContent()
 		save(commitMsg)
@@ -528,6 +530,24 @@ func createNewPage(title string) string {
 	return filePath
 }
 
+// determineCommitMessage figures out which commit message to save the repo with
+// The order of precedence is:
+//	* message passed in via the -s flag
+//	* message defined in config.yml for the commitMessage key
+//	* message as a hard-coded constant, at top, in defaultCommitMsg
+// Example:
+//  > til -t b -s this is message
+func determineCommitMessage(cfg *config.Config, args []string) string {
+	if flag.NArg() == 0 {
+		return cfg.UString("commitMessage", defaultCommitMsg)
+	}
+
+	msgOffset := len(args) - flag.NArg()
+	msg := strings.Join(args[msgOffset:], " ")
+
+	return msg
+}
+
 // listTargetDirectories writes the list of target directories in the configuration
 // out to the terminal
 func listTargetDirectories(cfg *config.Config) {
@@ -664,19 +684,18 @@ func save(commitMsg string) {
 		Defeat(err)
 	}
 
-	defaultCommitMsg, err1 := globalConfig.String("commitMessage")
 	defaultCommitEmail, err2 := globalConfig.String("committerEmail")
 	defaultCommitName, err3 := globalConfig.String("committerName")
-	if err1 != nil || err2 != nil || err3 != nil {
+	if err2 != nil || err3 != nil {
 		Defeat(errors.New(errConfigValueRead))
 	}
 
-	if commitMsg == "" {
-		// The incoming commitMsg is optional (if it is set, it probably came in
-		// via command line args on -save). If it isn't set, we use the default
-		// from the config file instead
-		commitMsg = defaultCommitMsg
-	}
+	// if commitMsg == "" {
+	// 	// The incoming commitMsg is optional (if it is set, it probably came in
+	// 	// via command line args on -save). If it isn't set, we use the default
+	// 	// from the config file instead
+	// 	commitMsg = defaultCommitMsg
+	// }
 
 	commit, err := w.Commit(commitMsg, &git.CommitOptions{
 		Author: &object.Signature{

til_test.go

@@ -1,11 +1,57 @@
 package main
 
 import (
+	"flag"
+	"fmt"
+	"os"
 	"testing"
 
+	"github.com/olebedev/config"
 	"github.com/stretchr/testify/assert"
 )
 
+func Test_determineCommitMessage(t *testing.T) {
+	tests := []struct {
+		name       string
+		cfgMessage string
+		args       []string
+		expected   string
+	}{
+		{
+			name:       "passed in via -s",
+			cfgMessage: "from the config",
+			args:       []string{"test", "-t", "b", "-s", "this", "is", "test"},
+			expected:   "this is test",
+		},
+		{
+			name:       "from config file",
+			cfgMessage: "from the config",
+			args:       []string{"test", "-t", "b", "-s"},
+			expected:   "from the config",
+		},
+		{
+			name:       "from default const",
+			cfgMessage: "",
+			args:       []string{"test", "-t", "b", "-s"},
+			expected:   "build, save, push",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			os.Args = tt.args
+			flag.Parse()
+
+			msg := fmt.Sprintf("commitMessage: %s", tt.cfgMessage)
+			cfg, _ := config.ParseYamlBytes([]byte(msg))
+
+			actual := determineCommitMessage(cfg, os.Args)
+
+			assert.Equal(t, tt.expected, actual)
+		})
+	}
+}
+
 /* -------------------- Configuration -------------------- */
 
 func Test_getConfigPath(t *testing.T) {