Add configuration na convenience sub commands (#1)

* wip: integrated config, tests passing. some coverage missing
* * solved edge case "initial commit in a new git repository" by making a call to "git log" to determine branch name, when "git branch" returned empty input in a fresh initialzed repo.
* simplyfied config
* add diagnostics output and update readme
* add several convinience sub commands (diagnostics, install, uninstall, test)
cleaned up unnecessary files, moved hook files from root into hook package
* prepare custom docker file, cleanup makefile from deprecated tools
* remove appveyor

Author: Nils Wogatzky

.docker/Dockerfile

@@ -0,0 +1,11 @@
+FROM golang:1.10
+
+WORKDIR /go/src/github.com/Oppodelldog/git-commit-hook
+
+RUN go get -u gopkg.in/alecthomas/gometalinter.v2 && \
+	go get -u github.com/golang/dep/cmd/dep && \
+	go get -u golang.org/x/tools/cmd/goimports && \
+    go get -u github.com/mattn/goveralls
+
+RUN apt-get update && \
+    apt-get install -y libpcre++-dev

.drone.yml

@@ -1,19 +1,10 @@
 workspace:
-  base: /go
-  path: src/github.com/Oppodelldog/git-commit-hook
+  base: /go/src/github.com/Oppodelldog/git-commit-hook
+  path: /
 
 pipeline:
   build:
-    image: golang:1.9.4
+    image: oppodelldog/git-commit-hook:latest
+    pull: true
     commands:
-      - go get -u github.com/golang/dep/cmd/dep
-      - dep ensure
-      - go get ./...
-      - go get github.com/mattn/goveralls
-      - goveralls -service drone.io -repotoken BddPGJN9lAFBYHLGI5mIHLjZVJlD74n3X
-      - go build
-
-matrix:
- GO_VERSION:
-   - latest
-   - "1.9"
+      - make ci

Gopkg.lock

@@ -20,10 +20,22 @@
 #  version = "2.4.0"
 
 
+[[constraint]]
+  name = "github.com/Oppodelldog/filediscovery"
+  version = "0.1.0"
+
+[[constraint]]
+  branch = "master"
+  name = "github.com/glenn-brown/golang-pkg-pcre"
+
 [[constraint]]
   name = "github.com/pkg/errors"
   version = "0.8.0"
 
 [[constraint]]
   name = "github.com/stretchr/testify"
-  version = "1.2.1"
+  version = "1.2.2"
+
+[[constraint]]
+  name = "gopkg.in/yaml.v2"
+  version = "2.2.1"

Gopkg.toml

@@ -1,17 +1,12 @@
-SOURCE_FILES?=$$(go list ./... | grep -v /vendor/)
-TEST_PATTERN?=.
-TEST_OPTIONS?=-race -covermode=atomic -coverprofile=coverage.txt
-
 setup: ## Install all the build and lint dependencies
 	go get -u gopkg.in/alecthomas/gometalinter.v2
 	go get -u github.com/golang/dep/cmd/dep
-	go get -u golang.org/x/tools/cmd/cover
 	go get -u golang.org/x/tools/cmd/goimports
 	dep ensure
 	gometalinter --install --update
 
 test: ## Run all the tests
-	gotestcover $(TEST_OPTIONS)  $(SOURCE_FILES) -run $(TEST_PATTERN) -timeout=1m
+	echo 'mode: atomic' > coverage.txt && go list ./... | xargs -n1 -I{} sh -c 'go test -race -covermode=atomic -coverprofile=coverage.tmp {} && tail -n +2 coverage.tmp >> coverage.txt' && rm coverage.tmp
 
 cover: test ## Run all the tests and opens the coverage report
 	go tool cover -html=coverage.txt
@@ -41,9 +36,15 @@ lint: ## Run all the linters
 		--deadline=10m \
 		./...
 
-ci: lint test ## Run all the tests and code checks
+ci: ## Run all the tests and code checks
+	dep ensure
+	go get ./...
+	go get github.com/mattn/goveralls
+	goveralls -service drone.io -repotoken BddPGJN9lAFBYHLGI5mIHLjZVJlD74n3X
+	go build cmd/main.go
 
 build: ## build binary to .build folder
+	rm -f .build/git-commit-hook
 	go build -o ".build/git-commit-hook" cmd/main.go
 
 install: ## Install to <gopath>/src
@@ -52,7 +53,6 @@ install: ## Install to <gopath>/src
 build-release: ## builds the checked out version into the .release/${tag} folder
 	.release/build.sh
 
-
 # Self-Documented Makefile see https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
 help:
 	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)

Makefile

@@ -1,24 +1,72 @@
+[![Go Report Card](https://goreportcard.com/badge/github.com/Oppodelldog/git-commit-hook)](https://goreportcard.com/report/github.com/Oppodelldog/git-commit-hook) [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://raw.githubusercontent.com/Oppodelldog/git-commit-hook/master/LICENSE) [![Linux build](http://nulldog.de:12080/api/badges/Oppodelldog/git-commit-hook/status.svg)](http://nulldog.de:12080/Oppodelldog/git-commit-hook) [![Coverage Status](https://coveralls.io/repos/github/Oppodelldog/git-commit-hook/badge.svg?branch=master)](https://coveralls.io/github/Oppodelldog/git-commit-hook?branch=master)
+
 # git-commit-hook
+> configureable git commit hook
+
+
+**Customize commit messages dynamically with templating**
+
+**Validate commit message**
+
+### 1. install
+#### Download
+downlod the binary and ensure your user has execution permissions
+#### Install
+Copy or link the binary into your git repositories ```hooks``` folder
+(Project/.git/hooks), rename it to ```commit-msg```
+
+Or create a symlink:
+```ln -sf ~/Downloads/git-commit-hook ~/MyProject/.git/hooks/commit-msg```
+
+### 2. Configure
+```yaml
+ "project xyz":
+   # path to the git repository
+   path: "/home/nils/projects/xyz/.git"
+
+   # define types of branch and a pattern to identify the type for the current branch you are working on
+   branch:
+      master: "^(origin\\/)*master"
+
+   # define a commit message template per branch type, or as here for all (*) branch types
+   template:
+     "*": "{.BranchName}: {.CommitMessage}"
+
+   # define validation rules per branch type
+   validation:
+      master:
+        "(?m)(?:\\s|^|/)(([A-Z](_)*)+-[0-9]+)([\\s,;:!.-]|$)" : "valid ticket ID"
+ ```
+ There are several places the configuration will be searched at, but one thing is for sure, the config file
+ must be named ```git-commit-hook.yaml```.
 
-[![Go Report Card](https://goreportcard.com/badge/github.com/Oppodelldog/git-commit-hook)](https://goreportcard.com/report/github.com/Oppodelldog/git-commit-hook) [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://raw.githubusercontent.com/Oppodelldog/git-commit-hook/master/LICENSE) [![Linux build](http://nulldog.de:12080/api/badges/Oppodelldog/git-commit-hook/status.svg)](http://nulldog.de:12080/Oppodelldog/git-commit-hook) [![Windows build](https://ci.appveyor.com/api/projects/status/qpe2889fbk1bw7lf/branch/master?svg=true)](https://ci.appveyor.com/project/Oppodelldog/git-commit-hook/branch/master) [![Coverage Status](https://coveralls.io/repos/github/Oppodelldog/git-commit-hook/badge.svg?branch=master)](https://coveralls.io/github/Oppodelldog/git-commit-hook?branch=master)
+ Here are some places the configuration will be searched at:
+ * **~/.config/git-commit-hook**
+ * inside the **git repository** you commit in (also in subfolders **.git**, **.git/hooks**)
 
-**Problem:** I forget to add ticket numbers to commit messages or I take the wrong ticket ID.
+Watch out the test [fixture](config/test-data.yaml) for full feature sample
 
-**Solution:** a custom git-hook that prepends the current branch-name to every commit message.
+### 3. Commit
+You can do it on your own, I know that!!
 
-The implementation and rules are tightly coupled to **git flow** used with **jira**.
+---
 
-The intention is on the one hand to make life easier when working on features.
-On the other hand the intention must be to not allow commits to non-fetaure branches without having a valid ticket reference.
+### Configuration check
+to check if the git hook is installed and configured correctly, just call the command from
+your repository like this:
+```.git/hooks/commit-msg```
 
-### So here are the rules
+The output will be something like this:
 
-* At least there must always be a non empty commit message.
+    git-commit-hook - parsed configuration
 
-* When you are committing to a **feature** branch
 
-        the hook will preprend the branch name to the commit message
+    branch types:
+         master : ^(origin\/)*master
 
-* When you are committing to a non feature branch, lets say **develop** for a quick fix, **release/v0.1.1** for a release fix or a **hotfix**
+    branch type templates:
+         master : {{.CommitMessage}} - whatever !!! {{.BranchName}}
 
-        you have to enter a valid feature reference.
+    branch type validation:
+         master :
+             (?m)^.*(#\d*)+.*$ : must have a ticket reference (eg. #267)

README.md

@@ -1,26 +1,78 @@
 package main
 
 import (
-	"fmt"
-
 	"os"
 
-	"github.com/Oppodelldog/git-commit-hook"
+	"fmt"
+
+	"github.com/Oppodelldog/git-commit-hook/config"
+	"github.com/Oppodelldog/git-commit-hook/hook"
+	"github.com/Oppodelldog/git-commit-hook/subcommand"
+	"github.com/pkg/errors"
 )
 
-type rewriteCommitMessageFuncDef func(string) error
+type callWithIntResult func() int
+type rewriteCommitMessageFuncDef func(string, hook.CommitMessageModifier) error
 type exitFuncDef func(code int)
 
-var rewriteCommitMessageFunc = rewriteCommitMessageFuncDef(gitcommithook.RewriteCommitMessage)
+var diagnosticsFunc = callWithIntResult(subcommand.Diagnostics)
+var testFunc = callWithIntResult(subcommand.Test)
+var installFunc = callWithIntResult(subcommand.Install)
+var uninstallFunc = callWithIntResult(subcommand.Uninstall)
+var rewriteCommitMessageFunc = rewriteCommitMessageFuncDef(hook.RewriteCommitMessage)
 var exitFunc = exitFuncDef(os.Exit)
 
 func main() {
+	if len(os.Args) < 2 {
+		fmt.Println("too few arguments")
+		fmt.Println("")
+		fmt.Println("diag		- gives diagnostic output of configuration")
+		fmt.Println("install 	- helps to install git-commit-hook")
+		fmt.Println("uninstall 	- helps to uninstall git-commit-hook")
+		fmt.Println("test 		- helps to test configuration with manual inputs")
+		exitFunc(0)
+		return
+	}
+
+	if os.Args[1] == "test" {
+		result := testFunc()
+		exitFunc(result)
+		return
+	} else if os.Args[1] == "install" {
+		result := installFunc()
+		exitFunc(result)
+		return
+	} else if os.Args[1] == "uninstall" {
+		result := uninstallFunc()
+		exitFunc(result)
+		return
+	} else if os.Args[1] == "diag" {
+		result := diagnosticsFunc()
+		exitFunc(result)
+		return
+	}
+
 	commitMessageFile := os.Args[1]
-	err := rewriteCommitMessageFunc(commitMessageFile)
+	if commitMessageFile == "" {
+		fmt.Print(errors.New("no commit message file passed as parameter 1"))
+		exitFunc(1)
+		return
+	}
+
+	projectConfiguration, err := config.LoadProjectConfigurationFromCommitMessageFileDir(commitMessageFile)
+	if err != nil {
+		fmt.Print(err)
+		exitFunc(1)
+		return
+	}
+
+	commitMessageModifier := hook.NewCommitMessageModifier(projectConfiguration)
+	err = rewriteCommitMessageFunc(commitMessageFile, commitMessageModifier)
 	if err != nil {
 		fmt.Print(err)
 		exitFunc(1)
 		return
 	}
+
 	exitFunc(0)
 }