hone-git_pivot 0.0.0 → 0.1.0

data/README.rdoc

@@ -2,13 +2,37 @@
 
 Tool that allows you to work with Pivotal Tracker from the command line.
 
+== Installation and Usage
+
+To install:
+
+    $ gem install hone-git_pivot -s http://gems.github.com
+    
+Now you'll need to add a <tt>git_pivot.yml</tt> to the root directory of your project:
+
+    project_id: 213992
+    token: 3a9390ed9309ba304903939ae948298
+    owner: Matt Buck
+    use_git: true
+    
+... where <tt>owner</tt> is your name as it appears in the Pivotal Tracker interface.  Set <tt>use_git</tt> to <tt>true</tt> if you want GitPivot to automatically create (local) topic branches when you start a story.
+
+== Current Features
+* display stories in current
+* display stories under "My Work"
+* start a story (optional git support to start a topic branch)
+* display a story with associated "Notes"
+* add a note to a story
+* finish a story
+* list tasks for a story
+* add a task to a story
+* complete tasks
+
 == Planned Features
 
 Planned features include:
-* display stories in current sprint 
-* start working on a ticket that creates a new branch in Git, starts ticket in Pivotal Tracker
-* close ticket in Pivotal Tracker
 * search for stories
+* backlog stories
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -12,6 +12,7 @@ begin
     gem.authors = ["hone"]
     gem.add_development_dependency "hone-pivotal-tracker"
     gem.add_development_dependency "rupot"
+    gem.add_development_dependency "git"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 rescue LoadError

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/git_pivot.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{git_pivot}
-  s.version = "0.0.0"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["hone"]
-  s.date = %q{2009-08-29}
+  s.date = %q{2009-09-08}
   s.default_executable = %q{git_pivot}
   s.description = %q{TODO: longer description of your gem}
   s.email = %q{hone02@gmail.com}
@@ -24,8 +24,10 @@ Gem::Specification.new do |s|
      "LICENSE",
      "README.rdoc",
      "Rakefile",
+     "VERSION",
      "bin/git_pivot",
      "git_pivot.gemspec",
+     "git_pivot.yml.example",
      "lib/git_pivot.rb",
      "lib/runner.rb"
   ]
@@ -43,12 +45,15 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<hone-pivotal-tracker>, [">= 0"])
       s.add_development_dependency(%q<rupot>, [">= 0"])
+      s.add_development_dependency(%q<git>, [">= 0"])
     else
       s.add_dependency(%q<hone-pivotal-tracker>, [">= 0"])
       s.add_dependency(%q<rupot>, [">= 0"])
+      s.add_dependency(%q<git>, [">= 0"])
     end
   else
     s.add_dependency(%q<hone-pivotal-tracker>, [">= 0"])
     s.add_dependency(%q<rupot>, [">= 0"])
+    s.add_dependency(%q<git>, [">= 0"])
   end
 end

data/git_pivot.yml.example

@@ -0,0 +1,3 @@
+project_id: 213992
+token: 3a9390ed9309ba304903939ae948298
+owner: Matt Buck

data/lib/git_pivot.rb

@@ -19,14 +19,16 @@
 
 require 'ruport'
 require 'pivotal-tracker'
+require 'git'
 
 module GitPivot
   class GitPivot
 
     # ssl should default to yes since http basic auth is insecure
-    def initialize(project_id, token, owner, use_ssl = true)
+    def initialize(project_id, token, owner, git = nil, use_ssl = true)
       @owner = owner
       @tracker = PivotalTracker.new(project_id, token, {:use_ssl => use_ssl })
+      @g = Git.open('.') if git
     end
 
     # list stories in current sprint
@@ -61,10 +63,11 @@ module GitPivot
     end
 
     # start story
-    def start_story(id)
+    def start_story(id, name = nil)
       story = @tracker.find_story(id)
       story.current_state = "started"
       @tracker.update_story(story)
+      create_topic_branch(topic_branch_name(story, name))
 
       display_story(id)
     end
@@ -82,6 +85,36 @@ module GitPivot
       display_story(id)
     end
 
+    # add a new note
+    def add_note(id, note_text)
+      note = Note.new(:text => note_text)
+      @tracker.create_note(id, note)
+
+      display_story(id)
+    end
+
+    def tasks(id)
+      tasks = @tracker.tasks(id)
+      display_tasks(id, tasks)
+    end
+
+    def add_task(id, task_text)
+      task = Task.new(:description => task_text)
+      @tracker.create_task(id, task)
+
+      tasks = @tracker.tasks(id)
+      display_tasks(id, tasks)
+    end
+
+    def complete_task(id, task_id)
+      task = @tracker.find_task(id, task_id)
+      task.complete = true
+      @tracker.update_task(id, task)
+
+      tasks = @tracker.tasks(id)
+      display_tasks(id, tasks)
+    end
+
     private
     def display_stories(stories)
       data = stories.collect do |story| 
@@ -91,5 +124,43 @@ module GitPivot
       puts Table(:data => data, :column_names => ["ID", "Type", "Owner", "State", "Name"])
     end
 
+    def display_tasks(story_id, tasks)
+      data = tasks.collect do |task|
+        [task.id, task.position, task.complete, task.created_at, task.description]
+      end
+
+      puts "Story ID: #{story_id}"
+      puts Table(:data => data,
+                 :column_names => ["ID", "Position", "Complete", "Created At", "Description"])
+    end
+
+    def create_topic_branch(name)
+      if @g
+        # always branch from master
+        unless @g.lib.branch_current == "master"
+          puts 'Switching to master branch'
+          @g.branch('master').checkout
+        end
+
+        puts "Switching to #{name} branch"
+        @g.branch(name).checkout
+      end
+    end
+
+    def topic_branch_name(story, name = nil)
+      name_to_use =
+        if name
+          name
+        else
+          story.name
+        end
+      # convert spaces to underscores and remove all punctation
+      "#{story.id}_#{transform_name(name_to_use)}"
+    end
+
+    def transform_name(name)
+      name.downcase.gsub(' ', '_').gsub(/[^\w]/, '')
+    end
+
   end
 end

data/lib/runner.rb

@@ -17,32 +17,214 @@
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 =end
 
-require 'optparse'
+require 'trollop'
 require 'date'
 
 module GitPivot
   class Runner
+    SUB_COMMANDS = %w{current work display start finish note stack push tasks task complete}
+    STATE_FILE = "git_pivot.state"
+    
     def initialize(args)
-      @argv = args
-      process_args
+      @method, @cmd, @cmd_opts = process_args(args)
+
       # configuration stuff
       configuration = YAML.load_file("git_pivot.yml")
+      if File.exist?(STATE_FILE)
+        File.open(STATE_FILE) do |file|
+          @states = Marshal.load(file)
+          if @states.is_a?(Array)
+            @states.uniq!
+          else
+            @states = nil
+          end
+        end
+      end
 
-      @git_pivot = GitPivot.new(configuration["project_id"], configuration["token"], configuration["owner"])
+      @git_pivot = GitPivot.new(configuration["project_id"], configuration["token"], configuration["owner"], configuration["use_git"])
     end
 
     def run
-      if @arg1
-        @git_pivot.send(@command, @arg1)
-      else
-        @git_pivot.send(@command)
+      args = [@method]
+      if @method and @git_pivot.method(@method).arity.abs > 0
+        if @cmd_opts[:id]
+          args << @cmd_opts[:id]
+        elsif @states.any?
+          args << @states.first
+        else
+          Trollop::die "Need to specify a story id"
+        end
+
+        if @cmd_opts[:name]
+          args << @cmd_opts[:name].join(' ')
+        end
+        if @cmd_opts[:text]
+          args << @cmd_opts[:text].join(' ')
+        end
+        if @cmd_opts[:"task-id"]
+          args << @cmd_opts[:"task-id"]
+        end
+      end
+
+      if @method == :start_story
+        add_story_to_states(@cmd_opts[:id])
+      end
+
+      if @method
+        @git_pivot.send(*args)
+      end
+
+      # must do this after, in case finish fails, don't want to pop
+      if @method == :finish_story
+        if @states and @states.first == args[1]
+          @states.shift
+
+          save_state
+        end
+      end
+
+      case @cmd
+      when "stack"
+        puts @states
+      when "push"
+        add_story_to_states(@cmd_opts[:id])
+        puts @states
       end
     end
 
     private
-    def process_args
-      @command = @argv.shift
-      @arg1 = @argv.shift
+    def save_state
+      File.open(STATE_FILE, 'w') {|file| Marshal.dump(@states, file) }
+    end
+
+    def add_story_to_states(story_id)
+      if @states.nil?
+        @states = [story_id]
+      else
+        @states.delete(story_id)
+        @states.unshift(story_id)
+      end
+
+      save_state
+    end
+
+    def process_args(args)
+      global_opts = Trollop::options do
+        banner <<-BANNER
+A command-line interface for Pivotal Tracker.
+
+Subcommands:
+  current  - Lists the stories that are part of the current iteration.
+  work     - Lists the stories that you own.
+  display  - Displays information about a specific story.
+  start    - Marks a story as started.
+  finish   - Marks a story as finished.
+  note     - Add a new note to an existing story
+  stack    - Current Stack of Story ids
+  push     - Push a story to the top of the Story Stack
+  tasks    - Display tasks associated to a story
+  task     - Add a task to the given story
+  complete - Mark a task as completed
+  
+BANNER
+        stop_on SUB_COMMANDS
+      end
+
+      command = nil
+      cmd = args.shift
+      cmd_opts = case cmd
+        when "current"
+          command = :current_sprint
+        
+          Trollop::options(args) do
+            banner "Lists the stories that are part of the current iteration."
+          end
+        when "work"
+          command = :my_work
+        
+          # FIXME: This help message doesn't appear with a 'git_pivot work -h', but the 'git_pivot current -h' message does.
+          Trollop::options(args) do
+            banner "Lists the stories that you own."
+          end
+        when "display"
+          command = :display_story
+        
+          Trollop::options(args) do
+            banner "Display information about a specific story."
+        
+            opt :id, "The id of the story to display.", :type => Integer
+          end
+        when "start"
+          command = :start_story
+        
+          Trollop::options(args) do
+            banner "Marks a specific story as started."
+        
+            opt :id, "The id of the story to start.", :required => true, :type => Integer
+            opt :name, "Topic branch name", :type => :strings
+          end
+        when "finish"
+          command = :finish_story
+        
+          Trollop::options(args) do
+            banner "Marks a specific story as finished."
+        
+            opt :id, "The id of the story to finish.", :type => Integer
+          end
+        when "note"
+          command = :add_note
+
+          Trollop::options(args) do
+            banner "Adds a note to the story."
+
+            opt :id, "The id of the story to finish.", :type => Integer
+            opt :text, "The text of the note.", :required => true, :type => :strings
+          end
+        when "stack"
+          command = nil
+
+          Trollop::options(args) do
+            banner "Displays the stack of story ids."
+          end
+        when "push"
+          command = nil
+
+          Trollop::options(args) do
+            banner "Push story to the top of the story stack."
+            
+            opt :id, "The id of the story.", :type => Integer
+          end
+        when "tasks"
+          command = :tasks
+
+          Trollop::options(args) do
+            banner "Tasks for a given story."
+
+            opt :id, "The id of the story.", :type => Integer
+          end
+        when "task"
+          command = :add_task
+
+          Trollop::options(args) do
+            banner "Add a task to the story."
+
+            opt :id, "The id of the story.", :type => Integer
+            opt :text, "The text of the task.", :required => true, :type => :strings
+          end
+        when "complete"
+          command = :complete_task
+
+          Trollop::options(args) do
+            banner "Complete a task"
+
+            opt :id, "The id of the story.", :type => Integer
+            opt :"task-id", "The id of the task.", :required => true, :type => Integer
+          end
+        else
+          Trollop::die "unknown subcommand #{cmd.inspect}"
+        end
+
+      [command, cmd, cmd_opts]
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hone-git_pivot
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - hone
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-29 00:00:00 -07:00
+date: 2009-09-08 00:00:00 -07:00
 default_executable: git_pivot
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: git
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: "TODO: longer description of your gem"
 email: hone02@gmail.com
 executables: 
@@ -47,13 +57,14 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
+- VERSION
 - bin/git_pivot
 - git_pivot.gemspec
+- git_pivot.yml.example
 - lib/git_pivot.rb
 - lib/runner.rb
 has_rdoc: true
 homepage: http://github.com/hone/git_pivot
-licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -74,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: "TODO: one-line summary of your gem"