captain_hook 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Adam Pearson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,30 @@
+= captain_hook
+
+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
+  
+  @hook = CaptainHook.from_path(File.join(File.dirname(__FILE__), "..",".."))
+
+  @hook.handle_post_receive do
+    @room = Campfire.room(1)
+    @room.message "New commit: '#{message}' by #{author} to #{ref_name}"
+  end
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Adam Pearson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = "captain_hook"
+    gem.summary     = %Q{A ruby manager for git hooks}
+    gem.description = %Q{Makes handling git hooks easy, with built-in notification to campfire}
+    gem.email       = "ampearson@gmail.com"
+    gem.homepage    = "http://github.com/radamant/captain_hook"
+    gem.authors     = ["Adam Pearson"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "grit", "2.0.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "captain_hook #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/captain_hook.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# 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.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.description = %q{Makes handling git hooks easy, with built-in notification to campfire}
+  s.email = %q{ampearson@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "captain_hook.gemspec",
+     "lib/captain_hook.rb",
+     "lib/captain_hook/base.rb",
+     "lib/captain_hook/dsl.rb",
+     "lib/captain_hook/dsl/handle_post_receive.rb",
+     "lib/captain_hook/post_receive_event.rb",
+     "spec/captain_hook/base_spec.rb",
+     "spec/captain_hook/dsl/handle_post_receive_spec.rb",
+     "spec/captain_hook/post_receive_event_spec.rb",
+     "spec/captain_hook_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  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.summary = %q{A ruby manager for git hooks}
+  s.test_files = [
+    "spec/captain_hook/base_spec.rb",
+     "spec/captain_hook/dsl/handle_post_receive_spec.rb",
+     "spec/captain_hook/post_receive_event_spec.rb",
+     "spec/captain_hook_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<grit>, ["= 2.0.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<grit>, ["= 2.0.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<grit>, ["= 2.0.0"])
+  end
+end
+

data/lib/captain_hook.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'grit'
+module CaptainHook
+  require 'captain_hook/base'
+  require 'captain_hook/post_receive_event'
+  require 'captain_hook/dsl'
+  
+  def self.from_path(path)
+    repo = Grit::Repo.new(path)
+    Base.new(repo)
+  end
+end

data/lib/captain_hook/base.rb

@@ -0,0 +1,29 @@
+module CaptainHook
+  class Base
+    attr_accessor :repo
+    
+    def initialize(repo)
+      @repo = repo
+    end
+
+    def handle_post_receive(data = nil, &block)
+      data = data || $stdin
+      post_receive = post_receive_from_data(data)
+      
+      dsl = CaptainHook::DSL::HandlePostReceive.new(post_receive)
+      dsl.run(&block) if block_given?
+    end
+    
+    private
+    
+    def post_receive_from_data(data)
+      args = data.read.split(" ")
+      post_receive = CaptainHook::PostReceiveEvent.new(
+        :old_sha  => args[0],
+        :new_sha  => args[1],
+        :ref_name => args[2],
+        :repo     => @repo
+      )
+    end
+  end  
+end

data/lib/captain_hook/dsl.rb

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

data/lib/captain_hook/dsl/handle_post_receive.rb

@@ -0,0 +1,26 @@
+module CaptainHook
+  module DSL
+    class HandlePostReceive
+      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
+      
+      def ref_name
+        @post_receive_event.ref_name
+      end
+      
+      def author
+        @post_receive_event.author
+      end
+      
+      def run &block
+        instance_eval &block
+      end
+    end
+  end
+end

data/lib/captain_hook/post_receive_event.rb

@@ -0,0 +1,44 @@
+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

data/spec/captain_hook/base_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe CaptainHook::Base do
+  context "with a valid repo" do
+    before(:each) do
+      @repo = mock("Git repo").as_null_object
+      @hook = CaptainHook::Base.new(@repo)
+    end
+
+    describe :handle_post_receive do
+      before(:each) do        
+        @yielded = nil
+        @args = "sha1 sha2 refree"
+        $stdin.stub!(:read).and_return(@args)
+      end
+      
+      it "should call run on a CaptainHook::DSL::HandlePostReceive" do
+        dsl = mock()
+        CaptainHook::DSL::HandlePostReceive.stub!(:new).and_return(dsl)
+        dsl.should_receive(:run)
+        @hook.handle_post_receive {}
+      end
+      
+      it "should use $stdin to parse args" do
+        CaptainHook::PostReceiveEvent.
+          should_receive(:new).
+          with({
+            :old_sha => "sha1",
+            :new_sha => "sha2",
+            :ref_name => "refree",
+            :repo => @repo
+          })
+            
+        @hook.handle_post_receive
+      end
+    end
+    
+    
+  end
+  
+end

data/spec/captain_hook/dsl/handle_post_receive_spec.rb

@@ -0,0 +1,31 @@
+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",
+      :ref_name => "misty mountain hop"
+    )
+  end
+
+  subject{ CaptainHook::DSL::HandlePostReceive.new(@event)}
+
+  it "should return the event's commit message for #message" do
+    subject.message.should == "hey hey, mama"
+  end
+  
+  it "should return the event's author for #author" do
+    subject.author.should == "zeppelin"
+  end
+  
+  it "should return the event's ref_name for #ref_name" do
+    subject.ref_name.should == "misty mountain hop"
+  end
+  
+  it "should let a block run against itself like a good DSL" do
+    subject.run do
+      "#{author} - #{ref_name}"
+    end.should == "zeppelin - misty mountain hop"
+  end
+end

data/spec/captain_hook/post_receive_event_spec.rb

@@ -0,0 +1,91 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe CaptainHook::PostReceiveEvent do
+  before(:each) do
+    @repo = mock('repo')
+    @ref_name = 'refs/heads/master'
+    @old_commit = mock('commit').as_null_object
+    @new_commit = mock('commit').as_null_object
+    @repo.stub!(:commit).with('oldsha').and_return(@old_commit)
+    @repo.stub!(:commit).with('newsha').and_return(@new_commit)    
+  end
+  
+  subject { 
+    CaptainHook::PostReceiveEvent.new(
+      :old_sha => "oldsha",
+      :new_sha => "newsha",
+      :ref_name => @ref_name,
+      :repo => @repo
+    )
+  }
+  
+  it "should expose new_commit" do
+    subject.new_commit.should == @new_commit
+  end
+  
+  it "should expose old_commit" do
+    subject.old_commit.should == @old_commit
+  end
+  
+  describe "#ref_name" do
+    it "should parse from refs/heads/etc" do
+      subject.ref_name.should == "master"
+    end
+    
+    it "should return 'unknown' if it can't be parsed" do
+      @ref_name = "bogus"
+      subject.ref_name.should == "unknown"
+    end
+    
+  end
+  
+  describe "#commits" do
+    it "should expose commits between old and new" do
+      @repo.stub!(:commits_between).and_return(%w{id ego})
+      subject.commits.should == %w{id ego}
+    end
+
+    it "should cache the list of commits" do
+      @repo.should_receive(:commits_between).
+        once().
+        and_return(true)
+      2.times { subject.commits }
+    end
+    
+    it "should get the commits from old -> new" do
+      @repo.should_receive(:commits_between).with(@new_commit, @old_commit)
+      subject.commits
+    end
+  end
+  
+  context "convenience api" do
+    before(:each) do
+      message = <<EOM
+this message is going to be long
+
+i mean really long
+and longer
+EOM
+      subject.stub!(:new_commit).and_return(mock(:message => message))
+    end
+    
+    describe "#author" do
+      it "should return new_commit.author" do
+        subject.stub!(:new_commit).and_return(mock(:author => "Kurt Vonnegut"))
+        subject.author.should == "Kurt Vonnegut"
+      end
+    end
+    
+    describe "#message" do
+      it "should return the first line of new_commit#message" do
+        subject.message.should == "this message is going to be long"
+      end
+    end
+    
+    describe "#message_detail" do
+      it "should return lines 1.. of the new_commit#message" do
+        subject.message_detail.should == "i mean really long\nand longer"
+      end
+    end
+  end
+end

data/spec/captain_hook_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "CaptainHook" do
+  describe "CaptainHook.from_path" do
+    before(:each) do
+      Grit::Repo.stub!(:new)
+    end
+    it "should create a grit repo based on the path" do
+      Grit::Repo.should_receive(:new).with('foo')
+      c = CaptainHook.from_path('foo')
+    end    
+    
+    it "should return an instance of CaptainHook" do
+      CaptainHook.from_path('foo').should be_an_instance_of(CaptainHook::Base)
+    end
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'captain_hook'
+require 'spec'
+require 'spec/autorun'
+
+require 'rubygems'
+require 'grit'
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: captain_hook
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Adam Pearson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-25 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: grit
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+description: Makes handling git hooks easy, with built-in notification to campfire
+email: ampearson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- captain_hook.gemspec
+- lib/captain_hook.rb
+- lib/captain_hook/base.rb
+- lib/captain_hook/dsl.rb
+- lib/captain_hook/dsl/handle_post_receive.rb
+- lib/captain_hook/post_receive_event.rb
+- spec/captain_hook/base_spec.rb
+- spec/captain_hook/dsl/handle_post_receive_spec.rb
+- spec/captain_hook/post_receive_event_spec.rb
+- spec/captain_hook_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/radamant/captain_hook
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+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_receive_spec.rb
+- spec/captain_hook/post_receive_event_spec.rb
+- spec/captain_hook_spec.rb
+- spec/spec_helper.rb