pivotalprinter 0.2.0 → 0.3.0

data/.gitignore

@@ -2,3 +2,4 @@
 pkg
 Gemfile.lock
 .rvmrc
+.DS_Store

data/Gemfile

@@ -1,5 +1,7 @@
 # vim: set ft=ruby:
 
-source "http://rubygems.org"
+source :rubygems
 
 gemspec
+
+gem 'utils'

data/History.txt

@@ -1,3 +1,18 @@
+=== 0.3.0 2013-01-07
+
+* Always show estimated points for all story types.
+* Some refactoring of the code.
+* Improved the images a bit (I think).
+* Display project name on each story card.
+
+=== 0.2.0 2012-11-27
+
+* Adds more information on the ticket.
+
+=== 0.1.8 2011-10-25
+
+* Allow for ruby 1.9 compatibility.
+
 === 0.1.7 2011-07-19
 
 * use a newver prawn version

data/Manifest.txt

@@ -1,17 +1,21 @@
+COPYING
+Gemfile
 History.txt
 Manifest.txt
 PostInstall.txt
 README.rdoc
 Rakefile
 bin/pivotalprinter
-images/bug.png
-images/chore.png
-images/feature.png
-images/release.png
 lib/pivotalprinter.rb
 lib/pivotalprinter/client.rb
-lib/pivotalprinter/story.rb
+lib/pivotalprinter/images/bug.png
+lib/pivotalprinter/images/chore.png
+lib/pivotalprinter/images/feature.png
+lib/pivotalprinter/images/release.png
 lib/pivotalprinter/iteration.rb
+lib/pivotalprinter/printer.rb
+lib/pivotalprinter/story.rb
+lib/pivotalprinter/version.rb
 pivotalprinter.gemspec
 script/console
 script/destroy

data/bin/pivotalprinter

@@ -5,149 +5,4 @@ require 'pivotalprinter'
 
 class String; include Term::ANSIColor; end
 
-module Pivotalprinter
-  class ConfigNeeded < StandardError; end
-  class TokenMissing < StandardError; end
-  class ProjectMissing < StandardError; end
-end
-
-module Pivotalprinter
-  class Printer
-    def run
-      opts = parse_options
-      yaml = load_yaml_config
-      project,token = extract_config(opts, yaml)
-      Pivotalprinter::Client.project = project
-      Pivotalprinter::Client.token   = token
-      @stories = case ARGV.last
-        when "done"    then Pivotalprinter::Iteration.open('done').stories
-        when "backlog" then Pivotalprinter::Iteration.open('backlog').stories
-        when /^\d+$/   then Pivotalprinter::Story.open(ARGV.map(&:to_i))
-        else Pivotalprinter::Iteration.open('current').stories
-      end
-      generate_output
-    rescue ConfigNeeded
-      print_config
-    rescue TokenMissing
-      Trollop::die :token, "token must be specified through config file or explicitly"
-    rescue ProjectMissing
-      Trollop::die :project, "project must be a valid number or one of the configured projects (#{(yaml.keys - ["default"]).join(", ")}) if no default is configured in $HOME/.pivotalprinterrc"
-    rescue SystemExit
-    rescue Exception
-      puts "[!] There was an error while generating the PDF file... What happened was:".white.on_red
-      raise
-    end
-
-    def print_config
-      puts %{---\ndefault: &default\n  token: "YOUR TOKEN HERE"\n  project: 123\n\nsome_project:\n  <<: *default # so you don't need to rewrite the token\n  project: 789}
-    end
-
-    def parse_options
-      opts = Trollop::options do
-        version "pivotalprinter #{Pivotalprinter::VERSION} (c) 2010#{(year = Time.now.year) > 2010 ? "-#{year}" : ''} pkw.de"
-        banner <<-EOS
-Pivotalprinter is an awesome program to print stories from the PivotalTracker.
-
-Usage:
-        pivotalprinter [-p PROJECT] [-t TOKEN] [current|backlog|done|STORY]
-        pivotalprinter --config > ~/.pivotalprinterrc
-
-Options:
-EOS
-        opt :project,  "Project Name defined in $HOME/.pivotalprinterrc or project number", :short => "-p", :type => :string
-        opt :token,    "Pivotaltracker Token",    :short => "-t", :type => :string
-        opt :config,   "show example configuration", :short => "-c"
-      end
-
-      raise ConfigNeeded if opts[:config]
-      opts
-    end
-
-    def load_yaml_config
-      File.exist?("#{ENV["HOME"]}/.pivotalprinterrc") ? YAML::load_file("#{ENV["HOME"]}/.pivotalprinterrc") : {}
-    end
-
-    def extract_config(opts, yaml)
-      if opts[:project].nil? && yaml.key?("default")
-        return yaml["default"]["project"], yaml["default"]["token"]
-      elsif opts[:project] =~ /[0-9]+/
-        return opts[:project], (opts[:token] || yaml["default"]["project"])
-      elsif yaml.key?(opts[:project])
-        return yaml[opts[:project]]["project"], yaml[opts[:project]]["token"]
-      else
-        raise ProjectMissing
-      end
-    end
-
-    def generate_output
-      Prawn::Document.generate("/tmp/stories.pdf", :page_layout => :landscape, :margin => [25, 25, 50, 25], :page_size   => 'A4') do |pdf|
-        @num_cards_on_page = 0
-        pdf.font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
-        @stories.each_with_index do |story, i|
-          # --- Split pages
-          if i > 0 and i % 4 == 0
-            # puts "New page..."
-            pdf.start_new_page
-            @num_cards_on_page  = 1
-          else
-            @num_cards_on_page += 1
-          end
-
-          # --- Define 2x2 grid
-          pdf.define_grid(:columns => 2, :rows => 2, :gutter => 42)
-          # pdf.grid.show_all
-
-          row    = (@num_cards_on_page + 1) / 4
-          column = i % 2
-          padding = 12
-          cell = pdf.grid( row, column )
-          cell.bounding_box do
-
-            pdf.stroke_color = "666666"
-            pdf.stroke_bounds
-
-            pdf.text_box story.name, :size => 14, :height => 50, :overflow => :truncate,
-              :width => cell.width - (padding * 2) - 50,
-              :at => [pdf.bounds.left + padding + 50, pdf.bounds.top - padding]
-
-            pdf.text_box story.description, :size => 8, :overflow => :truncate,
-              :width => cell.width - ( padding * 2), :height => cell.height - (padding * 7),
-              :at => [pdf.bounds.left + padding, pdf.bounds.top - padding - 55]
-
-            pdf.text_box "Created at: #{story.created_at.strftime('%F')}", :size => 8,
-              :at => [pdf.bounds.left + padding, pdf.bounds.bottom + padding]
-
-            pdf.text_box "ID: #{story.id}", :size => 8,
-              :at => [pdf.bounds.left + 110, pdf.bounds.bottom + padding]
-
-              pdf.text_box "State: #{story.current_state}", :size => 8,
-              :at => [pdf.bounds.left + 170, pdf.bounds.bottom + padding]
-
-            pdf.text_box "Requester: #{story.requested_by}", :size => 8,
-              :at => [pdf.bounds.left + 240, pdf.bounds.bottom + padding]
-
-
-            x, y = 32, 205
-            if story.story_type == "feature"
-              pdf.fill_color story.points_background
-              pdf.fill_circle [x, y], 25
-              pdf.font_size = 36
-              pdf.font "Helvetica", :style => :bold
-              pdf.fill_color 'ffffff'
-              pdf.draw_text "#{story.points}", :at => [x - 10, y - 12]
-              pdf.fill_color '000000'
-              pdf.font_size = 14
-              pdf.font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf", :style => :normal
-            else
-              pdf.image open("#{File.dirname(__FILE__)}/../images/#{story.story_type}.png"), :position => 5, :vposition => 5
-            end
-          end
-        end
-      end
-      puts ">>> Generated PDF file in 'stories.pdf' with #{@stories.size} stories".black.on_green
-      system "open /tmp/stories.pdf"
-    end
-  end
-end
-
-Pivotalprinter::Printer.new.run
+Pivotalprinter::Printer.new.run(ARGV)

data/lib/pivotalprinter.rb

@@ -1,18 +1,13 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
 module Pivotalprinter
-  require 'rubygems'
-  require 'pivotalprinter/version'
-  require 'term/ansicolor'
-  require 'prawn'
-  require 'prawn/layout/grid'
-  require 'tins/xt/full'
-  require 'trollop'
-  require 'yaml'
-  require "open-uri"
-  require "nokogiri"
-  require "pivotalprinter/client"
-  require "pivotalprinter/iteration"
-  require "pivotalprinter/story"
+  class ConfigNeeded < StandardError; end
+  class TokenMissing < StandardError; end
+  class ProjectMissing < StandardError; end
 end
+
+require 'pivotalprinter/version'
+require 'pivotalprinter/client'
+require 'pivotalprinter/iteration'
+require 'pivotalprinter/story'
+require 'pivotalprinter/printer'
+require 'term/ansicolor'
+require 'tins/xt/full'

data/lib/pivotalprinter/client.rb

@@ -1,3 +1,6 @@
+require 'open-uri'
+require 'nokogiri'
+
 module Pivotalprinter
   class Client
     class << self
@@ -6,7 +9,8 @@ module Pivotalprinter
       def get(path, options={})
         raise TokenMissing if @token.nil?
         raise ProjectMissing if @project.nil?
-        open("http://www.pivotaltracker.com/services/v3#{path}", 'X-TrackerToken' => @token, 'Content-Type' => 'application/xml').read
+        response = open("http://www.pivotaltracker.com/services/v3#{path}", 'X-TrackerToken' => @token, 'Content-Type' => 'application/xml').read
+        Nokogiri::XML.parse(response)
       end
     end
   end

data/lib/pivotalprinter/iteration.rb

@@ -1,24 +1,23 @@
 module Pivotalprinter
   class Iteration
-    
+
     attr_accessor :stories
-    
+
     def self.open(name)
       self.new(name)
     end
-    
+
     def initialize(name)
       @stories = []
-      extract_stories(Client.get "/projects/#{Client.project}/iterations/#{name}")
+      extract_stories Client.get("/projects/#{Client.project}/iterations/#{name}")
     end
-    
+
     private
-    
+
     def extract_stories(response)
-      response = Nokogiri::XML.parse(response)
       response.css("story").each do |story|
         @stories << Story.new(story)
       end
     end
   end
-end
+end

data/lib/pivotalprinter/printer.rb

@@ -0,0 +1,151 @@
+require 'trollop'
+require 'yaml'
+require 'prawn'
+require 'prawn/layout/grid'
+
+module Pivotalprinter
+  class Printer
+    def run(argv)
+      argv = argv.dup
+      opts = parse_options
+      yaml = load_yaml_config
+      project, token = extract_config(opts, yaml)
+      Pivotalprinter::Client.project = project
+      Pivotalprinter::Client.token   = token
+      @project_name = (Client.get("/projects/#{project}") / 'project/name').text
+      @stories =
+        case argv.last
+        when "done"    then Pivotalprinter::Iteration.open('done').stories
+        when "backlog" then Pivotalprinter::Iteration.open('backlog').stories
+        when /^\d+$/   then Pivotalprinter::Story.open(argv.map(&:to_i))
+        else                Pivotalprinter::Iteration.open('current').stories
+        end
+      generate_output
+    rescue ConfigNeeded
+      print_config
+    rescue TokenMissing
+      Trollop::die :token, "token must be specified through config file or explicitly"
+    rescue ProjectMissing
+      Trollop::die :project, "project must be a valid number or one of the configured projects (#{(yaml.keys - ["default"]).join(", ")}) if no default is configured in $HOME/.pivotalprinterrc"
+    rescue Exception
+      puts "[!] There was an error while generating the PDF file... What happened was:".white.on_red
+      raise
+    end
+
+    def print_config
+      puts <<CONFIG
+---
+default: &default
+  token:   "YOUR TOKEN HERE"
+  project: 123
+
+some_project:
+  <<:      *default # so you don't need to rewrite the token
+  project: 789
+CONFIG
+    end
+
+    def parse_options
+      opts = Trollop::options do
+        version "pivotalprinter #{Pivotalprinter::VERSION} (c) 2010#{(year = Time.now.year) > 2010 ? "-#{year}" : ''} pkw.de"
+        banner <<-EOS
+Pivotalprinter is an awesome program to print stories from the PivotalTracker.
+
+Usage:
+        pivotalprinter [-p PROJECT] [-t TOKEN] [current|backlog|done|STORY]
+        pivotalprinter --config > ~/.pivotalprinterrc
+
+Options:
+EOS
+        opt :project,  "Project Name defined in $HOME/.pivotalprinterrc or project number",
+          :short => "-p", :type => :string
+        opt :token,    "Pivotaltracker Token",       :short => "-t", :type => :string
+        opt :config,   "show example configuration", :short => "-c"
+      end
+
+      raise ConfigNeeded if opts[:config]
+      opts
+    end
+
+    def load_yaml_config
+      File.exist?("#{ENV["HOME"]}/.pivotalprinterrc") ? YAML::load_file("#{ENV["HOME"]}/.pivotalprinterrc") : {}
+    end
+
+    def extract_config(opts, yaml)
+      if opts[:project].nil? && yaml.key?("default")
+        return yaml["default"]["project"], yaml["default"]["token"]
+      elsif opts[:project] =~ /[0-9]+/
+        return opts[:project], (opts[:token] || yaml["default"]["project"])
+      elsif yaml.key?(opts[:project])
+        return yaml[opts[:project]]["project"], yaml[opts[:project]]["token"]
+      else
+        raise ProjectMissing
+      end
+    end
+
+    def generate_output
+      Prawn::Document.generate("/tmp/stories.pdf", :page_layout => :landscape, :margin => [25, 25, 50, 25], :page_size   => 'A4') do |pdf|
+        @num_cards_on_page = 0
+        pdf.font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
+        @stories.each_with_index do |story, i|
+          # --- Split pages
+          if i > 0 and i % 4 == 0
+            # puts "New page..."
+            pdf.start_new_page
+            @num_cards_on_page  = 1
+          else
+            @num_cards_on_page += 1
+          end
+
+          # --- Define 2x2 grid
+          pdf.define_grid(:columns => 2, :rows => 2, :gutter => 42)
+          # pdf.grid.show_all
+
+          row    = (@num_cards_on_page + 1) / 4
+          column = i % 2
+          padding = 12
+          cell = pdf.grid( row, column )
+          cell.bounding_box do
+            pdf.stroke_color = "666666"
+            pdf.stroke_bounds
+
+            pdf.text_box "#@project_name ##{story.id}", :size => 10, :overflow => :truncate,
+              :width => cell.width - ( padding * 2),
+              :at => [pdf.bounds.left + padding, pdf.bounds.top - padding / 2 ]
+
+            pdf.text_box story.name, :size => 14, :height => 50, :overflow => :truncate,
+              :width => cell.width - (padding * 2) - 100,
+              :at => [pdf.bounds.left + padding + 50, pdf.bounds.top - 2 * padding]
+
+            pdf.text_box story.description.strip, :size => 8, :overflow => :truncate,
+              :width => cell.width - ( padding * 2), :height => cell.height - (padding * 8),
+              :at => [pdf.bounds.left + padding, pdf.bounds.top - 2 * padding - 55]
+
+            pdf.text_box "Created at: #{story.created_at.strftime('%F')}", :size => 8,
+              :at => [pdf.bounds.left + padding, pdf.bounds.bottom + padding]
+
+            pdf.text_box "State: #{story.current_state}", :size => 8,
+              :at => [pdf.bounds.left + 120, pdf.bounds.bottom + padding]
+
+            pdf.text_box "Requester: #{story.requested_by}", :size => 8,
+              :at => [pdf.bounds.left + 200, pdf.bounds.bottom + padding]
+
+            x, y = 32, 205 - padding
+            pdf.fill_color story.points_background
+            pdf.fill_circle [x, y], 25
+            pdf.font_size = 36
+            pdf.font "Helvetica", :style => :bold
+            pdf.fill_color 'ffffff'
+            pdf.draw_text "#{story.points}", :at => [x - 10, y - 12]
+            pdf.fill_color '000000'
+            pdf.font_size = 14
+            pdf.font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf", :style => :normal
+            pdf.image open("#{File.dirname(__FILE__)}/images/#{story.story_type}.png"), :position => cell.width - 51, :vposition => 5 + padding
+          end
+        end
+      end
+      puts ">>> Generated PDF file in 'stories.pdf' with #{@stories.size} stories".black.on_green
+      system "open /tmp/stories.pdf"
+    end
+  end
+end

data/lib/pivotalprinter/story.rb

@@ -4,7 +4,7 @@ module Pivotalprinter
   class Story
     FIELDS = [ :name, :id, :story_type, :estimate, :current_state, :description, :requested_by, :labels, :created_at, :updated_at ]
     attr_accessor(*FIELDS)
-    
+
     def initialize(xml)
       FIELDS.each do |field|
         value = xml.css("#{field}")
@@ -13,19 +13,18 @@ module Pivotalprinter
       created_at and self.created_at = Time.parse(created_at)
       updated_at and self.updated_at = Time.parse(updated_at)
     end
-    
+
     def self.open(ids)
       ids.map do |id|
         response = Client.get "/projects/#{Client.project}/stories/#{id}"
-        response = Nokogiri::XML.parse(response)
-        self.new(response.css('story'))        
+        self.new(response.css('story'))
       end
     end
-    
+
     def points
       estimate.to_i >= 0 ? estimate.to_i : '?'
     end
-    
+
     def points_background
       case points
         when '?' then 'cccccc'

data/lib/pivotalprinter/version.rb

@@ -1,3 +1,3 @@
 module Pivotalprinter
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pivotalprinter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-27 00:00:00.000000000 Z
+date: 2013-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
@@ -140,13 +140,14 @@ files:
 - README.rdoc
 - Rakefile
 - bin/pivotalprinter
-- images/bug.png
-- images/chore.png
-- images/feature.png
-- images/release.png
 - lib/pivotalprinter.rb
 - lib/pivotalprinter/client.rb
+- lib/pivotalprinter/images/bug.png
+- lib/pivotalprinter/images/chore.png
+- lib/pivotalprinter/images/feature.png
+- lib/pivotalprinter/images/release.png
 - lib/pivotalprinter/iteration.rb
+- lib/pivotalprinter/printer.rb
 - lib/pivotalprinter/story.rb
 - lib/pivotalprinter/version.rb
 - pivotalprinter.gemspec
@@ -169,7 +170,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3495001522045933990
+      hash: -738262424533095811
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -178,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3495001522045933990
+      hash: -738262424533095811
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24