git_pivotal_tracker 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ruby-1.9.2-p180@git_pivotal_tracker

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Ben Lindsey
+
+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,101 @@
+git-tracker
+===========
+
+Inspired by [Hashrocket's blend of git and Pivotal Tracker](http://reinh.com/blog/2009/03/02/a-git-workflow-for-agile-teams.html) and [a popular article on effective git workflows](http://blog.carbonfive.com/2010/11/01/integrating-topic-branches-in-git/), I wanted to build a tool to simplify the workflow between the two.
+
+It also includes a git prepare-commit-msg hook that appends the story id to all your commit messages from a topic branch:
+[https://www.pivotaltracker.com/help/api?version=v3#github_hooks](https://www.pivotaltracker.com/help/api?version=v3#github_hooks)
+
+Features
+--------
+
+* `git-story`
+* `git-feature`
+* `git-bug`
+* `git-chore`
+
+These commands collect the first available story from your Pivotal Tracker project and create a topic branch for it.
+
+* `git-finish`
+
+When on a topic branch, this command will fetch the latest integration branch ('master' by default), rebase your topic branch from it, merge the branch into the integration branch with no-fast-forword and push the integration branch to origin.
+
+* `git-info`
+
+Print out the Pivotal Tracker story information for the current topic branch
+
+Examples
+--------
+
+    FIXME (code sample of usage)
+
+Requirements
+------------
+
+* github
+* tracker project
+* github to tracker api integration turned on
+
+Install
+-------
+
+* gem install git_pivotal_tracker
+
+Once installed, git pivotal needs two bits of info: your Pivotal Tracker API Token and your Pivotal Tracker project id:
+
+   git config --global pivotal.api-token 123a456b
+
+The project id is best placed within your project's git config:
+
+   git config -f .git/config pivotal.project-id 88888
+
+If you prefer to merge back to a branch other than master when you've finished a story, you can configure that:
+
+   git config --global pivotal.integration-branch develop
+
+If you prefer to fetch and rebase from origin before merging (default is no):
+
+   git config --global pivotal.rebase 1
+
+If you prefer to fast-forward your merges into the integration branch (default is --no-ff):
+
+   git config --global pivotal.fast-forward 1
+
+If your Pivotal Tracker user name is different than your git user name:
+
+   git config --global pivotal.full-name 'Ben Lindsey'
+
+Author
+------
+
+* Ben Lindsey <ben@carbonfive.com>
+
+Acknowledgements
+------
+* Inspired by [trydionel](https://github.com/trydionel/git-pivotal)
+
+License
+-------
+
+(The MIT License)
+
+Copyright (c) 2011 Ben Lindsey
+
+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/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/git-bug

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'git_pivotal_tracker'
+
+exit GitPivotalTracker::Bug.new(*ARGV).run!

data/bin/git-chore

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'git_pivotal_tracker'
+
+exit GitPivotalTracker::Chore.new(*ARGV).run!

data/bin/git-feature

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'git_pivotal_tracker'
+
+exit GitPivotalTracker::Feature.new(*ARGV).run!

data/bin/git-finish

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'git_pivotal_tracker'
+
+exit GitPivotalTracker::Finish.new(*ARGV).run!

data/bin/git-info

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'git_pivotal_tracker'
+
+exit GitPivotalTracker::Info.new(*ARGV).run!

data/bin/git-story

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'git_pivotal_tracker'
+
+exit GitPivotalTracker::Story.new(*ARGV).run!

data/bin/prepare-commit-msg

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# vim: set syntax=ruby
+
+branch = `git branch 2> /dev/null | grep -e ^* | awk '{print $2}'`
+if branch =~ /-(\d{7,})-/
+  commit_msg = IO.read(ARGV[0])
+  unless commit_msg.include?($1)
+    File.open(ARGV[0], 'w') do |file|
+      file.print commit_msg
+      file.print "[##{$1}]"
+    end
+  end
+end

data/git_pivotal_tracker.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'git_pivotal_tracker/version'
+
+Gem::Specification.new do |s|
+  s.name        = "git_pivotal_tracker"
+  s.version     = GitPivotalTracker::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ben Lindsey"]
+  s.email       = ["ben@carbonfive.com"]
+  s.homepage    = "https://github.com/blindsey/git_pivotal_tracker"
+  s.summary     = "A git workflow integrated with Pivotal Tracker"
+  s.description = "git_pivotal_tracker provides a set of scripts that integrates directly with git to start and finish Pivotal Tracker stories on topic branches"
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "grit"
+  s.add_runtime_dependency "pivotal-tracker"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/lib/git_pivotal_tracker/base.rb

@@ -0,0 +1,92 @@
+module GitPivotalTracker
+  class Base
+    GIT_DIR = ENV['GIT_DIR'] || '.git'
+
+    attr_reader :options, :repository
+
+    def initialize(*args)
+      directories = Dir.pwd.split(::File::SEPARATOR)
+      begin
+        break if File.directory?(File.join(*directories, GIT_DIR))
+      end while directories.pop
+
+      raise "No #{GIT_DIR} directory found" if directories.empty?
+      root = File.join(*directories, GIT_DIR)
+      @repository = Grit::Repo.new(root)
+
+      new_hook_path = File.join(*directories, GIT_DIR, 'hooks', 'prepare-commit-msg')
+      unless File.executable?(new_hook_path)
+        puts "Installing prepare-commit-msg hook..."
+        old_hook_path = File.join(File.dirname(__FILE__), '..', '..', 'bin', 'prepare-commit-msg')
+        FileUtils.cp(old_hook_path, new_hook_path, :preserve => true)
+      end
+
+      @options = {}
+      parse_gitconfig
+      parse_argv(*args)
+    end
+
+    def run!
+      unless options[:api_token] && options[:project_id]
+        puts "Pivotal Tracker API Token and Project ID are required"
+        return 1
+      end
+
+      PivotalTracker::Client.token = options[:api_token]
+      nil
+    end
+
+    protected
+
+    def integration_branch
+      options[:integration_branch] || 'master'
+    end
+
+    def current_branch
+      @current_branch ||= repository.head.name
+    end
+
+    def story_id
+      @story_id ||= current_branch[/\d+/].to_i
+    end
+
+    def project
+      @project ||= PivotalTracker::Project.find(options[:project_id])
+    end
+
+    def story
+      @story ||= project.stories.find(story_id)
+    end
+
+    def log(message)
+      puts message if options[:verbose]
+    end
+
+    private
+
+    def parse_gitconfig
+      options[:api_token]          = repository.config['pivotal.api-token']
+      options[:project_id]         = repository.config['pivotal.project-id']
+      options[:integration_branch] = repository.config['pivotal.integration-branch']
+      options[:fast_forward]       = repository.config['pivotal.fast-forward']
+      options[:rebase]             = repository.config['pivotal.rebase']
+      options[:full_name]          = repository.config['pivotal.full-name'] || repository.config['user.name']
+      options[:verbose]            = repository.config['pivotal.verbose']
+    end
+
+    def parse_argv(*args)
+      OptionParser.new do |opts|
+        opts.banner = "Usage: git <feature|chore|bug> [options]"
+        opts.on("-k", "--api-key=", "Pivotal Tracker API key") { |k| options[:api_token] = k }
+        opts.on("-p", "--project-id=", "Pivotal Tracker project id") { |p| options[:project_id] = p }
+        opts.on("-b", "--integration-branch=", "The branch to merge finished stories back down onto") { |b| options[:integration_branch] = b }
+        opts.on("-f", "--fast-forward=", "Merge topic branch with fast forward") { |f| options[:fast_foward] = f }
+        opts.on("-n", "--full-name=", "Your Pivotal Tracker full name") { |n| options[:full_name] = n }
+        opts.on("-r", "--rebase=", "Fetch and rebase the integration branch before merging") { |r| options[:rebase] = r }
+        opts.on("-v", "--verbose=", "Verbose command logging") { |v| options[:verbose] = v }
+        opts.on_tail("-h", "--help", "This usage guide") { put opts.to_s; exit 0 }
+      end.parse!(args)
+    end
+
+  end
+end

data/lib/git_pivotal_tracker/finish.rb

@@ -0,0 +1,43 @@
+module GitPivotalTracker
+  class Finish < Base
+
+    def run!
+      return 1 if super
+
+      unless story_id
+        put "Branch name must contain a Pivotal Tracker story id"
+        return 1
+      end
+
+      if options[:rebase]
+        puts "Fetching origin and rebasing #{current_branch}"
+        log repository.git.fetch({:raise => true}, "origin")
+        log repository.git.rebase({:raise => true}, "origin/#{integration_branch}")
+      end
+
+      puts "Merging #{current_branch} into #{integration_branch}"
+      log repository.git.checkout({:raise => true}, integration_branch)
+
+      flags = options[:fast_forward] ? {} : {:'no-ff' => true}
+      log repository.git.merge({:raise => true}.merge(flags), current_branch)
+
+      puts "Pushing #{integration_branch} to origin"
+      log repository.git.push({:raise => true}, "origin", integration_branch)
+
+      puts "Marking Story #{story_id} as finished..."
+      if story.update(:current_state => finished_state)
+        puts "Success"
+        return 0
+      else
+        puts "Unable to mark Story #{story_id} as finished"
+        return 1
+      end
+    end
+
+    private
+
+    def finished_state
+      story.story_type == "chore" ? "accepted" : "finished"
+    end
+  end
+end

data/lib/git_pivotal_tracker/info.rb

@@ -0,0 +1,19 @@
+module GitPivotalTracker
+  class Info < Base
+
+    def run!
+      return 1 if super
+
+      unless story_id
+        put "Branch name must contain a Pivotal Tracker story id"
+        return 1
+      end
+
+      puts "URL:           #{story.url}"
+      puts "Story:         #{story.name}"
+      puts "Description:   #{story.description}"
+
+      return 0
+    end
+  end
+end

data/lib/git_pivotal_tracker/story.rb

@@ -0,0 +1,55 @@
+module GitPivotalTracker
+  class Story < Base
+
+    def run!
+      return 1 if super
+
+      puts "Retrieving latest #{type} from Pivotal Tracker"
+
+      unless story = fetch_story
+        puts "No #{type} available!"
+        return 1
+      end
+
+      puts "URL:   #{story.url}"
+      puts "Story: #{story.name}"
+
+      default_suffix = story.name.downcase.gsub(/\W+/, '_')
+      print "Enter branch name [#{default_suffix}]: "
+      suffix = gets.chomp
+      suffix = default_suffix if suffix == ""
+
+      branch = "#{story.story_type}-#{story.id}-#{suffix}"
+      puts "Checking out a new branch '#{branch}'"
+      log repository.git.checkout({:b => true, :raise => true}, branch)
+
+      puts "Updating #{type} status in Pivotal Tracker..."
+      if story.update(:owned_by => options[:name], :current_state => :started)
+        puts "Success"
+        return 0
+      else
+        puts "Unable to mark #{type} as started"
+        return 1
+      end
+    end
+
+    private
+
+    def type
+      self.class.name.downcase.split(/::/).last
+    end
+
+    def fetch_story
+      # TODO: check for rejected stories as well
+      conditions = { :current_state => "unstarted", :limit => 1, :offset => 0 }
+      conditions[:story_type] = type unless type == 'story'
+      project.stories.all(conditions).first
+    end
+  end
+
+  class Bug < Story; end
+
+  class Feature < Story; end
+
+  class Chore < Story; end
+end

data/lib/git_pivotal_tracker/version.rb

@@ -0,0 +1,3 @@
+module GitPivotalTracker
+  VERSION = '0.0.1'
+end

data/lib/git_pivotal_tracker.rb

@@ -0,0 +1,9 @@
+require 'grit'
+require 'pivotal-tracker'
+require 'optparse'
+require 'fileutils'
+
+require 'git_pivotal_tracker/base'
+require 'git_pivotal_tracker/story'
+require 'git_pivotal_tracker/info'
+require 'git_pivotal_tracker/finish'

data/spec/git_pivotal_tracker_spec.rb

@@ -0,0 +1,4 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe GitPivotalTracker do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib git_pivotal_tracker]))
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: git_pivotal_tracker
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ben Lindsey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: grit
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: pivotal-tracker
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: git_pivotal_tracker provides a set of scripts that integrates directly with git to start and finish Pivotal Tracker stories on topic branches
+email: 
+- ben@carbonfive.com
+executables: 
+- git-bug
+- git-chore
+- git-feature
+- git-finish
+- git-info
+- git-story
+- prepare-commit-msg
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/git-bug
+- bin/git-chore
+- bin/git-feature
+- bin/git-finish
+- bin/git-info
+- bin/git-story
+- bin/prepare-commit-msg
+- git_pivotal_tracker.gemspec
+- lib/git_pivotal_tracker.rb
+- lib/git_pivotal_tracker/base.rb
+- lib/git_pivotal_tracker/finish.rb
+- lib/git_pivotal_tracker/info.rb
+- lib/git_pivotal_tracker/story.rb
+- lib/git_pivotal_tracker/version.rb
+- spec/git_pivotal_tracker_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/blindsey/git_pivotal_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: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A git workflow integrated with Pivotal Tracker
+test_files: 
+- spec/git_pivotal_tracker_spec.rb
+- spec/spec_helper.rb