git-hook 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffd94b9dc21eb07eeba7437c31123e9d09bc58a9
-  data.tar.gz: 7e8a1c295e60c722b55b755d40a165987ef36bcf
+  metadata.gz: cf6166f0c4490566438f84355083fbb01137991d
+  data.tar.gz: df828c975fff03186afcf4b8db160baaa132c44d
 SHA512:
-  metadata.gz: 5b8919653e6c9655c8423fb1552d8b264a9b6c9377407a34e0357b78ac5694148d885d880c518557060c32fb5ac3789e261f71fdf1c6c7bbca993915c09499ef
-  data.tar.gz: 1c1ce9090adcccf38cae79627f1c7b143c020a0954479adec5f23dad60bad85d63776a1429482149194ac7faa500eae7322710e462a222d514073cf029c70ef6
+  metadata.gz: 9693c3c556aed7b16cdba1f46b1764aceada7cef9eba1a30dbb9e9cfe08abd60be5289e1264f2e1d94f83236417e5761353f7191ed1b7d1ddb57fca0c44820be
+  data.tar.gz: 1b86d49222d85ceb260d5561f025215c204b045df9b090b4a16608ad7afdec3da194380c7249180056f7cae4aca9cfd72f299e5cc2d4a69ae7e435a57ff043c6

data/README.md

@@ -71,7 +71,9 @@ Demos:
 
 ## Principle
 
-Git will call some hooks when you commit, merge, rebase code, etc. The hooks place in `.git/hooks` folder, there are many default sample hooks, you need remove the `.sample` appendix to make it works if you want to execute the hook. The 3 hooks are most useful for us: pre-commit, prepare-commit-msg, commit-msg.
+Git will call some hooks when you commit, merge, rebase code, etc. The hooks place in `.git/hooks` folder, there are many default sample hooks, you need remove the `.sample` suffix to make it works if you want to execute the hook. The 3 hooks are most useful for us: `pre-commit`, `prepare-commit-msg`, `commit-msg`.
+
+`pre-commit` hook will be executed at the most begining when commit code, `prepare-commit-msg` hook will be executed after `pre-commit` hook, before you start to input some commit message, `commit-msg` hook will be executed after you save the commit message.
 
 [See more hooks introduction in git official website - Customizing Git - Git Hooks](https://git-scm.com/book/gr/v2/Customizing-Git-Git-Hooks).
 
@@ -117,7 +119,7 @@ Where do we define the `:pre_commit` value? It is defined by user in `.githook/c
       # 'pre_commit:rubocop',
       # 'pre_commit:rspec',
 
-      # uncomment following lines if it is a java project built by gradle
+      # uncomment following lines if it is an android or java project built by gradle
       # 'pre_commit:checkstyle'
     )
     set :prepare_commit_msg, fetch(:prepare_commit_msg, []).push(
@@ -129,9 +131,9 @@ Where do we define the `:pre_commit` value? It is defined by user in `.githook/c
       'commit_msg:check_msg'
     )
 
-We use `set` method to set the value. It seems the `:pre_commit` value is an empty array by default, all items are commented, so `githook pre_commit` in `pre-commit` hook will do nothing, but if your project is a ruby or rails project, there are 2 default tasks are prepared for `:pre_commit`, they are `pre_commit:rubocop` and `pre_commit:rspec`, if you uncomment the above 2 lines code, then `pre_commit:rubocp` and `pre_commit:rspec` will be executed when you commit code, of course, you can define your customized task and add to some hook (later I will introduce how to add a customized task).
+We use `set` method to set the value. It seems the `:pre_commit` value is an empty array by default, all items are commented, so `githook pre_commit` in `pre-commit` hook will do nothing, but if your project is a ruby or rails project, there are 2 default tasks are prepared for `:pre_commit`, they are `pre_commit:rubocop` and `pre_commit:rspec` (also has a default task `pre_commit:checkstyle` prepared for android or java project), if you uncomment the above 2 lines code, then `pre_commit:rubocp` and `pre_commit:rspec` will be executed when you commit code, of course, you can define your customized tasks and add to hooks (later I will introduce how to add a customized task).
 
-How the default tasks `pre_commit:rubocop` and `pre_commit:rspec` looks like, they are defined in `tasks/pre-commit.rake`:
+How do the default tasks `pre_commit:rubocop` and `pre_commit:rspec` look like, they are defined in `tasks/pre-commit.rake`:
 
     namespace :pre_commit do
       desc 'check ruby code style by rubocop'
@@ -153,7 +155,7 @@ How the default tasks `pre_commit:rubocop` and `pre_commit:rspec` looks like, th
       end
     end
 
-The `pre_commit:rubocop` just simply runs `bundle exec rubocop` command to check ruby code style, while `pre_commit:rspec` runs `bundle exec rspec` to test ruby code.
+The `pre_commit:rubocop` just simply runs `bundle exec rubocop` command to check ruby code style, while `pre_commit:rspec` runs `bundle exec rspec` to test ruby code. (`pre_commit:checkstyle` runs the `./gradlew checkstyle` command.)
 
 At last, let's see what do `prepare_commit_msg:prepare` and `commit_msg:check_msg` tasks do?
 
@@ -176,7 +178,7 @@ The `prepare_commit_msg:prepare` is defined in `tasks/prepare-commit-msg.rake`,
       end
     end
 
-The `commit_msg:check_msg` is defined in `tasks/commit-msg.rake`, it is executed in `commit-msg` hook after you save the commit message. It will check your commit message style, if it doesn't match the expected format, then this commit will be aborted. In default, our expected commit message summary format is "FEAUTER|BUG|MISC|REFACTOR|WIP #issue_num - Summary", if you want to another format, you need to define yourself task to replace the default behavior.
+The `commit_msg:check_msg` is defined in `tasks/commit-msg.rake`, it is executed in `commit-msg` hook after you save the commit message. It will check your commit message style, if it doesn't match the expected format, then this commit will be aborted. In default, our expected commit message summary format is "FEAUTER|BUG|MISC|REFACTOR #issue_num - Summary", if you prefer to use other format, you need to define yourself task to replace the default behavior.
 
     namespace :commit_msg do
       desc 'check commit msg style'
@@ -195,7 +197,7 @@ The `commit_msg:check_msg` is defined in `tasks/commit-msg.rake`, it is executed
 
 The default `pre_commit:rubocp`, `pre_commit:rspec` tasks will help you check ruby code style and test ruby code before commit, the `prepare_commit_msg:prepare` task will help auto generate commit message according branch name when commit code, the `commit_msg:check_msg` task will help check commit message style after save the commit message.
 
-If you don't like these default behaviors, for example you have your own commit message style, or you want to add more checks, for example you want to be more strict in the branch name, you can't name a branch arbitrarily, it must follow some rules, it should be any of `develop/staging/master`, `/^(feature|bug|hotfix|misc|refactor)\/(\d*)?(\w*)/`, let's try to implement this custom task.
+If you don't like these default behaviors, for example you have your own commit message style, or you want to add more checks, for example you want to be more strict in the branch name, you can't name a branch arbitrarily, it must follow some rules, it should be one of `develop/staging/master`, `/^(feature|bug|hotfix|misc|refactor)\/(\d*)?(\w*)/`, let's try to implement this custom task.
 
 We can define it in any rake file in `.githook/tasks` folder, there is already an empty `task.rake` file, so let's just define in it. It should work in `pre-commit` hook, so let's define it in `:pre_commit` namespace.
 
@@ -228,6 +230,11 @@ Demo:
 
 ![](./art/check_branch_name.gif)
 
+## References
+
+1. [Git Hooks Sample](https://github.com/baurine/git-hooks-sample)
+1. [Step-by-Step Guide to Building Your First Ruby Gem](https://quickleft.com/blog/engineering-lunch-series-step-by-step-guide-to-building-your-first-ruby-gem/)
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/githook/templates/tasks/task.rake

@@ -12,7 +12,7 @@
 #       valid = %w(develop staging master).include?(branch_name)
 #     end
 #     unless valid
-#       puts "Branch name #{branch_name} doesn't match the expected foramt."
+#       puts "Branch name \"#{branch_name}\" doesn't match the expected foramt."
 #       exit 1
 #     end
 #   end

data/lib/githook/util.rb

@@ -127,8 +127,8 @@ module Githook
       end
     end
 
-    DEF_MSG_SUMMARY_REG = /^(FEATURE|BUG|MISC|REFACTOR|WIP)(\s#\d+)* - ([A-Z].*)[^.]$/
-    DEF_MSG_SUMMARY_FORMAT = "FEAUTER|BUG|MISC|REFACTOR|WIP #issue_num - Summary"
+    DEF_MSG_SUMMARY_REG = /^(FEATURE|BUG|MISC|REFACTOR)(\s#\d+)* - ([A-Z].*)[^.]$/
+    DEF_MSG_SUMMARY_FORMAT = "FEAUTER|BUG|MISC|REFACTOR #issue_num - Summary"
     DEF_MSG_BODY_REG = /^- ([a-z].*)[^.]$/
     DEF_MSG_BODY_FORMAT = "- detail"
     def self.check_msg_format?(commit_msg_arr)

data/lib/githook/version.rb

@@ -1,3 +1,3 @@
 module Githook
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-hook
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - baurine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-04 00:00:00.000000000 Z
+date: 2017-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Setup git hooks easily