captain_hook 0.1.0 → 0.1.1

data/CHANGELOG.markdown

@@ -0,0 +1,8 @@
+# captain_hook 0.1.1
+
+* Added `post-commit` hook to DSL
+
+# captain_hook 0.1.0
+
+* Initial release
+* `post-receive` hook added to DSL

data/README.rdoc

@@ -4,15 +4,33 @@ A ruby library for managing git hooks.
 
 == Usage
 
-=== A post-receive hook sending to campfire (using your favorite campfire lib)
-your_repo/.git/hooks/post-receive:
-  #! /usr/bin/env ruby
+=== An example post-receive hook sending to campfire (tinder)
+your_repo/.git/hooks/post-receive
+  require 'captain_hook'
+  require 'tinder'
   
-  @hook = CaptainHook.from_path(File.join(File.dirname(__FILE__), "..",".."))
+  hook = CaptainHook.from_path("../../")
 
-  @hook.handle_post_receive do
-    @room = Campfire.room(1)
-    @room.message "New commit: '#{message}' by #{author} to #{ref_name}"
+  hook.handle_post_receive do
+    room = MyCampfire.my_room
+    room.speak "New commit: '#{message}' by #{author} to #{ref_name}"
+  end
+  
+=== An example post-commit hook sending an email detailing the commit
+your_repo/.git/hooks/post-commit
+  require 'captain_hook'
+  require 'mail'
+
+  hook = CaptainHook.from_path(File.join(File.dirname(__FILE__), '..','..'))
+  hook.handle_post_commit do
+    mail =        Mail.new 
+    mail.from     'from@example.com'
+    mail.to       'to@example.com'
+    mail.subject  "#{message} committed by #{author} to #{ref_name}"
+    mail.body     diff
+  
+    mail.delivery_method(:sendmail)
+    mail.deliver
   end
 
 == Note on Patches/Pull Requests

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/captain_hook.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{captain_hook}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adam Pearson"]
-  s.date = %q{2010-02-25}
+  s.date = %q{2010-03-02}
   s.description = %q{Makes handling git hooks easy, with built-in notification to campfire}
   s.email = %q{ampearson@gmail.com}
   s.extra_rdoc_files = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "CHANGELOG.markdown",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
@@ -27,11 +28,17 @@ Gem::Specification.new do |s|
      "lib/captain_hook.rb",
      "lib/captain_hook/base.rb",
      "lib/captain_hook/dsl.rb",
+     "lib/captain_hook/dsl/base.rb",
+     "lib/captain_hook/dsl/handle_post_commit.rb",
      "lib/captain_hook/dsl/handle_post_receive.rb",
-     "lib/captain_hook/post_receive_event.rb",
+     "lib/captain_hook/events.rb",
+     "lib/captain_hook/events/post_commit.rb",
+     "lib/captain_hook/events/post_receive.rb",
      "spec/captain_hook/base_spec.rb",
+     "spec/captain_hook/dsl/handle_post_commit_spec.rb",
      "spec/captain_hook/dsl/handle_post_receive_spec.rb",
-     "spec/captain_hook/post_receive_event_spec.rb",
+     "spec/captain_hook/events/post_commit_spec.rb",
+     "spec/captain_hook/events/post_receive_spec.rb",
      "spec/captain_hook_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
@@ -39,12 +46,14 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/radamant/captain_hook}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{A ruby manager for git hooks}
   s.test_files = [
     "spec/captain_hook/base_spec.rb",
+     "spec/captain_hook/dsl/handle_post_commit_spec.rb",
      "spec/captain_hook/dsl/handle_post_receive_spec.rb",
-     "spec/captain_hook/post_receive_event_spec.rb",
+     "spec/captain_hook/events/post_commit_spec.rb",
+     "spec/captain_hook/events/post_receive_spec.rb",
      "spec/captain_hook_spec.rb",
      "spec/spec_helper.rb"
   ]

data/lib/captain_hook.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'grit'
 module CaptainHook
   require 'captain_hook/base'
-  require 'captain_hook/post_receive_event'
+  require 'captain_hook/events'
   require 'captain_hook/dsl'
   
   def self.from_path(path)

data/lib/captain_hook/base.rb

@@ -14,11 +14,18 @@ module CaptainHook
       dsl.run(&block) if block_given?
     end
     
+    def handle_post_commit(&block)
+      post_commit = CaptainHook::Events::PostCommit.new(:repo => self.repo)
+      if block_given?
+        CaptainHook::DSL::HandlePostCommit.new(post_commit).run(&block)
+      end
+    end
+    
     private
     
     def post_receive_from_data(data)
       args = data.read.split(" ")
-      post_receive = CaptainHook::PostReceiveEvent.new(
+      post_receive = CaptainHook::Events::PostReceive.new(
         :old_sha  => args[0],
         :new_sha  => args[1],
         :ref_name => args[2],

data/lib/captain_hook/dsl.rb

@@ -1,5 +1,7 @@
 module CaptainHook
   module DSL
+    require 'captain_hook/dsl/base'
     require 'captain_hook/dsl/handle_post_receive'
+    require 'captain_hook/dsl/handle_post_commit'
   end
 end

data/lib/captain_hook/dsl/base.rb

@@ -0,0 +1,9 @@
+module CaptainHook
+  module DSL
+    module Base
+      def run &block
+        instance_eval &block
+      end
+    end
+  end
+end

data/lib/captain_hook/dsl/handle_post_commit.rb

@@ -0,0 +1,29 @@
+module CaptainHook
+  module DSL
+    class HandlePostCommit
+      include Base
+      
+      def initialize(event)
+        @event = event
+      end
+      
+      def message
+        @event.message
+      end
+      
+      def author
+        @event.author
+      end
+      
+      def diff
+        @event.diff
+      end
+      
+      def ref_name
+        @event.ref_name
+      end
+      
+        
+    end
+  end
+end

data/lib/captain_hook/dsl/handle_post_receive.rb

@@ -1,12 +1,13 @@
 module CaptainHook
   module DSL
     class HandlePostReceive
+      include Base
+      
       def initialize(post_receive_event)
         @post_receive_event = post_receive_event
       end
 
       def message
-        puts "post-receive: #{@post_receive_event.message}"
         @post_receive_event.message
       end
       
@@ -16,11 +17,7 @@ module CaptainHook
       
       def author
         @post_receive_event.author
-      end
-      
-      def run &block
-        instance_eval &block
-      end
+      end      
     end
   end
 end

data/lib/captain_hook/events.rb

@@ -0,0 +1,6 @@
+module CaptainHook
+  module Events
+    require 'captain_hook/events/post_receive'
+    require 'captain_hook/events/post_commit'
+  end
+end

data/lib/captain_hook/events/post_commit.rb

@@ -0,0 +1,36 @@
+module CaptainHook
+  module Events
+    class PostCommit
+      def initialize(options={})
+        @repo = options[:repo]
+      end
+      
+      # The represents the git commit object in question
+      def commit
+        @commit ||= @repo.commit(@repo.head.commit)
+      end
+      
+      # The commit message
+      def message
+        commit.message
+      end
+      
+      def author
+        commit.author
+      end
+      
+      # The diff string from the commit
+      # Concatenates all of the sub-diffs into one string
+      def diff
+        @diff ||= begin
+          commit.diffs.collect{|diff| diff.diff}.join("\n")
+        end
+      end
+      
+      def ref_name
+        @ref_name ||= @repo.head.name
+      end
+    
+    end
+  end
+end

data/lib/captain_hook/events/post_receive.rb

@@ -0,0 +1,45 @@
+module CaptainHook
+  module Events
+    class PostReceive
+      attr_accessor :repo, :old_commit, :new_commit
+
+      def initialize(options = {})
+        @repo       = options[:repo]
+        @old_commit = @repo.commit(options[:old_sha])
+        @new_commit = @repo.commit(options[:new_sha])
+        @full_ref_name   = options[:ref_name]
+      end
+    
+      def commits
+        @commits ||= @repo.commits_between(new_commit, old_commit)
+      end
+    
+      def ref_name
+        @ref_name ||= begin
+          @full_ref_name =~ %r{^refs/(?:tags|heads|remotes)/(.+)} ?
+            $1 : "unknown"
+        end
+      end
+    
+      # Returns the author of the most-recent revision
+      def author
+        new_commit.author
+      end
+    
+      # Returns the first line of the most recent revision's commit message
+      def message
+        @message ||= new_commit.message.split("\n")[0]
+      end
+    
+      # Returns lines 1..n of the most recent revision's commit message
+      def message_detail
+        @message_detail ||= begin
+          new_commit.message.
+            split("\n")[1..-1].
+            reject{|s| s == ""}.
+            join("\n")
+          end
+      end  
+    end
+  end
+end

data/spec/captain_hook/base_spec.rb

@@ -9,7 +9,6 @@ describe CaptainHook::Base do
 
     describe :handle_post_receive do
       before(:each) do        
-        @yielded = nil
         @args = "sha1 sha2 refree"
         $stdin.stub!(:read).and_return(@args)
       end
@@ -22,7 +21,7 @@ describe CaptainHook::Base do
       end
       
       it "should use $stdin to parse args" do
-        CaptainHook::PostReceiveEvent.
+        CaptainHook::Events::PostReceive.
           should_receive(:new).
           with({
             :old_sha => "sha1",
@@ -35,6 +34,22 @@ describe CaptainHook::Base do
       end
     end
     
+    describe :handle_post_commit do
+      it "should call run on the right DSL handler" do
+        dsl = mock()
+        CaptainHook::DSL::HandlePostCommit.stub!(:new).and_return(dsl)
+        dsl.should_receive(:run)
+        @hook.handle_post_commit {}
+      end
+      
+      it "should create a post-commit event with the repo" do
+        CaptainHook::Events::PostCommit.should_receive(:new).with({:repo => @repo})
+        @hook.handle_post_commit
+      end
+      
+    end
+  
+    
     
   end
   

data/spec/captain_hook/dsl/handle_post_commit_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe CaptainHook::DSL::HandlePostCommit do
+  before(:each) do
+    @event = mock('post_commit_event',
+      :message  => "wave a white flag",
+      :author   => "costello",
+      :ref_name => "put away the pistol",
+      :diff     => "none"
+    )
+  end
+
+  subject{ CaptainHook::DSL::HandlePostCommit.new(@event)}
+
+  it "should return the event's commit message for #message" do
+    subject.message.should == "wave a white flag"
+  end
+  
+  it "should return the event's author for #author" do
+    subject.author.should == "costello"
+  end
+  
+  it "should return the event's ref_name for #ref_name" do
+    subject.ref_name.should == "put away the pistol"
+  end
+  
+  it "should return the event's diff for #diff" do
+    subject.diff.should == "none"
+  end
+  
+  it "should let a block run against itself like a good DSL" do
+    subject.run do
+      "#{author} - #{ref_name}"
+    end.should == "costello - put away the pistol"
+    
+  end
+end

data/spec/captain_hook/dsl/handle_post_receive_spec.rb

@@ -3,8 +3,8 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 describe CaptainHook::DSL::HandlePostReceive do
   before(:each) do
     @event = mock('post_receive_event',
-      :message => "hey hey, mama",
-      :author => "zeppelin",
+      :message  => "hey hey, mama",
+      :author   => "zeppelin",
       :ref_name => "misty mountain hop"
     )
   end

data/spec/captain_hook/events/post_commit_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe CaptainHook::Events::PostCommit do
+  before(:each) do
+    @diff = mock('diff', :diff => "foo")
+    @repo = mock('repo', 
+      :head   => mock('head', :commit => 'sha1', :name => "talking"),
+      :commit => mock('commit', 
+        :message => 'been a long time',
+        :author  => 'a visionary',
+        :diffs   => [@diff, @diff, @diff])
+    )
+  end
+  
+  subject { CaptainHook::Events::PostCommit.new(:repo => @repo) }
+  
+  it "should expose the latest commit" do
+    subject.commit.message.should be
+  end
+  
+  it "should expose the message of the latest commit" do
+    subject.message.should == "been a long time"
+  end
+  
+  it "should expose the author of the latest commit" do
+    subject.author.should == 'a visionary'
+  end
+  
+  it "should expose the ref-name of the latest commit" do
+    subject.ref_name.should == "talking"
+  end
+  
+  describe "#diff" do
+    it "should concatenate the diffs from the latest commit" do
+      expected_diff = "#{@diff.diff}\n#{@diff.diff}\n#{@diff.diff}"
+      subject.diff.should == expected_diff
+    end
+  end
+end

data/spec/captain_hook/{post_receive_event_spec.rb → events/post_receive_spec.rb}

@@ -1,6 +1,6 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
-describe CaptainHook::PostReceiveEvent do
+describe CaptainHook::Events::PostReceive do
   before(:each) do
     @repo = mock('repo')
     @ref_name = 'refs/heads/master'
@@ -11,7 +11,7 @@ describe CaptainHook::PostReceiveEvent do
   end
   
   subject { 
-    CaptainHook::PostReceiveEvent.new(
+    CaptainHook::Events::PostReceive.new(
       :old_sha => "oldsha",
       :new_sha => "newsha",
       :ref_name => @ref_name,

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: captain_hook
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Adam Pearson
@@ -9,29 +14,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-25 00:00:00 -08:00
+date: 2010-03-02 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
         version: 1.2.9
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: grit
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
         version: 2.0.0
-    version: 
+  type: :runtime
+  version_requirements: *id002
 description: Makes handling git hooks easy, with built-in notification to campfire
 email: ampearson@gmail.com
 executables: []
@@ -44,6 +57,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- CHANGELOG.markdown
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -52,11 +66,17 @@ files:
 - lib/captain_hook.rb
 - lib/captain_hook/base.rb
 - lib/captain_hook/dsl.rb
+- lib/captain_hook/dsl/base.rb
+- lib/captain_hook/dsl/handle_post_commit.rb
 - lib/captain_hook/dsl/handle_post_receive.rb
-- lib/captain_hook/post_receive_event.rb
+- lib/captain_hook/events.rb
+- lib/captain_hook/events/post_commit.rb
+- lib/captain_hook/events/post_receive.rb
 - spec/captain_hook/base_spec.rb
+- spec/captain_hook/dsl/handle_post_commit_spec.rb
 - spec/captain_hook/dsl/handle_post_receive_spec.rb
-- spec/captain_hook/post_receive_event_spec.rb
+- spec/captain_hook/events/post_commit_spec.rb
+- spec/captain_hook/events/post_receive_spec.rb
 - spec/captain_hook_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -73,24 +93,28 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A ruby manager for git hooks
 test_files: 
 - spec/captain_hook/base_spec.rb
+- spec/captain_hook/dsl/handle_post_commit_spec.rb
 - spec/captain_hook/dsl/handle_post_receive_spec.rb
-- spec/captain_hook/post_receive_event_spec.rb
+- spec/captain_hook/events/post_commit_spec.rb
+- spec/captain_hook/events/post_receive_spec.rb
 - spec/captain_hook_spec.rb
 - spec/spec_helper.rb

data/lib/captain_hook/post_receive_event.rb

@@ -1,44 +0,0 @@
-module CaptainHook
-  class PostReceiveEvent
-    attr_accessor :repo, :old_commit, :new_commit
-
-    def initialize(options = {})
-      @repo       = options[:repo]
-      @old_commit = @repo.commit(options[:old_sha])
-      @new_commit = @repo.commit(options[:new_sha])
-      @full_ref_name   = options[:ref_name]
-    end
-    
-    def commits
-      @commits ||= @repo.commits_between(new_commit, old_commit)
-    end
-    
-    def ref_name
-      @ref_name ||= begin
-        @full_ref_name =~ %r{^refs/(?:tags|heads|remotes)/(.+)} ?
-          $1 : "unknown"
-      end
-    end
-    
-    # Returns the author of the most-recent revision
-    def author
-      new_commit.author
-    end
-    
-    # Returns the first line of the most recent revision's commit message
-    def message
-      @message ||= new_commit.message.split("\n")[0]
-    end
-    
-    # Returns lines 1..n of the most recent revision's commit message
-    def message_detail
-      @message_detail ||= begin
-        new_commit.message.
-          split("\n")[1..-1].
-          reject{|s| s == ""}.
-          join("\n")
-        end
-    end
-        
-  end
-end