pivotal-slacker 1.6.0 → 1.7.0

data/bin/pivotal-slacker

@@ -6,6 +6,8 @@ require "pivotal-tracker"
 require "rainbow"
 require "action_view"
 require "launchy"
+require "readline"
+require "shellwords"
 require "pp"
 require "app_config"
 require "formatter"
@@ -14,9 +16,9 @@ include ActionView::Helpers::DateHelper
 # ----------------------------------------------------------
 # Load config
 
-config = nil
+$config = nil
 begin
-  config = AppConfig.load
+  $config = AppConfig.load
 rescue Exception => e
   puts e
   exit 1
@@ -25,8 +27,11 @@ end
 # ----------------------------------------------------------
 # Init
 
-PivotalTracker::Client.token = config.api_key
-project = PivotalTracker::Project.find config.project
+PivotalTracker::Client.token = $config.api_key
+$project = PivotalTracker::Project.find $config.project
+
+# For `shell` mode, to retain menu number history.
+$menu_story_mapping = {}
 
 # ----------------------------------------------------------
 # Main app code
@@ -34,17 +39,32 @@ project = PivotalTracker::Project.find config.project
 require "commander/import"
 require "pivotal-tracker"
 
-program :version, "1.5.0"
+program :version, "1.6.0"
 program :description, "Pivotal Tracker command line client."
 
 # ----------------------------------------------------------
 # Support functionality
 
-def output_story_list opts={:project => nil, :states => [], :owned_by => nil}
+# Supports looking up a story ID from $menu_story_mapping. If no mapping is found there, defaults
+# to `id` as passed in.
+def normalize_story_id id
+  mapped = $menu_story_mapping[id]
+  
+  if mapped != nil
+    mapped
+  else
+    id
+  end
+end
+
+# Shared functionality for outputting lists of stories (e.g. for `mine`, `started`, etc.).
+# Handles menuing functionality if opts[:menu] is `true`.
+def output_story_list opts={:project => nil, :states => [], :owned_by => nil, :menu => false}
   puts "Looking for stories owned by #{opts[:owned_by]} in states: #{opts[:states]}".color("#444444")
 
   stories = opts[:project].stories.all(:owned_by => opts[:owned_by], :current_state => opts[:states])
   stories.sort! { |a, b| a.created_at <=> b.created_at }
+  menu_number = 1  # Only used when --menu specified.
   stories.each do |story|
     id = Formatter.story_id(story.id)
     name = Formatter.story_name(story.name)
@@ -52,195 +72,264 @@ def output_story_list opts={:project => nil, :states => [], :owned_by => nil}
     requested_by = Formatter.requested_by(story.requested_by)
     created_at = Formatter.time_ago(story.created_at)
     story_type = Formatter.story_type(story.story_type)
+    
+    menu_output = nil
+    if opts[:menu]
+      $menu_story_mapping[menu_number] = story.id
+      menu_output = "#{menu_number}. "
+      
+      menu_number += 1
+    end
 
-    puts "[#{id}] #{name}  ~  #{state} #{story_type}, from #{requested_by}, created #{created_at}"
+    puts "#{menu_output}[#{id}] #{name}  ~  #{state} #{story_type}, from #{requested_by}, created #{created_at}"
   end
 end
 
 # ----------------------------------------------------------
 # Command-line interaction functionality
 
-command :mine do |c|
-  c.syntax = "pivotal-slacker mine"
-  c.description = "List your stories in Pivotal Tracker."
-  c.example "List your open stories", "pivotal-slacker mine"
-  c.action do |args, options|
-    states = %w{unstarted started finished rejected}
-    owned_by = config.user
+def define_commands
+  command :mine do |c|
+    c.syntax = "pivotal-slacker mine"
+    c.description = "List your stories in Pivotal Tracker."
+    c.example "List your open stories", "pivotal-slacker mine"
+    c.option "--menu", "Print an easily-navigable menu for stories. Only useful for `shell` mode"
+    c.action do |args, options|
+      states = %w{unstarted started finished rejected}
+      owned_by = $config.user
     
-    output_story_list :project => project, :states => states, :owned_by => owned_by
+      output_story_list :project => $project, :states => states, :owned_by => owned_by, :menu => options.menu
+    end
   end
-end
 
-command :accepted do |c|
-  c.syntax = "pivotal-slacker accepted"
-  c.description = "List your accepted stories in Pivotal Tracker."
-  c.example "List your accepted stories", "pivotal-slacker accepted"
-  c.action do |args, options|
-    states = %w{accepted}
-    owned_by = config.user
+  command :accepted do |c|
+    c.syntax = "pivotal-slacker accepted"
+    c.description = "List your accepted stories in Pivotal Tracker."
+    c.example "List your accepted stories", "pivotal-slacker accepted"
+    c.action do |args, options|
+      states = %w{accepted}
+      owned_by = $config.user
     
-    output_story_list :project => project, :states => states, :owned_by => owned_by
+      output_story_list :project => $project, :states => states, :owned_by => owned_by
+    end
   end
-end
 
-command :started do |c|
-  c.syntax = "pivotal-slacker started"
-  c.description = "List your started stories in Pivotal Tracker."
-  c.example "List your started stories", "pivotal-slacker started"
-  c.action do |args, options|
-    states = %w{started}
-    owned_by = config.user
+  command :started do |c|
+    c.syntax = "pivotal-slacker started"
+    c.description = "List your started stories in Pivotal Tracker."
+    c.example "List your started stories", "pivotal-slacker started"
+    c.action do |args, options|
+      states = %w{started}
+      owned_by = $config.user
     
-    output_story_list :project => project, :states => states, :owned_by => owned_by
+      output_story_list :project => $project, :states => states, :owned_by => owned_by
+    end
   end
-end
 
-command :unstarted do |c|
-  c.syntax = "pivotal-slacker unstarted"
-  c.description = "List your unstarted stories in Pivotal Tracker."
-  c.example "List your unstarted stories", "pivotal-slacker unstarted"
-  c.action do |args, options|
-    states = %w{unstarted}
-    owned_by = config.user
+  command :unstarted do |c|
+    c.syntax = "pivotal-slacker unstarted"
+    c.description = "List your unstarted stories in Pivotal Tracker."
+    c.example "List your unstarted stories", "pivotal-slacker unstarted"
+    c.action do |args, options|
+      states = %w{unstarted}
+      owned_by = $config.user
     
-    output_story_list :project => project, :states => states, :owned_by => owned_by
+      output_story_list :project => $project, :states => states, :owned_by => owned_by
+    end
   end
-end
 
-command :open do |c|
-  c.syntax = "pivotal-slacker open story_id"
-  c.description = "Open a specific Pivotal Tracker story in the browser."
-  c.example "Open a story with ID 123", "pivotal-slacker open 123"
-  c.action do |args, options|
-    story = project.stories.find(args[0].to_i)
-    Launchy.open story.url
+  command :open do |c|
+    c.syntax = "pivotal-slacker open story_id"
+    c.description = "Open a specific Pivotal Tracker story in the browser."
+    c.example "Open a story with ID 123", "pivotal-slacker open 123"
+    c.action do |args, options|
+      story = $project.stories.find(args[0].to_i)
+      Launchy.open story.url
+    end
   end
-end
 
-command :show do |c|
-  c.syntax = "pivotal-slacker show story_id"  
-  c.description = "Show the details of a given Pivotal Tracker story."
-  c.example "Show a story with ID 123", "pivotal-slacker show 123"
-  c.action do |args, options|
-    story = project.stories.find(args[0].to_i)
-    id = Formatter.story_id(story.id)
-    state = Formatter.state(story.current_state)
-    requested_by = Formatter.requested_by(story.requested_by)
-    created_at = Formatter.time_ago(story.created_at)
-    story_type = Formatter.story_type(story.story_type)
+  command :show do |c|
+    c.syntax = "pivotal-slacker show story_id"  
+    c.description = "Show the details of a given Pivotal Tracker story."
+    c.example "Show a story with ID 123", "pivotal-slacker show 123"
+    c.action do |args, options|
+      story_id = normalize_story_id(args[0].to_i)
+      story = $project.stories.find(story_id)
+      id = Formatter.story_id(story.id)
+      state = Formatter.state(story.current_state)
+      requested_by = Formatter.requested_by(story.requested_by)
+      created_at = Formatter.time_ago("created #{story.created_at}")
+      story_type = Formatter.story_type(story.story_type)
 
-    puts ""
-    puts "[#{id}] #{Formatter.story_name(story.name, :heading => true)}"
-    puts "#{state} #{story_type}, from #{requested_by}, created #{created_at}"
-    puts "☛  #{story.url.color('#0066CC').underline}"
-    puts ""
-    puts Formatter.description(story.description)
-    puts ""
-    
-    notes = story.notes.all.sort { |a, b| a.noted_at <=> b.noted_at }
-    notes.each do |note|
-      author = Formatter.note_author(note.author)
-      noted_at = Formatter.time_ago(note.noted_at)
-      note_text = Formatter.note_text(note.text)
-      puts "#{author} (#{noted_at}): #{note_text}"
-    end
-    
-    # Extra padding line after notes.
-    if notes != nil and notes.size > 0
       puts ""
+      puts "[#{id}] #{Formatter.story_name(story.name, :heading => true)}"
+      puts "#{state} #{story_type}, from #{requested_by}, #{created_at}"
+      puts "☛  #{story.url.color('#0066CC').underline}"
+      puts ""
+      puts Formatter.description(story.description)
+      puts ""
+    
+      notes = story.notes.all.sort { |a, b| a.noted_at <=> b.noted_at }
+      notes.each do |note|
+        author = Formatter.note_author(note.author)
+        noted_at = Formatter.time_ago(note.noted_at)
+        note_text = Formatter.note_text(note.text)
+        puts "#{author} (#{noted_at}): #{note_text}"
+      end
+    
+      # Extra padding line after notes.
+      if notes != nil and notes.size > 0
+        puts ""
+      end
+    
     end
+  end
+
+  command :start do |c|
+    c.syntax = "pivotal-slacker start story_id"
+    c.description = "Mark a given Pivotal Tracker story as \"started\"."
+    c.example "Start a story with ID 123", "pivotal-slacker start 123"
+    c.action do |args, options|
+      story_id = normalize_story_id(args[0].to_i)
     
+      story = $project.stories.find(story_id)
+      story.update :current_state => "started"
+    
+      puts Formatter.story_action(Formatter.state("started"), story.id, story.name) + "."
+    end
   end
-end
 
-command :start do |c|
-  c.syntax = "pivotal-slacker start story_id"
-  c.description = "Mark a given Pivotal Tracker story as \"started\"."
-  c.example "Start a story with ID 123", "pivotal-slacker start 123"
-  c.action do |args, options|
-    story_id = args[0].to_i
+  command :comment do |c|
+    c.syntax = "pivotal-slacker comment story_id comment"
+    c.description = "Comment on a given Pivotal Tracker story."
+    c.example "Comment on story 123", "pivotal-slacker comment 123 \"Due to my skills I will destroy this task.\""
+    c.action do |args, options|
+      story_id = normalize_story_id(args[0].to_i)
+      comment = args[1]
     
-    story = project.stories.find(story_id)
-    story.update :current_state => "started"
+      story = $project.stories.find(story_id)
+      story.notes.create :text => comment
     
-    puts Formatter.story_action(Formatter.state("started"), story_id, story.name) + "."
+      comment = Formatter.note_text(comment)
+      puts "#{Formatter.story_action "Commented on", story.id, story.name}:"
+      puts "#{Formatter.note_author($config.user)}: #{comment}"
+    end
   end
-end
 
-command :comment do |c|
-  c.syntax = "pivotal-slacker comment story_id comment"
-  c.description = "Comment on a given Pivotal Tracker story."
-  c.example "Comment on story 123", "pivotal-slacker comment 123 \"Due to my skills I will destroy this task.\""
-  c.action do |args, options|
-    story_id = args[0].to_i
-    comment = args[1]
+  command :finish do |c|
+    c.syntax = "pivotal-slacker finish story_id"
+    c.description = "Mark a given Pivotal Tracker story as \"finished\"."
+    c.example "Finish a story with ID 123", "pivotal-slacker finish 123"
+    c.action do |args, options|
+      story_id = normalize_story_id(args[0].to_i)
     
-    story = project.stories.find(story_id)
-    story.notes.create :text => comment
+      story = $project.stories.find(story_id)
+      story.update :current_state => "finished"
     
-    comment = Formatter.note_text(comment)
-    puts "#{Formatter.story_action "Commented on", story_id, story.name}:"
-    puts "#{Formatter.note_author(config.user)}: #{comment}"
+      puts Formatter.story_action(Formatter.state("finished"), story.id, story.name) + "."
+    end
   end
-end
 
-command :finish do |c|
-  c.syntax = "pivotal-slacker finish story_id"
-  c.description = "Mark a given Pivotal Tracker story as \"finished\"."
-  c.example "Finish a story with ID 123", "pivotal-slacker finish 123"
-  c.action do |args, options|
-    story_id = args[0].to_i
+  command :create do |c|
+    c.syntax = "pivotal-slacker create [options]"
+    c.description = "Create a new task in Pivotal Tracker."
+    c.example "Create a new task", "pivotal-slacker create --chore --owner \"Jimmy Winkerbean\""
+    c.option "--feature", "Designate the story as a feature"
+    c.option "--bug", "Designate the story as a bug"
+    c.option "--chore", "Designate the story as a chore"
+    c.option "--release", "Designate the story as a release"
+    c.option "--owner STRING", String, "Assigns the story to a user"
+    c.option "--name STRING", String, "Name of story"
+    c.option "--description STRING", String, "Description of story"
+    c.action do |args, options|
+      options.default :chore => false, :owner => $config.user, :name => nil, :description => nil
     
-    story = project.stories.find(story_id)
-    story.update :current_state => "finished"
+      raise "--name is required" if options.name == nil
+      raise "--description is required" if options.description == nil
+
+      story_type = "feature" if options.feature
+      story_type = "bug" if options.bug
+      story_type = "chore" if options.chore
+      story_type = "release" if options.release
+
+      puts ""
+      puts Formatter.story_name(options.name, :heading => true)
+      puts "#{Formatter.attr_descriptor('type is', Formatter.story_type(story_type))}"
+      puts "#{Formatter.attr_descriptor('requested by', Formatter.owner($config.user))}"
+      puts "#{Formatter.attr_descriptor('owned by', Formatter.owner(options.owner))}"
+      puts "#{Formatter.attr_descriptor('description is', Formatter.description(options.description))}"
+      puts ""
     
-    puts Formatter.story_action(Formatter.state("finished"), story_id, story.name) + "."
+      if agree "Really create? (y/n)"
+        story = $project.stories.create(
+          :name => options.name,
+          :story_type => story_type,
+          :description => options.description,
+          :requested_by => $config.user,
+          :owned_by => options.owner
+        )
+        puts Formatter.story_action("Created", story.id, story.name)
+      else
+        puts "Didn't create story."
+      end
+    end
   end
 end
 
-command :create do |c|
-  c.syntax = "pivotal-slacker create [options]"
-  c.description = "Create a new task in Pivotal Tracker."
-  c.example "Create a new task", "pivotal-slacker create --chore --owner \"Jimmy Winkerbean\""
-  c.option "--feature", "Designate the story as a feature"
-  c.option "--bug", "Designate the story as a bug"
-  c.option "--chore", "Designate the story as a chore"
-  c.option "--release", "Designate the story as a release"
-  c.option "--owner STRING", String, "Assigns the story to a user"
-  c.option "--name STRING", String, "Name of story"
-  c.option "--description STRING", String, "Description of story"
+define_commands
+
+command :shell do |c|
+  c.syntax = "pivotal-slacker shell"
+  c.description = %q{
+    The pivotal-slacker shell mode allows entry of commands with less effort.
+    
+    In shell mode you can run commands as normal. You can also enter "menu numbers"
+    (listed to the left of stories in story listings) instead of story IDs when running
+    commands (e.g. `show 3` instead of `show 456123`).
+
+    Readline support is available, so you can go back through the history of
+    commands entered in the current session.
+  }
+  c.example "Enter the pivotal-slacker shell mode", "pivotal-slacker shell"
   c.action do |args, options|
-    options.default :chore => false, :owner => config.user, :name => nil, :description => nil
-    
-    raise "--name is required" if options.name == nil
-    raise "--description is required" if options.description == nil
-
-    story_type = "feature" if options.feature
-    story_type = "bug" if options.bug
-    story_type = "chore" if options.chore
-    story_type = "release" if options.release
-
-    puts ""
-    puts Formatter.story_name(options.name, :heading => true)
-    puts "#{Formatter.attr_descriptor('type is', Formatter.story_type(story_type))}"
-    puts "#{Formatter.attr_descriptor('requested by', Formatter.owner(config.user))}"
-    puts "#{Formatter.attr_descriptor('owned by', Formatter.owner(options.owner))}"
-    puts "#{Formatter.attr_descriptor('description is', Formatter.description(options.description))}"
-    puts ""
-    
-    if agree "Really create? (y/n)"
-      story = project.stories.create(
-        :name => options.name,
-        :story_type => story_type,
-        :description => options.description,
-        :requested_by => config.user,
-        :owned_by => options.owner
-      )
-      puts Formatter.story_action("Created", story.id, story.name)
-    else
-      puts "Didn't create story."
-    end
+    loop do
+      input = Readline::readline("pivotal-slacker> ")
+      break if input.nil? or input == "q" or input == "quit"
+      next if input.strip == ""
+      
+      # Add input to Readinput history.
+      Readline::HISTORY.push(input)
+
+      # Turn output into an ARGV array.
+      argv = Shellwords.shellwords input  
+      
+      # Shift the command name off the ARGV array; Commander doesn't want it in there.
+      command_name = argv.shift
+      command = command(command_name.to_sym)
+      
+      if command.nil?
+        puts Formatter.err "No such command, \"#{command_name}\""
+        next
+      end
+      
+      # Tell all commands to be in "menu" mode (print list numbers, save list number history, etc.)
+      # Only do this if the command supports --menu.
+      command.options.each do |option|
+        args = option[:args]
+        if (not args.nil?) and args.include? "--menu"
+          argv.push "--menu"
+          
+          # Reset the menu mapping, since the command we're about to call will update them,
+          # and we want this mapping to not have any stale data in it.
+          menu_story_mapping = {}
+        end
+      end
+      
+      command.run *argv
+      
+      # Commander doesn't act right when you try to run the same command more than once,
+      # so we have to redefine them after we use them.
+      define_commands
+    end    
   end
 end
-

data/lib/formatter.rb

@@ -62,4 +62,9 @@ class Formatter
   def self.description description
     description
   end
+  
+  # Format error messages.
+  def self.err errmsg
+    errmsg.background('#990000').color(:white)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pivotal-slacker
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pivotal-tracker