tpope-pickler 0.0.5 → 0.0.6

data/README.rdoc

@@ -2,6 +2,10 @@
 
 Synchronize user stories in Pivotal Tracker with Cucumber features.
 
+If you aren't using Cucumber, you can still use pickler as a Pivotal Tracker
+command line client, provided you humor it with a features/ directory
+containing a tracker.yml file.
+
 == Getting started
 
   gem install tpope-pickler --source=http://gems.github.com

data/lib/pickler/feature.rb

@@ -13,6 +13,9 @@ class Pickler
         @story = identifier
         @id = @story.id
 
+      when Integer
+        @id = identifier
+
       when /^#{URL_REGEX}$/, /^(\d+)$/
         @id = $1.to_i
 
@@ -54,7 +57,9 @@ class Pickler
 
     def start(default = nil)
       story.transition!("started") if story.startable?
-      pull(default)
+      if filename || default
+        pull(default)
+      end
     end
 
     def push
@@ -64,9 +69,13 @@ class Pickler
     end
 
     def finish
-      story.current_state = "finished" unless story.complete?
-      story.to_s = local_body
-      story.save
+      if filename
+        story.finish
+        story.to_s = local_body
+        story.save
+      else
+        story.finish!
+      end
     end
 
     def id

data/lib/pickler/runner.rb

@@ -118,20 +118,48 @@ class Pickler
         end
       end
 
+      def colorize(code, string)
+        if color?
+          "\e[#{code}m#{string}\e[00m"
+        else
+          string.to_s
+        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 << colorize("3#{STATE_COLORS[story.current_state]}", state) << ' '
+        summary << colorize("01;3#{TYPE_COLORS[story.story_type]}", type) << ' '
         summary << story.name
         puts summary
       end
 
+      def puts_full(story)
+        puts colorize("01;3#{TYPE_COLORS[story.story_type]}", story.name)
+        puts "Type:      #{story.story_type}".rstrip
+        if story.story_type == "release"
+          puts "Deadline:  #{story.deadline}".rstrip
+        else
+          puts "Estimate:  #{story.estimate}".rstrip
+        end
+        puts "State:     #{story.current_state}".rstrip
+        puts "Labels:    #{story.labels.join(', ')}".rstrip
+        puts "Requester: #{story.requested_by}".rstrip
+        puts "Owner:     #{story.owned_by}".rstrip
+        puts "URL:       #{story.url}".rstrip
+        puts unless story.description.blank?
+        story.description_lines.each do |line|
+          puts "  #{line}".rstrip
+        end
+        story.notes.each do |note|
+          puts
+          puts "  #{colorize('01', note.author)} (#{note.date})"
+          puts *note.lines(72).map {|l| "    #{l}".rstrip}
+        end
+      end
+
       def paginated_output
         stdout = $stdout
         if @tty && pager = pickler.config["pager"]
@@ -144,6 +172,7 @@ class Pickler
         else
           yield
         end
+      rescue Errno::EPIPE
       ensure
         $stdout = stdout
       end
@@ -177,9 +206,9 @@ class Pickler
         when 0
           puts "#{pickler.project_id} #{pickler.project.name}"
         when 1
-          story = pickler.project.story(args.first)
+          story = pickler.story(args.first)
           paginated_output do
-            puts story
+            puts_full story
           end
         else
           too_many
@@ -200,17 +229,28 @@ class Pickler
         end
       end
       [:requester, :owner, :mywork].each do |o|
-        on "--#{o} USERNAME" do |value|
-          modifications[o] = value
+        on "--#{o}[=USERNAME]" do |value|
+          modifications[o] = value || pickler.real_name
         end
       end
       on "--[no-]includedone", "include accepted stories" do |value|
         modifications[:includedone] = value
+        @iterations ||= []
+        @iterations << :done?
+      end
+
+      on "-b", "--backlog", "filter results to future iterations" do |c|
+        @iterations ||= []
+        @iterations << :backlog?
       end
 
-      attr_writer :current
       on "-c", "--current", "filter results to current iteration" do |b|
-        self.current = b
+        @iterations ||= []
+        @iterations << :current?
+      end
+
+      on "--[no-]full", "show full story, not a summary line" do |b|
+        @full = b
       end
 
       process do |*argv|
@@ -221,10 +261,19 @@ class Pickler
         else
           stories = pickler.project.stories(*argv)
         end
-        stories.reject! {|s| !s.current?} if argv.empty? || @current
+        if @iterations && @iterations != [:done?]
+          stories.reject! {|s| !@iterations.any? {|i| s.send(i)}}
+        end
         paginated_output do
+          first = true
           stories.each do |story|
-            puts_summary story
+            if @full
+              puts unless first
+              puts_full story
+            else
+              puts_summary story
+            end
+            first = false
           end
         end
       end
@@ -237,6 +286,13 @@ class Pickler
 Upload the given story or all features with a tracker url in a comment on the
 first line.
       EOF
+
+      process do |*args|
+        args.replace(pickler.local_features) if args.empty?
+        args.each do |arg|
+          pickler.feature(arg).push
+        end
+      end
     end
 
     command :pull do
@@ -247,6 +303,13 @@ 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
+
+      process do |*args|
+        args.replace(pickler.scenario_features) if args.empty?
+        args.each do |arg|
+          pickler.feature(arg).pull
+        end
+      end
     end
 
     command :start do
@@ -254,12 +317,11 @@ encouraged to change.
       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.
+and no local file exists, features/basename.feature will be created.
       EOF
 
-      process do |story_id, *args|
-        pickler.start(story_id, args.first)
+      process do |story, *args|
+        pickler.feature(story).start(args.first)
       end
     end
 
@@ -267,8 +329,8 @@ of features/id.feature.
       banner_arguments "<story>"
       summary "Push a story and mark it finished"
 
-      process do |story_id|
-        super
+      process do |story|
+        pickler.feature(story).finish
       end
     end
 
@@ -288,6 +350,34 @@ of features/id.feature.
       end
     end
 
+    command :unstart do
+      banner_arguments "[story] ..."
+      summary "Mark stories unstarted"
+      on "--all-started", "unstart all started stories" do
+        @all = true
+      end
+      process do |*args|
+        if @all
+          pickler.project.stories(:state => "started").each do |story|
+            story.transition!('unstarted')
+          end
+        end
+        args.each do |arg|
+          pickler.story(arg).transition!('unstarted')
+        end
+      end
+    end
+
+    command :unschedule do
+      banner_arguments "[story] ..."
+      summary "Move stories to icebox"
+      process do |*args|
+        args.each do |arg|
+          pickler.story(arg).transition!('unscheduled')
+        end
+      end
+    end
+
     command :browse do
       banner_arguments "[story]"
       summary "Open a story in the web browser"
@@ -324,6 +414,15 @@ Requires launchy (gem install launchy).
       end
     end
 
+    command :comment do
+      banner_arguments "<story> <paragraph> ..."
+      summary "Post a comment to a story"
+
+      process do |story, *paragraphs|
+        pickler.story(story).comment!(paragraphs.join("\n\n"))
+      end
+    end
+
     def initialize(argv)
       @argv = argv
     end

data/lib/pickler/tracker/iteration.rb

@@ -29,6 +29,10 @@ class Pickler
       def inspect
         "#<#{self.class.inspect}:#{number.inspect} (#{range.inspect})>"
       end
+
+      def to_s
+        "#{number} (#{start}...#{finish})"
+      end
     end
   end
 end

data/lib/pickler/tracker/note.rb

@@ -18,6 +18,10 @@ class Pickler
         "#<#{self.class.inspect}:#{id.inspect}, story_id: #{story.id.inspect}, date: #{date.inspect}, author: #{author.inspect}, text: #{text.inspect}>"
       end
 
+      def lines(width = 79)
+        text.scan(/(?:.{0,#{width}}|\S+?)(?:\s|$)/).map! {|line| line.strip}[0..-2]
+      end
+
     end
   end
 end

data/lib/pickler/tracker/story.rb

@@ -5,22 +5,27 @@ class Pickler
       TYPES = %w(bug feature chore release)
       STATES = %w(unscheduled unstarted started finished delivered rejected accepted)
 
-      attr_reader :project, :iteration
-      reader :url, :labels
+      attr_reader :project, :iteration, :labels
+      reader :url
       date_reader :created_at, :accepted_at, :deadline
       accessor :current_state, :name, :description, :owned_by, :requested_by, :story_type
 
       def initialize(project, attributes = {})
         @project = project
-        @iteration = Iteration.new(project, attributes["iteration"]) if attributes["iteration"]
         super(attributes)
+        @iteration = Iteration.new(project, @attributes["iteration"]) if @attributes["iteration"]
+        @labels = normalize_labels(@attributes["labels"])
+      end
+
+      def labels=(value)
+        @labels = normalize_labels(value)
       end
 
       def transition!(state)
         raise Pickler::Tracker::Error, "Invalid state #{state}", caller unless STATES.include?(state)
         self.current_state = state
         if id
-          xml = "<story><current-state>#{state}</current-state></story>"
+          xml = "<story><current_state>#{state}</current_state></story>"
           error = tracker.request_xml(:put, resource_url, xml).fetch("errors",{})["error"] || true
         else
           error = save
@@ -28,10 +33,33 @@ class Pickler
         raise Pickler::Tracker::Error, Array(error).join("\n"), caller unless error == true
       end
 
+      def finish
+        case story_type
+        when "bug", "feature"
+          self.current_state = "finished" unless complete?
+        when "chore", "release"
+          self.current_state = "accepted"
+        end
+        current_state
+      end
+
+      def finish!
+        transition!(finish)
+      end
+
+      def backlog?(as_of = Date.today)
+        iteration && iteration.start >= as_of
+      end
+
       def current?(as_of = Date.today)
         iteration && iteration.include?(as_of)
       end
 
+      # In a previous iteration
+      def done?(as_of = Date.today)
+        iteration && iteration.finish <= as_of
+      end
+
       def complete?
         %w(finished delivered accepted).include?(current_state)
       end
@@ -87,22 +115,27 @@ class Pickler
       end
 
       def comment!(body)
-        raise ArgumentError if body.strip.empty? || body.size > 5000
         response = tracker.request_xml(:post, "#{resource_url}/notes",{:text => body}.to_xml(:dasherize => false, :root => 'note'))
-        Note.new(self, response["note"])
+        if response["note"]
+          Note.new(self, response["note"])
+        else
+          raise Pickler::Tracker::Error, Array(response["errors"]["error"]).join("\n"), caller
+        end
       end
 
-      def to_xml
+      def to_xml(force_labels = true)
         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(", ")
+        if force_labels || !id || normalize_labels(@attributes["labels"]) != labels
+          hash["labels"] = labels.join(", ")
+        end
         hash.to_xml(:dasherize => false, :root => "story")
       end
 
       def destroy
         if id
-          response = tracker.request_xml(:delete, "/projects/#{project.id}/stories/#{id}", to_xml)
+          response = tracker.request_xml(:delete, "/projects/#{project.id}/stories/#{id}", "")
           raise Error, response["message"], caller if response["success"] != "true"
           @attributes["id"] = nil
           self
@@ -114,7 +147,7 @@ class Pickler
       end
 
       def save
-        response = tracker.request_xml(id ? :put : :post,  resource_url, to_xml)
+        response = tracker.request_xml(id ? :put : :post,  resource_url, to_xml(false))
         if response["success"] == "true"
           initialize(project, response["story"])
           true
@@ -123,6 +156,11 @@ class Pickler
         end
       end
 
+      private
+      def normalize_labels(value)
+        Array(value).join(", ").strip.split(/\s*,\s*/)
+      end
+
     end
   end
 end

data/lib/pickler.rb

@@ -47,6 +47,41 @@ class Pickler
     self.class.config.merge(@config)
   end
 
+  def real_name
+    config["real_name"] || (require 'etc'; Etc.getpwuid.gecos.split(',').first)
+  end
+
+  def new_story(attributes = {}, &block)
+    attributes = attributes.inject('requested_by' => real_name) do |h,(k,v)|
+      h.update(k.to_s => v)
+    end
+    project.new_story(attributes, &block)
+  end
+
+  def stories(*args)
+    project.stories(*args)
+  end
+
+  def name
+    project.name
+  end
+
+  def iteration_length
+    project.iteration_length
+  end
+
+  def point_scale
+    project.point_scale
+  end
+
+  def week_start_day
+    project.week_start_day
+  end
+
+  def deliver_all_finished_stories
+    project.deliver_all_finished_stories
+  end
+
   def parser
     require 'cucumber'
     require "cucumber/treetop_parser/feature_#@lang"
@@ -75,51 +110,26 @@ class Pickler
     Cucumber.language['scenario']
   end
 
-  def features(*args)
-    if args.any?
-      args.map {|a| feature(a)}
-    else
-      Dir[features_path('**','*.feature')].map {|f|feature(f)}.select {|f|f.id}
+  def local_features
+    Dir[features_path('**','*.feature')].map {|f|feature(f)}.select {|f|f.id}
+  end
+
+  def scenario_features
+    project.stories(scenario_word, :includedone => true).reject do |s|
+      %(unscheduled unstarted).include?(s.current_state)
+    end.select do |s|
+      s.to_s =~ /^\s*#{Regexp.escape(scenario_word)}:/ && parser.parse(s.to_s)
     end
   end
 
   def feature(string)
-    Feature.new(self,string)
+    string.kind_of?(Feature) ? string : Feature.new(self,string)
   end
 
   def story(string)
     feature(string).story
   end
 
-  def pull(*args)
-    if args.empty?
-      args = project.stories(scenario_word, :includedone => true).reject do |s|
-        %(unscheduled unstarted).include?(s.current_state)
-      end.select do |s|
-        s.to_s =~ /^\s*#{Regexp.escape(scenario_word)}:/ && parser.parse(s.to_s)
-      end
-    end
-    args.each do |arg|
-      feature(arg).pull
-    end
-  end
-
-  def start(arg, default = nil)
-    feature(arg).start(default)
-  end
-
-  def push(*args)
-    features(*args).each do |feature|
-      feature.push
-    end
-  end
-
-  def finish(*args)
-    features(*args).each do |feature|
-      feature.finish
-    end
-  end
-
   protected
 
 end

data/pickler.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name                = "pickler"
-  s.version             = "0.0.5"
+  s.version             = "0.0.6"
 
   s.summary             = "PIvotal traCKer Liaison to cucumbER"
   s.description         = "Synchronize between Cucumber and Pivotal Tracker"
@@ -25,4 +25,6 @@ Gem::Specification.new do |s|
   ]
   s.add_dependency("activesupport", [">= 2.0.0"])
   s.add_dependency("cucumber", [">= 0.1.9"])
+  s.add_dependency("builder")
+  s.add_dependency("xml-simple")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tpope-pickler
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Tim Pope
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-27 00:00:00 -07:00
+date: 2008-12-15 00:00:00 -08:00
 default_executable: pickler
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,6 +30,24 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.1.9
     version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: xml-simple
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: Synchronize between Cucumber and Pivotal Tracker
 email: ruby@tpope.info
 executables: