git-hook 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83556fdb46bba0169e6b6b49af7bb3db20149749
-  data.tar.gz: 444a35267d74f379355d450d378e968874250a89
+  metadata.gz: bd3b750cfbd6d3b3158be919978cccf9b9f3e391
+  data.tar.gz: 3063fc3f1b655c7062326457187e3e66fd7e8677
 SHA512:
-  metadata.gz: f86dbbdd1c145db185b07dcfa4e6a9af0bb63a2350c32e7f910551c02edd85a813542c453ae1c1deb0f63c6947fd190a0588a63d589f0ff0c806c24616eac9f7
-  data.tar.gz: b4726565873251918b6d45ba8140279aa70dd7c9e272247d0c6e9ddb140c7c7399c95b944aca5e2af94c609d4fe9683ae270810742270d92f0111cf068abfea1
+  metadata.gz: 3120664307138925564ad5f227cb54999010d103ac4c35d61f008be3047ed479e8ab0d20bc0059091e89618e07d40da3382fc0ea26b6fd72c9482b262a279392
+  data.tar.gz: 1b62f43c9006c333af6e8ab246c0ef5905dcd3636e6197c0c34482e95203c238c331a0f1086245c385aa250a1077f8df068a3bc62ff8af18127bbdc0460a9c30

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

@@ -13,7 +13,7 @@ namespace :commit_msg do
 
     unless Githook::Util.expected_msg_format?(commit_msg)
       puts "ERROR! commit failed, commit msg doesn't match the required format"
-      puts "expected msg format: FEAUTER|BUG|MISC|REFACTOR #issue_num - Content"
+      puts "expected msg format: #{Githook::Util::MSG_FORMAT}"
       exit 1
     end
   end

data/lib/githook/tasks/setup.rake

@@ -1,28 +1,38 @@
-desc 'Setup hooks'
-task :setup do
-  # setup 1, check whether has '.githook/hooks' and '.git' folder
+desc 'Check where .githook folder exists'
+task :check_githook_folder do
   hooks_path = '.githook/hooks'
   unless Dir.exists?(hooks_path)
     puts "There isn't a .githook/hooks folder."
     exit 1
   end
+end
 
-  git_path = '.git'
+desc 'Check where .git folder exists'
+task :check_git_folder do
+  git_path = '.git/hooks'
   unless Dir.exists?(git_path)
-    puts "There isn't a .git folder."
+    puts "There isn't a .git/hooks folder."
     exit 1
   end
+end
+
+#################################################################
+
+desc 'Setup hooks'
+task :setup => [:check_githook_folder, :check_git_folder] do
+  # setup 1, check whether has '.githook/hooks' and '.git' folder
+  # => [:check_githook_folder, :check_git_folder]
 
   # setup 2, backup hooks
   puts "Backup old hooks:"
   Rake::Task[:backup].invoke
 
   # setup 3, copy hooks to .git/hooks
-  FileUtils.cp_r(hooks_path, git_path)
+  FileUtils.cp_r('.githook/hooks', '.git')
 end
 
 desc 'Backup old hooks in .git/hooks'
-task :backup do
+task :backup => :check_git_folder do
   has_backup = false
   Dir.glob('.git/hooks/*').each do |path|
     file_name = path.split('/').last
@@ -38,7 +48,7 @@ task :backup do
 end
 
 desc 'Clear backup hooks in .git/hooks'
-task :clear_backup do
+task :clear_backup => :check_git_folder do
   backup = Dir.glob('.git/hooks/*.bak')
   Githook::Util.interactive_delete_files(backup, 'backup hooks')
 end
@@ -53,43 +63,50 @@ end
 #   Githook::Util.interactive_delete_files(hooks, 'hooks')
 # end
 
-ALL_HOOKS = %w(
-  applypatch_msg
-  pre_applypatch
-  post_applypatch
-  pre_commit
-  prepare_commit_msg
-  commit_msg
-  post_commit
-  pre_rebase
-  post_checkout
-  post_merge
-  pre_receive
-  post_receive
-  update
-  post_update
-  pre_auto_gc
-  post_rewrite
-)
+# all hooks
+# https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks
+# ALL_HOOKS = %w(
+#   pre_commit
+#   prepare_commit_msg
+#   commit_msg
+#   post_commit
+#   pre_rebase
+#   post_checkout
+#   post_merge
+#   pre_push
+#   applypatch_msg
+#   pre_applypatch
+#   post_applypatch
+#   pre_receive
+#   post_receive
+#   update
+#   post_update
+# )
+
+desc 'Disable hooks: [HOOKS=pre_commit,commit_msg] githook disable'
+task :disable => :check_git_folder do
+  target_hooks = (ENV['HOOKS'] || '').split(',')
+  target_hooks = Githook::Util.all_hooks if target_hooks.empty?
 
-desc 'Disable hooks: HOOKS=pre_commit,commit_msg githook disable'
-task :disable do
-  target_hooks = (ENV['HOOKS'] || '').split(',') || ALL_HOOKS
   target_hooks.each do |hook|
     hook_path = File.join('.git/hooks', hook.gsub('_', '-'))
+    disable_path = hook_path + '.disable'
     if File.file?(hook_path)
-      disable_path = hook_path + '.disable'
       FileUtils.mv(hook_path, disable_path)
       puts "Disable #{hook} hook."
+    elsif File.file?(disable_path)
+      puts "#{hook} is already disabled, skip."
     else
       puts "#{hook} hook doesn't exist, skip."
     end
   end
 end
 
-desc 'Enable hooks: HOOKS=pre_commit,commit_msg githook enable'
-task :enable do
-  target_hooks = (ENV['HOOKS'] || '').split(',') || ALL_HOOKS
+desc 'Enable hooks: [HOOKS=pre_commit,commit_msg] githook enable'
+task :enable => :check_git_folder do
+  target_hooks = (ENV['HOOKS'] || '').split(',')
+  target_hooks = Githook::Util.all_hooks if target_hooks.empty?
+
   target_hooks.each do |hook|
     hook_path = File.join('.git/hooks', hook.gsub('_', '-'))
     disable_path = hook_path + '.disable'
@@ -105,10 +122,11 @@ task :enable do
 end
 
 desc 'List all hooks'
-task :list do
+task :list => :check_git_folder do
   enabled_hooks = []
   disabled_hooks = []
-  ALL_HOOKS.each do |hook|
+  all_hooks = Githook::Util.all_hooks
+  all_hooks.each do |hook|
     hook_path = File.join('.git/hooks', hook.gsub('_', '-'))
     disable_path = hook_path + '.disable'
     if File.file?(hook_path)

data/lib/githook/util.rb

@@ -37,6 +37,25 @@ module Githook
 
     #######################################################
 
+    # def self.enabled_hooks
+    #   Dir.glob('.git/hooks/*')
+    #      .map { |path| path.split('/').last }
+    #      .reject { |name| name.include?('.') }
+    #      .map { |name| name.gsub('-', '_') }
+    # end
+
+    # include enabled_hooks and disabled_hooks
+    def self.all_hooks
+      Dir.glob('.git/hooks/*')
+         .map { |path| path.split('/').last }
+         .select { |name| !name.include?('.') || name.include?('.disable') }
+         .map { |name| name.gsub('.disable', '') }
+         .uniq
+         .map { |name| name.gsub('-', '_') }
+    end
+
+    #######################################################
+
     # check whether origin commit msg is empty
     def self.commit_msg_empty?(commit_msg_file)
       File.open(commit_msg_file, 'r') do |f|
@@ -91,7 +110,8 @@ module Githook
       commit_msg
     end
 
-    MSG_FORMAT_REG = /^(FEATURE|BUG|MISC|REFACTOR)(\s#\d+)* - ([A-Z].*)/
+    MSG_FORMAT_REG = /^(FEATURE|BUG|MISC|REFACTOR|WIP)(\s#\d+)* - ([A-Z].*)/
+    MSG_FORMAT = "FEAUTER|BUG|MISC|REFACTOR|WIP #issue_num - Content"
     # check commit msg style
     def self.expected_msg_format?(commit_msg)
       commit_msg.start_with?('Merge branch') || MSG_FORMAT_REG.match(commit_msg)

data/lib/githook/version.rb

@@ -1,3 +1,3 @@
 module Githook
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-hook
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - baurine