tpope-pickler 0.0.4 → 0.0.5

data/README.rdoc

@@ -7,6 +7,7 @@ Synchronize user stories in Pivotal Tracker with Cucumber features.
   gem install tpope-pickler --source=http://gems.github.com
   echo "api_token: ..."  > ~/.tracker.yml
   echo "project_id: ..." > ~/my/app/features/tracker.yml
+  pickler --help
 
 For details about the Pivotal Tracker API, including where to find your API
 token and project id, see http://www.pivotaltracker.com/help/api .
@@ -19,9 +20,7 @@ feature's body.  Keep this in mind when entering stories into Pivotal Tracker.
 
   pickler pull
 
-Download all well formed stories to the features/ directory.  Previously
-unseen stories will be given a numeric filename that you are encouraged to
-change.
+Download all well formed stories to the features/ directory.
 
   pickler push
 
@@ -31,19 +30,21 @@ Upload all features with a tracker url in a comment on the first line.
 
 List all stories matching the given query.
 
-  pickler show <id>
+  pickler start <story>
 
-Show details for the story referenced by the id.
+Pull a given feature and change its state to started.
 
-  pickler start <id> [basename]
+  pickler finish <story>
 
-Pull a given feature and change its state to started.  If basename is given
-and no local file exists, features/basename.feature will be created in lieu
-of features/id.feature.
+Push a given feature and change its state to finished.
 
-  pickler finish <id>
+  pickler --help
 
-Push a given feature and change its state to finished.
+Full list of commands.
+
+  pickler <command> --help
+
+Further help for a given command.
 
 == Disclaimer
 

data/lib/pickler/feature.rb

@@ -47,10 +47,8 @@ class Pickler
     end
 
     def pull(default = nil)
-      body = "# http://www.pivotaltracker.com/story/show/#{id}\n" <<
-      normalize_feature(story.to_s)
       filename = filename() || pickler.features_path("#{default||id}.feature")
-      File.open(filename,'w') {|f| f.puts body}
+      File.open(filename,'w') {|f| f.puts story}
       @filename = filename
     end
 
@@ -84,24 +82,5 @@ class Pickler
       @story ||= @pickler.project.story(id) if id
     end
 
-    protected
-
-    def normalize_feature(body)
-      return body unless ast = pickler.parser.parse(body)
-      feature = ast.compile
-      new = ''
-      (feature.header.chomp << "\n").each_line do |l|
-        new << '  ' unless new.empty?
-        new << l.strip << "\n"
-      end
-      feature.scenarios.each do |scenario|
-        new << "\n  Scenario: #{scenario.name}\n"
-        scenario.steps.each do |step|
-          new << "    #{step.keyword} #{step.name}\n"
-        end
-      end
-      new
-    end
-
   end
 end

data/lib/pickler/runner.rb

@@ -1,15 +1,331 @@
+require 'optparse'
+
 class Pickler
   class Runner
 
-    attr_reader :argv
+    class Base
+      attr_reader :argv
+
+      def initialize(argv)
+        @argv = argv
+        @tty = $stdout.tty?
+        @opts = OptionParser.new
+        @opts.version = "0.0"
+        @opts.banner = "Usage: pickler #{self.class.command_name} #{self.class.banner_arguments}"
+        @opts.base.long["help"] = OptionParser::Switch::NoArgument.new do
+          help = @opts.help.chomp.chomp + "\n"
+          help += "\n#{self.class.description}" if self.class.description
+          puts help
+          @exit = 0
+        end
+        @opts.separator("")
+      end
+
+      def self.options
+        @options ||= []
+      end
+
+      def self.on(*args, &block)
+        options << args
+        define_method("option_#{args.object_id}", &block)
+      end
+
+      def self.banner_arguments(value = nil)
+        if value
+          @banner_arguments = value
+        else
+          @banner_arguments || (arity.zero? ? "" : "...")
+        end
+      end
+
+      def self.summary(value = nil)
+        if value
+          @summary = value
+        else
+          @summary
+        end
+      end
+
+      def self.description(value = nil)
+        if value
+          @description = value
+        else
+          @description || "#@summary."
+        end
+      end
+
+      def self.command_name
+        name.split('::').last.gsub(/(.)([A-Z])/) {"#$1-#$2"}.downcase
+      end
+
+      def self.method_name
+        command_name.gsub('-','_')
+      end
+
+      def self.process(&block)
+        define_method(:process, &block)
+      end
+
+      def self.arity
+        instance_method(:process).arity
+      end
+
+      def arity
+        self.class.arity
+      end
+
+      def pickler
+        @pickler ||= Pickler.new(Dir.getwd)
+      end
+
+      def abort(message)
+        raise Error, message
+      end
+
+      def too_many
+        abort "too many arguments"
+      end
+
+      def run
+        self.class.options.each do |arguments|
+          @opts.on(*arguments, &method("option_#{arguments.object_id}"))
+        end
+        begin
+          @opts.parse!(@argv)
+        rescue OptionParser::InvalidOption
+          abort $!.message
+        end
+        return @exit if @exit
+        minimum = arity < 0 ? -1 - arity : arity
+        if arity >= 0 && arity < @argv.size
+          too_many
+        elsif minimum > @argv.size
+          abort "not enough arguments"
+        end
+        process(*@argv)
+      end
+
+      def process(*argv)
+        pickler.send(self.class.method_name,*argv)
+      end
+
+      def color?
+        case pickler.config["color"]
+        when "always" then true
+        when "never"  then false
+        else
+          @tty && RUBY_PLATFORM !~ /mswin|mingw/
+        end
+      end
+
+      def puts_summary(story)
+        summary = "%6d " % story.id
+        type  = story.estimate || TYPE_SYMBOLS[story.story_type]
+        state = STATE_SYMBOLS[story.current_state]
+        if color?
+          summary << "\e[3#{STATE_COLORS[story.current_state]}m#{state}\e[00m "
+          summary << "\e[01;3#{TYPE_COLORS[story.story_type]}m#{type}\e[00m "
+        else
+          summary << "#{state} #{type} "
+        end
+        summary << story.name
+        puts summary
+      end
+
+      def paginated_output
+        stdout = $stdout
+        if @tty && pager = pickler.config["pager"]
+          # Modeled after git
+          ENV["LESS"] ||= "FRSX"
+          IO.popen(pager,"w") do |io|
+            $stdout = io
+            yield
+          end
+        else
+          yield
+        end
+      ensure
+        $stdout = stdout
+      end
 
-    def pickler
-      @pickler ||= Pickler.new(Dir.getwd)
+    end
+
+    def self.[](command)
+      klass_name = command.to_s.capitalize.gsub(/[-_](.)/) { $1.upcase }
+      if klass_name =~ /^[A-Z]\w*$/ && const_defined?(klass_name)
+        klass = const_get(klass_name)
+        if Class === klass && klass < Base
+          return klass
+        end
+      end
+    end
+
+    def self.commands
+      constants.map {|c| Runner.const_get(c)}.select {|c| Class === c && c < Runner::Base}.sort_by {|r| r.command_name}.uniq
+    end
+
+    def self.command(name, &block)
+      const_set(name.to_s.capitalize.gsub(/[-_](.)/) { $1.upcase },Class.new(Base,&block))
+    end
+
+    command :show do
+      banner_arguments "<story>"
+      summary "Show details for a story"
+
+      process do |*args|
+        case args.size
+        when 0
+          puts "#{pickler.project_id} #{pickler.project.name}"
+        when 1
+          story = pickler.project.story(args.first)
+          paginated_output do
+            puts story
+          end
+        else
+          too_many
+        end
+      end
+    end
+
+    command :search do
+      banner_arguments "[query]"
+      summary "List all stories matching a query"
+
+      def modifications
+        @modifications ||= {}
+      end
+      [:label, :type, :state].each do |o|
+        on "--#{o} #{o.to_s.upcase}" do |value|
+          modifications[o] = value
+        end
+      end
+      [:requester, :owner, :mywork].each do |o|
+        on "--#{o} USERNAME" do |value|
+          modifications[o] = value
+        end
+      end
+      on "--[no-]includedone", "include accepted stories" do |value|
+        modifications[:includedone] = value
+      end
+
+      attr_writer :current
+      on "-c", "--current", "filter results to current iteration" do |b|
+        self.current = b
+      end
+
+      process do |*argv|
+        argv << modifications unless modifications.empty?
+        if argv == [{:includedone => true}]
+          # Bypass the 200 search results limitation
+          stories = pickler.project.stories
+        else
+          stories = pickler.project.stories(*argv)
+        end
+        stories.reject! {|s| !s.current?} if argv.empty? || @current
+        paginated_output do
+          stories.each do |story|
+            puts_summary story
+          end
+        end
+      end
+    end
+
+    command :push do
+      banner_arguments "[story] ..."
+      summary "Upload stories"
+      description <<-EOF
+Upload the given story or all features with a tracker url in a comment on the
+first line.
+      EOF
+    end
+
+    command :pull do
+      banner_arguments "[story] ..."
+      summary "Download stories"
+      description <<-EOF
+Download the given story or all well formed stories to the features/ directory.
+Previously unseen stories will be given a numeric filename that you are
+encouraged to change.
+      EOF
+    end
+
+    command :start do
+      banner_arguments "<story> [basename]"
+      summary "Pull a story and mark it started"
+      description <<-EOF
+Pull a given story and change its state to started.  If basename is given
+and no local file exists, features/basename.feature will be created in lieu
+of features/id.feature.
+      EOF
+
+      process do |story_id, *args|
+        pickler.start(story_id, args.first)
+      end
+    end
+
+    command :finish do
+      banner_arguments "<story>"
+      summary "Push a story and mark it finished"
+
+      process do |story_id|
+        super
+      end
+    end
+
+    command :deliver do
+      banner_arguments "[story] ..."
+      summary "Mark stories delivered"
+      on "--all-finished", "deliver all finished stories" do
+        @all = true
+      end
+      process do |*args|
+        if @all
+          pickler.deliver_all_finished_stories
+        end
+        args.each do |arg|
+          pickler.story(arg).transition!('delivered')
+        end
+      end
+    end
+
+    command :browse do
+      banner_arguments "[story]"
+      summary "Open a story in the web browser"
+      description <<-EOF
+Open project or a story in the web browser.
+
+Requires launchy (gem install launchy).
+      EOF
+
+      on "--dashboard" do
+        @special = "dashboard"
+      end
+      on "--faq" do
+        @special = "help"
+      end
+      on "--profile", "get your API Token here" do
+        @special = "profile"
+      end
+      on "--time", "not publicly available" do
+        @special = "time_shifts?project=#{pickler.project_id}"
+      end
+
+      process do |*args|
+        too_many if args.size > 1 || @special && args.first
+        if args.first
+          url = pickler.story(args.first).url
+        elsif @special
+          url = "http://www.pivotaltracker.com/#@special"
+        else
+          url = "http://www.pivotaltracker.com/projects/#{pickler.project_id}/stories"
+        end
+        require 'launchy'
+        Launchy.open(url)
+      end
     end
 
     def initialize(argv)
       @argv = argv
-      @tty = $stdout.tty?
     end
 
     COLORS = {
@@ -58,73 +374,22 @@ class Pickler
       "bug"     => "/"
     }
 
-    def color?
-      case pickler.config["color"]
-      when "always" then true
-      when "never"  then false
-      else
-        @tty && RUBY_PLATFORM !~ /mswin|mingw/
-      end
-    end
-
-    def puts_summary(story)
-      summary = "%6d " % story.id
-      type  = story.estimate || TYPE_SYMBOLS[story.story_type]
-      state = STATE_SYMBOLS[story.current_state]
-      if color?
-        summary << "\e[3#{STATE_COLORS[story.current_state]}m#{state}\e[00m "
-        summary << "\e[01;3#{TYPE_COLORS[story.story_type]}m#{type}\e[00m "
-      else
-        summary << "#{state} #{type} "
-      end
-      summary << story.name
-      puts summary
-    end
-
-    def paginated_output
-      stdout = $stdout
-      if @tty && pager = pickler.config["pager"]
-        # Modeled after git
-        ENV["LESS"] ||= "FRSX"
-        IO.popen(pager,"w") do |io|
-          $stdout = io
-          yield
-        end
-      else
-        yield
-      end
-    ensure
-      $stdout = stdout
-    end
-
     def run
-      case first = argv.shift
-      when 'show', /^\d+$/
-        story = pickler.project.story(first == 'show' ? argv.shift : first)
-        paginated_output do
-          puts story
-        end
-      when 'search'
-        stories = pickler.project.stories(*argv)
-        stories.reject! {|s| %w(unscheduled unstarted accepted).include?(s.current_state)} if argv.empty?
-        paginated_output do
-          stories.each do |story|
-            puts_summary story
-          end
+      command = @argv.shift
+      if klass = self.class[command]
+        result = klass.new(@argv).run
+        exit result.respond_to?(:to_int) ? result.to_int : 0
+      elsif ['help', '--help', '-h', '', nil].include?(command)
+        puts "usage: pickler <command> [options] [arguments]"
+        puts
+        puts "Commands:"
+        self.class.commands.each do |command|
+          puts "    %-19s %s" % [command.command_name, command.summary]
         end
-      when 'push'
-        pickler.push(*argv)
-      when 'pull'
-        pickler.pull(*argv)
-      when 'start'
-        pickler.start(argv.first,argv[1])
-      when 'finish'
-        pickler.finish(argv.first)
-      when 'help', '--help', '-h', '', nil
-        puts 'pickler commands: [show|start|finish] <id>, search <query>, push, pull'
+        puts
+        puts "Run pickler <command> --help for help with a given command"
       else
-        $stderr.puts "pickler: unknown command #{first}"
-        exit 1
+        raise Error, "Unknown pickler command #{command}"
       end
     rescue Pickler::Error
       $stderr.puts "#$!"

data/lib/pickler/tracker/iteration.rb

@@ -18,6 +18,10 @@ class Pickler
         start...finish
       end
 
+      def include?(date)
+        range.include?(date)
+      end
+
       def succ
         self.class.new(project, 'number' => number.succ.to_s, 'start' => @attributes['finish'], 'finish' => (finish + (finish - start)).strftime("%b %d, %Y"))
       end

data/lib/pickler/tracker/note.rb

@@ -11,7 +11,7 @@ class Pickler
       end
 
       def to_xml
-        @attributes.to_xml(:root => 'note')
+        @attributes.to_xml(:dasherize => false, :root => 'note')
       end
 
       def inspect

data/lib/pickler/tracker/story.rb

@@ -28,6 +28,10 @@ class Pickler
         raise Pickler::Tracker::Error, Array(error).join("\n"), caller unless error == true
       end
 
+      def current?(as_of = Date.today)
+        iteration && iteration.include?(as_of)
+      end
+
       def complete?
         %w(finished delivered accepted).include?(current_state)
       end
@@ -84,14 +88,16 @@ class Pickler
 
       def comment!(body)
         raise ArgumentError if body.strip.empty? || body.size > 5000
-        response = tracker.request_xml(:post, "#{resource_url}/notes",{:text => body}.to_xml(:root => 'note'))
+        response = tracker.request_xml(:post, "#{resource_url}/notes",{:text => body}.to_xml(:dasherize => false, :root => 'note'))
         Note.new(self, response["note"])
       end
 
       def to_xml
-        hash = @attributes.except("id","url","iteration","notes","labels")
+        hash = @attributes.reject do |k,v|
+          !%w(current_state deadline description estimate name owned_by requested_by story_type).include?(k)
+        end
         hash["labels"] = Array(@attributes["labels"]).join(", ")
-        hash.to_xml(:root => "story")
+        hash.to_xml(:dasherize => false, :root => "story")
       end
 
       def destroy

data/lib/pickler/tracker.rb

@@ -12,7 +12,8 @@ class Pickler
     attr_reader :token
 
     def initialize(token)
-      require 'active_support'
+      require 'active_support/core_ext/blank'
+      require 'active_support/core_ext/hash'
       @token = token
     end
 
@@ -52,8 +53,11 @@ class Pickler
     end
 
     class Abstract
-      def initialize(attributes)
-        @attributes = (attributes || {}).stringify_keys
+      def initialize(attributes = {})
+        @attributes = {}
+        (attributes || {}).each do |k,v|
+          @attributes[k.to_s] = v
+        end
         yield self if block_given?
       end
 
@@ -78,7 +82,7 @@ class Pickler
       reader :id
 
       def to_xml(options = nil)
-        @attributes.to_xml({:root => self.class.name.split('::').last.downcase}.merge(options||{}))
+        @attributes.to_xml({:dasherize => false, :root => self.class.name.split('::').last.downcase}.merge(options||{}))
       end
 
     end

data/lib/pickler.rb

@@ -5,6 +5,10 @@ class Pickler
   class Error < RuntimeError
   end
 
+  autoload :Runner,  'pickler/runner'
+  autoload :Feature, 'pickler/feature'
+  autoload :Tracker, 'pickler/tracker'
+
   def self.config
     @config ||= {'api_token' => ENV["TRACKER_API_TOKEN"]}.merge(
       if File.exist?(path = File.expand_path('~/.tracker.yml'))
@@ -14,7 +18,6 @@ class Pickler
   end
 
   def self.run(argv)
-    require 'pickler/runner'
     Runner.new(argv).run
   end
 
@@ -91,7 +94,7 @@ class Pickler
   def pull(*args)
     if args.empty?
       args = project.stories(scenario_word, :includedone => true).reject do |s|
-        s.current_state == 'unstarted'
+        %(unscheduled unstarted).include?(s.current_state)
       end.select do |s|
         s.to_s =~ /^\s*#{Regexp.escape(scenario_word)}:/ && parser.parse(s.to_s)
       end
@@ -120,6 +123,3 @@ class Pickler
   protected
 
 end
-
-require 'pickler/feature'
-require 'pickler/tracker'

data/pickler.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name                = "pickler"
-  s.version             = "0.0.4"
+  s.version             = "0.0.5"
 
   s.summary             = "PIvotal traCKer Liaison to cucumbER"
   s.description         = "Synchronize between Cucumber and Pivotal Tracker"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tpope-pickler
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Tim Pope