rgithook 3.0.2

data/lib/rgithook/runner.rb

@@ -0,0 +1,178 @@
+module RGitHook
+   class Runner
+
+      attr_reader :binding
+
+      def initialize(repo) #::nodoc::
+         raise ArgumentError unless repo.is_a? ::Grit::Repo
+         @_repo = repo
+         @_hooks = {}
+         @_bg_hooks = {}
+         @options = Plugin.options_to_hash
+      end
+
+      # Define a hook that is executed when git-commands call these hook
+      # These is the very most important part of rgithook. These are all
+      # the hooks that you can run from git.
+      #
+      #   # GIT_DIR/hooks/rgithook.rb (edit by rgithook -e)
+      #
+      #   #These will make that you will never can commit anthing that brake the tests
+      #   on :pre_commit do
+      #     system(rake test)
+      #   end
+      #
+      #   #These will send test results of the master branch when the repo is updated
+      #   on :post_receive do |old_rev,new_rev,ref|
+      #     if ref =~ /master$/
+      #       %x(rake test | mail -s 'Updated #{ref}' guillermo@cientifico.net)
+      #     end
+      #   end
+      #
+      # Also you can make the hooks run in a separate process with background option
+      #
+      #   #These will run in background
+      #   on :post_receive, :background => true do |old_rev,new_rev,ref|
+      #     run_tests(repo) # These is a long runing operation
+      #   end
+      #
+      # The abailable hooks within git docs are:
+      #
+      # * <em>on <b>:applypatch_msg</b> do |commit_msg_path| </em>- Check the commit log message
+      #   taken by applypatch from an e-mail 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.<br/>
+      #   <em>commit_msg_path</em> - Is the file_path of the commit_message
+      #
+      # * <em>on <b>:commit_msg</b> do |commit_msg_path| </em>- 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.
+      #   These hook have *params*:
+      #   <em>commit_msg_path</em> - Is the file_path of the commit_message
+      #
+      # * <em>on <b>:post_commit</b> do </em>- Is called after a successful commit is made.
+      #
+      # * <em>on <b>:post_receive</b> do |old_rev,new_rev,ref| </em>- Is run after receive-pack has accepted a pack
+      #   and the repository has been updated. <em>old_rev</em>/<em>new_rev</em> Is the string old/new sha1 commit id.
+      #   <em>ref</em> is the string of the updated ref (<em>ref/head/master</em>).
+      #   These is the perfect hook to put your code in a bare central repo.
+      #
+      #     # Send to the authors off the commits the results of their commits
+      #     on :post_receive do |old_rev,new_rev,ref|
+      #       if ref =~ /master$/
+      #         emails = repo.commits_between(old_rev, new_rev).map{|c| c.author.email}.uniq
+      #         test = %x(rake test)
+      #         emails.each do |mail|
+      #           IO.popen("mail -s 'Updated #{repo_name}' #{mail}",'w') {|mail| mail.write test}
+      #         end
+      #       end
+      #     end
+      #
+      # * <em>on <b>:post_update</b> do</em> - Prepare a packed repository for use over
+      #   dumb transports.
+      #
+      # * <em>on <b>:pre_apply_patch</b> do</em> - Verify what is about to be committed
+      #   by applypatch from an e-mail message.
+      #   The hook should return non zero after issuing an
+      #   appropriate message if it wants to stop the commit.
+      #
+      # * <em>on <b>:pre_commit</b> do</em> - Verify what is about to be committed.
+      #   Called by git-commit with no arguments.  The hook should
+      #   return non-zero after issuing an appropriate message if
+      #   it wants to stop the commit.
+      #
+      # * <em>on <b>:pre_rebase</b> do</em> - Run just before "git-rebase" starts doing
+      #   its job, and can prevent the command from running by exiting with
+      #   non-zero status.
+      #
+      # * <em>on <b>:prepare_commit_msg</b> do |commit_msg_path,commit_src|</em> - 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 returns non-zero status,
+      #   the commit is aborted.
+      #
+      # In case of an unrescue exception rgithook will show a warning with the error and return 255 to git.
+      # In case of more than one block for the same hook, rgithook return to git the max value of all returns values of the same hook
+      #
+      #
+      def on(hook, options = {}, &block)
+         raise ArgumentError, "No block given for #{hook.to_s} in #{caller[0]}" unless block_given?
+         if HOOKS.include? hook.to_s
+            if options.delete(:background)
+               @_bg_hooks[hook] ||= []
+               @_bg_hooks[hook] << block
+            else
+               @_hooks[hook] ||= []
+               @_hooks[hook] << block
+            end
+         else
+            raise ArgumentError, "Not available hook #{hook.to_s} in #{caller[0]}"
+         end
+      end
+
+
+      # Run arbitrary code in runner context
+      def run(code,file=nil,line=nil)
+         file,line = caller.first.split(':') unless file && line
+         eval(code,binding,file,line.to_i)
+      end
+
+      def load(file)
+         hooks = File.file?(file) && File.read(file) || ''
+         eval(hooks, binding, file,0)
+      end
+
+      # Execute all the hooks defined in the configuration file
+      # Return a two dimension array. The first element is the outputs of the foreground_hooks.
+      # The second element is another array with the pids of the background_hooks
+      #   fg_hook_val, bg_hook_val = @runner.run_hooks(hook_name)
+      def run_hooks(hook_name, *args)
+         Plugin.load!
+         [run_foreground_hooks(hook_name,*args),run_background_hooks(hook_name,*args)]
+      end
+
+
+
+
+      def run_foreground_hooks(hook_name,*args)
+         ret_vals = []
+         @_hooks[hook_name.to_sym] && @_hooks[hook_name.to_sym].each do |hook|
+            ret_vals << hook.call(*args)
+         end
+         ret_vals
+      end
+
+      # Execute all the hooks in a new process
+      # Return an array with the pids of each hook process
+      def run_background_hooks(hook_name, *args)
+         ret_vals = []
+         @_bg_hooks[hook_name.to_sym] && @_bg_hooks[hook_name.to_sym].each do |hook|
+            ret_vals << fork {hook.call(*args)}
+         end
+         ret_vals
+      end
+
+      def repo
+         @_repo
+      end
+
+      # Hash with all the plugin options
+      #   option[:PluginName][:option] => option_value
+      #
+      #   option[PluginClass.to_sym][:option_group][:option_name] => option_value
+      #
+      def options
+         @options
+      end
+
+      # ::nodoc::
+      def load_options(options_file)
+         @options = YAML.load(File.read(options_file)) if File.file?(options_file)
+         @options ||={}
+      end
+   end
+end

data/lib/rgithook/templates/hook.rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rgithook'
+
+exit RGitHook::Hook.execute

data/lib/rgithook/templates/rgithook.rb

@@ -0,0 +1,18 @@
+# RGitHook hooks_file
+# To define a hook just type:
+#
+#   on :hook_name do |hook_params|
+#     ... Actions ...
+#   end
+#
+# Just simple.
+#
+# There is a few factory-made plugins ready to use
+#  * test (spec/cucumber/test::unit)
+#  * db Persisten layer for commit properties.
+
+
+
+
+
+

data/lib/rgithook/test/unit.rb

@@ -0,0 +1,70 @@
+
+
+class Test::Unit::TestCase
+  def mock_repo
+    repo = mock('grit_repo')
+    repo.stubs(:'is_a?').with(::Grit::Repo).returns(true)
+    repo.stubs(:path).returns('path')
+    repo
+  end
+
+  def create_rgithook_instance
+    # This is not really a rgithook_instance ;-P
+    ::RGitHook::Plugin.stubs(:load!)
+    ::RGitHook::RGitHook.stubs(:parse_path).with(@repo).returns(@repo)
+    ::RGitHook::Runner.stubs(:new).with(@repo).returns(@runner)
+    @runner.stubs(:load_options).with('plugin_conf_file')
+    @runner.stubs(:load).with('hooks_file')
+    ::RGitHook::RGitHook.any_instance.stubs(:plugin_conf_file).returns('plugin_conf_file')
+    ::RGitHook::RGitHook.any_instance.stubs(:hooks_file).returns('hooks_file')
+    ::RGitHook::RGitHook.new(@repo)
+  end
+
+  def in_temp_dir(&block)
+    old_dir = Dir.pwd
+    raise LocalJumpError, 'no block given' unless block_given?
+
+    tmpdir = File.expand_path(File.join(Dir.tmpdir,'rgithook-'+Time.now.usec.to_s+rand.to_s[2..-1]))
+    FileUtils.mkdir_p(tmpdir)
+    Dir.chdir tmpdir
+    ret_val = yield tmpdir
+    Dir.chdir old_dir
+    FileUtils.remove_dir(tmpdir)
+    ret_val
+  end
+
+  def in_sample_repo
+    in_temp_dir do |temp_file|
+      %x(unzip #{fixture_path('sample_repo.zip')})
+      yield ::Grit::Repo.new(temp_file)
+    end
+  end
+
+
+  def with_sample_rgithook
+    in_sample_repo do |repo|
+      @rgithook = ::RGitHook::RGitHook.new(repo)
+      yield @rgithook
+    end
+  end
+
+  # Execute something in the runner
+  # @rgithook must exists
+  def in_runner(code,file=nil,line=nil)
+    file,line = caller.first.split(":") unless file && line
+    if @rgithook
+      @rgithook.run(code,file,line)
+    else
+      with_sample_rgithook do
+        RGitHook::Plugin.load!
+        @rgithook.run(code,file,line)
+      end
+    end
+  end
+  
+  private
+  def fixture_path(fixture_name)
+    file = File.join(::RGitHook::PATH,'..','test','fixtures',fixture_name)
+    file if File.file?(file) or raise "Not found fixture in #{file}"
+  end
+end

data/rgithook.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rgithook}
+  s.version = "3.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Guillermo \303\201lvarez"]
+  s.cert_chain = ["/Users/guillermo/.rubygems/gem-public_cert.pem"]
+  s.date = %q{2009-02-02}
+  s.default_executable = %q{rgithook}
+  s.description = %q{Ruby gem specify for git hooks.}
+  s.email = %q{guillermo@cientifico.net}
+  s.executables = ["rgithook"]
+  s.extra_rdoc_files = ["bin/rgithook", "CHANGELOG", "lib/plugins/custom.rb", "lib/plugins/db.rb", "lib/plugins/email.rb", "lib/plugins/html/commit.html.erb", "lib/plugins/html/diff.html.erb", "lib/plugins/html.rb", "lib/plugins/rake.rb", "lib/plugins/spec/rgithook_formatter.rb", "lib/plugins/spec/spec_result.rb", "lib/plugins/temp.rb", "lib/plugins/test.rb", "lib/plugins/twitter.rb", "lib/rgithook/command_line.rb", "lib/rgithook/hook.rb", "lib/rgithook/plugin.rb", "lib/rgithook/rgithook.rb", "lib/rgithook/runner.rb", "lib/rgithook/templates/hook.rb", "lib/rgithook/templates/rgithook.rb", "lib/rgithook/test/unit.rb", "lib/rgithook.rb", "README.rdoc", "TODO.txt"]
+  s.files = ["bin/rgithook", "CHANGELOG", "lib/plugins/custom.rb", "lib/plugins/db.rb", "lib/plugins/email.rb", "lib/plugins/html/commit.html.erb", "lib/plugins/html/diff.html.erb", "lib/plugins/html.rb", "lib/plugins/rake.rb", "lib/plugins/spec/rgithook_formatter.rb", "lib/plugins/spec/spec_result.rb", "lib/plugins/temp.rb", "lib/plugins/test.rb", "lib/plugins/twitter.rb", "lib/rgithook/command_line.rb", "lib/rgithook/hook.rb", "lib/rgithook/plugin.rb", "lib/rgithook/rgithook.rb", "lib/rgithook/runner.rb", "lib/rgithook/templates/hook.rb", "lib/rgithook/templates/rgithook.rb", "lib/rgithook/test/unit.rb", "lib/rgithook.rb", "Manifest", "Rakefile", "README.rdoc", "rgithook.gemspec", "test/fixtures/sample_plugin.rb", "test/fixtures/sample_repo.zip", "test/integration/test_install.rb", "test/integration/test_pull_and_push.rb", "test/plugins/test_email.rb", "test/plugins/test_html.rb", "test/plugins/test_spec.rb", "test/plugins/test_test.rb", "test/test_helper.rb", "test/unit/test_command_line.rb", "test/unit/test_hook.rb", "test/unit/test_plugin.rb", "test/unit/test_rgithook.rb", "test/unit/test_runner.rb", "TODO.txt"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/guillermo/rgithook2}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Rgithook", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rgithook}
+  s.rubygems_version = %q{1.3.1}
+  s.signing_key = %q{/Users/guillermo/.rubygems/gem-private_key.pem}
+  s.summary = %q{You can deploy updated code, restart the web server, run the tests, email the diff, etc... You can use a cron to pull or a githook to run when pushed to the repo.}
+  s.test_files = ["test/integration/test_install.rb", "test/integration/test_pull_and_push.rb", "test/plugins/test_email.rb", "test/plugins/test_html.rb", "test/plugins/test_spec.rb", "test/plugins/test_test.rb", "test/test_helper.rb", "test/unit/test_command_line.rb", "test/unit/test_hook.rb", "test/unit/test_plugin.rb", "test/unit/test_rgithook.rb", "test/unit/test_runner.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mojombo-grit>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<mojombo-grit>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mojombo-grit>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end

data/test/fixtures/sample_plugin.rb

@@ -0,0 +1,28 @@
+class SamplePluginException < Exception ; end
+
+module OtherApp
+   class SamplePlugin < ::RGitHook::Plugin
+
+      option :test_option, 'Test Option description', :default_value, Symbol
+
+      option_group :test_group, 'Test Option group' do |opt_group|
+         opt_group.option :test_option_group_option, 'Test OptionGroup Option', :default_value, Symbol
+      end
+
+      module RunnerMethods
+         def test_method
+            'test_result'
+         end
+
+         def raised_method
+            raise SamplePluginException
+         end
+      end
+
+      module GritCommit
+         def test_method
+         end
+      end
+   end
+
+end

data/test/integration/test_install.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__)+'/../test_helper'
+
+class IntegrationTest < Test::Unit::TestCase
+
+   def test_inastall_without_confirmation
+      in_sample_repo do
+         @repo = ::RGitHook::RGitHook.new('.')
+         @repo.install(false)
+         assert File.file?('.git/hooks/rgithook.rb')
+         assert File.file?('.git/hooks/applypatch-msg')
+         assert File.file?('.git/hooks/commit-msg')
+         assert File.file?('.git/hooks/post-commit')
+         assert File.file?('.git/hooks/post-receive')
+         assert File.file?('.git/hooks/post-update')
+         assert File.file?('.git/hooks/pre-applypatch')
+         assert File.file?('.git/hooks/pre-commit')
+         assert File.file?('.git/hooks/pre-rebase')
+         assert File.file?('.git/hooks/prepare-commit-msg')
+         assert File.file?('.git/hooks/update')
+      end
+   end
+
+   def test_simple_hook
+      with_sample_rgithook do
+         File.open(@rgithook.conf_file,'w') do |f|
+        hook_file =<<-EOF
+        on :post_receive do |old_commit,new_commit,ref|
+          %x(touch \#{old_commit})
+          %x(touch \#{new_commit})
+          %x(touch \#{ref})
+        end
+        
+        on :pre_commit do
+          %x(rm a b c)
+        end
+            EOF
+            f.write(hook_file)
+         end
+
+         @rgithook = RGitHook::RGitHook.new('.')
+         @rgithook.post_receive('a','b','c')
+         assert File.file?('a')
+         assert File.file?('b')
+         assert File.file?('c')
+         @rgithook.pre_commit
+         assert !File.file?('a')
+         assert !File.file?('b')
+         assert !File.file?('c')
+      end
+   end
+
+   def test_project_name
+      with_sample_rgithook do
+         assert_match /^rgithook-(.*)/, @rgithook.project_name
+      end
+   end
+
+   def test_plugin_options
+
+      in_sample_repo do
+         @repo = RGitHook::RGitHook.new('.')
+         @repo.install(false)
+         @repo.save_plugin_options
+         assert File.file?('.git/hooks/rgithook.yaml')
+
+      end
+   end
+end

data/test/integration/test_pull_and_push.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__)+'/../test_helper'
+
+
+class FetchPullPushTest < Test::Unit::TestCase
+  
+  def test_a_default_installation
+    with_sample_rgithook do |rgithook1|
+      rgithook1.install(false)
+      
+      in_temp_dir do |dir|
+        %x(git clone #{rgithook1.path} sample_test)
+        Dir.chdir 'sample_test'
+        %x(touch asdf && git add . && git commit -m 'adf')
+        push_result = %x(git push)
+        assert_equal $?.to_i, 0, "Error:\n#{push_result}"
+      end
+    end
+    
+  end
+end

data/test/plugins/test_email.rb

@@ -0,0 +1,8 @@
+
+
+class EmailPluginTest < Test::Unit::TestCase
+
+   def test_email
+      in_runner "email('guillermo@cientifico.net','hello')"
+   end
+end