git_tracker 1.1.0 → 1.2.0

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 tags
+.rvmrc

data/README.md

@@ -68,6 +68,26 @@ the top)*
 
 ```
 
+## Keywords
+You can use the custom keywords that Pivotal Tracker provide with the API.
+
+The keywords are [Delivers] and [Fixes]
+
+If you use those keywords in your commit message, the keyword will be prepended to the story ID in the commit message.
+
+For example:
+
+```bash
+# on branch named `bug/redis_connection_not_initializing_#8675309`
+$ git commit -am "changed the redis connection string [Fixes]"
+```
+
+Will result in a this being appended to the commit message
+
+```bash
+[Fixes #8675309]
+```
+
 You should then add a [useful and responsible commit message][tpope]. :heart:
 
 ### Valid branch names

data/Rakefile

@@ -1,5 +1,5 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)

data/lib/git_tracker.rb

@@ -1,6 +1,6 @@
-require "git_tracker/hook"
-require "git_tracker/prepare_commit_message"
-require "git_tracker/version"
+require 'git_tracker/hook'
+require 'git_tracker/prepare_commit_message'
+require 'git_tracker/version'
 
 module GitTracker
   def self.execute(cmd_arg, *args)

data/lib/git_tracker/branch.rb

@@ -1,4 +1,5 @@
 require 'English'
+require 'git_tracker/repository'
 
 module GitTracker
   module Branch
@@ -9,9 +10,15 @@ module GitTracker
     def self.current
       branch_path = `git symbolic-ref HEAD`
 
-      abort unless $CHILD_STATUS.exitstatus == 0
+      Repository.ensure_exists unless exit_successful?
 
       branch_path[%r{refs/heads/(?<name>.+)}, :name] || ''
     end
+
+    private
+
+    def self.exit_successful?
+      $CHILD_STATUS.exitstatus == 0
+    end
   end
 end

data/lib/git_tracker/commit_message.rb

@@ -10,6 +10,11 @@ module GitTracker
       @message =~ /^(?!#).*\[(\w+\s)?(#\d+\s)*##{number}(\s#\d+)*(\s\w+)?\]/io
     end
 
+    def keyword
+      @message =~ /\[(Delivers|Fixes)\]/
+      $1
+    end
+
     def append(text)
       body, postscript = parse(@message)
       new_message = format_message(body, text, postscript)
@@ -23,7 +28,7 @@ module GitTracker
 
     def parse(message)
       lines = message.split($/)
-      body = lines.take_while { |line| !line.start_with?("#") }
+      body = lines.take_while { |line| !line.start_with?('#') }
       postscript = lines.slice(body.length..-1)
       [body.join("\n"), postscript.join("\n")]
     end

data/lib/git_tracker/prepare_commit_message.rb

@@ -16,15 +16,23 @@ module GitTracker
     end
 
     def run
-      story = story_number_from_branch
+      exit_when_commit_exists
 
+      story = story_number_from_branch
       message = CommitMessage.new(file)
       exit if message.mentions_story?(story)
-      message.append("[##{story}]")
+      keyword = message.keyword
+
+      message_addition = [keyword, "##{story}"].compact.join(' ')
+      message.append("[#{message_addition}]")
     end
 
     private
 
+    def exit_when_commit_exists
+      exit if source == 'commit'
+    end
+
     def story_number_from_branch
       story = Branch.story_number
       exit unless story

data/lib/git_tracker/repository.rb

@@ -9,5 +9,9 @@ module GitTracker
       path
     end
 
+    def self.ensure_exists
+      root
+    end
+
   end
 end

data/lib/git_tracker/version.rb

@@ -1,3 +1,3 @@
 module GitTracker
-  VERSION = "1.1.0"
+  VERSION = '1.2.0'
 end

data/spec/git_tracker/branch_spec.rb

@@ -1,3 +1,4 @@
+require 'spec_helper'
 require 'git_tracker/branch'
 
 describe GitTracker::Branch do
@@ -16,40 +17,41 @@ describe GitTracker::Branch do
       subject.current
     end
 
-    it 'aborts with non-zero exit status when not in a Git repository' do
-      stub_branch(nil, 128)
+    it 'ensures in a Git repository when looking for HEAD exits with non-zero status' do
+      stub_branch('', 128)
 
-      -> { subject.current }.should raise_error SystemExit
+      GitTracker::Repository.should_receive(:ensure_exists)
+      subject.current
     end
   end
 
   describe '.story_number' do
-    context "Current branch has a story number" do
-      it "finds the story that starts with a hash" do
+    context 'Current branch has a story number' do
+      it 'finds the story that starts with a hash' do
         stub_branch('refs/heads/a_very_descriptive_name_#8675309')
         subject.story_number.should == '8675309'
       end
 
-      it "finds the story without a leading hash" do
+      it 'finds the story without a leading hash' do
         stub_branch('refs/heads/a_very_descriptive_name_1235309')
         subject.story_number.should == '1235309'
       end
 
-      it "finds the story following a forward hash" do
+      it 'finds the story following a forward hash' do
         stub_branch('refs/heads/alindeman/8675309_got_her_number')
         subject.story_number.should == '8675309'
       end
     end
 
-    context "The current branch doesn't have a story number" do
-      it "finds no story" do
+    context 'The current branch does not have a story number' do
+      it 'finds no story' do
         stub_branch('refs/heads/a_very_descriptive_name_without_a_#number')
         subject.story_number.should_not be
       end
     end
 
-    context "Not on a branch (HEAD doesn't exist)" do
-      it "finds no story" do
+    context 'Not on a branch (HEAD does not exist)' do
+      it 'finds no story' do
         stub_branch('')
         subject.story_number.should_not be
       end

data/spec/git_tracker/commit_message_spec.rb

@@ -6,76 +6,88 @@ describe GitTracker::CommitMessage do
   include CommitMessageHelper
 
   subject { described_class.new(file) }
-  let(:file) { "COMMIT_EDITMSG" }
+  let(:file) { 'COMMIT_EDITMSG' }
 
-  it "requires path to the temporary commit message file" do
-    -> { GitTracker::CommitMessage.new }.should raise_error ArgumentError
+  it 'requires path to the temporary commit message file' do
+    lambda { GitTracker::CommitMessage.new }.should raise_error ArgumentError
   end
 
-  describe "#mentions_story?" do
-    def stub_commit_message(story_text)
-      File.stub(:read).with(file) { example_commit_message(story_text) }
+  def stub_commit_message(story_text)
+    File.stub(:read).with(file) { example_commit_message(story_text) }
+  end
+
+  describe '#keyword' do
+    it 'should return the correct keyword' do
+      stub_commit_message('[Delivers]')
+      subject.keyword.should == 'Delivers'
+    end
+
+    it 'should return nil when there no keyword matching' do
+      stub_commit_message('[Something]')
+      subject.keyword.should be_nil
     end
+  end
 
-    context "commit message contains the special Pivotal Tracker story syntax" do
-      it "allows just the number" do
-        stub_commit_message("[#8675309]")
-        subject.should be_mentions_story("8675309")
+  describe '#mentions_story?' do
+    context 'commit message contains the special Pivotal Tracker story syntax' do
+      it 'allows just the number' do
+        stub_commit_message('[#8675309]')
+        subject.should be_mentions_story('8675309')
       end
 
-      it "allows multiple numbers" do
-        stub_commit_message("[#99 #777 #8675309 #111222]")
-        subject.should be_mentions_story("99")
-        subject.should be_mentions_story("777")
-        subject.should be_mentions_story("8675309")
-        subject.should be_mentions_story("111222")
+      it 'allows multiple numbers' do
+        stub_commit_message('[#99 #777 #8675309 #111222]')
+        subject.should be_mentions_story('99')
+        subject.should be_mentions_story('777')
+        subject.should be_mentions_story('8675309')
+        subject.should be_mentions_story('111222')
       end
 
-      it "allows state change before number" do
-        stub_commit_message("[Fixes #8675309]")
-        subject.should be_mentions_story("8675309")
+      it 'allows state change before number' do
+        stub_commit_message('[Fixes #8675309]')
+        subject.should be_mentions_story('8675309')
       end
 
-      it "allows state change after the number" do
-        stub_commit_message("[#8675309 Delivered]")
-        subject.should be_mentions_story("8675309")
+      it 'allows state change after the number' do
+        stub_commit_message('[#8675309 Delivered]')
+        subject.should be_mentions_story('8675309')
       end
 
-      it "allows surrounding text" do
-        stub_commit_message("derp de #herp [Fixes #8675309] de herp-ity derp")
-        subject.should be_mentions_story("8675309")
+      it 'allows surrounding text' do
+        stub_commit_message('derp de #herp [Fixes #8675309] de herp-ity derp')
+        subject.should be_mentions_story('8675309')
       end
     end
 
-    context "commit message doesn't contain the special Pivotal Tracker story syntax" do
-      it "requires brackets" do
-        stub_commit_message("#8675309")
-        subject.should_not be_mentions_story("8675309")
+    context 'commit message doesn not contain the special Pivotal Tracker story syntax' do
+      it 'requires brackets' do
+        stub_commit_message('#8675309')
+        subject.should_not be_mentions_story('8675309')
       end
 
-      it "requires a pound sign" do
-        stub_commit_message("[8675309]")
-        subject.should_not be_mentions_story("8675309")
+      it 'requires a pound sign' do
+        stub_commit_message('[8675309]')
+        subject.should_not be_mentions_story('8675309')
       end
 
-      it "doesn't allow the bare number" do
-        stub_commit_message("8675309")
-        subject.should_not be_mentions_story("8675309")
+      it 'does not allow the bare number' do
+        stub_commit_message('8675309')
+        subject.should_not be_mentions_story('8675309')
       end
 
-      it "doesn't allow multiple state changes" do
-        stub_commit_message("[Fixes Deploys #8675309]")
-        subject.should_not be_mentions_story("8675309")
+      it 'does not allow multiple state changes' do
+        stub_commit_message('[Fixes Deploys #8675309]')
+        subject.should_not be_mentions_story('8675309')
       end
 
-      it "doesn't allow comments" do
-        stub_commit_message("#[#8675309]")
-        subject.should_not be_mentions_story("8675309")
+      it 'does not allow comments' do
+        stub_commit_message('#[#8675309]')
+        subject.should_not be_mentions_story('8675309')
       end
     end
   end
 
-  describe "#append" do
+  describe '#append' do
     let(:fake_file) { GitTracker::FakeFile.new }
     before do
       File.stub(:open).and_yield(fake_file)
@@ -84,9 +96,9 @@ describe GitTracker::CommitMessage do
       File.stub(:read) { message }
     end
 
-    it "handles no existing message" do
+    it 'handles no existing message' do
       stub_original_commit_message("\n\n# some other comments\n")
-      subject.append("[#8675309]")
+      subject.append('[#8675309]')
 
       fake_file.content.should == <<-COMMIT_MESSAGE.strip_heredoc
 
@@ -96,9 +108,9 @@ describe GitTracker::CommitMessage do
       COMMIT_MESSAGE
     end
 
-    it "preserves existing messages" do
+    it 'preserves existing messages' do
       stub_original_commit_message("A first line\n\nWith more here\n# other comments\n")
-      subject.append("[#8675309]")
+      subject.append('[#8675309]')
 
       fake_file.content.should == <<-COMMIT_MESSAGE.strip_heredoc
         A first line
@@ -110,9 +122,9 @@ describe GitTracker::CommitMessage do
       COMMIT_MESSAGE
     end
 
-    it "preserves line breaks in comments" do
+    it 'preserves line breaks in comments' do
       stub_original_commit_message("# comment #1\n# comment B\n# comment III")
-      subject.append("[#8675309]")
+      subject.append('[#8675309]')
 
       fake_file.content.should == <<-COMMIT_MESSAGE.strip_heredoc
 
@@ -124,5 +136,4 @@ describe GitTracker::CommitMessage do
       COMMIT_MESSAGE
     end
   end
-
 end

data/spec/git_tracker/prepare_commit_message_spec.rb

@@ -1,73 +1,96 @@
+require 'spec_helper'
 require 'git_tracker/prepare_commit_message'
 
 describe GitTracker::PrepareCommitMessage do
   subject { GitTracker::PrepareCommitMessage }
 
   describe '.run' do
-    let(:hook) { stub("PrepareCommitMessage") }
+    let(:hook) { stub('PrepareCommitMessage') }
     before do
       subject.stub(:new) { hook }
     end
 
-    it "runs the hook" do
+    it 'runs the hook' do
       hook.should_receive(:run)
-      subject.run("FILE1", "hook_source", "sha1234")
+      subject.run('FILE1', 'hook_source', 'sha1234')
     end
   end
 
-  describe ".new" do
+  describe '.new' do
 
-    it "requires the name of the commit message file" do
+    it 'requires the name of the commit message file' do
       lambda { subject.new }.should raise_error(ArgumentError)
     end
 
-    it "remembers the name of the commit message file" do
-      subject.new("FILE1").file.should == "FILE1"
+    it 'remembers the name of the commit message file' do
+      subject.new('FILE1').file.should == 'FILE1'
     end
 
-    it "optionally accepts a message source" do
-      hook = subject.new("FILE1", "merge").source.should == "merge"
+    it 'optionally accepts a message source' do
+      hook = subject.new('FILE1', 'merge').source.should == 'merge'
     end
 
-    it "optionally accepts the SHA-1 of a commit" do
-      hook = subject.new("FILE1", "commit", "abc1234").commit_sha.should == "abc1234"
+    it 'optionally accepts the SHA-1 of a commit' do
+      hook = subject.new('FILE1', 'commit', 'abc1234').commit_sha.should == 'abc1234'
     end
   end
 
   describe '#run' do
-    let(:hook) { GitTracker::PrepareCommitMessage.new("FILE1") }
+    let(:hook) { GitTracker::PrepareCommitMessage.new('FILE1') }
     before do
       GitTracker::Branch.stub(:story_number) { story }
     end
 
-    context "branch name without a Pivotal Tracker story number" do
+    context 'with an existing commit (via `-c`, `-C`, or `--amend` options)' do
+      let(:hook) { described_class.new('FILE2', 'commit', '60a086f3') }
+
+      it 'exits with status code 0' do
+        lambda { hook.run }.should succeed
+      end
+    end
+
+    context 'branch name without a Pivotal Tracker story number' do
       let(:story) { nil }
 
-      it "exits without updating the commit message" do
-        lambda { hook.run }.should raise_exception(SystemExit)
+      it 'exits without updating the commit message' do
+        lambda { hook.run }.should succeed
         GitTracker::CommitMessage.should_not have_received(:append)
       end
     end
 
-    context "branch name with a Pivotal Tracker story number" do
-      let(:story) { "8675309" }
-      let(:commit_message) { stub("CommitMessage", mentions_story?: false) }
+    context 'branch name with a Pivotal Tracker story number' do
+      let(:story) { '8675309' }
+      let(:commit_message) { stub('CommitMessage', mentions_story?: false) }
+
       before do
+        commit_message.stub(:keyword) { nil }
         GitTracker::CommitMessage.stub(:new) { commit_message }
       end
 
-      it "appends the number to the commit message" do
-        commit_message.should_receive(:append).with("[#8675309]")
+      it 'appends the number to the commit message' do
+        commit_message.should_receive(:append).with('[#8675309]')
         hook.run
       end
 
-      context "number already mentioned in the commit message" do
+      context 'keyword mentioned in the commit message' do
+        before do
+          commit_message.stub(:mentions_story?).with('8675309') { false }
+          commit_message.stub(:keyword) { 'Delivers' }
+        end
+
+        it 'appends the keyword and the story number' do
+          commit_message.should_receive(:append).with('[Delivers #8675309]')
+          hook.run 
+        end
+      end
+
+      context 'number already mentioned in the commit message' do
         before do
-          commit_message.stub(:mentions_story?).with("8675309") { true }
+          commit_message.stub(:mentions_story?).with('8675309') { true }
         end
 
-        it "exits without updating the commit message" do
-          lambda { hook.run }.should raise_exception(SystemExit)
+        it 'exits without updating the commit message' do
+          lambda { hook.run }.should succeed
           GitTracker::CommitMessage.should_not have_received(:append)
         end
       end

data/spec/git_tracker/repository_spec.rb

@@ -1,23 +1,31 @@
+require 'spec_helper'
 require 'git_tracker/repository'
 
 describe GitTracker::Repository do
   subject { described_class }
+  let(:git_command) { 'git rev-parse --show-toplevel' }
+  before do
+    allow_message_expectations_on_nil
+    subject.stub(:`).with(git_command) { "/path/to/git/repo/root\n" }
+  end
 
   describe '.root' do
-    let(:git_command) { 'git rev-parse --show-toplevel' }
-    before do
-      allow_message_expectations_on_nil
-      subject.stub(:`).with(git_command) { "/path/to/git/repo/root\n" }
+
+    it 'gets the path to the top-level directory of the local Repository' do
       $?.stub(:exitstatus) { 0 }
+      subject.root.should == '/path/to/git/repo/root'
     end
 
-    it "gets the path to the local Repository's top-level directory" do
-      subject.root.should == '/path/to/git/repo/root'
+    it 'aborts when not in a git repository' do
+      $?.stub(:exitstatus) { 128 }
+      lambda { subject.root }.should_not succeed
     end
+  end
 
+  describe '.ensure_exists' do
     it 'aborts when not in a git repository' do
       $?.stub(:exitstatus) { 128 }
-      -> { subject.root }.should raise_error SystemExit
+      lambda { subject.root }.should_not succeed
     end
   end
 

data/spec/git_tracker_spec.rb

@@ -1,34 +1,34 @@
+require 'spec_helper'
 require 'git_tracker'
 
 describe GitTracker do
   subject { described_class }
-  let(:args) { ["a_file", "the_source", "sha1234"] }
+  let(:args) { ['a_file', 'the_source', 'sha1234'] }
 
-  describe ".execute" do
+  describe '.execute' do
     before do
       subject.stub(:prepare_commit_msg) { true }
     end
 
-    it "runs the hook, passing the args" do
+    it 'runs the hook, passing the args' do
       subject.should_receive(:prepare_commit_msg).with(*args) { true }
       subject.execute('prepare-commit-msg', *args)
     end
 
     # TODO: stop the abort from writing to stderr during tests?
-    it "doesn't run hooks we don't know about" do
-      lambda { subject.execute('non-existent-hook', *args) }.
-        should raise_error SystemExit, "[git_tracker] command: 'non-existent-hook' does not exist."
+    it 'does not run hooks we do not know about' do
+      lambda { subject.execute('non-existent-hook', *args) }.should_not succeed
     end
   end
 
-  describe ".prepare_commit_msg" do
-    it "runs the hook, passing the args" do
+  describe '.prepare_commit_msg' do
+    it 'runs the hook, passing the args' do
       GitTracker::PrepareCommitMessage.should_receive(:run).with(*args) { true }
       subject.prepare_commit_msg(*args)
     end
   end
 
-  describe ".install" do
+  describe '.install' do
     it 'tells the hook to install itself' do
       GitTracker::Hook.should_receive(:install)
       subject.install

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'fake_file'
 require 'commit_message_helper'
+require_relative 'support/matchers/exit_code_matchers'
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

data/spec/support/matchers/exit_code_matchers.rb

@@ -0,0 +1,33 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :succeed do
+  actual = nil
+
+  match do |block|
+    begin
+      block.call
+    rescue SystemExit => e
+      actual = e.status
+    end
+    actual and actual == successful_exit_code
+  end
+
+  failure_message_for_should do |block|
+    "expected block to call exit(#{successful_exit_code}) but exit" +
+      (actual.nil? ? ' not called' : "(#{actual}) was called")
+  end
+
+  failure_message_for_should_not do |block|
+    "expected block not to call exit(#{successful_exit_code})"
+  end
+
+  description do
+    "expect block to call exit(#{successful_exit_code})"
+  end
+
+  def successful_exit_code
+    0
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git_tracker
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-03 00:00:00.000000000 Z
+date: 2012-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70367025411540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *70367025411540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: rspec-spies
-  requirement: &70367025410760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70367025410760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70367025410280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: 0.9.8
   type: :development
   prerelease: false
-  version_requirements: *70367025410280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.8
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70367025409820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +69,15 @@ dependencies:
         version: '3.2'
   type: :development
   prerelease: false
-  version_requirements: *70367025409820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70367025409440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +85,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70367025409440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! "    Some simple tricks that make working with Pivotal Tracker even\n
   \   better... and easier... um, besier!\n"
 email:
@@ -101,6 +126,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/commit_message_helper.rb
 - spec/support/fake_file.rb
+- spec/support/matchers/exit_code_matchers.rb
 homepage: https://github.com/highgroove/git_tracker
 licenses: []
 post_install_message: 
@@ -121,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Teaching Git about Pivotal Tracker.
@@ -135,3 +161,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/commit_message_helper.rb
 - spec/support/fake_file.rb
+- spec/support/matchers/exit_code_matchers.rb