git-hook 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de19dce608753a5f44f2cded224fa71a86d4b9af
-  data.tar.gz: e94a4ea4e8c749e6acaabd4987d5a6f2de2e46b7
+  metadata.gz: 65d3e00ec19974b20450b6c052f4bbbc57eca0a1
+  data.tar.gz: 89525dbe7fededbc2bee68b46b29c03489535125
 SHA512:
-  metadata.gz: 976300f7c1cb7826321132a9f095adc76d85660d4c6ea432e45bfa92b3b85bf8c8e508f9d5eb2dd70e2ed3bc1f5c35475c4da2fbc8108b1f11dd0a3a1a2f961e
-  data.tar.gz: 9429b31337657ded853d3205291254cecec72eaf7da31741a802c0bbfd3c961c42d8363c6cfacde8bdd8a2051fa41b694cced74867725baffd32eb1578e211e4
+  metadata.gz: 7ec386606137eeb958e85cc1398649be9050cb570d644e81bb10e7a8539495c708d0418576c0cd9bfd0b96346b8c3027d4084e2e0cc17c3756d3025bce3d3ba9
+  data.tar.gz: 9cdb75174577473f3632cfb992d08a15a9e1930fd23b7551e2a16f99199275f0d1bed68e5153e0463110a2ee051220ddf5f3dad66c6eee3980c9095431e4d003

data/.gitignore

@@ -10,3 +10,9 @@
 
 # rspec failure tracking
 .rspec_status
+
+# built gem file
+*.gem
+
+# hooks
+.githook

data/README.md

@@ -1,15 +1,13 @@
 # Githook
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/githook`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A ruby gem that help to setup git hooks easily, base on Rake, inspired from Capistrano.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'githook'
+gem 'git-hook'
 ```
 
 And then execute:
@@ -18,24 +16,15 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install githook
+    $ gem install git-hook
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/githook. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+    $ githook install
+    $ githook setup
 
+More: TODO
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/bin/githook

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "githook"
+
+task_name = ARGV[0]
+begin
+  Rake::Task[task_name].invoke
+rescue => e
+  puts "Error: #{e.message}"
+end

data/build-install.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+# for build and install easier to test in local
+rm -f *.gem
+gem build githook.gemspec
+target=`ls *.gem`
+gem install $target

data/lib/githook.rb

@@ -1,4 +1,9 @@
+require "rake"
 require "githook/version"
+require "githook/context"
+require "githook/util"
+require "githook/tasks"
+require "githook/config"
 
 module Githook
   # Your code goes here...

data/lib/githook/config.rb

@@ -0,0 +1,3 @@
+if ARGV[0] != "install"
+  load ".githook/config.rb"
+end

data/lib/githook/context.rb

@@ -0,0 +1,21 @@
+module Githook
+  class Context
+    def self.set(key, value)
+      @env ||= {}
+      @env[key] = value
+    end
+  
+    def self.fetch(key, def_val)
+      @env ||= {}
+      @env[key] || def_val
+    end 
+  end
+end
+
+def set(key, value)
+  Githook::Context.set(key, value)
+end
+
+def fetch(key, def_val)
+  Githook::Context.fetch(key, def_val)
+end

data/lib/githook/tasks.rb

@@ -0,0 +1,11 @@
+# load rake files from lib
+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 }
+end

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

@@ -0,0 +1,21 @@
+namespace :commit_msg do
+  desc 'check commit msg style'
+  task :check_msg do |t|
+    Githook::Util.log(t.name)
+
+    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)
+
+    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
+
+desc 'run all commit-msg hook tasks'
+task :commit_msg do |t|
+  Githook::Util.log(t.name)
+  Githook::Util.run_tasks(t.name.to_sym)
+end

data/lib/githook/tasks/install.rake

@@ -0,0 +1,22 @@
+task :install do |t|
+  # step 1, check whether Dir.pwd is in git repo root folder
+  git_path = ".git"
+  unless Dir.exists?(git_path)
+    puts "It isn't in a git repo root folder."
+    exit 1
+  end
+
+  # step 2, check whether '.githook' folder already exists
+  githook_path = ".githook"
+  if Dir.exists?(githook_path)
+    print ".githook already exists, do you want to override it? [y/(n)]: "
+    choice = STDIN.gets
+    exit 0 if ["n", "N", "\n"].include?(choice[0])
+    FileUtils.rm_r(githook_path)
+  end
+
+  # setup 3, copy templates to .githook
+  templates_path = File.expand_path("../../templates", __FILE__)
+  FileUtils.cp_r(templates_path, githook_path)
+  puts "Create .githook folder."
+end

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

@@ -0,0 +1,19 @@
+namespace :pre_commit do
+  desc 'check ruby code style by rubocop'
+  task :rubocop do |t|
+    Githook::Util.log(t.name)
+    exit 1 unless system("bundle exec rubocop")
+  end
+
+  desc 'test by rspec'
+  task :rspec do |t|
+    Githook::Util.log(t.name)
+    exit 1 unless system("bundle exec rspec")
+  end
+end
+
+desc 'run all pre-commit hook tasks'
+task :pre_commit do |t|
+  Githook::Util.log(t.name)
+  Githook::Util.run_tasks(t.name.to_sym)
+end

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

@@ -0,0 +1,21 @@
+namespace :prepare_commit_msg do
+  desc 'prepare commit msg'
+  task :prepare do |t|
+    Githook::Util.log(t.name)
+
+    commit_msg_file = '.git/COMMIT_EDITMSG'
+    # can't use return in block
+    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)
+  end
+end
+
+desc 'run all prepare-commit-msg hook tasks'
+task :prepare_commit_msg do |t|
+  Githook::Util.log(t.name)
+  Githook::Util.run_tasks(t.name.to_sym)
+end

data/lib/githook/tasks/setup.rake

@@ -0,0 +1,58 @@
+desc 'setup hooks'
+task :setup do |t|
+  Githook::Util.log(t.name)
+
+  # setup 1, check whether has '.git-hooks/hooks' and '.git' folder
+  hooks_path = '.githook/hooks'
+  unless Dir.exists?(hooks_path)
+    puts "There isn't .git-hooks/hooks folder."
+    exit 1
+  end
+
+  git_path = '.git'
+  unless Dir.exists?(git_path)
+    puts "There isn't .git folder."
+    exit 1
+  end
+
+  # setup 2, backup hooks
+  Rake::Task[:backup_hooks].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)
+
+  has_backup = false
+  Dir.glob('.git/hooks/*').each do |path|
+    file_name = path.split('/').last
+    next if file_name.include?('.')
+
+    appendix = ".#{Time.now.strftime("%Y%m%d%H%m%S")}.bak"
+    puts "Backup old #{file_name} to #{file_name}#{appendix}"
+    FileUtils.cp(path, "#{path}#{appendix}")
+    has_backup = true
+  end
+
+  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)
+
+  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)
+
+  hooks = Dir.glob('.git/hooks/*')
+             .reject { |path| path.split('/').last.include?('.') }
+  Githook::Util.interactive_delete_files(hooks, 'hooks')
+end

data/lib/githook/templates/config.rb

@@ -0,0 +1,11 @@
+# you can uncomment following lines if it is a ruby project
+# set :pre_commit, fetch(:pre_commit, []).push(
+#   'pre_commit:rubocop',
+#   'pre_commit:rspec',
+# )
+set :prepare_commit_msg, fetch(:prepare_commit_msg, []).push(
+  'prepare_commit_msg:prepare'
+)
+set :commit_msg, fetch(:commit_msg, []).push(
+  'commit_msg:check_msg'
+)

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

@@ -0,0 +1,27 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message.
+# Called by "git commit" with one argument, the name of the file
+# that has the commit message.  The hook should exit with non-zero
+# status after issuing an appropriate message if it wants to stop the
+# commit.  The hook is allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "commit-msg".
+
+# Uncomment the below to add a Signed-off-by line to the message.
+# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
+# hook is more suited to it.
+#
+# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
+
+# This example catches duplicate Signed-off-by lines.
+
+test "" = "$(grep '^Signed-off-by: ' "$1" |
+	 sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
+	echo >&2 Duplicate Signed-off-by lines.
+	exit 1
+}
+
+# custom commit-msg hooks
+githook commit_msg

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

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# An example hook script to verify what is about to be committed.
+# Called by "git commit" with no arguments.  The hook should
+# exit with non-zero status after issuing an appropriate message if
+# it wants to stop the commit.
+#
+# To enable this hook, rename this file to "pre-commit".
+
+if git rev-parse --verify HEAD >/dev/null 2>&1
+then
+	against=HEAD
+else
+	# Initial commit: diff against an empty tree object
+	against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
+fi
+
+# If you want to allow non-ASCII filenames set this variable to true.
+allownonascii=$(git config --bool hooks.allownonascii)
+
+# Redirect output to stderr.
+exec 1>&2
+
+# custom pre-commit hooks
+githook pre_commit
+if [ $? -ne 0 ]; then
+  exit 1
+fi
+
+# Cross platform projects tend to avoid non-ASCII filenames; prevent
+# them from being added to the repository. We exploit the fact that the
+# printable range starts at the space character and ends with tilde.
+if [ "$allownonascii" != "true" ] &&
+	# Note that the use of brackets around a tr range is ok here, (it's
+	# even required, for portability to Solaris 10's /usr/bin/tr), since
+	# the square bracket bytes happen to fall in the designated range.
+	test $(git diff --cached --name-only --diff-filter=A -z $against |
+	  LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
+then
+	cat <<\EOF
+Error: Attempt to add a non-ASCII file name.
+
+This can cause problems if you want to work with people on other platforms.
+
+To be portable it is advisable to rename the file.
+
+If you know what you are doing you can disable this check using:
+
+  git config hooks.allownonascii true
+EOF
+	exit 1
+fi
+
+# If there are whitespace errors, print the offending file names and fail.
+exec git diff-index --check --cached $against --

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

@@ -0,0 +1,39 @@
+#!/bin/sh
+#
+# An example hook script to prepare the commit log message.
+# Called by "git commit" with the name of the file that has the
+# commit message, followed by the description of the commit
+# message's source.  The hook's purpose is to edit the commit
+# message file.  If the hook fails with a non-zero status,
+# the commit is aborted.
+#
+# To enable this hook, rename this file to "prepare-commit-msg".
+
+# This hook includes three examples.  The first comments out the
+# "Conflicts:" part of a merge commit.
+#
+# The second includes the output of "git diff --name-status -r"
+# into the message, just before the "git status" output.  It is
+# commented because it doesn't cope with --amend or with squashed
+# commits.
+#
+# The third example adds a Signed-off-by line to the message, that can
+# still be edited.  This is rarely a good idea.
+
+case "$2,$3" in
+  merge,)
+    /usr/bin/perl -i.bak -ne 's/^/# /, s/^# #/#/ if /^Conflicts/ .. /#/; print' "$1" ;;
+
+# ,|template,)
+#   /usr/bin/perl -i.bak -pe '
+#      print "\n" . `git diff --cached --name-status -r`
+#	 if /^#/ && $first++ == 0' "$1" ;;
+
+  *) ;;
+esac
+
+# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
+
+# custom prepare-commit-msg hooks
+githook prepare_commit_msg

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

@@ -0,0 +1,8 @@
+# define yourself tasks here
+# or put them in a new .rake file
+#
+# namespace :pre_commit do
+#   task :checkstyle do
+#     # ...
+#   end
+# end

data/lib/githook/util.rb

@@ -0,0 +1,96 @@
+module Githook
+  class Util
+    def self.log(task_name)
+      puts "[#{Time.now.strftime('%H:%m:%S')}] #{task_name.gsub('_', ' ')}"
+    end
+
+    def self.run_tasks(hook_stage)
+      tasks = fetch(hook_stage, [])
+      tasks.each do |task|
+        Rake::Task[task].invoke
+      end
+    end
+
+    #######################################################
+
+    def self.interactive_delete_files(path_arr, type)
+      if path_arr.length == 0
+        puts "There are no #{type}."
+      else
+        puts "There are following #{type}:"
+        puts path_arr
+        print "Are you sure want to delete all of them [(y)/n]: "
+        # https://stackoverflow.com/a/40643667/2998877
+        choice = STDIN.gets
+        if ["Y", "y", "\n"].include?(choice[0])
+          path_arr.each do |path|
+            FileUtils.rm(path)
+            puts "Delete #{path}"
+          end
+        end
+      end
+    end
+
+    #######################################################
+
+    # check whether origin commit msg is empty
+    def self.commit_msg_empty?(commit_msg_file)
+      File.open(commit_msg_file, 'r') do |f|
+        f.readlines.each do |line|
+          strip_line = line.strip
+          return false if (!strip_line.empty? && !strip_line.start_with?('#'))
+        end
+      end
+      true
+    end
+
+    BRANCH_NAME_REG = /^(feature|bug|hotfix|misc|refactor)\/(\d*)?(\w*)/
+    # generate pre msg according branch name
+    def self.gen_pre_msg(branch_name)
+      match_group = 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|
+        ori_content = f.read
+        f.seek(0, IO::SEEK_SET)
+        f.puts pre_msg
+        f.puts ori_content
+      end
+    end
+
+    def self.get_commit_msg(commit_msg_file)
+      commit_msg = ''
+      File.open(commit_msg_file, 'r') do |f|
+        f.readlines.each do |line|
+          strip_line = line.strip
+          if !strip_line.empty? && !strip_line.start_with?('#')
+            commit_msg = line
+            break
+          end
+        end
+      end
+      commit_msg
+    end
+
+    MSG_FORMAT_REG = /^(FEATURE|BUG|MISC|REFACTOR)(\s#\d+)* - ([A-Z].*)/
+    # check commit msg style
+    def self.expected_msg_format?(commit_msg)
+      commit_msg.start_with?('Merge branch') || MSG_FORMAT_REG.match(commit_msg)
+    end
+  end
+end

data/lib/githook/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-hook
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - baurine
@@ -56,8 +56,7 @@ description: Help to setup git hooks easily, base on Rake, inspired from Capistr
 email:
 - 2008.hbl@gmail.com
 executables:
-- console
-- setup
+- githook
 extensions: []
 extra_rdoc_files: []
 files:
@@ -68,10 +67,24 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- bin/githook
+- build-install.sh
 - githook.gemspec
 - lib/githook.rb
+- lib/githook/config.rb
+- lib/githook/context.rb
+- lib/githook/tasks.rb
+- lib/githook/tasks/commit-msg.rake
+- lib/githook/tasks/install.rake
+- lib/githook/tasks/pre-commit.rake
+- lib/githook/tasks/prepare-commit-msg.rake
+- lib/githook/tasks/setup.rake
+- lib/githook/templates/config.rb
+- lib/githook/templates/hooks/commit-msg
+- lib/githook/templates/hooks/pre-commit
+- lib/githook/templates/hooks/prepare-commit-msg
+- lib/githook/templates/tasks/task.rake
+- lib/githook/util.rb
 - lib/githook/version.rb
 homepage: https://github.com/baurine/githook
 licenses:

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "githook"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here