git-hook 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cbbda040e9b08f7a73cb7a7bce3adb0e18a05b3
-  data.tar.gz: e4a79c0201970aefc8d2002273f75b1236117b6e
+  metadata.gz: ebab726ddd8101a28247bc96a20628711c56f22f
+  data.tar.gz: c29c99fa2fcb931101290d18f40c3a75c025f713
 SHA512:
-  metadata.gz: 22a7f13fdfd6ab50078d3516940770f5ca7beb96ae37b02ea8fde843e91924703b9857bf4c33a5d46a510b3b8442f0a97bdaafe867dfd0581fcbf1fd36f178f7
-  data.tar.gz: 00549414373fe0b38dc1d77fb0a7bdd6cc2672ceb8c056833d425ecf9bc718bf06504ca7b9b6da4e7d66d44cef5f28e1dbb927c15a48c0c06d2b5beedb14be6d
+  metadata.gz: ef86bf172e83076e1af209611564b93b4e30345c65d95cf39c003df27c52f632ffa9ab6df3205a9d097f4bdb57d43dc36e4eb69e3494065dd654ff0b5e5114df
+  data.tar.gz: 448237492eaa4dde373d7a2ffa93f4c38af944053f4cb728e1dbcfb773d53eda613cb44fe565a48ace7f1a2b73fedb0b1d676f37cdff7b0626834a1cd383ff59

data/README.md

@@ -32,6 +32,8 @@ Or install it yourself as:
 
     $ gem install git-hook
 
+**Notice!** The gem name isn't **githook**, it is another gem written by some guy.
+
 ## Usage
 
 Help:
@@ -43,7 +45,7 @@ Help:
       install  -- Init githook, create .githook folder, prepare template files
       setup    -- Setup hooks, copy hooks from .githook/hooks to .git/hooks
       backup   -- Backup old hooks in .git/hooks
-      clearup  -- Clear backup hooks in .git/hooks
+      clean  -- Clear backup hooks in .git/hooks
       disable  -- Disable hooks: [HOOKS=pre_commit,commit_msg] githook disable
       enable   -- Enable hooks: [HOOKS=pre_commit,commit_msg] githook enable
       list     -- List all hooks
@@ -235,6 +237,10 @@ Demo:
 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/)
 
+## Note
+
+1. [How to Build a Gem](note/how-to-build-a-gem.md)
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/githook.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   # end
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features|art)/})
+    f.match(%r{^(test|spec|features|art|note)/})
   end
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})

data/lib/githook/tasks/{pre-commit.rake → 1-pre-commit.rake}

@@ -17,9 +17,3 @@ namespace :pre_commit do
     exit 1 unless system("./gradlew checkstyle")
   end
 end
-
-desc "Run all pre-commit hook tasks"
-task :pre_commit do |t|
-  Githook::Util.log_task(t.name)
-  Githook::Util.run_tasks(t.name.to_sym)
-end

data/lib/githook/tasks/2-prepare-commit-msg.rake

@@ -0,0 +1,77 @@
+namespace :prepare_commit_msg do
+  # generate pre msg according branch name
+  # why do I pass branch_name as a parameter, not implement it inside the gen_pre_msg_for_ekohe_branch,
+  # because this is easy to test, it a kind of inject dependency thinking.
+  def gen_pre_msg_for_ekohe_branch(branch_name)
+    # default ekohe valid branch name: feature/24_add_enable_task
+    # will generate commit message: FEATURE #24 - Add enable task
+    default_ekohe_branch_name_reg = /^(feature|bug|hotfix|misc|refactor)\/(\d*)?(\w*)/
+
+    match_group = default_ekohe_branch_name_reg.match(branch_name)
+    if match_group
+      issue_type = match_group[1].upcase
+      issue_num = match_group[2]
+      issue_content = match_group[3]
+
+      issue_type = "BUG" if issue_type == "HOTFIX"
+      issue_num = " \##{issue_num}" unless issue_num.empty?
+      issue_content = issue_content.tr("_", " ").strip.capitalize
+
+      "#{issue_type}#{issue_num} - #{issue_content}"
+    else
+      msg = branch_name.tr('-_/', ' ').strip.capitalize
+      "MISC - #{msg}"
+    end
+  end
+
+  def gen_pre_msg_for_gitlab_branch(branch_name)
+    # default gitlab valid branch name: 24-add-enable-task
+    # will generate commit message: FEATURE #24 - Add enable task
+    default_gitlab_branch_name_reg = /^(\d+)-(\S*)/
+
+    match_group = default_gitlab_branch_name_reg.match(branch_name)
+    if match_group
+      issue_num = match_group[1]
+      issue_content = match_group[2]
+
+      issue_type = "FEATURE"
+      issue_num = "\##{issue_num}"
+      issue_content = issue_content.tr("-", " ").strip.capitalize
+
+      "#{issue_type} #{issue_num} - #{issue_content}"
+    else
+      msg = branch_name.tr('-_/', ' ').strip.capitalize
+      "MISC - #{msg}"
+    end
+  end
+
+  desc "Prepare commit msg for ekohe type branch"
+  task :prepare_for_ekohe_branch do |t|
+    Githook::Util.log_task(t.name)
+
+    commit_msg_file = Githook::Util.commit_msg_file
+    commit_msg = Githook::Util.get_commit_msg(commit_msg_file)
+    if Githook::Util.commit_msg_empty?(commit_msg)
+      branch_name = Githook::Util.branch_name
+      pre_msg = gen_pre_msg_for_ekohe_branch(branch_name)
+      puts "pre-msg:"
+      puts pre_msg
+      Githook::Util.prefill_msg(commit_msg_file, pre_msg)
+    end
+  end
+
+  desc "Prepare commit msg for gitlab type branch"
+  task :prepare_for_gitlab_branch do |t|
+    Githook::Util.log_task(t.name)
+
+    commit_msg_file = Githook::Util.commit_msg_file
+    commit_msg = Githook::Util.get_commit_msg(commit_msg_file)
+    if Githook::Util.commit_msg_empty?(commit_msg)
+      branch_name = Githook::Util.branch_name
+      pre_msg = gen_pre_msg_for_gitlab_branch(branch_name)
+      puts "pre-msg:"
+      puts pre_msg
+      Githook::Util.prefill_msg(commit_msg_file, pre_msg)
+    end
+  end
+end

data/lib/githook/tasks/3-commit-msg.rake

@@ -0,0 +1,49 @@
+namespace :commit_msg do
+  def check_msg_for_ekohe_format?(commit_msg_arr)
+    def_ekohe_msg_summary_reg = /^(FEATURE|BUG|MISC|REFACTOR)(\s#\d+)* - ([A-Z].*)[^.]$/
+    def_ekohe_msg_format = "FEAUTER|BUG|MISC|REFACTOR #issue_num - Summary"
+    def_ekohe_body_reg = /^- ([a-z].*)[^.]$/
+    def_ekohe_body_format = "- detail"
+
+    summary = commit_msg_arr[0] || ""
+    second_line = commit_msg_arr[1] || ""
+    body = commit_msg_arr[2..-1] || []
+
+    valid = summary.start_with?("Merge branch") || def_ekohe_msg_summary_reg.match(summary)
+    unless valid
+      puts "Commit message summary \"#{summary}\" format isn't correct."
+      puts "Expected format: \"#{def_ekohe_msg_format}\""
+      return false
+    end
+
+    valid = second_line.strip.empty?
+    unless valid
+      puts "Commit message the first line after summary should be blank."
+      return false
+    end
+
+    body.each do |line|
+      unless def_ekohe_body_reg.match(line)
+        puts "Commit message body line \"#{line}\" format isn't correct."
+        puts "Expected format: \"#{def_ekohe_body_format}\""
+        return false
+      end
+    end
+    true
+  end
+
+  desc "Check commit msg style for ekohe format"
+  task :check_msg_for_ekohe_format do |t|
+    Githook::Util.log_task(t.name)
+
+    commit_msg_file = Githook::Util.commit_msg_file
+    commit_msg = Githook::Util.get_commit_msg(commit_msg_file)
+    puts "commit-msg:"
+    puts commit_msg.join("\n")
+
+    # can't use return in block
+    # can't "exit 0" in advance, else will abort later tasks
+    # but we can "exit 1" in advance
+    exit 1 unless check_msg_for_ekohe_format?(commit_msg)
+  end
+end

data/lib/githook/tasks/run.rake

@@ -0,0 +1,8 @@
+desc "Run hook tasks"
+task :run do |t|
+  hook = ENV["HOOK"]
+  if hook
+    Githook::Util.log_task(hook)
+    Githook::Util.run_tasks(hook.to_sym)
+  end
+end

data/lib/githook/tasks/setup.rake

@@ -44,25 +44,15 @@ task :backup => :check_git_folder do
     has_backup = true
   end
 
-  puts "You can run 'githook clearup' to delete these backup." if has_backup
+  puts "You can run 'githook clean' to delete these backup." if has_backup
 end
 
 desc "Clear backup hooks in .git/hooks"
-task :clearup => :check_git_folder do
+task :clean => :check_git_folder do
   backup = Dir.glob(".git/hooks/*.bak")
   Githook::Util.interactive_delete_files(backup, "backup hooks")
 end
 
-# later I think we don't need to clear hooks, use disable/enable replace them
-# desc "Clear all hooks (include backup) in .git/hooks"
-# task :clear => :clearup do |t|
-#   Githook::Util.log_task(t.name)
-
-#   hooks = Dir.glob(".git/hooks/*")
-#              .reject { |path| path.split("/").last.include?(".") }
-#   Githook::Util.interactive_delete_files(hooks, "hooks")
-# end
-
 # all hooks
 # https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks
 # ALL_HOOKS = %w(
@@ -150,7 +140,7 @@ TASKS_NAME = %w(
   install
   setup
   backup
-  clearup
+  clean
   disable
   enable
   list

data/lib/githook/templates/config.rb

@@ -10,9 +10,10 @@ set :pre_commit, fetch(:pre_commit, []).push(
 )
 set :prepare_commit_msg, fetch(:prepare_commit_msg, []).push(
   # comment following lines if you want to skip it
-  "prepare_commit_msg:prepare"
+  "prepare_commit_msg:prepare_for_ekohe_branch"
+  # "prepare_commit_msg:prepare_for_gitlab_branch"
 )
 set :commit_msg, fetch(:commit_msg, []).push(
   # comment following lines if you want to skip it
-  "commit_msg:check_msg"
+  "commit_msg:check_msg_for_ekohe_format"
 )

data/lib/githook/templates/hooks/commit-msg

@@ -24,4 +24,4 @@ test "" = "$(grep '^Signed-off-by: ' "$1" |
 }
 
 # custom commit-msg hooks
-githook commit_msg
+HOOK=commit_msg githook run

data/lib/githook/templates/hooks/pre-commit

@@ -22,7 +22,7 @@ allownonascii=$(git config --bool hooks.allownonascii)
 exec 1>&2
 
 # custom pre-commit hooks
-githook pre_commit
+HOOK=pre_commit githook run
 if [ $? -ne 0 ]; then
   exit 1
 fi

data/lib/githook/templates/hooks/prepare-commit-msg

@@ -36,4 +36,4 @@ esac
 # grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
 
 # custom prepare-commit-msg hooks
-githook prepare_commit_msg
+HOOK=prepare_commit_msg githook run

data/lib/githook/util.rb

@@ -94,29 +94,6 @@ module Githook
       true
     end
 
-    # default valid branch name: feature/24_add_enable_task
-    # will generate commit message: FEATURE #24 - Add enable task
-    DEF_BRANCH_NAME_REG = /^(feature|bug|hotfix|misc|refactor)\/(\d*)?(\w*)/
-    # generate pre msg according branch name
-    # why do I pass branch_name as a parameter, not implement it inside the gen_pre_msg,
-    # because this is easy to test, it a kind of inject dependency thinking.
-    def self.gen_pre_msg(branch_name)
-      match_group = DEF_BRANCH_NAME_REG.match(branch_name)
-      if match_group
-        issue_type = match_group[1].upcase
-        issue_num = match_group[2]
-        issue_content = match_group[3]
-
-        issue_type = "BUG" if issue_type == "HOTFIX"
-        issue_num = " \##{issue_num}" unless issue_num.empty?
-        issue_content = issue_content.tr("_", " ").strip.capitalize
-
-        "#{issue_type}#{issue_num} - #{issue_content}"
-      else
-        "MISC - "
-      end
-    end
-
     # write the pre msg at the begining of commit_msg_file
     def self.prefill_msg(commit_msg_file, pre_msg)
       File.open(commit_msg_file, "r+") do |f|
@@ -126,37 +103,5 @@ module Githook
         f.puts ori_content
       end
     end
-
-    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)
-      summary = commit_msg_arr[0] || ""
-      second_line = commit_msg_arr[1] || ""
-      body = commit_msg_arr[2..-1] || []
-
-      valid = summary.start_with?("Merge branch") || DEF_MSG_SUMMARY_REG.match(summary)
-      unless valid
-        puts "Commit message summary \"#{summary}\" format isn't correct."
-        puts "Expected format: \"#{DEF_MSG_SUMMARY_FORMAT}\""
-        return false
-      end
-
-      valid = second_line.strip.empty?
-      unless valid
-        puts "Commit message the first line after summary should be blank."
-        return false
-      end
-
-      body.each do |line|
-        unless DEF_MSG_BODY_REG.match(line)
-          puts "Commit message body line \"#{line}\" format isn't correct."
-          puts "Expected format: \"#{DEF_MSG_BODY_FORMAT}\""
-          return false
-        end
-      end
-      true
-    end
   end
 end

data/lib/githook/version.rb

@@ -1,3 +1,3 @@
 module Githook
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-hook
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - baurine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-06 00:00:00.000000000 Z
+date: 2018-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,10 +74,11 @@ files:
 - lib/githook/config.rb
 - lib/githook/context.rb
 - lib/githook/tasks.rb
-- lib/githook/tasks/commit-msg.rake
+- lib/githook/tasks/1-pre-commit.rake
+- lib/githook/tasks/2-prepare-commit-msg.rake
+- lib/githook/tasks/3-commit-msg.rake
 - lib/githook/tasks/install.rake
-- lib/githook/tasks/pre-commit.rake
-- lib/githook/tasks/prepare-commit-msg.rake
+- lib/githook/tasks/run.rake
 - lib/githook/tasks/setup.rake
 - lib/githook/templates/config.rb
 - lib/githook/templates/hooks/commit-msg

data/lib/githook/tasks/commit-msg.rake

@@ -1,22 +0,0 @@
-namespace :commit_msg do
-  desc "Check commit msg style"
-  task :check_msg do |t|
-    Githook::Util.log_task(t.name)
-
-    commit_msg_file = Githook::Util.commit_msg_file
-    commit_msg = Githook::Util.get_commit_msg(commit_msg_file)
-    puts "commit-msg:"
-    puts commit_msg.join("\n")
-    # can't use return in block
-    # can't "exit 0" in advance, else will abort later tasks
-    # but we can "exit 1" in advance
-    # exit 0 if Githook::Util.expected_msg_format?(commit_msg)
-    exit 1 unless Githook::Util.check_msg_format?(commit_msg)
-  end
-end
-
-desc "Run all commit-msg hook tasks"
-task :commit_msg do |t|
-  Githook::Util.log_task(t.name)
-  Githook::Util.run_tasks(t.name.to_sym)
-end

data/lib/githook/tasks/prepare-commit-msg.rake

@@ -1,27 +0,0 @@
-namespace :prepare_commit_msg do
-  desc "Prepare commit msg"
-  task :prepare do |t|
-    Githook::Util.log_task(t.name)
-
-    commit_msg_file = Githook::Util.commit_msg_file
-    # can't use return in block
-    # can't "exit 0" in advance, else will abort later tasks
-    # but we can "exit 1" in advance
-    # exit 0 unless Githook::Util.commit_msg_empty?(commit_msg_file)
-
-    commit_msg = Githook::Util.get_commit_msg(commit_msg_file)
-    if Githook::Util.commit_msg_empty?(commit_msg)
-      branch_name = Githook::Util.branch_name
-      pre_msg = Githook::Util.gen_pre_msg(branch_name)
-      puts "pre-msg:"
-      puts pre_msg
-      Githook::Util.prefill_msg(commit_msg_file, pre_msg)
-    end
-  end
-end
-
-desc "Run all prepare-commit-msg hook tasks"
-task :prepare_commit_msg do |t|
-  Githook::Util.log_task(t.name)
-  Githook::Util.run_tasks(t.name.to_sym)
-end