git-pivotal-tracker-centro 1.0.0.rc1

data/features/test_repo/origin.git/logs/refs/heads/master

@@ -0,0 +1 @@
+0000000000000000000000000000000000000000 10ecf2b7ce989f01f3f7266e712b48d9275f2635 Jeff Tucker <trydionel@gmail.com> 1279979728 -0400	commit (initial): A blank repo for testing

data/features/test_repo/origin.git/refs/heads/master

@@ -0,0 +1 @@
+10ecf2b7ce989f01f3f7266e712b48d9275f2635

data/features/test_repo/readme

@@ -0,0 +1 @@
+Testing repo

data/git-pivotal-tracker-centro.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-  
+$:.push File.expand_path("../lib", __FILE__)  
+  
+Gem::Specification.new do |s|  
+  s.name          = "git-pivotal-tracker-centro"
+  s.version       = IO.read("VERSION")
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ["Zach Dennis", "Jeff Tucker", "Sam Stokes", "John Wood"]
+  s.email         = "john@johnpwood.net"
+  s.homepage      = "https://github.com/centro/git-pivotal"
+  s.summary       = "A collection of git utilities to ease integration with Pivotal Tracker."
+  s.description   = "A collection of git utilities to ease integration with 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"]
+
+  s.add_runtime_dependency(%q<pivotal-tracker>, [">= 0"])
+
+  s.add_development_dependency(%q<rake>, [">= 0"])
+  s.add_development_dependency(%q<mocha>, [">= 0"])
+  s.add_development_dependency(%q<simplecov>, [">= 0"])
+  s.add_development_dependency(%q<aruba>, [">= 0"])
+  s.add_development_dependency(%q<rspec>, [">= 0"])
+  s.add_development_dependency(%q<cucumber>, [">= 0"])
+  s.add_development_dependency(%q<pry>, [">= 0"])
+end
+

data/lib/commands/base.rb

@@ -0,0 +1,120 @@
+require 'rubygems'
+require 'pivotal-tracker'
+require 'optparse'
+
+module Commands
+  class Base
+
+    attr_accessor :input, :output, :options
+
+    def initialize(*args)
+      @input = STDIN
+      @output = STDOUT
+
+      @options = {}
+
+      parse_gitconfig
+      parse_argv(*args)
+    end
+    
+    def with(input, output)
+      tap do
+        @input = input
+        @output = output
+      end
+    end
+
+    def put(string, newline=true)
+      @output.print(newline ? string + "\n" : string) unless options[:quiet]
+    end
+
+    def sys(cmd)
+      if options[:verbose]
+        put cmd
+        system cmd
+      else
+        system "#{cmd} > /dev/null 2>&1"
+      end
+    end
+
+    def get(cmd)
+      put cmd if options[:verbose]
+      `#{cmd}`
+    end
+
+    def get_char
+      input.getc
+    end
+
+    def run!
+      unless options[:api_token] && options[:project_id]
+        put "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]
+
+      return 0
+    end
+
+  protected
+  
+    def on_parse(opts)
+      # no-op, override in sub-class to provide command specific options
+    end
+
+    def current_branch
+      @current_branch ||= get('git symbolic-ref HEAD').chomp.split('/').last
+    end
+
+    def project
+      @project ||= PivotalTracker::Project.find(options[:project_id])
+    end
+    
+    def full_name
+      options[:full_name]
+    end
+    
+    def remote
+      options[:remote] || "origin"
+    end
+    
+  private
+
+    def parse_gitconfig
+      token              = get("git config --get pivotal.api-token").strip
+      name               = get("git config --get pivotal.full-name").strip
+      id                 = get("git config --get pivotal.project-id").strip
+      remote             = get("git config --get pivotal.remote").strip
+      use_ssl            = get("git config --get pivotal.use-ssl").strip
+      verbose            = get("git config --get pivotal.verbose").strip
+
+      options[:api_token]          = token              unless token == ""
+      options[:project_id]         = id                 unless id == ""
+      options[:full_name]          = name               unless name == ""
+      options[:remote]             = remote             unless remote == ""
+      options[:use_ssl] = (/^true$/i.match(use_ssl))
+      options[:verbose] = verbose == "" ? true : (/^true$/i.match(verbose))
+    end
+
+    def parse_argv(*args)
+      OptionParser.new do |opts|
+        opts.banner = "Usage: git pick [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("-n", "--full-name=", "Pivotal Tracker full name") { |n| options[:full_name] = n }
+        opts.on("-S", "--use-ssl", "Use SSL for connection to Pivotal Tracker (for private repos(?))") { |s| options[:use_ssl] = s }
+        opts.on("-D", "--defaults", "Accept default options. No-interaction mode") { |d| options[:defaults] = d }
+        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("-f", "--force", "Do not prompt") { |f| options[:force] = f }
+        
+        on_parse(opts)
+        
+        opts.on_tail("-h", "--help", "This usage guide") { put opts.to_s; exit 0 }
+      end.parse!(args)
+    end
+
+  end
+end

data/lib/commands/bug.rb

@@ -0,0 +1,19 @@
+require 'commands/pick'
+
+module Commands
+  class Bug < Pick
+
+    def type
+      "bug"
+    end
+    
+    def plural_type
+      "bugs"
+    end
+    
+    def branch_suffix
+      "bugfix"
+    end
+
+  end
+end

data/lib/commands/card.rb

@@ -0,0 +1,32 @@
+require 'commands/pick'
+
+module Commands
+  class Card < Pick
+    attr_accessor :story_id
+
+    def type
+      "story"
+    end
+    
+    def plural_type
+      "cards"
+    end
+    
+    def branch_suffix
+      if story.story_type == "bug"
+        "bugfix"
+      else
+        story.story_type
+      end
+    end
+
+    protected
+    
+    def story
+      return @story if @story
+      raise ArgumentError, "No story id was given!" unless story_id
+      project.stories.find(story_id)
+    end
+
+  end
+end

data/lib/commands/chore.rb

@@ -0,0 +1,19 @@
+require 'commands/pick'
+
+module Commands
+  class Chore < Pick
+
+    def type
+      "chore"
+    end
+    
+    def plural_type
+      "chores"
+    end
+    
+    def branch_suffix
+      "chore"
+    end
+
+  end
+end

data/lib/commands/feature.rb

@@ -0,0 +1,19 @@
+require 'commands/pick'
+
+module Commands
+  class Feature < Pick
+
+    def type
+      "feature"
+    end
+    
+    def plural_type
+      "features"
+    end
+    
+    def branch_suffix
+      "feature"
+    end
+
+  end
+end

data/lib/commands/finish.rb

@@ -0,0 +1,67 @@
+require 'commands/base'
+
+module Commands
+  class Finish < Base
+
+    def run!
+      super
+
+      unless story_id
+        put "Branch name must contain a Pivotal Tracker story id"
+        return 1
+      end
+
+      if confirm_should_finish_story?
+        topic_branch = current_branch
+
+        put "Switching to master"
+        sys "git checkout master"
+
+        put "Destroying local branch"
+        local_branch_deleted_successfully = sys "git branch -d #{topic_branch}"
+
+        if local_branch_deleted_successfully
+          put "Destroying remote branch"
+          sys "git push origin :#{topic_branch}"
+
+          put "Marking Story #{story_id} as finished..."
+          if !story.update(:current_state => finished_state)
+            put "Unable to mark Story #{story_id} as finished"
+            return 1
+          end
+        else
+          put "The local branch could not be deleted.  Please make sure your changes have been merged."
+          return 1
+        end
+      end
+
+      return 0
+    end
+
+  protected
+
+    def confirm_should_finish_story?
+      return true if options[:force]
+
+      put "Finish story #{story_id} and delete local and remote branches? (y/N): ", false
+      finish_story = get_char.strip.downcase
+      finish_story == 'y'
+    end
+
+    def finished_state
+      if story.story_type == "chore"
+        "accepted"
+      else
+        "finished"
+      end
+    end
+
+    def story_id
+      match = current_branch[/\d+/] and match.to_i
+    end
+
+    def story
+      @story ||= project.stories.find(story_id)
+    end
+  end
+end

data/lib/commands/info.rb

@@ -0,0 +1,58 @@
+require 'commands/base'
+
+module Commands
+  class Info < Base
+    def initialize(*args)
+      @story_id = args.shift if args.first =~ /^(\d+)$/
+      super(*args)
+    end
+
+    def run!
+      super
+
+      unless story_id
+        put "No story id was supplied and you aren't on a topic branch!"
+        return 1
+      end
+
+      put "Story:         #{story.name}"
+      put "URL:           #{story.url}"
+      put "Labels:        #{story.labels.split(',').join(', ')}" if story.labels
+      put "State:         #{story.accepted_at ? 'accepted' : 'not accepted'}"
+      
+      colwidth = 74
+      
+      put "\nDescription:\n"
+      put wrap_text("#{story.description}\n", colwidth).gsub(/^/, '  ').chomp
+
+      if options[:comments]
+        put "\nComments:\n"
+        story.notes.all.each do |note|
+          @output.printf "  %-37s%37s\n\n", note.author, note.noted_at.strftime("%b %e, %Y %k:%M%p")
+          put wrap_text(note.text, colwidth - 2).gsub(/^/, '    ')
+        end
+      end
+      
+      return 0
+    end
+
+  protected
+  
+    def wrap_text(txt, col = 80)
+      txt.gsub(/(.{1,#{col}})( +|$\n?)|(.{1,#{col}})/,
+        "\\1\\3\n") 
+    end  
+
+    def on_parse(opts)
+      opts.on("-c", "--comments", "Display comments"){ |v| options[:comments] = v }
+    end
+
+    def story_id
+      @story_id || current_branch[/\d+/]
+    end
+
+    def story
+      @story ||= project.stories.find(story_id)
+    end
+  end
+end

data/lib/commands/map.rb

@@ -0,0 +1,10 @@
+module Commands
+  class Map < Hash
+    def [](arg)
+      super || (
+        key = keys.detect{ |e| !arg.nil? && e.respond_to?(:match) && e.match(arg) }
+        super key
+      )
+    end
+  end
+end

data/lib/commands/pick.rb

@@ -0,0 +1,94 @@
+require 'commands/base'
+
+module Commands
+  class Pick < Base
+
+    def type
+      raise Error("must define in subclass")
+    end
+
+    def plural_type
+      raise Error("must define in subclass")
+    end
+
+    def branch_suffix
+      raise Error("must define in subclass")
+    end
+
+    def run!
+      response = super
+      return response if response > 0
+
+      if story
+        put "Story: #{story.name}"
+        put "URL:   #{story.url}\n"
+
+        if confirm_should_start_story?
+          put "Updating #{type} status in Pivotal Tracker..."
+          story.update(:owned_by => options[:full_name], :current_state => :started)
+
+          if story.errors.empty?
+            branch_name = get_branch_name
+            create_branch(branch_name)
+          else
+            put "Unable to mark #{type} as started"
+            put "\t" + story.errors.to_a.join("\n\t")
+            return 1
+          end
+        end
+      else
+        put "No #{plural_type} available!"
+      end
+
+      return 0
+    end
+
+    protected
+
+    def confirm_should_start_story?
+      return true if options[:force]
+
+      put "Start #{type} #{story.id} - #{story.name}? (Y/n): ", false
+      start_story = get_char.strip.downcase
+      start_story == '' || start_story == 'y'
+    end
+
+    def story
+      if @story.nil?
+        msg = "Retrieving latest #{plural_type} from Pivotal Tracker"
+        msg += " for #{options[:full_name]}" if options[:only_mine]
+        put "#{msg}..."
+
+        conditions = { :story_type => type, :current_state => "unstarted", :limit => 1, :offset => 0 }
+        conditions[:owned_by] = options[:full_name] if options[:only_mine]
+        @story = project.stories.all(conditions).first
+      end
+      @story
+    end
+
+    def get_branch_name
+      branch_name = ""
+      suggested_branch_name = "#{story.id}-#{story.name.downcase.gsub(/\s+/, "-")}"
+
+      unless options[:quiet] || options[:defaults]
+        put "Enter branch name [#{suggested_branch_name}]: ", false
+        branch_name = input.gets.chomp.strip
+      end
+
+      branch_name == "" ? suggested_branch_name : branch_name
+    end
+
+    def create_branch(branch)
+      if get("git branch").match(branch).nil?
+        put "Creating remote branch '#{branch}'"
+        sys "git push origin origin:refs/heads/#{branch}"
+        sys "git fetch origin"
+
+        put "Switched to a new branch '#{branch}'"
+        sys "git branch #{branch} origin/#{branch}"
+        sys "git checkout #{branch}"
+      end
+    end
+
+  end
+end

data/lib/commands/start.rb

@@ -0,0 +1,39 @@
+require 'commands/map'
+require 'commands/bug'
+require 'commands/card'
+require 'commands/chore'
+require 'commands/feature'
+
+module Commands
+  class Start
+    COMMAND_MAP = Map.new.merge({
+      "bug"     => Commands::Bug,
+      "chore"   => Commands::Chore,
+      "feature" => Commands::Feature,
+      /^\d+$/   => Commands::Card
+    })
+    
+    class << self
+      def for(*args)
+        identifier = args.shift
+        construct_instance_for(identifier, args) || display_usage_instructions_and_quit(identifier)
+      end
+      
+      private
+      
+      def construct_instance_for(identifier, args)
+        if klass=COMMAND_MAP[identifier]
+          instance = klass.new(*args)
+          instance.story_id = identifier if instance.respond_to?(:story_id=)
+          instance
+        end
+      end
+
+      def display_usage_instructions_and_quit(identifier)
+        puts "ERROR: Unknown card identifier given: '#{identifier}'.  Valid options are 'bug', 'chore', 'feature', or the card number."
+        exit 1
+      end
+    end
+  end
+
+end

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,106 @@
+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 _story\_type_"
+* Users should be able to interact with specific stories when possible.
+ * e.g. "git start 123456" should start story 123456. 
+ * being generic (interacting with next available or specific should apply to all applicable commands)
+* Add more commands to interact with Pivotal:
+ * git comments
+ * git label 
+ * git unstart
+* 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 story'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.
+
+## The workflow
+
+1. Assign the story to yourself (or have someone assign it to you)
+2. From _master_, `git start <story_type>`, where story\_type is either 'bug', 'chore', 'feature', or the story number.  A new branch will be created, and you will be automatically  switched to it.  The story will also be marked as started.
+3. WRITE ALL THE CODE!, create pull request, merge into master.
+4. `git finish`. This will destroy the local and remote branches, and mark the story as finished.
+
+### git start - Starting the next available Feature/Bug/Chore
+
+    git start <story_type>
+    
+Replace story\_type in the above command to start the next available story in your Pivotal project, e.g.:
+
+    1 git-pivotal:master % git start feature
+    Retrieving latest features from Pivotal Tracker for John Wood...
+    Story: Test the tracker gem
+    URL:   http://www.pivotaltracker.com/story/show/38895179
+
+    Start feature 38895179 - Test the tracker gem? (Y/n): Y
+    Updating feature status in Pivotal Tracker...
+    Enter branch name [38895179-test-the-tracker-gem]: 
+    git branch
+    Creating remote branch '38895179-test-the-tracker-gem'
+    git push origin origin:refs/heads/38895179-test-the-tracker-gem
+    Total 0 (delta 0), reused 0 (delta 0)
+    To git@github.com:centro/git-pivotal.git
+     * [new branch]      origin/HEAD -> 38895179-test-the-tracker-gem
+    git fetch origin
+    Switched to a new branch '38895179-test-the-tracker-gem'
+    git branch 38895179-test-the-tracker-gem origin/38895179-test-the-tracker-gem
+    Branch 38895179-test-the-tracker-gem set up to track remote branch 38895179-test-the-tracker-gem from origin.
+    git checkout 38895179-test-the-tracker-gem
+    Switched to branch '38895179-test-the-tracker-gem'
+    2 git-pivotal:38895179-test-the-tracker-gem %
+
+### git finish
+When on a feature branch, this command will close the associated story in Pivotal Tracker and remove the feature branch.
+
+    3 git-pivotal:38895179-test-the-tracker-gem % git finish
+    git symbolic-ref HEAD
+    Finish story 38895179 and delete local and remote branches? (y/N): y
+    Switching to master
+    git co master
+    Switched to branch 'master'
+    Destroying local branch
+    git branch -d 38895179-test-the-tracker-gem
+    Deleted branch 38895179-test-the-tracker-gem (was 99e52a3).
+    Destroying remote branch
+    git push origin :38895179-test-the-tracker-gem
+    To git@github.com:centro/git-pivotal.git
+     - [deleted]         38895179-test-the-tracker-gem
+    Marking Story 38895179 as finished...
+    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"
+
+The project id is best placed within your project's git config:
+
+    git config -f .git/config pivotal.project-id 88888
+
+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.
+