githooks 0.0.3 → 0.0.4

data/README.md

@@ -33,7 +33,7 @@ After the gem is installed, you need to initialize githooks in your repository.
 
     $ githooks --init
 
-Following key words can be used in your githooks.rb files
+Following key words can be used in your filename_githooks.rb files
 *   applypatch_msg
 *   pre_applypatch
 *   post_applypatch
@@ -51,6 +51,8 @@ Following key words can be used in your githooks.rb files
 *   pre_auto_gc
 *   post_rewrite
 
+The framework enable you to group different git hooks in one file and manage hooks based on their functionalities. Arguments for a specific hook is yielded to its corresponding marco. For example, you can access commit file through commit_msg { |args| p args[0] }  
+
 ## Example
 ```ruby
 # dummy_githooks.rb
@@ -58,11 +60,23 @@ pre_commit do
   puts "executed in pre commit hook"
 end
 
-commit_msg do
-  puts "executed in commit msg hook"
-  exit -1
+commit_msg do |args|
+  git_root = `git rev-parse --show-toplevel`.chop
+  
+  message_file = args[0]
+  message = File.read(git_root+'/'+message_file)
+  
+  $regex = /\[ref: (\d+)\]/
+  
+  if !$regex.match(message)
+    puts "[POLICY] Your message is not formatted correctly"
+    exit 1
+  end
 end
 ```
+
+The example hook checks whether the commit message follows the provided pattern. 
+
 ## Contributing
 
 1. Fork it

data/bin/githooks

@@ -23,11 +23,13 @@ options = OptionParser.new do |opts|
   
   opts.on('-i', '--init', 'Initialize githooks for the current repository') do
     exit unless system("git rev-parse")
-    puts "Copying git hooks..."
-    git_root = `git rev-parse --show-toplevel`.chop
-    gem_root = File.expand_path "..", File.dirname($0)
-    FileUtils.cp_r(Dir["#{gem_root}/gems/githooks-#{Githooks::VERSION}/lib/hooks/*"], "#{git_root}/.git/hooks")
-    puts "git hooks initialized"
+    if ask "githooks --init will override your existing hooks, continue? ", false
+      puts "Copying git hooks..."
+      git_root = `git rev-parse --show-toplevel`.chop
+      gem_root = File.expand_path "..", File.dirname($0)
+      FileUtils.cp_r(Dir["#{gem_root}/gems/githooks-#{Githooks::VERSION}/lib/hooks/*"], "#{git_root}/.git/hooks")
+      puts "git hooks initialized"
+    end
     exit
   end
   

data/lib/githooks/helper.rb

@@ -0,0 +1,15 @@
+module Githooks
+  module Helper
+    def ask(question, default=true)
+      option_string = default ? '[Y/n]' : '[y/N]'
+      response = nil
+      while (response != "Y\n") && (response != "N\n") && (response != "\n")
+        print "#{question} #{option_string} "
+        response = gets
+        response.upcase!
+      end
+      return default if response == "\n"
+      return (response == "Y\n") ? true : false
+    end
+  end
+end

data/lib/githooks/version.rb

@@ -1,3 +1,3 @@
 module Githooks
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/githooks.rb

@@ -1,6 +1,5 @@
 require "githooks/version"
 require "githooks/base"
+require "githooks/helper"
 
-module Githooks
-  # Your code goes here...
-end
+self.extend Githooks::Helper

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: githooks
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-11 00:00:00.000000000 Z
+date: 2012-10-12 00:00:00.000000000 Z
 dependencies: []
 description: git hooks framework in Ruby
 email:
@@ -29,6 +29,7 @@ files:
 - githooks.gemspec
 - lib/githooks.rb
 - lib/githooks/base.rb
+- lib/githooks/helper.rb
 - lib/githooks/version.rb
 - lib/hooks/applypatch-msg
 - lib/hooks/commit-msg