git-hook 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65d3e00ec19974b20450b6c052f4bbbc57eca0a1
-  data.tar.gz: 89525dbe7fededbc2bee68b46b29c03489535125
+  metadata.gz: 83556fdb46bba0169e6b6b49af7bb3db20149749
+  data.tar.gz: 444a35267d74f379355d450d378e968874250a89
 SHA512:
-  metadata.gz: 7ec386606137eeb958e85cc1398649be9050cb570d644e81bb10e7a8539495c708d0418576c0cd9bfd0b96346b8c3027d4084e2e0cc17c3756d3025bce3d3ba9
-  data.tar.gz: 9cdb75174577473f3632cfb992d08a15a9e1930fd23b7551e2a16f99199275f0d1bed68e5153e0463110a2ee051220ddf5f3dad66c6eee3980c9095431e4d003
+  metadata.gz: f86dbbdd1c145db185b07dcfa4e6a9af0bb63a2350c32e7f910551c02edd85a813542c453ae1c1deb0f63c6947fd190a0588a63d589f0ff0c806c24616eac9f7
+  data.tar.gz: b4726565873251918b6d45ba8140279aa70dd7c9e272247d0c6e9ddb140c7c7399c95b944aca5e2af94c609d4fe9683ae270810742270d92f0111cf068abfea1

data/README.md

@@ -2,6 +2,20 @@
 
 A ruby gem that help to setup git hooks easily, base on Rake, inspired from Capistrano.
 
+## TODO
+
+- [x] install task
+- [x] setup hooks task
+- [x] clear hooks task
+- [x] disable/enable hooks task
+- [x] list hooks task
+- [x] version/help task
+- [x] pre-commit hook tasks
+- [x] prepare-commit-msg hook tasks
+- [x] commit-msg hook tasks
+- [x] implement as a gem
+- [ ] more document
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,6 +34,7 @@ Or install it yourself as:
 
 ## Usage
 
+    $ githook help
     $ githook install
     $ githook setup
 

data/bin/githook

@@ -2,9 +2,9 @@
 
 require "githook"
 
-task_name = ARGV[0]
-begin
+task_name = ARGV[0] || 'help'
+if Rake::Task.task_defined?(task_name)
   Rake::Task[task_name].invoke
-rescue => e
-  puts "Error: #{e.message}"
+else
+  puts "Error: #{task_name} task doesn't exist"
 end

data/lib/githook/config.rb

@@ -1,3 +1,11 @@
-if ARGV[0] != "install"
-  load ".githook/config.rb"
+# we must be very careful to load outside ruby code
+# because they are out of our control
+# only load outside "*.rake" when there are ".git" and ".githook" folder, and target task isn't "install"
+if Dir.exist?('.git') && Dir.exist?('.githook') && ARGV[0] != "install"
+  begin
+    load ".githook/config.rb"
+  rescue => e
+    puts "Error: #{e.message} in .githook/config.rb"
+    exit 1
+  end
 end

data/lib/githook/tasks.rb

@@ -1,11 +1,23 @@
+# https://stackoverflow.com/questions/8781263/access-rake-task-description-from-within-task
+# enable get task description
+# you aslo can see it in Rake source code: lib/rake/application.rb#select_tasks_to_show
+Rake::TaskManager.record_task_metadata = true
+
 # load rake files from lib
-rake_files_pattern = File.dirname(__FILE__) + "/tasks/**/*.rake"
-# => gems/git-hook-0.1.1/lib/githook/tasks/**/*.rake
+rake_files_pattern = File.dirname(__FILE__) + "/tasks/*.rake"
+# => gems/git-hook-0.1.1/lib/githook/tasks/*.rake
 Dir.glob(rake_files_pattern).each { |r| load r }
 
-# load rake files from outside project, defined by developer
-# in case the outside rake file has some errors,
-# not load them when target task is "install"
-if ARGV[0] != "install"
-  Dir.glob(".githook/tasks/**/*.rake").each { |r| load r }
+# we must be very careful to load outside ruby code
+# because they are out of our control
+# only load outside "*.rake" when there are ".git" and ".githook" folder, and target task isn't "install"
+if Dir.exist?('.git') && Dir.exist?('.githook') && ARGV[0] != "install"
+  Dir.glob(".githook/tasks/**/*.rake").each do |rake|
+    begin
+      load rake
+    rescue => e
+      puts "Error: #{e.message} in #{rake}"
+      exit 1
+    end
+  end
 end

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

@@ -6,11 +6,16 @@ namespace :commit_msg do
     commit_msg_file = '.git/COMMIT_EDITMSG'
     commit_msg = Githook::Util.get_commit_msg(commit_msg_file)
     puts "commit-msg: #{commit_msg}"
-    exit 0 if Githook::Util.expected_msg_format?(commit_msg)
+    # 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)
 
-    puts "ERROR! commit failed, commit msg doesn't match the required format"
-    puts "expected msg format: FEAUTER|BUG|MISC|REFACTOR #issue_num - Content"
-    exit 1
+    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"
+      exit 1
+    end
   end
 end
 

data/lib/githook/tasks/install.rake

@@ -1,4 +1,5 @@
-task :install do |t|
+desc 'Init githook, prepare template files'
+task :install do
   # step 1, check whether Dir.pwd is in git repo root folder
   git_path = ".git"
   unless Dir.exists?(git_path)

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

@@ -5,12 +5,16 @@ namespace :prepare_commit_msg do
 
     commit_msg_file = '.git/COMMIT_EDITMSG'
     # can't use return in block
-    exit 0 unless Githook::Util.commit_msg_empty?(commit_msg_file)
+    # 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)
 
-    branch_name = `git symbolic-ref --short HEAD`
-    pre_msg = Githook::Util.gen_pre_msg(branch_name)
-    puts "pre-msg: #{pre_msg}"
-    Githook::Util.prefill_msg(commit_msg_file, pre_msg)
+    if Githook::Util.commit_msg_empty?(commit_msg_file)
+      branch_name = `git symbolic-ref --short HEAD`
+      pre_msg = Githook::Util.gen_pre_msg(branch_name)
+      puts "pre-msg: #{pre_msg}"
+      Githook::Util.prefill_msg(commit_msg_file, pre_msg)
+    end
   end
 end
 

data/lib/githook/tasks/setup.rake

@@ -1,31 +1,28 @@
-desc 'setup hooks'
-task :setup do |t|
-  Githook::Util.log(t.name)
-
-  # setup 1, check whether has '.git-hooks/hooks' and '.git' folder
+desc 'Setup hooks'
+task :setup do
+  # setup 1, check whether has '.githook/hooks' and '.git' folder
   hooks_path = '.githook/hooks'
   unless Dir.exists?(hooks_path)
-    puts "There isn't .git-hooks/hooks folder."
+    puts "There isn't a .githook/hooks folder."
     exit 1
   end
 
   git_path = '.git'
   unless Dir.exists?(git_path)
-    puts "There isn't .git folder."
+    puts "There isn't a .git folder."
     exit 1
   end
 
   # setup 2, backup hooks
-  Rake::Task[:backup_hooks].invoke
+  puts "Backup old hooks:"
+  Rake::Task[:backup].invoke
 
   # setup 3, copy hooks to .git/hooks
   FileUtils.cp_r(hooks_path, git_path)
 end
 
-desc 'backup old hooks in .git/hooks'
-task :backup_hooks do |t|
-  Githook::Util.log(t.name)
-
+desc 'Backup old hooks in .git/hooks'
+task :backup do
   has_backup = false
   Dir.glob('.git/hooks/*').each do |path|
     file_name = path.split('/').last
@@ -40,19 +37,116 @@ task :backup_hooks do |t|
   puts "you can run 'rake clear_backup' to delete these backup" if has_backup
 end
 
-desc 'clear backup hooks in .git/hooks'
-task :clear_backup do |t|
-  Githook::Util.log(t.name)
-
+desc 'Clear backup hooks in .git/hooks'
+task :clear_backup do
   backup = Dir.glob('.git/hooks/*.bak')
   Githook::Util.interactive_delete_files(backup, 'backup hooks')
 end
 
-desc 'clear all hooks (include backup) in .git/hooks'
-task :clear => :clear_backup do |t|
-  Githook::Util.log(t.name)
+# 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 => :clear_backup do |t|
+#   Githook::Util.log(t.name)
+
+#   hooks = Dir.glob('.git/hooks/*')
+#              .reject { |path| path.split('/').last.include?('.') }
+#   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
+)
 
-  hooks = Dir.glob('.git/hooks/*')
-             .reject { |path| path.split('/').last.include?('.') }
-  Githook::Util.interactive_delete_files(hooks, 'hooks')
+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('_', '-'))
+    if File.file?(hook_path)
+      disable_path = hook_path + '.disable'
+      FileUtils.mv(hook_path, disable_path)
+      puts "Disable #{hook} hook."
+    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
+  target_hooks.each do |hook|
+    hook_path = File.join('.git/hooks', hook.gsub('_', '-'))
+    disable_path = hook_path + '.disable'
+    if File.file?(hook_path)
+      puts "#{hook} hook is arleady enabled, skip."
+    elsif File.file?(disable_path)
+      FileUtils.mv(disable_path, hook_path)
+      puts "Enable #{hook} hook."
+    else
+      puts "#{hook} hook doesn't exist, skip."
+    end
+  end
+end
+
+desc 'List all hooks'
+task :list do
+  enabled_hooks = []
+  disabled_hooks = []
+  ALL_HOOKS.each do |hook|
+    hook_path = File.join('.git/hooks', hook.gsub('_', '-'))
+    disable_path = hook_path + '.disable'
+    if File.file?(hook_path)
+      enabled_hooks << hook
+    elsif File.file?(disable_path)
+      disabled_hooks << hook
+    end
+  end
+  puts "Enabled hooks:"
+  enabled_hooks.each { |h| puts "  * #{h}" }
+  puts "Disabled hooks:"
+  disabled_hooks.each { |h| puts "  * #{h}" }
+end
+
+desc 'Version'
+task :version do
+  puts Githook::VERSION
+end
+
+TASKS_NAME = %w(
+  install
+  setup
+  backup
+  clear_backup
+  disable
+  enable
+  list
+  version
+  help
+)
+desc 'Help'
+task :help do
+  puts
+  puts "Usage: githook task_name"
+  puts
+  puts "task_name:"
+  TASKS_NAME.each do |task_name|
+    task = Rake::Task[task_name]
+    puts "  #{task_name.ljust(13)} -- #{task.comment}"
+  end
 end

data/lib/githook/util.rb

@@ -7,7 +7,11 @@ module Githook
     def self.run_tasks(hook_stage)
       tasks = fetch(hook_stage, [])
       tasks.each do |task|
-        Rake::Task[task].invoke
+        if Rake::Task.task_defined?(task)
+          Rake::Task[task].invoke
+        else
+          puts "#{task} task doesn't exist."
+        end
       end
     end
 

data/lib/githook/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-hook
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - baurine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-02 00:00:00.000000000 Z
+date: 2017-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler