git-pivotal-tracker 0.9.0

data/lib/git-pivotal-tracker.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.dirname(__FILE__))
+
+require File.join('commands', 'base')
+require File.join('commands', 'pick')
+require File.join('commands', 'card')
+require File.join('commands', 'feature')
+require File.join('commands', 'bug')
+require File.join('commands', 'chore')
+require File.join('commands', 'finish')
+require File.join('commands', 'info')
+require File.join('commands', 'start')

data/readme.markdown

@@ -0,0 +1,95 @@
+[![Build Status](https://secure.travis-ci.org/zdennis/git-pivotal.png)](http://travis-ci.org/#!/zdennis/git-pivotal)
+
+This is based on https://github.com/trydionel/git-pivotal but has an extended vision and set of goals to achieve.
+
+Things like:
+
+* Make the existing API more intuitive:
+ * git-bug, git-chore, git-feature should not be separate CLI commands. The common action is start, so goal here is to support "git-start _card\_type_"
+* Users should be able to interact with specific cards when possible.
+ * e.g. "git start 123456" should start card 123456. 
+ * being generic (interacting with next available or specific should apply to all applicable commands)
+* Add more commands to interact with Pivotal:
+ * git block
+ * git unblock
+ * git comments
+ * git label 
+ * git unstart
+ * git accept
+* Add verbosity and dry-run support to commands to communicate to the users what commands will be run
+* Add before/after hooks extension points so people do not have to modify the project in order to do something custom. 
+  * e.g. if you want to build a changelog as card's are finished, this should be able to be done by hooking into the "git finish" command and not require altering the code-base
+* better support for handling merge conflicts (_this may be nothing more than communicating better to the user if a merge conflict happens when issuing a command_)
+
+The main vision for this is simple: Encourage and support good practices and be flexible. 
+
+More README to come. See ISSUES for things I want to tackle in this project.
+
+
+### git start - Starting the next available Feature/Bug/Chore
+
+    git start <card_type>
+    
+Replace card\_type in the above command to start the next available card in your Pivotal project, e.g.:
+
+    1 git-pivotal:master % git start 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-pivotal:1234567-testing %
+
+    
+### git finish
+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-pivotal:1234567-testing % git finish
+    Marking Story 1234567 as finished...
+    Merging 1234567-testing into master
+    Removing 1234567-testing branch
+    4 git-pivotal:master %
+
+### git info
+When on a feature/bug/chore branch, this command will display the story information as recorded in Pivotal Tracker.
+
+    5 git-pivotal:1234567-testing % git info
+    Story:        Test git pivotal
+    URL:          http://www.pivotaltracker.com/story/show/1234567
+    Description:  The awesome story description
+    6 git-pivotal:1234567-testing % 
+
+## Installation
+
+_This section is out of date and applies to the original project. It needs to be updated._
+
+To install git-pivotal, simply run
+
+    [sudo] gem install git-pivotal
+
+## Configuration
+
+Once installed, git pivotal needs three bits of info: your Pivotal Tracker API Token, your name as it appears in Pivotal Tracker and your Pivotal Tracker project id.  The former two are best set as a global git config options:
+
+    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
+
+If you would rather have the story id appended to the branch name (feature-123456) instead of prepending (123456-feature), you can configue that:
+
+    git config -f .git/config pivotal.append-name true
+
+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.
+

data/spec/commands/base_spec.rb

@@ -0,0 +1,151 @@
+require 'spec_helper'
+
+describe Commands::Base do
+  
+  before(:each) do
+    @input = mock('input')
+    @output = mock('output')
+    
+    # stub out git config requests
+    Commands::Base.any_instance.stubs(:get).with { |v| v =~ /git config/ }.returns("")
+  end
+  
+  it "should set the api key with the -k option" do
+    @pick = Commands::Base.new("-k", "1234").with(@input, @output)
+    @pick.options[:api_token].should == "1234"
+  end
+  
+  it "should set the api key with the --api-token= option" do
+    @pick = Commands::Base.new("--api-key=1234").with(@input, @output)
+    @pick.options[:api_token].should == "1234"
+  end
+  
+  it "should set the project id with the -p option" do
+    @pick = Commands::Base.new("-p", "1").with(@input, @output)
+    @pick.options[:project_id].should == "1"
+  end
+  
+  it "should set the project id with the --project-id= option" do
+    @pick = Commands::Base.new("--project-id=1").with(@input, @output)
+    @pick.options[:project_id].should == "1"
+  end
+  
+  it "should set the full name with the -n option" do
+    @pick = Commands::Base.new("-n", "Jeff Tucker").with(@input, @output)
+    @pick.options[:full_name].should == "Jeff Tucker"
+  end
+  
+  it "should set the full name with the --full-name= option" do
+    @pick = Commands::Base.new(@input, @output,"--full-name=Jeff Tucker")
+    @pick.options[:full_name].should == "Jeff Tucker"
+  end
+  
+  it "should set the quiet flag with the -q option" do
+    @pick = Commands::Base.new("-q").with(@input, @output)
+    @pick.options[:quiet].should be_true
+  end
+  
+  it "should set the quiet flag with the --quiet option" do
+    @pick = Commands::Base.new("--quiet").with(@input, @output)
+    @pick.options[:quiet].should be_true
+  end
+  
+  it "should set the verbose flag with the -v option" do
+    @pick = Commands::Base.new("-v").with(@input, @output)
+    @pick.options[:verbose].should be_true
+  end
+  
+  it "should set the verbose flag with the --verbose option" do
+    @pick = Commands::Base.new("--verbose").with(@input, @output)
+    @pick.options[:verbose].should be_true
+  end
+  
+  it "should unset the verbose flag with the --no-verbose option" do
+    @pick = Commands::Base.new("--no-verbose").with(@input, @output)
+    @pick.options[:verbose].should be_false
+  end
+
+  it "should set the integration branch with the -b option" do
+    @pick = Commands::Base.new("-b", "integration").with(@input, @output)
+    @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("--integration-branch=integration").with(@input, @output)
+    @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")
+
+    @pick = Commands::Base.new("-p", "1").with(@input, @output)
+    @pick.run!
+  end
+  
+  it "should print a message if the project ID is missing" do
+    @output.expects(:print).with("Pivotal Tracker API Token and Project ID are required\n")
+
+    @pick = Commands::Base.new("-k", "1").with(@input, @output)
+    @pick.run!    
+  end
+  
+  it "should set the append name flag with the -a option" do
+    @pick = Commands::Base.new("-a").with(@input, @output)
+    @pick.options[:append_name].should be_true
+  end
+
+  it "should set the append name flag from git config" do
+    Commands::Base.any_instance.stubs(:get).with("git config --get pivotal.append-name").returns("true")
+    @pick = Commands::Base.new
+    @pick.options[:append_name].should be_true
+  end
+
+  it "should set the append name flag with the --append-name" do
+    @pick = Commands::Base.new("--append-name").with(@input, @output)
+    @pick.options[:append_name].should be_true
+  end
+
+  it "should default the append name flag if none is specified" do
+    @pick = Commands::Base.new
+    @pick.options[:append_name].should be_false
+  end
+
+  it "should set use_ssl to true with --use-ssl" do
+    @pick = Commands::Base.new("--use-ssl").with(@input, @output)
+    @pick.options[:use_ssl].should be_true
+  end
+
+  it "should set use_ssl to true with -S" do
+    @pick = Commands::Base.new("-S").with(@input, @output)
+    @pick.options[:use_ssl].should be_true
+  end
+
+  it "should set use_ssl to false by default" do
+    @pick = Commands::Base.new("").with(@input, @output)
+    @pick.options[:use_ssl].should be_false
+  end
+
+  it "should respect use_ssl from git config if it's set true (case insensitive)" do
+    Commands::Base.any_instance.stubs(:get).with("git config --get pivotal.use-ssl").returns("truE")
+    @pick = Commands::Base.new
+    @pick.options[:use_ssl].should be_true
+  end
+
+  it "should respect use_ssl from git config if it's set to anything but true" do
+    Commands::Base.any_instance.stubs(:get).with("git config --get pivotal.use-ssl").returns("not true")
+    @pick = Commands::Base.new
+    @pick.options[:use_ssl].should be_false
+  end
+
+end

data/spec/commands/bug_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Commands::Bug do
+
+  before(:each) do
+    # stub out git config requests
+    Commands::Bug.any_instance.stubs(:get).with { |v| v =~ /git config/ }.returns("")
+
+    @bug = Commands::Bug.new
+  end
+  
+  it "should specify its story type" do
+    @bug.type.should == "bug"
+  end
+  
+  it "should specify a plural for its story types" do
+    @bug.plural_type.should == "bugs"
+  end
+  
+  it "should specify its branch suffix" do
+    @bug.branch_suffix.should == "bugfix"
+  end
+  
+end

data/spec/commands/chore_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Commands::Chore do
+
+  before(:each) do
+    # stub out git config requests
+    Commands::Chore.any_instance.stubs(:get).with { |v| v =~ /git config/ }.returns("")
+
+    @chore = Commands::Chore.new
+  end
+  
+  it "should specify its story type" do
+    @chore.type.should == "chore"
+  end
+  
+  it "should specify a plural for its story types" do
+    @chore.plural_type.should == "chores"
+  end
+  
+  it "should specify its branch suffix" do
+    @chore.branch_suffix.should == "chore"
+  end
+  
+end

data/spec/commands/feature_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Commands::Feature do
+
+  before(:each) do
+    # stub out git config requests
+    Commands::Feature.any_instance.stubs(:get).with { |v| v =~ /git config/ }.returns("")
+
+    @feature = Commands::Feature.new
+  end
+  
+  it "should specify its story type" do
+    @feature.type.should == "feature"
+  end
+  
+  it "should specify a plural for its story types" do
+    @feature.plural_type.should == "features"
+  end
+  
+  it "should specify its branch suffix" do
+    @feature.branch_suffix.should == "feature"
+  end
+  
+end

data/spec/commands/finish_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+describe Commands::Finish do
+
+  def mock_project_id
+    @mock_project_id ||= '4321'
+  end
+
+  def mock_projects
+    if @mock_projects.nil?
+      @mock_projects = mock("mock project")
+      @mock_projects.stubs(:stories).returns(mock_stories)
+    end
+    @mock_projects
+  end
+
+  def mock_stories
+    if @mock_stories.nil?
+      @mock_stories = mock("mock story list")
+      @mock_stories.stubs(:find).with(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
+
+  def branch_name
+    "#{mock_story_id}-feature-branch-name"
+  end
+
+  before(:each) do
+    # stub out git config requests
+    Commands::Finish.any_instance.stubs(:get).with { |v| v =~ /git config/ }.returns("")
+
+    PivotalTracker::Project.stubs(:find).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}")
+      Commands::Finish.any_instance.stubs(:get).with { |v| v == "git symbolic-ref HEAD" }.returns(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
+
+    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}")
+      Commands::Finish.any_instance.stubs(:get).with { |v| v == "git symbolic-ref HEAD" }.returns(branch_name)
+    end
+
+    it "should attempt to update the story status to the stories finished_state" do
+      mock_story.stubs(:story_type).returns("finished")
+      mock_story.expects(:update).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(:story_type).returns("finished")
+        mock_story.stubs(:update).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 acceptance branch" do
+        @finish.expects(:sys).with("git checkout acceptance")
+        @finish.run!
+      end
+
+      it "should pull down the latest changes into the developer's acceptance branch" do
+        @finish.expects(:sys).with("git pull")
+        @finish.run!
+      end
+
+      it "should merge in the story branch" do
+        @finish.expects(:sys).with("git merge --no-ff #{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(:story_type).returns("finished")
+        mock_story.stubs(:update).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