git_tracker 0.0.1 → 1.0.0

data/README.md

@@ -1,29 +1,117 @@
 # GitTracker
 
-TODO: Write a gem description
+*GitTracker*, or *git-tracker*, is a Git hook that will scan your current
+branch number looking for something it recognizes as a [Pivotal Tracker][pt]
+story number. If it finds one, it will automagically add it, in the [special
+format][pt-format], to your commit message.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+You need to get the `git-tracker` executable on your system.
 
-    gem 'git_tracker'
+### RubyGems
 
-And then execute:
+Currently, this is the only option, but I plan to have a standalone version
+ready soon.
 
-    $ bundle
+```bash
+$ gem install git_tracker
+```
 
-Or install it yourself as:
+Once you have the `git-tracker` executable on your system you need to install
+the hook into your local Git repository.
 
-    $ gem install git_tracker
+```bash
+# from inside a local Git repository
+$ git-tracker install
+```
+
+This will put the `prepare-commit-msg` hook in the `/path/to/repo/.git/hooks`
+directory and make it executable.
+
+**NOTE:** This will need to be done for each repository that you wish to use
+the hook.
 
 ## Usage
 
-TODO: Write usage instructions here
+With the hook installed in a repository, create branches being sure to include
+the Pivotal Tracker story number in the branch name.
+
+```bash
+$ git checkout -b a_useful_and_helpful_name_#8675309
+```
+
+When you commit, Git will fire the hook which will find the story number in the
+branch name and prepare your commit message so that it include the story number
+in the special Pivotal Tracker syntax.
+
+```bash
+# on branch named `best_feature_ever-#8675309`
+$ git commit
+```
+
+Will result in a commit message something like: *(notice the two empty lines at
+the top)*
+
+```diff
+
+
+[#8675309]
+# Please enter the commit message for your changes. Lines starting
+# with '#' will be ignored, and an empty message aborts the commit.
+# On branch best_feature_ever-#8675309
+# Changes to be committed:
+#   (use "git reset HEAD <file>..." to unstage)
+#
+# new file:   feature.rb
+#
+
+```
+
+You should then add a [useful and responsible commit message][tpope]. :heart:
+
+### Passing commit messages via command line
 
-## Contributing
+If you pass a commit message on the command line the hook will still add the
+story number, preceded by an empty line, to the end of your message.
+
+```bash
+# on branch named `best_feature_ever-#8675309`
+$ git commit -m'Look at this rad code, yo!'
+```
+
+Results in this commit message:
+
+```
+Look at this rad code, yo!
+
+[#8675309]
+```
+
+However, if you include the story number in the Pivotal Tracker format in your
+commit message, the hook will do nothing.
+
+```bash
+# on branch named `best_feature_ever-#8675309`
+$ git commit -m'[#8675309] Look at this rad code, yo!'
+```
+
+Results in this commit message:
+
+
+```
+[#12356] Look at this rad code, yo!
+```
+
+## Contributing :octocat:
 
 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
+
+
+[pt]: https://www.pivotaltracker.com/
+[pt-format]: https://www.pivotaltracker.com/help/api?version=v3#scm_post_commit_message_syntax
+[tpope]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

data/git_tracker.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rspec", "~> 2.0"
   gem.add_development_dependency "rspec-spies", "~> 2.0"
   gem.add_development_dependency "pry", "~> 0.9.8"
+  gem.add_development_dependency "activesupport", "~> 3.2"
 
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/git_tracker/hook.rb

@@ -0,0 +1,38 @@
+require 'git_tracker/repository'
+
+module GitTracker
+  class Hook
+
+    def self.install
+      install_at(Repository.root)
+    end
+
+    def self.install_at(root)
+      hook = hook_from(root)
+      write(hook)
+    end
+
+    private
+
+    def self.hook_from(root)
+      File.join(root, '.git', 'hooks', 'prepare-commit-msg')
+    end
+
+    def self.write(hook)
+      File.open(hook, 'w') do |f|
+        f.write(hook_body)
+        f.chmod(0755)
+      end
+    end
+
+    def self.hook_body
+      return <<-HOOK
+#!/usr/bin/env bash
+
+git-tracker prepare-commit-msg "$@"
+
+      HOOK
+    end
+
+  end
+end

data/lib/git_tracker/repository.rb

@@ -0,0 +1,13 @@
+require 'english'
+
+module GitTracker
+  module Repository
+
+    def self.root
+      path = `git rev-parse --show-toplevel`.chomp
+      abort unless $CHILD_STATUS.exitstatus == 0
+      path
+    end
+
+  end
+end

data/lib/git_tracker/version.rb

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

data/lib/git_tracker.rb

@@ -1,14 +1,19 @@
-require "git_tracker/version"
+require "git_tracker/hook"
 require "git_tracker/prepare_commit_message"
+require "git_tracker/version"
 
 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)
+  def self.execute(cmd_arg, *args)
+    command = cmd_arg.gsub(/-/, '_')
+    abort("[git_tracker] command: '#{cmd_arg}' does not exist.") unless respond_to?(command)
+    send(command, *args)
   end
 
   def self.prepare_commit_msg(*args)
     PrepareCommitMessage.run(*args)
   end
+
+  def self.install
+    Hook.install
+  end
 end

data/spec/git_tracker/commit_message_spec.rb

@@ -1,5 +1,6 @@
+require 'spec_helper'
 require 'git_tracker/commit_message'
-require 'commit_message_helper'
+require 'active_support/core_ext/string/strip'
 
 describe GitTracker::CommitMessage do
   include CommitMessageHelper
@@ -87,12 +88,11 @@ describe GitTracker::CommitMessage do
       stub_original_commit_message("\n\n# some other comments\n")
       subject.append("[#8675309]")
 
-      fake_file.content.should ==
-        <<-COMMIT_MESSAGE
+      fake_file.content.should == <<-COMMIT_MESSAGE.strip_heredoc
 
 
-[#8675309]
-# some other comments
+        [#8675309]
+        # some other comments
       COMMIT_MESSAGE
     end
 
@@ -100,13 +100,13 @@ describe GitTracker::CommitMessage 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
+      fake_file.content.should == <<-COMMIT_MESSAGE.strip_heredoc
+        A first line
 
-With more here
+        With more here
 
-[#8675309]
-# other comments
+        [#8675309]
+        # other comments
       COMMIT_MESSAGE
     end
 
@@ -114,13 +114,13 @@ With more here
       stub_original_commit_message("# comment #1\n# comment B\n# comment III")
       subject.append("[#8675309]")
 
-      fake_file.content.should == <<-COMMIT_MESSAGE
+      fake_file.content.should == <<-COMMIT_MESSAGE.strip_heredoc
 
 
-[#8675309]
-# comment #1
-# comment B
-# comment III
+        [#8675309]
+        # comment #1
+        # comment B
+        # comment III
       COMMIT_MESSAGE
     end
   end

data/spec/git_tracker/hook_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'git_tracker/hook'
+require 'active_support/core_ext/string/strip'
+
+describe GitTracker::Hook do
+  subject { described_class }
+  let(:root) { '/path/to/git/repo/toplevel' }
+  let(:hook_path) { File.join(root, '.git', 'hooks', 'prepare-commit-msg') }
+
+  describe '.install' do
+    before do
+      GitTracker::Repository.stub(:root) { root }
+    end
+
+    it 'installs to the root of the Git repository' do
+      subject.should_receive(:install_at).with(root)
+      subject.install
+    end
+  end
+
+  describe '.install_at' do
+    let(:fake_file) { GitTracker::FakeFile.new }
+    before do
+      File.stub(:open).and_yield(fake_file)
+    end
+
+    it 'writes the hook into the hooks directory' do
+      File.should_receive(:open).with(hook_path, 'w')
+      subject.install_at(root)
+    end
+
+    it 'makes the hook executable' do
+      subject.install_at(root)
+      fake_file.mode.should == 0755
+    end
+
+    it 'writes the hook code in the hook file' do
+      subject.install_at(root)
+      fake_file.content.should == <<-HOOK_CODE.strip_heredoc
+        #!/usr/bin/env bash
+
+        git-tracker prepare-commit-msg "$@"
+
+      HOOK_CODE
+    end
+  end
+
+end

data/spec/git_tracker/repository_spec.rb

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

data/spec/git_tracker_spec.rb

@@ -17,7 +17,7 @@ describe GitTracker do
     # 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."
+        should raise_error SystemExit, "[git_tracker] command: 'non-existent-hook' does not exist."
     end
   end
 
@@ -28,4 +28,11 @@ describe GitTracker do
     end
   end
 
+  describe ".install" do
+    it 'tells the hook to install itself' do
+      GitTracker::Hook.should_receive(:install)
+      subject.install
+    end
+  end
+
 end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'fake_file'
+require 'commit_message_helper'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

data/spec/support/commit_message_helper.rb

@@ -18,12 +18,3 @@ EXAMPLE
   end
 end
 
-module GitTracker
-  class FakeFile
-    attr_reader :content
-
-    def write(content)
-      @content = content
-    end
-  end
-end

data/spec/support/fake_file.rb

@@ -0,0 +1,13 @@
+module GitTracker
+  class FakeFile
+    attr_reader :content, :mode
+
+    def write(content)
+      @content = content
+    end
+
+    def chmod(mode_int)
+      @mode = mode_int
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git_tracker
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-23 00:00:00.000000000 Z
+date: 2012-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70146115751180 !ruby/object:Gem::Requirement
+  requirement: &70106555555260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70146115751180
+  version_requirements: *70106555555260
 - !ruby/object:Gem::Dependency
   name: rspec-spies
-  requirement: &70146115750200 !ruby/object:Gem::Requirement
+  requirement: &70106555554300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70146115750200
+  version_requirements: *70106555554300
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70146115749520 !ruby/object:Gem::Requirement
+  requirement: &70106555553320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,18 @@ dependencies:
         version: 0.9.8
   type: :development
   prerelease: false
-  version_requirements: *70146115749520
+  version_requirements: *70106555553320
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70106555552580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: *70106555552580
 description: ! "    Some simple tricks that make working with Pivotal Tracker even\n
   \   better... and easier... um, besier!\n"
 email:
@@ -64,14 +75,20 @@ files:
 - lib/git_tracker.rb
 - lib/git_tracker/branch.rb
 - lib/git_tracker/commit_message.rb
+- lib/git_tracker/hook.rb
 - lib/git_tracker/prepare_commit_message.rb
+- lib/git_tracker/repository.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/hook_spec.rb
 - spec/git_tracker/prepare_commit_message_spec.rb
+- spec/git_tracker/repository_spec.rb
 - spec/git_tracker_spec.rb
+- spec/spec_helper.rb
 - spec/support/commit_message_helper.rb
+- spec/support/fake_file.rb
 homepage: https://github.com/highgroove/git_tracker
 licenses: []
 post_install_message: 
@@ -99,6 +116,10 @@ summary: Teaching Git about Pivotal Tracker.
 test_files:
 - spec/git_tracker/branch_spec.rb
 - spec/git_tracker/commit_message_spec.rb
+- spec/git_tracker/hook_spec.rb
 - spec/git_tracker/prepare_commit_message_spec.rb
+- spec/git_tracker/repository_spec.rb
 - spec/git_tracker_spec.rb
+- spec/spec_helper.rb
 - spec/support/commit_message_helper.rb
+- spec/support/fake_file.rb