pivotal_to_pdf 0.1.1 → 0.5

data/CHANGELOG

@@ -1,2 +1,3 @@
+v0.5 be able to print out an iteration into one single PDF file
 v0.1.1 added a homepage
 v0.1 initial setup

data/Gemfile

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+gem 'rainbow'
+gem 'activeresource'
+gem 'prawn'
+gem 'thor'
+group :test do
+  gem 'rspec'
+end
+
+group :test, :development do
+  gem 'echoe'
+end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    echoe (4.3.1)
+      gemcutter
+      rubyforge
+    gemcutter (0.6.1)
+    i18n (0.5.0)
+    json_pure (1.4.6)
+    prawn (0.8.4)
+      prawn-core (>= 0.8.4, < 0.9)
+      prawn-layout (>= 0.8.4, < 0.9)
+      prawn-security (>= 0.8.4, < 0.9)
+    prawn-core (0.8.4)
+    prawn-layout (0.8.4)
+    prawn-security (0.8.4)
+    rainbow (1.1)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.2.0)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activeresource
+  echoe
+  prawn
+  rainbow
+  rspec
+  thor

data/Manifest

@@ -1,9 +1,17 @@
+6728599.pdf
 CHANGELOG
+Gemfile
+Gemfile.lock
 Manifest
-README
+README.md
 Rakefile
-bin/pivol_to_pdf
+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_bin_spec.rb
+spec/spec_helper.rb
+tasks/spec.rb

data/README.md

@@ -0,0 +1,28 @@
+pivotal_to_pdf -- print the stories from pivotal tracker to a PDF file
+====================================
+
+## DESCRIPTION
+This is a gem that can read a story from pivotal tracker and print into a 4x6 card so that you can print the card and stick to your physical story board.
+
+I steal the part of code from http://ephemera.karmi.cz/post/622136360/create-printable-pdf-cards-for-your-pivotal-tracker-stor The difference is the code there print to a A4 paper with 4 stories on it. This gem prints one card at a time and the gem doesn't require an exported csv file.
+ 
+## INSTALL
+  $ [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
+
+a sample .pivotal.yml:
+
+    token: your-api-token-of-pivotal-tracker
+    project_id: your-ptroject-id
+
+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 gem assumes that you have https access to the pivotal tracker

data/Rakefile

@@ -1,10 +1,11 @@
 require 'echoe'
+require File.expand_path(File.dirname(__FILE__))+'/tasks/spec'
 Echoe.new('pivotal_to_pdf') do |p|
   p.description    = "Convert Pivotal Tracker Stories to 4x6 PDF for printing so that you can stick the card to your story board"
   p.summary = "Convert Pivotal Tracker Stories to 4x6 PDF for printing"
   p.author         = "Yi Wen"
   p.email          = "hayafirst@gmail.com"
-  p.runtime_dependencies = %w(activeresource prawn rainbow)
+  p.runtime_dependencies = %w(activeresource prawn rainbow thor)
   p.bin_files = [ "bin/pivotal_to_pdf" ]
   p.url = "https://github.com/ywen/pivotal_to_pdf"
   # p.ignore_pattern = ["bin/*"]

data/bin/pivotal_to_pdf

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+require 'pivotal_to_pdf'
+require 'thor'
+
+class PivotalToPdfApp < Thor
+  desc "story STORY_ID", "print a single story specifed by ID into a PDF file"
+  def story(story_id)
+    PivotalToPdf.story story_id
+  end
+
+  desc "iteration", "print stories for the current iteration into a PDF file"
+  def iteration(iteration_number = "current")
+    PivotalToPdf.iteration iteration_number
+  end
+end
+
+PivotalToPdfApp.start

data/lib/pivotal_to_pdf/iteration.rb

@@ -0,0 +1,3 @@
+class Iteration < Pivotal
+  
+end

data/lib/pivotal_to_pdf/pdf_writer.rb

@@ -1,58 +1,54 @@
 #!/usr/bin/env ruby
 
-# Script to generate PDF cards suitable for planning poker
-# from Pivotal Tracker [http://www.pivotaltracker.com/] CSV export.
-
-# Inspired by Bryan Helmkamp's http://github.com/brynary/features2cards/
-
-# Example output: http://img.skitch.com/20100522-d1kkhfu6yub7gpye97ikfuubi2.png
-
 require 'rubygems'
 require 'prawn'
 require 'rainbow'
 
 class PdfWriter
-  attr_reader :card
-  def initialize(card)
-    @card = card
+  attr_reader :story_or_iteration, :stories
+  def initialize(story_or_iteration)
+    @story_or_iteration = story_or_iteration
+    @stories = story_or_iteration.is_a?(Iteration) ? story_or_iteration.stories : [story_or_iteration]
+    p stories.size
   end
 
   def write_to
-    Prawn::Document.generate("#{card.id}.pdf",
+    Prawn::Document.generate("#{story_or_iteration.id}.pdf",
                              :page_layout => :landscape,
                              :margin      => [25, 25, 50, 25],
                              :page_size   => [302, 432]) do |pdf|
 
       pdf.font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
       # pdf.start_new_page
-      padding = 12
-      pdf.stroke_color = "666666"
-      pdf.stroke_bounds
-      width = 370
-      # --- Write content
-      pdf.bounding_box [pdf.bounds.left+padding, pdf.bounds.top-padding], :width => width do
-        pdf.text card.name, :size => 14
-        pdf.text "\n", :size => 14
-        pdf.fill_color "444444"
-        pdf.text card.description || "", :size => 10
+
+      stories.each_with_index do |story, index|
+        padding = 12
+        pdf.stroke_color = "666666"
+        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 "\n", :size => 14
+          pdf.fill_color "444444"
+          pdf.text story.description || "", :size => 10
+          pdf.fill_color "000000"
+        end
+
+        pdf.text_box "Points: " + (story.respond_to?(:estimate) ? story.estimate.to_s : "Not yet estimated"),
+          :size => 12, :at => [12, 50], :width => width-18
+        pdf.text_box "Owner: " + story.owned_by,
+          :size => 8, :at => [12, 18], :width => width-18
+
+        pdf.fill_color "999999"
+        pdf.text_box story.story_type.capitalize,  :size => 8,  :align => :right, :at => [12, 18], :width => width-18
         pdf.fill_color "000000"
+        pdf.start_new_page unless index == stories.size - 1
       end
+      pdf.number_pages "<page>/<total>", [pdf.bounds.right-16, -28]
 
-      pdf.text_box "Points: " + card.estimate.to_s,
-        :size => 12, :at => [12, 50], :width => width-18
-      pdf.text_box "Owner: " + card.owned_by,
-        :size => 8, :at => [12, 18], :width => width-18
-
-      pdf.fill_color "999999"
-      pdf.text_box card.story_type.capitalize,  :size => 8,  :align => :right, :at => [12, 18], :width => width-18
-      pdf.fill_color "000000"
-
-
-      # --- Footer
-      pdf.number_pages "Story ID: #{card.id}", [pdf.bounds.left,  -28]
-
-      puts ">>> Generated PDF file in '#{card.id}.pdf'".foreground(:green)
-  end
+      puts ">>> Generated PDF file in '#{story_or_iteration.id}.pdf'".foreground(:green)
+                             end
   rescue Exception
     puts "[!] There was an error while generating the PDF file... What happened was:".foreground(:red)
     raise

data/lib/pivotal_to_pdf/pivotal.rb

@@ -0,0 +1,8 @@
+class Pivotal < ActiveResource::Base
+  def self.inherited(sub)
+    info = YAML.load_file File.expand_path("~/.pivotal.yml")
+    sub.site = %Q|https://www.pivotaltracker.com/services/v3/projects/#{info['project_id']}|
+    sub.headers['X-TrackerToken'] = info["token"]
+  end
+
+end

data/lib/pivotal_to_pdf/story.rb

@@ -1,5 +1,2 @@
-class Story < ActiveResource::Base
-  info = YAML.load_file File.expand_path("~/.pivotal.yml")
-  self.site = %Q|https://www.pivotaltracker.com/services/v3/projects/#{info['project_id']}|
-  headers['X-TrackerToken'] = info["token"]
+class Story < Pivotal
 end

data/lib/pivotal_to_pdf.rb

@@ -1,13 +1,21 @@
 require 'rubygems'
 require 'rainbow'
+require 'thor'
 require 'active_resource'
+require 'pivotal_to_pdf/pivotal'
+require 'pivotal_to_pdf/iteration'
 require 'pivotal_to_pdf/story'
 require 'pivotal_to_pdf/pdf_writer'
-class PivotalToPdf
+class PivotalToPdf < Thor
   class << self
-    def write(story_id)
+    def story(story_id)
       story = Story.find(story_id)
       PdfWriter.new(story).write_to
     end
+
+    def iteration(iteration_token)
+      iteration = Iteration.find(:all, :params => {:group => iteration_token}).first
+      PdfWriter.new(iteration).write_to
+    end
   end
 end

data/pivotal_to_pdf.gemspec

@@ -2,19 +2,19 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pivotal_to_pdf}
-  s.version = "0.1.1"
+  s.version = "0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Yi Wen"]
-  s.date = %q{2010-11-24}
-  s.default_executable = %q{pivol_to_pdf}
+  s.date = %q{2010-11-30}
+  s.default_executable = %q{pivotal_to_pdf}
   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 = ["pivol_to_pdf"]
-  s.extra_rdoc_files = ["CHANGELOG", "README", "bin/pivol_to_pdf", "lib/pivotal_to_pdf.rb", "lib/pivotal_to_pdf/pdf_writer.rb", "lib/pivotal_to_pdf/story.rb"]
-  s.files = ["CHANGELOG", "Manifest", "README", "Rakefile", "bin/pivol_to_pdf", "lib/pivotal_to_pdf.rb", "lib/pivotal_to_pdf/pdf_writer.rb", "lib/pivotal_to_pdf/story.rb", "pivotal_to_pdf.gemspec"]
+  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 = ["6728599.pdf", "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_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"]
+  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}
@@ -28,14 +28,17 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<activeresource>, [">= 0"])
       s.add_runtime_dependency(%q<prawn>, [">= 0"])
       s.add_runtime_dependency(%q<rainbow>, [">= 0"])
+      s.add_runtime_dependency(%q<thor>, [">= 0"])
     else
       s.add_dependency(%q<activeresource>, [">= 0"])
       s.add_dependency(%q<prawn>, [">= 0"])
       s.add_dependency(%q<rainbow>, [">= 0"])
+      s.add_dependency(%q<thor>, [">= 0"])
     end
   else
     s.add_dependency(%q<activeresource>, [">= 0"])
     s.add_dependency(%q<prawn>, [">= 0"])
     s.add_dependency(%q<rainbow>, [">= 0"])
+    s.add_dependency(%q<thor>, [">= 0"])
   end
 end

data/spec/pivotal_to_pdf_bin_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+load File.expand_path(File.join(File.dirname(__FILE__), "..", "bin", "pivotal_to_pdf"))
+
+describe 'PivotalToPdf Bin' do
+  describe "when pased in story sub command" do
+    it "should call story" do
+      PivotalToPdf.should_receive(:story).with(123)
+      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
+  end
+  describe "when pased in iteration sub command" do
+    it "should call iteration" do
+      PivotalToPdf.should_receive(:iteration).with(123)
+      PivotalToPdfApp.start(["iteration", 123])
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+require "#{File.dirname(__FILE__)}/../lib/pivotal_to_pdf"
+Dir["#{File.dirname(__FILE__)}/../lib/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+  # out = ENV['CC_BUILD_ARTIFACTS'] || "#{Rails.root}"
+  # config.output_stream = File.open("#{out}/UnitTests/index.html", "w") if config.formatter_class.name =~ /HtmlFormatter/
+
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, comment the following line or assign false
+  # instead of true.
+end

data/tasks/spec.rb

@@ -0,0 +1,17 @@
+begin
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+
+  spec_prereq = :noop
+  task :noop do
+  end
+
+  desc "Run all specs in spec directory (excluding plugin specs)"
+  RSpec::Core::RakeTask.new(:spec => spec_prereq) do |t|
+    t.rspec_opts = ["--format", "documentation"]
+    t.pattern = "spec/**/*_spec.rb"
+  end
+
+rescue LoadError => e
+  p e
+end

metadata

@@ -1,13 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: pivotal_to_pdf
 version: !ruby/object:Gem::Version 
-  hash: 25
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 5
+  version: "0.5"
 platform: ruby
 authors: 
 - Yi Wen
@@ -15,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-24 00:00:00 -06:00
+date: 2010-11-30 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +24,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -40,7 +37,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -54,35 +50,58 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
   type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
 description: Convert Pivotal Tracker Stories to 4x6 PDF for printing so that you can stick the card to your story board
 email: hayafirst@gmail.com
 executables: 
-- pivol_to_pdf
+- pivotal_to_pdf
 extensions: []
 
 extra_rdoc_files: 
 - CHANGELOG
-- README
-- bin/pivol_to_pdf
+- 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
 files: 
+- 6728599.pdf
 - CHANGELOG
+- Gemfile
+- Gemfile.lock
 - Manifest
-- README
+- README.md
 - Rakefile
-- bin/pivol_to_pdf
+- 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_bin_spec.rb
+- spec/spec_helper.rb
+- tasks/spec.rb
 has_rdoc: true
 homepage: https://github.com/ywen/pivotal_to_pdf
 licenses: []
@@ -94,7 +113,7 @@ rdoc_options:
 - --title
 - Pivotal_to_pdf
 - --main
-- README
+- README.md
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -102,7 +121,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -111,7 +129,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 11
       segments: 
       - 1
       - 2

data/README

@@ -1,15 +0,0 @@
-This is a gem that can read a story from pivotal tracker and print into a 4x6 card so that you can print the card and stick to your physical story board.
-
-==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
-
-a sample .pivotal.yml:
-
-token: your-api-token-of-pivotal-tracker
-project_id: your-ptroject-id
-
-After install the gem, type pivotal_to_pdf your-story-id
-
-The gem will then read the story and print it into a PDF
-
-The gem assumes that you have https access to the pivotal tracker

data/bin/pivol_to_pdf

@@ -1,5 +0,0 @@
-#!/usr/bin/env ruby
-$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
-require 'pivotal_to_pdf'
-PivotalToPdf.write ARGV[0]
-