pivotal_to_pdf 0.5.2.1 → 0.6

data/CHANGELOG

@@ -1,3 +1,8 @@
+v0.6
+ * The points section will be printed only for features. Bugs and Chores don't
+ have points
+ * Printed a green bounding box for feature, a yellow box for chores and a red
+ box for bugs
 v0.5.2.1 Fixed a manifest problem
 v0.5.2 Printed labels to the cards
 v0.5.1 minor improvement over printing estimate, owned by

data/Manifest

@@ -10,7 +10,8 @@ lib/pivotal_to_pdf/iteration.rb
 lib/pivotal_to_pdf/pdf_writer.rb
 lib/pivotal_to_pdf/pivotal.rb
 lib/pivotal_to_pdf/story.rb
+pivotal_to_pdf.gemspec
+spec/pivotal_to_pdf/story_spec.rb
 spec/pivotal_to_pdf_bin_spec.rb
 spec/spec_helper.rb
-spec/story_spec.rb
 tasks/spec.rb

data/README.md

@@ -10,7 +10,7 @@ I steal the part of code from http://ephemera.karmi.cz/post/622136360/create-pri
   $ [sudo] gem install pivotal_to_pdf
 
 ## USAGE
-First you need to create a .pivotal.yml under your home directory. No idea how you do this under Windows so no support to Windows yet
+First you need to create a .pivotal.yml under your home directory. On windows, have this file in %HOME%.pivotal.yml
 
 a sample .pivotal.yml:
 
@@ -22,9 +22,12 @@ After install the gem, you can do:
 * pivotal_to_pdf iteration       # print stories for the current iteration into a PDF file
 * pivotal_to_pdf story STORY_ID  # print a single story specifed by ID into a PDF file
 
-
 The gem will then read the story/stories and print it into a PDF file
 
+The points section will be printed only for features. Bugs and Chores don't have points
+
+Printed a green bounding box for feature, a yellow box for chores and a red box for bugs
+
 The gem assumes that you have https access to the pivotal tracker
 
 ##Contributors

data/bin/pivotal_to_pdf

@@ -4,14 +4,16 @@ require 'pivotal_to_pdf'
 require 'thor'
 
 class PivotalToPdfApp < Thor
-  desc "story STORY_ID", "print a single story specifed by ID into a PDF file"
+  desc "story STORY_ID", "print a single story specifed by ID into a PDF file. The card will have a color stripe. The color will be green for features, yellow for chores and red for bugs"
+  method_option :nocolor, :aliases => "-nc", :desc => "Make the card having no color stripe"
   def story(story_id)
-    PivotalToPdf.story story_id
+    PivotalToPdf.story story_id, options[:nocolor]
   end
 
   desc "iteration", "print stories for the current iteration into a PDF file"
+  method_option :nocolor, :aliases => "-nc", :desc => "Make the card having no color stripe"
   def iteration(iteration_number = "current")
-    PivotalToPdf.iteration iteration_number
+    PivotalToPdf.iteration iteration_number, options[:nocolor]
   end
 end
 

data/lib/pivotal_to_pdf/pdf_writer.rb

@@ -6,7 +6,7 @@ require 'rainbow'
 
 class PdfWriter
   attr_reader :story_or_iteration, :stories
-  def initialize(story_or_iteration)
+  def initialize(story_or_iteration, colored_stripe = true)
     @story_or_iteration = story_or_iteration
     @stories = story_or_iteration.is_a?(Iteration) ? story_or_iteration.stories : [story_or_iteration]
     p stories.size
@@ -22,13 +22,13 @@ class PdfWriter
       # pdf.start_new_page
 
       stories.each_with_index do |story, index|
-        padding = 12
-        pdf.stroke_color = "666666"
+        padding = 10
+        pdf.stroke_color = story.story_color
         pdf.stroke_bounds
         width = 370
         # --- Write content
         pdf.bounding_box [pdf.bounds.left+padding, pdf.bounds.top-padding], :width => width do
-          pdf.text "#{story.id} - #{story.name}", :size => 14
+          pdf.text story.name, :size => 14
           pdf.fill_color "52D017"
           pdf.text story.label_text, :size => 8
           pdf.text "\n", :size => 14
@@ -37,8 +37,7 @@ class PdfWriter
           pdf.fill_color "000000"
         end
 
-        pdf.text_box "Points: " + (story.respond_to?(:estimate) && !story.estimate.eql?(-1) ? story.estimate.to_s : "Not yet estimated"),
-          :size => 12, :at => [12, 50], :width => width-18
+        pdf.text_box story.points, :size => 12, :at => [12, 50], :width => width-18 unless story.points.nil?
         pdf.text_box "Owner: " + (story.respond_to?(:owned_by) ? story.owned_by : "None"),
           :size => 8, :at => [12, 18], :width => width-18
 
@@ -50,7 +49,7 @@ class PdfWriter
       pdf.number_pages "<page>/<total>", [pdf.bounds.right-16, -28]
 
       puts ">>> Generated PDF file in '#{story_or_iteration.id}.pdf'".foreground(:green)
-                             end
+  end
   rescue Exception
     puts "[!] There was an error while generating the PDF file... What happened was:".foreground(:red)
     raise

data/lib/pivotal_to_pdf/story.rb

@@ -3,4 +3,23 @@ class Story < Pivotal
     return "" if !self.respond_to?(:labels) || self.labels.nil? || self.labels.empty?
     labels
   end
+
+  def points
+    return nil unless self.feature?
+    "Points: " + (self.respond_to?(:estimate) && !self.estimate.eql?(-1) ? self.estimate.to_s : "Not yet estimated")
+  end
+
+  def story_color
+    return "52D017" if feature?
+    return "FF0000" if bug?
+    return "FFFF00" if chore?
+  end
+
+  private
+
+  ["feature", "bug", "chore"].each do |type_str|
+    define_method "#{type_str}?".to_sym do
+      self.story_type == type_str
+    end
+  end
 end

data/lib/pivotal_to_pdf.rb

@@ -8,14 +8,14 @@ require 'pivotal_to_pdf/story'
 require 'pivotal_to_pdf/pdf_writer'
 class PivotalToPdf < Thor
   class << self
-    def story(story_id)
+    def story(story_id, colored_stripe=true)
       story = Story.find(story_id)
-      PdfWriter.new(story).write_to
+      PdfWriter.new(story, colored_stripe).write_to
     end
 
-    def iteration(iteration_token)
+    def iteration(iteration_token, colored_stripe=true)
       iteration = Iteration.find(:all, :params => {:group => iteration_token}).first
-      PdfWriter.new(iteration).write_to
+      PdfWriter.new(iteration, colored_stripe).write_to
     end
   end
 end

data/pivotal_to_pdf.gemspec

@@ -2,26 +2,24 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pivotal_to_pdf}
-  s.version = "0.5.2.1"
+  s.version = "0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Yi Wen"]
-  s.date = %q{2010-12-19}
-  s.default_executable = %q{pivotal_to_pdf}
+  s.date = %q{2011-04-26}
   s.description = %q{Convert Pivotal Tracker Stories to 4x6 PDF for printing so that you can stick the card to your story board}
   s.email = %q{hayafirst@gmail.com}
   s.executables = ["pivotal_to_pdf"]
   s.extra_rdoc_files = ["CHANGELOG", "README.md", "bin/pivotal_to_pdf", "lib/pivotal_to_pdf.rb", "lib/pivotal_to_pdf/iteration.rb", "lib/pivotal_to_pdf/pdf_writer.rb", "lib/pivotal_to_pdf/pivotal.rb", "lib/pivotal_to_pdf/story.rb", "tasks/spec.rb"]
-  s.files = ["CHANGELOG", "Gemfile", "Gemfile.lock", "Manifest", "README.md", "Rakefile", "bin/pivotal_to_pdf", "lib/pivotal_to_pdf.rb", "lib/pivotal_to_pdf/iteration.rb", "lib/pivotal_to_pdf/pdf_writer.rb", "lib/pivotal_to_pdf/pivotal.rb", "lib/pivotal_to_pdf/story.rb", "spec/pivotal_to_pdf_bin_spec.rb", "spec/spec_helper.rb", "spec/story_spec.rb", "tasks/spec.rb", "pivotal_to_pdf.gemspec"]
+  s.files = ["CHANGELOG", "Gemfile", "Gemfile.lock", "Manifest", "README.md", "Rakefile", "bin/pivotal_to_pdf", "lib/pivotal_to_pdf.rb", "lib/pivotal_to_pdf/iteration.rb", "lib/pivotal_to_pdf/pdf_writer.rb", "lib/pivotal_to_pdf/pivotal.rb", "lib/pivotal_to_pdf/story.rb", "pivotal_to_pdf.gemspec", "spec/pivotal_to_pdf/story_spec.rb", "spec/pivotal_to_pdf_bin_spec.rb", "spec/spec_helper.rb", "tasks/spec.rb"]
   s.homepage = %q{https://github.com/ywen/pivotal_to_pdf}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Pivotal_to_pdf", "--main", "README.md"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{pivotal_to_pdf}
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.7.2}
   s.summary = %q{Convert Pivotal Tracker Stories to 4x6 PDF for printing}
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/spec/pivotal_to_pdf/story_spec.rb

@@ -0,0 +1,82 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+
+describe Story do
+  let(:story){Story.new :labels => [], :story_type => nil}
+  describe "#label_text" do
+    describe "and there is no label" do
+      it "should return blank string" do
+        story = Story.new
+        story.label_text.should == ""
+      end
+    end
+    describe "and labels is empty" do
+      it "should return blank string" do
+        story.label_text.should == ""
+      end
+    end
+    describe "and labels is nil" do
+      it "should return blank string" do
+        story.labels = nil
+        story.label_text.should == ""
+      end
+    end
+
+    describe "and when there are less than 3 labels" do
+      it "should return them in a nice format" do
+        story.labels="test1, test2"
+        story.label_text.should == "test1, test2"
+      end
+    end
+  end
+
+  describe "#points" do
+    describe "and the story is not a feature" do
+      before(:each) do
+        story.story_type = "bug"
+      end
+      it "should return nil" do
+        story.points.should be_nil
+      end
+    end
+    describe "and the story is a feature" do
+      before(:each) do
+        story.story_type = "feature"
+      end
+      describe "and the story is not respond_to estimate" do
+        it "should return Not yet estimated" do
+          story.points.should == "Points: Not yet estimated"
+        end
+      end
+
+      describe "and the story is respond_to estimate" do
+        let(:story) {Story.new :story_type => "feature", :estimate => -1}
+        describe "and the estimate is -1" do
+          it "should return not yet estimated" do
+            story.points.should == "Points: Not yet estimated"
+          end
+        end
+        describe "and the estimate is not -1" do
+          it "should return the points" do
+            story.estimate = 5
+            story.points.should == "Points: 5"
+          end
+        end
+      end
+    end
+  end
+
+  describe "#story_color" do
+    it "should return green for features" do
+      story.story_type = "feature"
+      story.story_color.should == "52D017"
+    end
+    it "should return red for bugs" do
+      story.story_type = "bug"
+      story.story_color.should == "FF0000"
+    end
+    it "should return yellow for chores" do
+      story.story_type = "chore"
+      story.story_color.should == "FFFF00"
+    end
+  end
+end

data/spec/pivotal_to_pdf_bin_spec.rb

@@ -4,19 +4,33 @@ load File.expand_path(File.join(File.dirname(__FILE__), "..", "bin", "pivotal_to
 describe 'PivotalToPdf Bin' do
   describe "when pased in story sub command" do
     it "should call story" do
-      PivotalToPdf.should_receive(:story).with(123)
+      PivotalToPdf.should_receive(:story).with(123, nil)
       PivotalToPdfApp.start(["story", 123])
     end
     it "should not call story when no story id is given" do
       PivotalToPdf.should_not_receive(:story)
       PivotalToPdfApp.start(["story"])
     end
+
+    describe "and when the nocolor option is defined" do
+      it "should pass the option in" do
+        PivotalToPdf.should_receive(:story).with(123, "nocolor")
+        PivotalToPdfApp.start(["story", 123, "--nocolor"])
+      end
+    end
   end
   describe "when pased in iteration sub command" do
     it "should call iteration" do
-      PivotalToPdf.should_receive(:iteration).with(123)
+      PivotalToPdf.should_receive(:iteration).with(123, nil)
       PivotalToPdfApp.start(["iteration", 123])
     end
+
+    describe "and when the nocolor option is defined" do
+      it "should pass the option in" do
+        PivotalToPdf.should_receive(:iteration).with(123, "nocolor")
+        PivotalToPdfApp.start(["iteration", 123, "--nocolor"])
+      end
+    end
   end
 end
 

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: pivotal_to_pdf
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 5
-  - 2
-  - 1
-  version: 0.5.2.1
+  prerelease: 
+  version: "0.6"
 platform: ruby
 authors: 
 - Yi Wen
@@ -15,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-19 00:00:00 -06:00
-default_executable: 
+date: 2011-04-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activeresource
@@ -26,8 +20,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -39,8 +31,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -52,8 +42,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id003
@@ -65,8 +53,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id004
@@ -99,12 +85,11 @@ files:
 - lib/pivotal_to_pdf/pdf_writer.rb
 - lib/pivotal_to_pdf/pivotal.rb
 - lib/pivotal_to_pdf/story.rb
+- pivotal_to_pdf.gemspec
+- spec/pivotal_to_pdf/story_spec.rb
 - spec/pivotal_to_pdf_bin_spec.rb
 - spec/spec_helper.rb
-- spec/story_spec.rb
 - tasks/spec.rb
-- pivotal_to_pdf.gemspec
-has_rdoc: true
 homepage: https://github.com/ywen/pivotal_to_pdf
 licenses: []
 
@@ -123,22 +108,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 2
       version: "1.2"
 requirements: []
 
 rubyforge_project: pivotal_to_pdf
-rubygems_version: 1.3.7
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Convert Pivotal Tracker Stories to 4x6 PDF for printing

data/spec/story_spec.rb

@@ -1,31 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
-
-describe Story do
-  let(:story){Story.new :labels => []}
-  describe "when asked for label text" do
-    describe "and there is no label" do
-      it "should return blank string" do
-        story = Story.new
-        story.label_text.should == ""
-      end
-    end
-    describe "and labels is empty" do
-      it "should return blank string" do
-        story.label_text.should == ""
-      end
-    end
-    describe "and labels is nil" do
-      it "should return blank string" do
-        story.labels = nil
-        story.label_text.should == ""
-      end
-    end
-
-    describe "and when there are less than 3 labels" do
-      it "should return them in a nice format" do
-        story.labels="test1, test2"
-        story.label_text.should == "test1, test2"
-      end
-    end
-  end
-end