git-pivotal 0.2.2 → 0.2.3

data/.gitignore

@@ -1,3 +1,4 @@
 pkg
 coverage
-*.gem
+*.gem
+*.swp

data/CHANGELOG

@@ -1,3 +1,21 @@
+v 0.2.3
+- Allow the developer to specify the integration branch for git finish [Graeme Mathieson]
+- Fixed bug which prevented chores from finishing successfully [Joshua Vial]
+- Added option to allow only pickup items already assigned to you [Mark Butcher]
+- Fix RestClient version issues
+
+v 0.2.2
+- Added git chore command
+
+v 0.2.1
+- Remove &:to_s shortcut for MRI 1.8.6 compatibility
+- Updated to handle RestClient 1.4
+
+v 0.2.0
+- Added git feature and git bug commands
+- Deprecated git feature
+- Improved XPath reliability for Pivotal API requests [Sam Stokes]
+
 v 0.1.3
 - Fixed bug preventing command line args from being properly interpretted
 

data/Rakefile

@@ -15,7 +15,7 @@ begin
     gemspec.authors = ["Jeff Tucker", "Sam Stokes"]
     
     gemspec.add_dependency "nokogiri"
-    gemspec.add_dependency "rest-client"
+    gemspec.add_dependency "rest-client", "~>1.4.0"
     gemspec.add_dependency "builder"
     
     gemspec.add_development_dependency "rspec"

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.3

data/git-pivotal.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{git-pivotal}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeff Tucker", "Sam Stokes"]
-  s.date = %q{2010-03-11}
+  s.date = %q{2010-07-23}
   s.description = %q{A collection of git utilities to ease integration with Pivotal Tracker}
   s.email = %q{jeff@trydionel.com}
   s.executables = ["git-bug", "git-chore", "git-feature", "git-finish", "git-pick"]
@@ -47,6 +47,7 @@ Gem::Specification.new do |s|
      "spec/commands/bug_spec.rb",
      "spec/commands/chore_spec.rb",
      "spec/commands/feature_spec.rb",
+     "spec/commands/finish_spec.rb",
      "spec/factories.rb",
      "spec/factory.rb",
      "spec/pivotal/api_spec.rb",
@@ -56,18 +57,20 @@ Gem::Specification.new do |s|
      "spec/pivotal/collection_spec.rb",
      "spec/pivotal/project_spec.rb",
      "spec/pivotal/story_spec.rb",
+     "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/trydionel/git-pivotal}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A collection of git utilities to ease integration with Pivotal Tracker}
   s.test_files = [
     "spec/commands/base_spec.rb",
      "spec/commands/bug_spec.rb",
      "spec/commands/chore_spec.rb",
      "spec/commands/feature_spec.rb",
+     "spec/commands/finish_spec.rb",
      "spec/factories.rb",
      "spec/factory.rb",
      "spec/pivotal/api_spec.rb",
@@ -84,16 +87,16 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
-      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<rest-client>, ["~> 1.4.0"])
       s.add_runtime_dependency(%q<builder>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<mocha>, [">= 0"])
     else
       s.add_dependency(%q<nokogiri>, [">= 0"])
-      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<rest-client>, ["~> 1.4.0"])
       s.add_dependency(%q<builder>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<rcov>, [">= 0"])
@@ -101,7 +104,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<nokogiri>, [">= 0"])
-    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<rest-client>, ["~> 1.4.0"])
     s.add_dependency(%q<builder>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<rcov>, [">= 0"])

data/lib/commands/base.rb

@@ -35,16 +35,34 @@ module Commands
       end
     end
 
+  protected
+
+    def project
+      @project ||= api.projects.find(:id => options[:project_id])
+    end
+
+    def api
+      @api ||= Pivotal::Api.new(:api_token => options[:api_token])
+    end
+
+    def integration_branch
+      options[:integration_branch] || "master"
+    end
+
   private
 
     def parse_gitconfig
-      token = get("git config --get pivotal.api-token").strip
-      id    = get("git config --get pivotal.project-id").strip
-      name  = get("git config --get pivotal.full-name").strip
+      token              = get("git config --get pivotal.api-token").strip
+      id                 = get("git config --get pivotal.project-id").strip
+      name               = get("git config --get pivotal.full-name").strip
+      integration_branch = get("git config --get pivotal.integration-branch").strip
+      only_mine          = get("git config --get pivotal.only-mine").strip
 
-      options[:api_token] = token unless token == ""
-      options[:project_id] = id unless id == ""
-      options[:full_name] = name unless name == ""
+      options[:api_token]          = token              unless token == ""
+      options[:project_id]         = id                 unless id == ""
+      options[:full_name]          = name               unless name == ""
+      options[:integration_branch] = integration_branch unless integration_branch == ""
+      options[:only_mine]          = (only_mine != "")  unless name == ""
     end
 
     def parse_argv(*args)
@@ -53,11 +71,13 @@ module Commands
         opts.on("-k", "--api-key=", "Pivotal Tracker API key") { |k| options[:api_token] = k }
         opts.on("-p", "--project-id=", "Pivotal Trakcer project id") { |p| options[:project_id] = p }
         opts.on("-n", "--full-name=", "Pivotal Trakcer full name") { |n| options[:full_name] = n }
+        opts.on("-b", "--integration-branch=", "The branch to merge finished stories back down onto") { |b| options[:integration_branch] = b }
+        opts.on("-m", "--only-mine", "Only select Pivotal Tracker stories assigned to you") { |m| options[:only_mine] = m }
         opts.on("-q", "--quiet", "Quiet, no-interaction mode") { |q| options[:quiet] = q }
         opts.on("-v", "--[no-]verbose", "Run verbosely") { |v| options[:verbose] = v }
-        opts.on_tail("-h", "--help", "This usage guide") { put opts; exit 0 }
+        opts.on_tail("-h", "--help", "This usage guide") { put opts.to_s; exit 0 }
       end.parse!(args)
     end
 
   end
-end
+end

data/lib/commands/finish.rb

@@ -6,26 +6,17 @@ module Commands
     def run!
       super
       
-      # clunky way to get branch name... need better method
-      current_branch = get('git status | head -1').gsub(/^.+On branch /, '').chomp
-      story_id = current_branch[/\d+/]
       unless story_id
         put "Branch name must contain a Pivotal Tracker story id"
         return 1
       end
 
-      api = Pivotal::Api.new(:api_token => options[:api_token])
-      project = api.projects.find(:id => options[:project_id])
-      story = project.stories.find(:id => story_id)
-      
       put "Marking Story #{story_id} as finished..."
-      if story.update_attributes(:current_state => :finished)
-      
-        target_branch = "develop"
-        put "Merging #{current_branch} into #{target_branch}"
-        sys "git checkout #{target_branch}"
+      if story.update_attributes(:current_state => story.finished_state)
+        put "Merging #{current_branch} into #{integration_branch}"
+        sys "git checkout #{integration_branch}"
         sys "git merge --no-ff #{current_branch}"
-      
+
         put "Removing #{current_branch} branch"
         sys "git branch -d #{current_branch}"
 
@@ -37,5 +28,19 @@ module Commands
       end
     end
 
+  protected
+
+    # FIXME: clunky way to get branch name... need better method
+    def current_branch
+      @current_branch ||= get('git status | head -1').gsub(/^.+On branch /, '').chomp
+    end
+
+    def story_id
+      current_branch[/\d+/]
+    end
+
+    def story
+      @story ||= project.stories.find(:id => story_id)
+    end
   end
-end
+end

data/lib/commands/pick.rb

@@ -4,26 +4,26 @@ module Commands
   class Pick < Base
   
     def type
-      raise Error "must define in subclass"
+      raise Error("must define in subclass")
     end
     
     def plural_type
-      raise Error "must define in subclass"
+      raise Error("must define in subclass")
     end
   
     def branch_suffix
-      raise Error "must define in subclass"
+      raise Error("must define in subclass")
     end
     
     def run!
       super
-    
-      put "Retrieving latest #{plural_type} from Pivotal Tracker..."
-      api = Pivotal::Api.new(:api_token => options[:api_token])
 
-      project = api.projects.find(:id => options[:project_id])
-      story = project.stories.find(:conditions => { :story_type => type, :current_state => :unstarted }, :limit => 1).first
-    
+      msg = "Retrieving latest #{plural_type} from Pivotal Tracker"
+      if options[:only_mine]
+        msg += " for #{options[:full_name]}"
+      end
+      put "#{msg}..."
+      
       unless story
         put "No #{plural_type} available!"
         return 0
@@ -57,5 +57,14 @@ module Commands
       end
     end
 
+  protected
+
+    def story
+      return @story if @story
+      
+      conditions = { :story_type => type, :current_state => :unstarted }
+      conditions[:owned_by] = options[:full_name] if options[:only_mine]
+      @story = project.stories.find(:conditions => conditions, :limit => 1).first
+    end
   end
-end
+end

data/lib/pivotal/base.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+gem 'rest-client', '~>1.4.0'
 require 'rest_client'
 require 'nokogiri'
 require 'builder'

data/lib/pivotal/story.rb

@@ -30,6 +30,15 @@ module Pivotal
     def unestimated?
       estimate == "unestimated"
     end
+
+    def finished_state
+      case story_type
+        when "chore"
+          :accepted
+        else
+          :finished
+      end
+    end
   
   end
-end
+end

data/readme.markdown

@@ -6,26 +6,26 @@ You might want to have [this song](http://www.dailymotion.com/video/x9vzh0_olivi
 ##Let's Git Pivotal
 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://nvie.com/archives/323), I set off to create a set of utilities to simplify the workflow between the two.
 
-###Git Pick
-The original `git pick` has been deprecated.  Three new commands take its place: `git feature`, `git bug` and `git chore`, which collects the top-most available feature, bug or chore (respectively) from your Pivotal Tracker, and offers to create a feature branch.
+###Git Feature/Bug/Chore
+The Git Pivotal utility provides three tools to integrate with your Pivotal Tracker project -- `git feature`, `git bug` and `git chore`.  These commands collect the top-most available feature, bug or chore (respectively) from your Pivotal Tracker and creates a unique feature branch for it.
 
-    1 git-pick:master % git feature
+    1 git-pivotal:master % git feature
     Collecting latest stories from Pivotal Tracker...
     Story: Test git pivotal
     URL:   http://www.pivotaltracker.com/story/show/1234567
     Updating story status in Pivotal Tracker...
     Enter branch name (will be prepended by 1234567) [feature]: testing
     Creating 1234567-testing branch...
-    2 git-pick:1234567-testing %
+    2 git-pivotal:1234567-testing %
     
 ###Git Finish
-When on a feature branch, this command will close the associated story in Pivotal Tracker, merge the branch into the develop branch and remove the feature branch.
+When on a feature branch, this command will close the associated story in Pivotal Tracker, merge the branch into your integration branch (`master` by default) and remove the feature branch.
 
-    3 git-pick:1234567-testing % git finish
+    3 git-pivotal:1234567-testing % git finish
     Marking Story 1234567 as finished...
-    Merging 1234567-testing into develop
+    Merging 1234567-testing into master
     Removing 1234567-testing branch
-    4 git-pick:develop %
+    4 git-pivotal:master %
 
 ##Installation
 To install git-pivotal, simply run
@@ -38,6 +38,14 @@ Once installed, git pivotal needs three bits of info: your Pivotal Tracker API T
     git config --global pivotal.api-token 9a9a9a9a9a9a9a9a9a9a
     git config --global pivotal.full-name "Jeff Tucker"
 
+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 only want to pick up bugs/features/chores that are already assigned to you, set:
+
+    git config --global pivotal.only-mine true
+
 The project id is best placed within your project's git config:
 
     git config -f .git/config pivotal.project-id 88888
@@ -45,11 +53,13 @@ The project id is best placed within your project's git config:
 If you're not interested in storing these options in git, you can pass them into git pivotal as command line arguments.  See the usage guides for more details.
 
 ##TODO
-This is <del>some seriously</del> alpha software.  Several things on the ol' todo list:
+This is beta software.  Several things on the ol' todo list:
 
 * <del>Create a general Pivotal::Base#update_attributes method</del>
 * <del>`git pick` doesn't update the story to indicate who claimed it</del>
 * <del>Add command to close/finish currently 'picked' feature</del>
 * <del>Reduce verbosity of `git pick`</del>
-* Allow users to define their development branch name for `git finish`
+* <del>Allow users to define their development branch name for `git finish`</del>
+* Add option to install git commit hooks which add commit messages to story comments
+* Drop custom Pivotal API in favor of pivotal-tracker gem
 * More that I can't recall at the moment

data/spec/commands/base_spec.rb

@@ -65,7 +65,28 @@ describe Commands::Base do
     @pick = Commands::Base.new(@input, @output,"--no-verbose")
     @pick.options[:verbose].should be_false
   end
-  
+
+  it "should set the integration branch with the -b option" do
+    @pick = Commands::Base.new(@input, @output, "-b", "integration")
+    @pick.send(:integration_branch).should == "integration"
+  end
+
+  it "should set the integration branch from git config" do
+    Commands::Base.any_instance.stubs(:get).with("git config --get pivotal.integration-branch").returns("chickens")
+    @pick = Commands::Base.new
+    @pick.send(:integration_branch).should == "chickens"
+  end
+
+  it "should set the integration branch with the --integration-branch= option" do
+    @pick = Commands::Base.new(@input, @output, "--integration-branch=integration")
+    @pick.send(:integration_branch).should == "integration"
+  end
+
+  it "should default the integration branch to master if none is specified" do
+    @pick = Commands::Base.new
+    @pick.send(:integration_branch).should == "master"
+  end
+
   it "should print a message if the API token is missing" do
     @output.expects(:print).with("Pivotal Tracker API Token and Project ID are required\n")
 

data/spec/commands/finish_spec.rb

@@ -0,0 +1,131 @@
+require 'commands/finish'
+require 'spec_helper'
+
+describe Commands::Finish do
+
+  def mock_projects
+    if @mock_projects.nil?
+      @mock_projects = mock("mock project list")
+      @mock_projects.stubs(:find).with(:id => mock_project_id).returns(mock_project)
+    end
+    @mock_projects
+  end
+
+  def mock_project_id
+    @mock_project_id ||= '4321'
+  end
+
+  def mock_project
+    if @mock_project.nil?
+      @mock_project = mock("mock project")
+      @mock_project.stubs(:stories).returns(mock_stories)
+    end
+    @mock_project
+  end
+
+  def mock_stories
+    if @mock_stories.nil?
+      @mock_stories = mock("mock story list")
+      @mock_stories.stubs(:find).with(:id => mock_story_id).returns(mock_story)
+    end
+    @mock_stories
+  end
+
+  def mock_story_id
+    @mock_story_id ||= '1234'
+  end
+
+  def mock_story
+    if @mock_story.nil?
+      @mock_story = mock("mock story")
+    end
+    @mock_story
+  end
+
+  before(:each) do
+    # stub out git config requests
+    Commands::Finish.any_instance.stubs(:get).with { |v| v =~ /git config/ }.returns("")
+
+    Pivotal::Api.any_instance.stubs(:projects).returns(mock_projects)
+
+    @finish = Commands::Finish.new(nil, nil, "-p", mock_project_id)
+    @finish.stubs(:sys)
+    @finish.stubs(:put)
+  end
+
+  context "where the branch name does not contain a valid story id" do
+    before(:each) do
+      # stub out git status request to identify the branch
+      branch_name = "invalid-branch-name-without-story-id"
+      Commands::Finish.any_instance.stubs(:get).with { |v| v =~ /git status/ }.returns("# On branch #{branch_name}")
+    end
+
+    it "should return an exit status of one" do
+      @finish.run!.should == 1
+    end
+
+    it "should print an error message" do
+      @finish.expects(:put).with("Branch name must contain a Pivotal Tracker story id").once
+      @finish.run!
+    end
+  end
+
+  context "where the branch name does contain a valid story id" do
+    def branch_name
+      "#{mock_story_id}-feature-branch-name"
+    end
+
+    before(:each) do
+      # stub out git status request to identify the branch
+      Commands::Finish.any_instance.stubs(:get).with { |v| v =~ /git status/ }.returns("# On branch #{branch_name}")
+    end
+
+    it "should attempt to update the story status to the stories finished_state" do
+      mock_story.stubs(:finished_state).returns(:finished)
+      mock_story.expects(:update_attributes).with(:current_state => :finished)
+      @finish.run!
+    end
+
+    context "and the story is successfully marked as finished in PT" do
+      before(:each) do
+        mock_story.stubs(:finished_state).returns(:finished)
+        mock_story.stubs(:update_attributes).with(:current_state => :finished).returns(true)
+      end
+
+      it "should succeed with an exist status of zero" do
+        @finish.run!.should == 0
+      end
+
+      it "should checkout the developer's integration branch" do
+        @finish.expects(:sys).with("git checkout master")
+        @finish.run!
+      end
+
+      it "should merge in the story branch" do
+        @finish.expects(:sys).with("git merge --no-ff #{branch_name}")
+        @finish.run!
+      end
+
+      it "should remove the story branch" do
+        @finish.expects(:sys).with("git branch -d #{branch_name}")
+        @finish.run!
+      end
+    end
+
+    context "and the story fails to be marked as finished in PT" do
+      before(:each) do
+        mock_story.stubs(:finished_state).returns(:finished)
+        mock_story.stubs(:update_attributes).with(:current_state => :finished).returns(false)
+      end
+
+      it "should fail with an exist status of one" do
+        @finish.run!.should == 1
+      end
+
+      it "should print an error message" do
+        @finish.expects(:put).with("Unable to mark Story #{mock_story_id} as finished").once
+        @finish.run!
+      end
+    end
+  end
+end

data/spec/pivotal/story_spec.rb

@@ -96,5 +96,18 @@ describe Pivotal::Story do
     @story.xml = Factory(:story, :story_type => :feature, :estimate => :unestimated)
     @story.start!.should be_false
   end
+
+  it "should return a finished state of accepted for a chore" do
+    @story.xml = story_type "chore"
+    @story.finished_state.should == :accepted
+  end
+
+  ["feature", "release", "bug"].each do |type|
+    it "should return a finished state of finished for a #{type}" do
+      @story.xml = story_type type
+      @story.finished_state.should == :finished
+    end
+  end
+
   
 end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: git-pivotal
 version: !ruby/object:Gem::Version 
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Jeff Tucker
@@ -15,16 +16,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-11 00:00:00 -05:00
+date: 2010-07-23 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -34,21 +37,27 @@ dependencies:
   name: rest-client
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
+        - 1
+        - 4
         - 0
-        version: "0"
+        version: 1.4.0
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: builder
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -58,9 +67,11 @@ dependencies:
   name: rspec
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -70,9 +81,11 @@ dependencies:
   name: rcov
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -82,9 +95,11 @@ dependencies:
   name: mocha
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -133,6 +148,7 @@ files:
 - spec/commands/bug_spec.rb
 - spec/commands/chore_spec.rb
 - spec/commands/feature_spec.rb
+- spec/commands/finish_spec.rb
 - spec/factories.rb
 - spec/factory.rb
 - spec/pivotal/api_spec.rb
@@ -142,6 +158,7 @@ files:
 - spec/pivotal/collection_spec.rb
 - spec/pivotal/project_spec.rb
 - spec/pivotal/story_spec.rb
+- spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/trydionel/git-pivotal
@@ -153,23 +170,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A collection of git utilities to ease integration with Pivotal Tracker
@@ -178,6 +199,7 @@ test_files:
 - spec/commands/bug_spec.rb
 - spec/commands/chore_spec.rb
 - spec/commands/feature_spec.rb
+- spec/commands/finish_spec.rb
 - spec/factories.rb
 - spec/factory.rb
 - spec/pivotal/api_spec.rb