git_tracker 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tags

data/.rspec

@@ -0,0 +1,4 @@
+--colour
+-I spec/support
+-r rspec-spies
+-r pry

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in git_tracker.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Steven Harman
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# GitTracker
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'git_tracker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install git_tracker
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/git-tracker

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'git_tracker'
+GitTracker.execute(*ARGV)

data/git_tracker.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/git_tracker/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "git_tracker"
+  gem.version       = GitTracker::VERSION
+  gem.authors       = ["Steven Harman"]
+  gem.email         = ["steveharman@gmail.com"]
+  gem.homepage      = "https://github.com/highgroove/git_tracker"
+  gem.summary       = %q{Teaching Git about Pivotal Tracker.}
+  gem.description   = <<-EOF
+    Some simple tricks that make working with Pivotal Tracker even
+    better... and easier... um, besier!
+  EOF
+
+  gem.add_development_dependency "rspec", "~> 2.0"
+  gem.add_development_dependency "rspec-spies", "~> 2.0"
+  gem.add_development_dependency "pry", "~> 0.9.8"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = %w(git-tracker)
+  gem.require_paths = ["lib"]
+end

data/lib/git_tracker.rb

@@ -0,0 +1,14 @@
+require "git_tracker/version"
+require "git_tracker/prepare_commit_message"
+
+module GitTracker
+  def self.execute(hook, *args)
+    hook_name = hook.gsub(/-/, '_')
+    abort("[git_tracker] hook: '#{hook}' does not exist.") unless respond_to?(hook_name)
+    send(hook_name, *args)
+  end
+
+  def self.prepare_commit_msg(*args)
+    PrepareCommitMessage.run(*args)
+  end
+end

data/lib/git_tracker/branch.rb

@@ -0,0 +1,12 @@
+module GitTracker
+  module Branch
+    def self.story_number
+      current[/#(?<number>\d+)/, :number]
+    end
+
+    def self.current
+      branch_path = `git symbolic-ref HEAD`
+      branch_path[%r{refs/heads/(?<name>.+)}, :name] || ''
+    end
+  end
+end

data/lib/git_tracker/commit_message.rb

@@ -0,0 +1,40 @@
+module GitTracker
+  class CommitMessage
+
+    def initialize(file)
+      @file = file
+      @message = File.read(@file)
+    end
+
+    def mentions_story?(number)
+      @message =~ /^(?!#).*\[(\w+\s)?(#\d+\s)*##{number}(\s#\d+)*(\s\w+)?\]/io
+    end
+
+    def append(text)
+      body, postscript = parse(@message)
+      new_message = format_message(body, text, postscript)
+      File.open(@file, 'w') do |f|
+        f.write(new_message)
+      end
+      new_message
+    end
+
+    private
+
+    def parse(message)
+      lines = message.split($/)
+      body = lines.take_while { |line| !line.start_with?("#") }
+      postscript = lines.slice(body.length..-1)
+      [body.join("\n"), postscript.join("\n")]
+    end
+
+    def format_message(preamble, text, postscript)
+      return <<-MESSAGE
+#{preamble.strip}
+
+#{text}
+#{postscript}
+MESSAGE
+    end
+  end
+end

data/lib/git_tracker/prepare_commit_message.rb

@@ -0,0 +1,34 @@
+require 'git_tracker/branch'
+require 'git_tracker/commit_message'
+
+module GitTracker
+  class PrepareCommitMessage
+    attr_reader :file, :source, :commit_sha
+
+    def self.run(file, source=nil, commit_sha=nil)
+      new(file, source, commit_sha).run
+    end
+
+    def initialize(file, source=nil, commit_sha=nil)
+      @file = file
+      @source = source
+      @commit_sha = commit_sha
+    end
+
+    def run
+      story = story_number_from_branch
+
+      message = CommitMessage.new(file)
+      exit if message.mentions_story?(story)
+      message.append("[##{story}]")
+    end
+
+    private
+
+    def story_number_from_branch
+      story = Branch.story_number
+      exit unless story
+      story
+    end
+  end
+end

data/lib/git_tracker/version.rb

@@ -0,0 +1,3 @@
+module GitTracker
+  VERSION = "0.0.1"
+end

data/prepare-commit-msg.example

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+git-tracker prepare-commit-msg "$@"
+

data/spec/git_tracker/branch_spec.rb

@@ -0,0 +1,38 @@
+require 'git_tracker/branch'
+
+describe GitTracker::Branch do
+  subject { described_class }
+
+  def stub_branch(ref)
+    subject.stub('`') { ref }
+  end
+
+  context "Current branch has a story number" do
+    before do
+      stub_branch('refs/heads/a_very_descriptive_name_#8675309')
+    end
+
+    it "shells out to git, looking for the current HEAD" do
+      subject.should_receive('`').with('git symbolic-ref HEAD')
+      subject.story_number
+    end
+
+    it "finds the story" do
+      subject.story_number.should == '8675309'
+    end
+  end
+
+  context "The current branch doesn't 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
+      stub_branch('')
+      subject.story_number.should_not be
+    end
+  end
+end

data/spec/git_tracker/commit_message_spec.rb

@@ -0,0 +1,128 @@
+require 'git_tracker/commit_message'
+require 'commit_message_helper'
+
+describe GitTracker::CommitMessage do
+  include CommitMessageHelper
+
+  subject { described_class.new(file) }
+  let(:file) { "COMMIT_EDITMSG" }
+
+  it "requires path to the temporary commit message file" do
+    -> { 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) }
+    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")
+      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")
+      end
+
+      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")
+      end
+
+      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")
+      end
+
+      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")
+      end
+
+      it "doesn't 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")
+      end
+    end
+  end
+
+  describe "#append" do
+    let(:fake_file) { GitTracker::FakeFile.new }
+    before do
+      File.stub(:open).and_yield(fake_file)
+    end
+    def stub_original_commit_message(message)
+      File.stub(:read) { message }
+    end
+
+    it "handles no existing message" do
+      stub_original_commit_message("\n\n# some other comments\n")
+      subject.append("[#8675309]")
+
+      fake_file.content.should ==
+        <<-COMMIT_MESSAGE
+
+
+[#8675309]
+# some other comments
+      COMMIT_MESSAGE
+    end
+
+    it "preserves existing messages" do
+      stub_original_commit_message("A first line\n\nWith more here\n# other comments\n")
+      subject.append("[#8675309]")
+
+      fake_file.content.should == <<-COMMIT_MESSAGE
+A first line
+
+With more here
+
+[#8675309]
+# other comments
+      COMMIT_MESSAGE
+    end
+
+    it "preserves line breaks in comments" do
+      stub_original_commit_message("# comment #1\n# comment B\n# comment III")
+      subject.append("[#8675309]")
+
+      fake_file.content.should == <<-COMMIT_MESSAGE
+
+
+[#8675309]
+# comment #1
+# comment B
+# comment III
+      COMMIT_MESSAGE
+    end
+  end
+
+end

data/spec/git_tracker/prepare_commit_message_spec.rb

@@ -0,0 +1,77 @@
+require 'git_tracker/prepare_commit_message'
+
+describe GitTracker::PrepareCommitMessage do
+  subject { GitTracker::PrepareCommitMessage }
+
+  describe '.run' do
+    let(:hook) { stub("PrepareCommitMessage") }
+    before do
+      subject.stub(:new) { hook }
+    end
+
+    it "runs the hook" do
+      hook.should_receive(:run)
+      subject.run("FILE1", "hook_source", "sha1234")
+    end
+  end
+
+  describe ".new" 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"
+    end
+
+    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"
+    end
+  end
+
+  describe '#run' do
+    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
+      let(:story) { nil }
+
+      it "exits without updating the commit message" do
+        lambda { hook.run }.should raise_exception(SystemExit)
+        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) }
+      before do
+        GitTracker::CommitMessage.stub(:new) { commit_message }
+      end
+
+      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
+        before do
+          commit_message.stub(:mentions_story?).with("8675309") { true }
+        end
+
+        it "exits without updating the commit message" do
+          lambda { hook.run }.should raise_exception(SystemExit)
+          GitTracker::CommitMessage.should_not have_received(:append)
+        end
+      end
+    end
+
+  end
+end

data/spec/git_tracker_spec.rb

@@ -0,0 +1,31 @@
+require 'git_tracker'
+
+describe GitTracker do
+  subject { described_class }
+  let(:args) { ["a_file", "the_source", "sha1234"] }
+
+  describe ".execute" do
+    before do
+      subject.stub(:prepare_commit_msg) { true }
+    end
+
+    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] hook: 'non-existent-hook' does not exist."
+    end
+  end
+
+  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
+
+end

data/spec/support/commit_message_helper.rb

@@ -0,0 +1,29 @@
+module CommitMessageHelper
+
+  def example_commit_message(pattern_to_match)
+    return <<-EXAMPLE
+Got Jenny's number, gonna' make her mine!
+
+#{pattern_to_match}
+# Please enter the commit message for your changes. Lines starting
+# with '#' will be ignored, and an empty message aborts the commit.
+# On branch get_jennys_number_#8675309
+# Changes to be committed:
+#   (use "git reset HEAD <file>..." to unstage)
+#
+# new file:   fake_file.rb
+#
+
+EXAMPLE
+  end
+end
+
+module GitTracker
+  class FakeFile
+    attr_reader :content
+
+    def write(content)
+      @content = content
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: git_tracker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Steven Harman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70146115751180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70146115751180
+- !ruby/object:Gem::Dependency
+  name: rspec-spies
+  requirement: &70146115750200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70146115750200
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70146115749520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :development
+  prerelease: false
+  version_requirements: *70146115749520
+description: ! "    Some simple tricks that make working with Pivotal Tracker even\n
+  \   better... and easier... um, besier!\n"
+email:
+- steveharman@gmail.com
+executables:
+- git-tracker
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/git-tracker
+- git_tracker.gemspec
+- lib/git_tracker.rb
+- lib/git_tracker/branch.rb
+- lib/git_tracker/commit_message.rb
+- lib/git_tracker/prepare_commit_message.rb
+- lib/git_tracker/version.rb
+- prepare-commit-msg.example
+- spec/git_tracker/branch_spec.rb
+- spec/git_tracker/commit_message_spec.rb
+- spec/git_tracker/prepare_commit_message_spec.rb
+- spec/git_tracker_spec.rb
+- spec/support/commit_message_helper.rb
+homepage: https://github.com/highgroove/git_tracker
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Teaching Git about Pivotal Tracker.
+test_files:
+- spec/git_tracker/branch_spec.rb
+- spec/git_tracker/commit_message_spec.rb
+- spec/git_tracker/prepare_commit_message_spec.rb
+- spec/git_tracker_spec.rb
+- spec/support/commit_message_helper.rb