Improve installation of executable

.github/workflows/binaries.yml

@@ -20,7 +20,7 @@ jobs:
         fetch-depth: 0
     - uses: "WyriHaximus/github-action-get-previous-tag@v1"
       id: previoustag
-    - uses: wangyoucao577/go-release-action@v1.34
+    - uses: wangyoucao577/go-release-action@v1.35
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
         goos: ${{ matrix.goos }}

.gitignore

@@ -1,2 +1,3 @@
 *cover.out
 .idea
+commit-message-check

README.md

@@ -4,28 +4,21 @@
 [![codecov](https://codecov.io/gh/rockstaedt/commit-message-check/branch/main/graph/badge.svg?token=VW245SMVP5)](https://codecov.io/gh/rockstaedt/commit-message-check)
 [![Latest tag](https://img.shields.io/github/v/tag/rockstaedt/commit-message-check)](https://github.com/rockstaedt/commit-message-check/releases)
 
-**Attention: Still under development.**
+**Attention: Still under development!**
 
 This is a commit message git hook to ensure that commit messages are not too 
 long.
 
 ## Installation
 
-Execute the command for your platform within the root folder of your git 
-project. This will download the latest release, puts it in the `./.git/hooks/`
-folder and makes it executable. See git documentation about hooks for 
+Execute the command within the root folder of your git 
+project. This will download the installation script that determines the OS and
+downloads the latest binary. Afterwards, the initialization is started and the 
+corresponding hook files are prepared. See git documentation about hooks for 
 further [reference](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks).
 
-### MacOS
-
-```shell
-curl -o .git/hooks/commit-msg  -L https://github.com/rockstaedt/commit-message-check/releases/download/v0.0.4/commit-message-check-v0.0.4-darwin-arm64 && chmod +x .git/hooks/commit-msg
-```
-
-### Linux
-
 ```shell
-curl -o .git/hooks/commit-msg -L https://github.com/rockstaedt/commit-message-check/releases/download/v0.0.4/commit-message-check-v0.0.4-linux-amd64 && chmod +x .git/hooks/commit-msg
+curl -o install.sh  -L https://raw.githubusercontent.com/rockstaedt/commit-message-check/main/install.sh && chmod +x ./install.sh && ./install.sh
 ```
 
 ## Usage

cmd/setup.go

@@ -0,0 +1,17 @@
+package cmd
+
+import (
+	"log"
+	"rockstaedt/commit-message-check/util"
+)
+
+func Setup(gitPath string) int {
+	err := util.WalkHookDirs(gitPath, util.CreateHook)
+	if err != nil {
+		log.Println("[ERROR]\t Could not create commit-msg script.")
+		return 1
+	}
+
+	log.Println("[SUCCESS]\t commit-message-check successfully installed.")
+	return 0
+}

cmd/setup_test.go

@@ -0,0 +1,55 @@
+package cmd
+
+import (
+	"bytes"
+	"fmt"
+	"github.com/stretchr/testify/assert"
+	"log"
+	"os"
+	"testing"
+)
+
+func TestSetup(t *testing.T) {
+	buffer := &bytes.Buffer{}
+	log.SetOutput(buffer)
+
+	t.Run("returns 0 and", func(t *testing.T) {
+
+		createDirs := func() string {
+			path := t.TempDir()
+			err := os.Mkdir(fmt.Sprintf("%s/hooks", path), os.ModePerm)
+			assert.Nil(t, err)
+
+			return path
+		}
+
+		t.Run("creates commit-msg script in hook folder", func(t *testing.T) {
+			path := createDirs()
+
+			status := Setup(path)
+
+			assert.Equal(t, 0, status)
+			assert.FileExists(t, fmt.Sprintf("%s/hooks/commit-msg", path))
+		})
+
+		t.Run("logs a success message", func(t *testing.T) {
+			buffer.Reset()
+			path := createDirs()
+
+			_ = Setup(path)
+
+			assert.Contains(t, buffer.String(), "[SUCCESS]\t commit-message-check successfully installed.")
+		})
+	})
+
+	t.Run("returns 1 when error at walking hooks and logs it", func(t *testing.T) {
+		errPath := t.TempDir()
+		err := os.Mkdir(fmt.Sprintf("%s/hooks", errPath), 0000)
+		assert.Nil(t, err)
+
+		status := Setup(errPath)
+
+		assert.Equal(t, 1, status)
+		assert.Contains(t, buffer.String(), "[ERROR]\t Could not create commit-msg script.")
+	})
+}

cmd/uninstall.go

@@ -0,0 +1,17 @@
+package cmd
+
+import (
+	"log"
+	"rockstaedt/commit-message-check/util"
+)
+
+func Uninstall(gitPath string) int {
+	err := util.WalkHookDirs(gitPath, util.DeleteHook)
+	if err != nil {
+		log.Println("[ERROR]\t Could not delete commit-msg hook.")
+		return 1
+	}
+
+	log.Println("[SUCCESS]\t commit-message-check successfully uninstalled.")
+	return 0
+}

cmd/uninstall_test.go

@@ -0,0 +1,63 @@
+package cmd
+
+import (
+	"bytes"
+	"fmt"
+	"github.com/stretchr/testify/assert"
+	"log"
+	"os"
+	"testing"
+)
+
+func TestUninstall(t *testing.T) {
+	buffer := &bytes.Buffer{}
+	log.SetOutput(buffer)
+
+	createDirs := func() string {
+		path := t.TempDir()
+		err := os.Mkdir(fmt.Sprintf("%s/hooks", path), os.ModePerm)
+		assert.Nil(t, err)
+		_, err = os.Create(fmt.Sprintf("%s/hooks/commit-msg", path))
+		assert.Nil(t, err)
+		err = os.Mkdir(fmt.Sprintf("%s/xyz", path), os.ModePerm)
+		assert.Nil(t, err)
+		_, err = os.Create(fmt.Sprintf("%s/xyz/commit-msg", path))
+		assert.Nil(t, err)
+
+		return path
+	}
+
+	t.Run("returns 0 and", func(t *testing.T) {
+
+		t.Run("removes all occurrences of commit-msg", func(t *testing.T) {
+			path := createDirs()
+
+			status := Uninstall(path)
+
+			assert.Equal(t, 0, status)
+			assert.NoFileExists(t, fmt.Sprintf("%s/hooks/commit-msg", path))
+			assert.FileExists(t, fmt.Sprintf("%s/xyz/commit-msg", path))
+		})
+
+		t.Run("logs a success message", func(t *testing.T) {
+			buffer.Reset()
+			path := createDirs()
+
+			_ = Uninstall(path)
+
+			assert.Contains(t, buffer.String(), "[SUCCESS]\t commit-message-check successfully uninstalled.")
+		})
+	})
+
+	t.Run("returns 1 on any error", func(t *testing.T) {
+		buffer.Reset()
+		errPath := t.TempDir()
+		err := os.Mkdir(fmt.Sprintf("%s/hooks", errPath), 0000)
+		assert.Nil(t, err)
+
+		status := Uninstall(errPath)
+
+		assert.Equal(t, 1, status)
+		assert.Contains(t, buffer.String(), "[ERROR]\t Could not delete commit-msg hook.")
+	})
+}

cmd/validate.go

@@ -0,0 +1,32 @@
+package cmd
+
+import (
+	"log"
+	"rockstaedt/commit-message-check/internal/model"
+)
+
+const (
+	softLimit = 50
+	hardLimit = 72
+)
+
+func Validate(commitLines []string) int {
+	log.Println("[INFO]\t Validate commit message.")
+
+	cm := model.CreateCommitMessageFrom(commitLines)
+
+	numOfExceedingChars := cm.ValidateSubject()
+	if numOfExceedingChars == 0 {
+		log.Println("[SUCCESS]\t Valid commit message.")
+		return 0
+	}
+
+	if numOfExceedingChars > (hardLimit - softLimit) {
+		log.Println("[ERROR]\t Abort commit. Subject line too long. Please fix.")
+		return 1
+	}
+
+	log.Printf("[WARN]\t Your subject exceeds the soft limit of 50 chars by %d chars.", numOfExceedingChars)
+
+	return 0
+}

cmd/validate_test.go

@@ -0,0 +1,44 @@
+package cmd
+
+import (
+	"bytes"
+	"github.com/stretchr/testify/assert"
+	"log"
+	"testing"
+)
+
+func TestValidate(t *testing.T) {
+	buffer := &bytes.Buffer{}
+	log.SetOutput(buffer)
+
+	t.Run("returns 0 if valid and logs a success", func(t *testing.T) {
+		buffer.Reset()
+		commitLines := []string{"i am shorter than 50 characters"}
+
+		status := Validate(commitLines)
+
+		assert.Equal(t, status, 0)
+		assert.Contains(t, buffer.String(), "[INFO]\t Validate commit message.")
+		assert.Contains(t, buffer.String(), "[SUCCESS]\t Valid commit message")
+	})
+
+	t.Run("returns 0 if soft limit exceeds and logs a warning", func(t *testing.T) {
+		buffer.Reset()
+		commitLines := []string{"i am two characters more thaaaaaaaaaaaaaaaaaaaaan 50"}
+
+		status := Validate(commitLines)
+
+		assert.Equal(t, status, 0)
+		assert.Contains(t, buffer.String(), "[WARN]\t Your subject exceeds the soft limit of 50 chars by 2 chars.")
+	})
+
+	t.Run("returns 1 if length > 70 and logs an error", func(t *testing.T) {
+		buffer.Reset()
+		commitLines := []string{"i am way toooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo long"}
+
+		status := Validate(commitLines)
+
+		assert.Equal(t, status, 1)
+		assert.Contains(t, buffer.String(), "[ERROR]\t Abort commit. Subject line too long. Please fix.")
+	})
+}

install.sh

@@ -0,0 +1,31 @@
+#!/bin/sh
+
+version=$(curl --silent "https://api.github.com/repos/rockstaedt/commit-message-check/releases/latest" |
+    grep '"tag_name":' |
+    sed -E 's/.*"([^"]+)".*/\1/')
+
+echo "-> Installing commit-message-check ${version}"
+
+if [[ "$OSTYPE" == "linux-gnu"* ]]; then
+  os="linux"
+elif [[ "$OSTYPE" == "darwin"* ]]; then
+  os="darwin"
+else
+  echo "ERROR - Could not determine operating system. Please download binary manually."
+  exit
+fi
+
+os="${os}-$(uname -m)"
+binary="commit-message-check-${version}-${os}"
+url="https://github.com/rockstaedt/commit-message-check/releases/latest/download/${binary}"
+
+curl -o commit-message-check -L $url && chmod +x ./commit-message-check
+
+if !(grep -Fxq "commit-message-check" .gitignore); then
+  read -e -p "Do you want to add the binary to gitignore? (y/n) " choice
+  [[ "$choice" == [Yy]* ]] && echo 'commit-message-check'>>.gitignore
+fi
+
+./commit-message-check setup
+
+rm ./install.sh

src/commit-message.go → internal/model/commit_message.go

@@ -1,4 +1,4 @@
-package src
+package model
 
 import (
 	"regexp"
@@ -10,12 +10,12 @@ type CommitMessage struct {
 	InvalidBody bool
 }
 
-func CreateCommitMessageFrom(messageLines []string) (*CommitMessage, error) {
+func CreateCommitMessageFrom(messageLines []string) *CommitMessage {
 	cm := &CommitMessage{InvalidBody: false}
 	cm.addSubject(messageLines)
 	cm.addBody(messageLines)
 
-	return cm, nil
+	return cm
 }
 
 func (cm *CommitMessage) ValidateSubject() int {

src/commit-message_test.go → internal/model/commit_message_test.go

@@ -1,4 +1,4 @@
-package src
+package model
 
 import (
 	"github.com/stretchr/testify/assert"
@@ -17,8 +17,7 @@ func TestNewCommitMessage(t *testing.T) {
 	}
 
 	t.Run("create new commit message object from File", func(t *testing.T) {
-		cm, err := CreateCommitMessageFrom(validCommitMsgLines)
-		assert.Nil(t, err)
+		cm := CreateCommitMessageFrom(validCommitMsgLines)
 
 		assert.Equal(t, "I am a valid Subject with less than 50 characters", cm.Subject)
 		assert.Len(t, cm.Body, 3)
@@ -27,8 +26,7 @@ func TestNewCommitMessage(t *testing.T) {
 
 	t.Run("Handles empty commit message", func(t *testing.T) {
 		var emptyCommitMsgLines []string
-		cm, err := CreateCommitMessageFrom(emptyCommitMsgLines)
-		assert.Nil(t, err)
+		cm := CreateCommitMessageFrom(emptyCommitMsgLines)
 
 		assert.Equal(t, "", cm.Subject)
 		assert.Len(t, cm.Body, 0)
@@ -40,8 +38,7 @@ func TestNewCommitMessage(t *testing.T) {
 			"body line 1",
 			"body line 2",
 		}
-		cm, err := CreateCommitMessageFrom(invalidCommitMsgLines)
-		assert.Nil(t, err)
+		cm := CreateCommitMessageFrom(invalidCommitMsgLines)
 
 		t.Run("sets body correct", func(t *testing.T) {
 			assert.Equal(t, "subject line", cm.Subject)
@@ -71,7 +68,7 @@ func TestNewCommitMessage(t *testing.T) {
 
 		for _, tc := range testcases {
 			t.Run(getDescFrom(tc.subject), func(t *testing.T) {
-				cm, _ := CreateCommitMessageFrom([]string{tc.subject})
+				cm := CreateCommitMessageFrom([]string{tc.subject})
 
 				aboveSoftLimit := cm.ValidateSubject()