git_pivotal_tracker_x 0.1.1

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/lib/git_pivotal_tracker/base.rb

@@ -0,0 +1,112 @@
+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(root, 'hooks', 'commit-msg')
+      unless File.executable?(new_hook_path)
+        puts "Installing commit-msg hook..."
+        old_hook_path = File.join(File.dirname(__FILE__), '..', '..', 'bin', '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]
+      PivotalTracker::Client.use_ssl = options[:use_ssl]
+
+      nil
+    end
+
+    protected
+
+    def integration_branch
+      current_branch_suffix || options[:integration_branch] || 'master'
+    end
+    
+    def current_branch_suffix
+      if current_branch =~ /.*-\d+?-(.*)/ and @repository.branches.any? { |branch| branch.name == $1 }
+        $1
+      end
+    end
+
+    def current_branch
+      @current_branch ||= repository.head.name
+    end
+
+    def story_id
+      if current_branch =~ /-(\d+)-/
+        $1
+      end
+    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[:only_mine]          = repository.config['pivotal.only-mine']
+      options[:include_rejected]   = repository.config['pivotal.include-rejected']
+      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']
+      options[:use_ssl]            = repository.config['pivotal.use-ssl']
+      options[:delete_branch]      = repository.config['pivotal.delete-branch']
+    end
+
+    def parse_argv(*args)
+      OptionParser.new do |opts|
+        opts.banner = "Usage: git <feature|chore|bug> [options]"
+        opts.on("-t", "--api-token=", "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("-n", "--full-name=", "Your Pivotal Tracker full name") { |n| options[:full_name] = n }
+
+
+        opts.on("-D", "--delete-branch", "Delete store branch after merging") { |d| options[:delete_branch] = d }
+        opts.on("-I", "--include-rejected", "Include rejected stories as well as unstarted ones") { |i| options[:include_rejected] = i }
+        opts.on("-O", "--only-mine", "Only include stories that are assigned to me") { |o| options[:only_mine] = o }
+        opts.on("-F", "--fast-forward", "Merge topic branch with fast forward") { |f| options[:fast_forward] = f }
+        opts.on("-S", "--use-ssl", "Use SSL for connection to Pivotal Tracker") { |s| options[:use_ssl] = s }
+        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,51 @@
+module GitPivotalTracker
+  class Finish < Base
+
+    def run!
+      return 1 if super
+
+      unless story_id
+        puts "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.checkout({:raise => true}, integration_branch)
+        log repository.git.pull({:raise => true})
+        log repository.git.rebase({:raise => true}, integration_branch, current_branch)
+      end
+
+      puts "Merging #{current_branch} into #{integration_branch}"
+      log repository.git.checkout({:raise => true}, integration_branch)
+
+      merge_options = {:raise => true}
+      merge_options[:no_ff] = true unless options[:fast_forward]
+      log repository.git.merge(merge_options, current_branch)
+
+      puts "Pushing #{integration_branch}"
+      log repository.git.push({:raise => true}, 'origin', integration_branch)
+
+      puts "Marking Story #{story_id} as finished..."
+      if story.update(:current_state => finished_state)
+        delete_current_branch if options[:delete_branch]
+        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
+    
+    def delete_current_branch
+      puts "Deleting #{current_branch}"
+      log repository.git.branch({:raise => true, :d => true}, current_branch)
+    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
+        puts "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,59 @@
+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}"
+
+      print "Enter branch name [#{branch_suffix story}]: "
+      suffix = gets.chomp
+      suffix = branch_suffix(story) 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[:full_name], :current_state => :started)
+        puts "Success"
+        return 0
+      else
+        puts "Unable to mark #{type} as started"
+        return 1
+      end
+    end
+
+    def type
+      self.class.name.downcase.split(/::/).last
+    end
+
+    private
+
+    def fetch_story
+      state = options[:include_rejected] ? "unstarted,rejected" : "unstarted"
+      conditions = { :current_state => state, :limit => 1 }
+      conditions[:owned_by] = "\"#{options[:full_name]}\"" if options[:only_mine]
+      conditions[:story_type] = type unless type == 'story'
+      project.stories.all(conditions).first
+    end
+
+    def branch_suffix(story)
+      story.name.sub(/^\W+/, '').sub(/\W+$/, '').gsub(/\W+/, '_').downcase
+    end
+  end
+
+  class Bug < Story; end
+
+  class Feature < Story; end
+
+  class Chore < Story; end
+end

data/spec/fixtures/finish_story.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<story>
+  <name> Pause the film!</name>
+  <description>As a moderator,
+I can pause the film
+In order to allow another activity to take place (discussion, etc).</description>
+  <story_type>feature</story_type>
+  <estimate>2</estimate>
+  <current_state>finished</current_state>
+  <requested_by>Ben Lindsey</requested_by>
+  <owned_by>Ben Lindsey</owned_by>
+  <labels>moderate,2_needs_design</labels>
+  <project_id>123</project_id>
+  <other_id></other_id>
+  <integration_id></integration_id>
+  <created_at>2011-07-14T23:06:28+00:00</created_at>
+</story>

data/spec/fixtures/no_stories.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<stories type="array" count="0" total="2" limit="0">
+</stories>

data/spec/fixtures/one_story.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<stories type="array" count="1" total="2" limit="1">
+  <story>
+    <id type="integer">1234567890</id>
+    <project_id type="integer">123</project_id>
+    <story_type>feature</story_type>
+    <url>http://www.pivotaltracker.com/story/show/1234567890</url>
+    <estimate type="integer">2</estimate>
+    <current_state>unstarted</current_state>
+    <description>As a moderator,
+I can pause the film
+In order to allow another activity to take place (discussion, etc).</description>
+    <name> Pause the film!</name>
+    <requested_by>Ben Lindsey</requested_by>
+    <created_at type="datetime">2011/07/14 23:06:28 UTC</created_at>
+    <updated_at type="datetime">2011/07/14 23:13:24 UTC</updated_at>
+    <labels>moderate,2_needs_design</labels>
+  </story>
+</stories>

data/spec/fixtures/project.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project>
+  <id>123</id>
+  <name>Test Project</name>
+  <iteration_length type="integer">1</iteration_length>
+  <week_start_day>Monday</week_start_day>
+  <point_scale>0,1,2,3,5,8</point_scale>
+  <account>Carbon Five</account>
+  <start_date type="date">2011/07/18</start_date>
+  <first_iteration_start_time type="datetime">2011/07/18 07:00:00 UTC</first_iteration_start_time>
+  <current_iteration_number type="integer">1</current_iteration_number>
+  <enable_tasks type="boolean">true</enable_tasks>
+  <velocity_scheme>Average of 3 iterations</velocity_scheme>
+  <current_velocity>10</current_velocity>
+  <initial_velocity>10</initial_velocity>
+  <number_of_done_iterations_to_show>12</number_of_done_iterations_to_show>
+  <labels>1_needs_definition,2_needs_design,discuss,moderate</labels>
+  <last_activity_at type="datetime">2011/07/14 23:16:29 UTC</last_activity_at>
+  <allow_attachments>true</allow_attachments>
+  <public>false</public>
+  <use_https>false</use_https>
+  <bugs_and_chores_are_estimatable>false</bugs_and_chores_are_estimatable>
+  <commit_mode>false</commit_mode>
+  <memberships type="array">
+    <membership>
+      <id>1058581</id>
+      <person>
+        <email>ben@carbonfive.com</email>
+        <name>Ben Lindsey</name>
+        <initials>BL</initials>
+      </person>
+      <role>Owner</role>
+    </membership>
+  </memberships>
+  <integrations type="array">
+  </integrations>
+</project>

data/spec/fixtures/start_story.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<story>
+  <name> Pause the film!</name>
+  <description>As a moderator,
+I can pause the film
+In order to allow another activity to take place (discussion, etc).</description>
+  <story_type>feature</story_type>
+  <estimate>2</estimate>
+  <current_state>started</current_state>
+  <requested_by>Ben Lindsey</requested_by>
+  <owned_by>Ben Lindsey</owned_by>
+  <labels>moderate,2_needs_design</labels>
+  <project_id>123</project_id>
+  <other_id></other_id>
+  <integration_id></integration_id>
+  <created_at>2011-07-14T23:06:28+00:00</created_at>
+</story>

data/spec/fixtures/story.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<story>
+  <id>1234567890</id>
+  <name> Pause the film!</name>
+  <description>As a moderator,
+I can pause the film
+In order to allow another activity to take place (discussion, etc).</description>
+  <story_type>feature</story_type>
+  <estimate>2</estimate>
+  <current_state>started</current_state>
+  <requested_by>Ben Lindsey</requested_by>
+  <owned_by>Ben Lindsey</owned_by>
+  <labels>moderate,2_needs_design</labels>
+  <project_id>123</project_id>
+  <other_id></other_id>
+  <integration_id></integration_id>
+  <created_at>2011-07-14T23:06:28+00:00</created_at>
+</story>

data/spec/git_pivotal_tracker/base_spec.rb

@@ -0,0 +1,235 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe GitPivotalTracker::Base do
+  describe "#parse_argv" do
+
+    context "by default" do
+      before do
+        stub_git_config
+        subject = GitPivotalTracker::Base.new
+      end
+
+      it "leaves integration_branch nil" do
+        subject.options[:integration_branch].should be_nil
+      end
+
+      it "leaves fast_forward nil" do
+        subject.options[:fast_forward].should be_nil
+      end
+
+      it "leaves rebase nil" do
+        subject.options[:rebase].should be_nil
+      end
+
+      it "leaves verbose nil" do
+        subject.options[:verbose].should be_nil
+      end
+
+      it "leaves use_ssl nil" do
+        subject.options[:use_ssl].should be_nil
+      end
+
+      it "leaves full_name nil" do
+        subject.options[:full_name].should be_nil
+      end
+
+      it "leaves include_rejected nil" do
+        subject.options[:include_rejected].should be_nil
+      end
+
+      it "leaves only_mine nil" do
+        subject.options[:only_mine].should be_nil
+      end
+
+      it "leaves delete_branch nil" do
+        subject.options[:delete_branch].should be_nil
+      end
+    end
+
+    it "sets the api_token" do
+      GitPivotalTracker::Base.new("--api-token", "8a8a8a8").options[:api_token].should == '8a8a8a8'
+      GitPivotalTracker::Base.new("-t", "8a8a8a8").options[:api_token].should == '8a8a8a8'
+    end
+
+    it "sets the project_id" do
+      GitPivotalTracker::Base.new("--project-id", "123").options[:project_id].should == '123'
+      GitPivotalTracker::Base.new("-p", "123").options[:project_id].should == '123'
+    end
+
+    it "sets the integration_branch" do
+      GitPivotalTracker::Base.new("--integration-branch", "development").options[:integration_branch].should == 'development'
+      GitPivotalTracker::Base.new("-b", "development").options[:integration_branch].should == 'development'
+    end
+
+    it "sets full_name" do
+      GitPivotalTracker::Base.new("--full-name", "Full Name").options[:full_name].should == 'Full Name'
+      GitPivotalTracker::Base.new("-n", "Full Name").options[:full_name].should == 'Full Name'
+    end
+
+    it "sets include_rejected" do
+      GitPivotalTracker::Base.new("--include-rejected").options[:include_rejected].should be
+      GitPivotalTracker::Base.new("-I").options[:include_rejected].should be
+    end
+
+    it "sets only_mine" do
+      GitPivotalTracker::Base.new("--only-mine").options[:only_mine].should be
+      GitPivotalTracker::Base.new("-O").options[:only_mine].should be
+    end
+
+    it "sets fast_forward" do
+      GitPivotalTracker::Base.new("--fast-forward").options[:fast_forward].should be
+      GitPivotalTracker::Base.new("-F").options[:fast_forward].should be
+    end
+
+    it "sets use_ssl" do
+      GitPivotalTracker::Base.new("--use-ssl").options[:use_ssl].should be
+      GitPivotalTracker::Base.new("-S").options[:use_ssl].should be
+    end
+
+    it "sets rebase" do
+      GitPivotalTracker::Base.new("--rebase").options[:rebase].should be
+      GitPivotalTracker::Base.new("-R").options[:rebase].should be
+    end
+
+    it "sets verbose" do
+      GitPivotalTracker::Base.new("--verbose").options[:verbose].should be
+      GitPivotalTracker::Base.new("-V").options[:verbose].should be
+    end
+    
+    it "sets delete_branch" do
+      GitPivotalTracker::Base.new("--delete-branch").options[:delete_branch].should be
+      GitPivotalTracker::Base.new("-D").options[:delete_branch].should be
+    end
+  end
+
+  describe "#parse_gitconfig" do
+    context "with a full-name" do
+      before do
+        stub_git_config 'pivotal.full-name' => 'Full Name', 'user.name' => 'User Name'
+        subject = GitPivotalTracker::Base.new
+      end
+
+      it "sets the full_name to the full name" do
+        subject.options[:full_name].should == 'Full Name'
+      end
+    end
+
+    context "with no full-name" do
+      before do
+        stub_git_config({
+          'user.name' => 'User Name',
+          'pivotal.integration-branch' => 'development',
+          'pivotal.only-mine' => 1,
+          'pivotal.include-rejected' => 1,
+          'pivotal.fast-forward' => 1,
+          'pivotal.rebase' => 1,
+          'pivotal.verbose' => 1,
+          'pivotal.use-ssl' => 1
+        })
+        subject = GitPivotalTracker::Base.new
+      end
+
+      it "sets use_ssl" do
+        subject.options[:use_ssl].should be
+      end
+
+      it "sets the api_token" do
+        subject.options[:api_token].should == '8a8a8a8'
+      end
+
+      it "sets the project_id" do
+        subject.options[:project_id].should == '123'
+      end
+
+      it "sets only_mine" do
+        subject.options[:only_mine].should be
+      end
+
+      it "sets include_rejected" do
+        subject.options[:include_rejected].should be
+      end
+
+      it "sets fast_forward" do
+        subject.options[:fast_forward].should be
+      end
+
+      it "sets rebase" do
+        subject.options[:rebase].should be
+      end
+
+      it "sets verbose" do
+        subject.options[:verbose].should be
+      end
+
+      it "sets the full_name to the user name" do
+        subject.options[:full_name].should == 'User Name'
+      end
+    end
+  end
+
+  describe ".new" do
+    context "given an invalid git root" do
+      before do
+        @current_dir = Dir.pwd
+        Dir.chdir("/")
+      end
+
+      it "fails to initialize" do
+        expect { GitPivotalTracker::Base.new }.to raise_error "No .git directory found"
+      end
+
+      after do
+        Dir.chdir @current_dir
+      end
+    end
+
+    context "given no commit-msg hook" do
+      let(:file_name) { ".git/hooks/commit-msg" }
+
+      before do
+        File.delete file_name if File.exists? file_name
+        GitPivotalTracker::Base.new
+      end
+
+      it "installs the hook" do
+        File.executable?(file_name).should be
+      end
+    end
+  end
+
+  describe "#run!" do
+    context "given a config with an api token and a project id" do
+      before do
+        stub_git_config
+        subject = GitPivotalTracker::Base.new
+        PivotalTracker::Client.should_receive(:token=).with('8a8a8a8')
+      end
+
+      it "succeeds" do
+        subject.run!.should be_nil
+      end
+    end
+
+    context "given the config has no api token" do
+      before do
+        stub_git_config 'pivotal.api-token' => nil
+        subject = GitPivotalTracker::Base.new
+      end
+
+      it "fails" do
+        subject.run!.should == 1
+      end
+    end
+
+    context "given the config has no project id" do
+      before do
+        stub_git_config 'pivotal.project-id' => nil
+        subject = GitPivotalTracker::Base.new
+      end
+
+      it "fails" do
+        subject.run!.should == 1
+      end
+    end
+  end
+end