githooks 0.0.1 → 0.0.2

data/README.md

@@ -1,7 +1,18 @@
 # Githooks
 
-TODO: Write a gem description
+A framework to manage git hooks with your repository. Codes in *_githooks.rb will be executed by the framework.
 
+## Convention
+Githooks will look for files named as filename_githooks.rb in your repository. The typical directory structure with Githooks will look like this,
+```
+/Your repository
+  /lib
+  /app
+  ...
+  /hooks
+    example_githooks.rb
+    example2_githooks.rb
+```
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,8 +29,40 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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
+*   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
+
+## Example
+```ruby
+# dummy_githooks.rb
+pre_commit do
+  puts "executed in pre commit hook"
+end
+
+commit_msg do
+  puts "executed in commit msg hook"
+  exit -1
+end
+```
 ## Contributing
 
 1. Fork it

data/bin/githooks

@@ -21,11 +21,14 @@ options = OptionParser.new do |opts|
   opts.separator ''
   opts.separator 'Options:'
   
-  opts.on('-i', '--install', 'Install githooks for the current project') do
+  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"
+    exit
   end
   
   opts.on( '-l', '--list', 'List supported git hooks') do

data/lib/githooks/base.rb

@@ -20,6 +20,11 @@ module Githooks
     pre_auto_gc
     post_rewrite]
   class Base
+
+    def initialize(args = nil)
+      @args = args
+    end
+    
     def execute
       lambda {
         hooks = []
@@ -44,9 +49,10 @@ module Githooks
         load file
       end
       
-      env = Object.new
+      # env = Object.new
       each_hook do |hook|
-        env.instance_eval &hook
+        # env.instance_eval &hook
+        hook.call @args
       end
     end
 

data/lib/githooks/version.rb

@@ -1,3 +1,3 @@
 module Githooks
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/hooks/applypatch-msg

@@ -5,4 +5,4 @@ require 'githooks'
 class ApplypatchMsg < Githooks::Base
 end
 
-ApplypatchMsg.new.execute
+ApplypatchMsg.new(ARGV).execute

data/lib/hooks/commit-msg

@@ -5,4 +5,4 @@ require 'githooks'
 class CommitMsg < Githooks::Base
 end
 
-CommitMsg.new.execute
+CommitMsg.new(ARGV).execute

data/lib/hooks/post-applypatch

@@ -5,4 +5,4 @@ require 'githooks'
 class PostApplypatch < Githooks::Base
 end
 
-PostApplypatch.new.execute
+PostApplypatch.new(ARGV).execute

data/lib/hooks/post-checkout

@@ -5,4 +5,4 @@ require 'githooks'
 class PostCheckout < Githooks::Base
 end
 
-PostCheckout.new.execute
+PostCheckout.new(ARGV).execute

data/lib/hooks/post-commit

@@ -5,4 +5,4 @@ require 'githooks'
 class PostCommit < Githooks::Base
 end
 
-PostCommit.new.execute
+PostCommit.new(ARGV).execute

data/lib/hooks/post-merge

@@ -5,4 +5,4 @@ require 'githooks'
 class PostMerge < Githooks::Base
 end
 
-PostMerge.new.execute
+PostMerge.new(ARGV).execute

data/lib/hooks/post-receive

@@ -5,4 +5,4 @@ require 'githooks'
 class PostReceive < Githooks::Base
 end
 
-PostReceive.new.execute
+PostReceive.new(ARGV).execute

data/lib/hooks/post-rewrite

@@ -5,4 +5,4 @@ require 'githooks'
 class PostRewrite < Githooks::Base
 end
 
-PostRewrite.new.execute
+PostRewrite.new(ARGV).execute

data/lib/hooks/post-update

@@ -5,4 +5,4 @@ require 'githooks'
 class PostUpdate < Githooks::Base
 end
 
-PostUpdate.new.execute
+PostUpdate.new(ARGV).execute

data/lib/hooks/pre-applypatch

@@ -5,4 +5,4 @@ require 'githooks'
 class PreApplypatch < Githooks::Base
 end
 
-PreApplypatch.new.execute
+PreApplypatch.new(ARGV).execute

data/lib/hooks/pre-auto-gc

@@ -5,4 +5,4 @@ require 'githooks'
 class PreAutoGc < Githooks::Base
 end
 
-PreAutoGc.new.execute
+PreAutoGc.new(ARGV).execute

data/lib/hooks/pre-commit

@@ -5,4 +5,4 @@ require 'githooks'
 class PreCommit < Githooks::Base
 end
 
-PreCommit.new.execute
+PreCommit.new(ARGV).execute

data/lib/hooks/pre-rebase

@@ -5,4 +5,4 @@ require 'githooks'
 class PreRebase < Githooks::Base
 end
 
-PreRebase.new.execute
+PreRebase.new(ARGV).execute

data/lib/hooks/pre-receive

@@ -5,4 +5,4 @@ require 'githooks'
 class PreReceive < Githooks::Base
 end
 
-PreReceive.new.execute
+PreReceive.new(ARGV).execute

data/lib/hooks/prepare-commit-msg

@@ -5,4 +5,4 @@ require 'githooks'
 class PrepareCommitMsg < Githooks::Base
 end
 
-PrepareCommitMsg.new.execute
+PrepareCommitMsg.new(ARGV).execute

data/lib/hooks/update

@@ -5,4 +5,4 @@ require 'githooks'
 class Update < Githooks::Base
 end
 
-Update.new.execute
+Update.new(ARGV).execute

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: githooks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: