pivotal_to_pdf 1.1.0 → 1.2.0

data/Gemfile

@@ -5,6 +5,9 @@ gem 'prawn'
 gem 'thor'
 group :test do
   gem 'rspec'
+  gem "guard-spork"
+  gem "guard-rspec"
+  gem "growl-rspec"
 end
 
 group :test, :development do

data/Gemfile.lock

@@ -12,8 +12,21 @@ GEM
     activesupport (3.0.9)
     builder (2.1.2)
     diff-lcs (1.1.3)
+    ffi (1.0.11)
+    growl (1.0.3)
+    growl-rspec (0.0.1)
+      growl
+      rspec
+    guard (1.0.1)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-rspec (0.7.0)
+      guard (>= 0.10.0)
+    guard-spork (0.6.1)
+      guard (>= 0.10.0)
+      spork (>= 0.8.4)
     i18n (0.5.0)
-    pdf-reader (1.0.0)
+    pdf-reader (1.1.0)
       Ascii85 (~> 1.0.0)
       ruby-rc4
     prawn (0.12.0)
@@ -21,15 +34,16 @@ GEM
       ttfunk (~> 1.0.2)
     rainbow (1.1.3)
     rake (0.9.2.2)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-    ruby-rc4 (0.1.3)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    ruby-rc4 (0.1.5)
+    spork (0.9.0)
     thor (0.14.6)
     ttfunk (1.0.3)
 
@@ -38,6 +52,9 @@ PLATFORMS
 
 DEPENDENCIES
   activeresource (= 3.0.9)
+  growl-rspec
+  guard-rspec
+  guard-spork
   prawn
   rainbow
   rake

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'spork' do
+  watch('Gemfile')
+  watch('Gemfile.lock')
+  watch('spec/spec_helper.rb') { :rspec }
+end
+
+guard 'rspec', :all_after_pass => false, :cli => "--color --format documentation --drb" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)/(.+)\.rb$})     { |m| "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -16,8 +16,13 @@ First you need to create a .pivotal.yml under your home directory. On windows, h
 
 a sample .pivotal.yml:
 
-    token: your-api-token-of-pivotal-tracker
-    project_id: your-ptroject-id
+```yaml
+token: your-api-token-of-pivotal-tracker
+project_id: your-ptroject-id
+formatter: PivotalToPdf::DefaultFormatter
+```
+
+The meaning of the ```formatter``` key will be explained in the next section
 
 After install the gem, you can do:
 
@@ -60,10 +65,29 @@ Printed a green bounding box for feature, a yellow box for chores and a red box
 
 The gem assumes that you have https access to the pivotal tracker
 
+## Formatters
+
+From the version 1.2, The gem supports alternative formatter other than the default one.
+In the ```.pivotal.yml``` file, if you define a key like
+
+```yaml
+
+formatter: PivotalToPdf::MyPrettyHtmlWriter
+```
+
+The gem will use ```PivotalToPdf::MyPrettyHtmlWriter``` to generate the output.
+
+The class implementation should have the same interface as the ```DefaultFormatter```
+
+- The ```initialize``` should take an array of stories
+- The ```write_to``` method write the output
+
+This feature is associated to the [issue #14](pivotal_to_pdf/issues/14). I basically rewrite the code to implement this myself.
+
 ##Contributors
 * [Yi Wen](https://github.com/ywen)
 * Carol Nichols
 * Kristian Rasmussen 
 * [Alastair Mair](https://github.com/amair)
 * [John-Mason P. Shackelford](https://github.com/jpshackelford)
-* [mogul](https://github.com/mogul)
+* [Bret Mogilefsky](https://github.com/mogul)

data/lib/pivotal_to_pdf/configure.rb

@@ -0,0 +1,13 @@
+module PivotalToPdf
+  class Configure
+    def initialize
+      base_dir = ENV["PIVOTAL_TO_PDF_CONFIG_DIR"] || "~"
+      info = YAML.load_file File.expand_path("#{base_dir}/.pivotal.yml")
+      info.each do |key, value|
+        self.class.send :define_method, key do
+          value
+        end
+      end
+    end
+  end
+end

data/lib/pivotal_to_pdf/{pdf_writer.rb → default_formatter.rb}

@@ -5,7 +5,7 @@ require 'prawn'
 require 'rainbow'
 
 module PivotalToPdf
-  class PdfWriter
+  class DefaultFormatter
     attr_reader :stories
     private :stories
     def initialize(stories)

data/lib/pivotal_to_pdf/formatter_factory.rb

@@ -0,0 +1,12 @@
+module PivotalToPdf
+  module FormatterFactory
+    class << self
+      def formatter
+        config = Configure.new
+        config.respond_to?(:formatter) ? 
+          config.formatter.constantize :
+          PivotalToPdf::DefaultFormatter
+      end
+    end
+  end
+end

data/lib/pivotal_to_pdf/pivotal.rb

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

data/lib/pivotal_to_pdf/version.rb

@@ -1,3 +1,3 @@
 module PivotalToPdf
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/pivotal_to_pdf.rb

@@ -3,38 +3,36 @@ require "pivotal_to_pdf/version"
 require 'rainbow'
 require 'thor'
 require 'active_resource'
+require 'pivotal_to_pdf/configure'
+require 'pivotal_to_pdf/formatter_factory'
 require 'pivotal_to_pdf/simple_text_formatter'
 require 'pivotal_to_pdf/pivotal'
 require 'pivotal_to_pdf/iteration'
 require 'pivotal_to_pdf/story'
-require 'pivotal_to_pdf/pdf_writer'
+require 'pivotal_to_pdf/default_formatter'
 require 'pivotal_to_pdf/pt-workarounds'
 
-# Uncomment the following to trace the URLs and results generated via ActiveResource
-# require 'logger'
-# ActiveResource::Base.logger = Logger.new(STDERR)
-
 module PivotalToPdf
   class Main < Thor
     class << self
       def story(story_id)
         story = Story.find(story_id)
-        PivotalToPdf::PdfWriter.new([ story ]).write_to(story_id)
+        FormatterFactory.formatter.new([ story ]).write_to(story_id)
       end
 
       def current_iteration
         iteration = Iteration.find(:all, :params => {:group => "current"}).first
-        PivotalToPdf::PdfWriter.new(iteration.stories).write_to("current")
+        FormatterFactory.formatter.new(iteration.stories).write_to("current")
       end
 
       def iteration(iteration_number)
         iteration = Iteration.find(:all, :params => {:offset => iteration_number.to_i - 1, :limit => 1}).first
-        PivotalToPdf::PdfWriter.new(iteration.stories).write_to(iteration_number)
+        FormatterFactory.formatter.new(iteration.stories).write_to(iteration_number)
       end
 
       def label(label_text)
         stories = Story.find(:all, :params => {:filter => "label:\"" + label_text + "\""})
-        PivotalToPdf::PdfWriter.new(stories).write_to(label_text)
+        FormatterFactory.formatter.new(stories).write_to(label_text)
       end
     end
   end

data/pivotal_to_pdf.gemspec

@@ -11,13 +11,14 @@ Gem::Specification.new do |s|
   s.description    = "Convert Pivotal Tracker Stories to 4x6 PDF for printing so that you can stick the card to your story board"
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
   s.author         = "Yi Wen"
-  s.add_runtime_dependency(%q<activeresource>, ["3.0.9"])
-  s.add_runtime_dependency(%q<prawn>, ["0.12.0"])
-  s.add_runtime_dependency(%q<rainbow>, [">= 0"])
-  s.add_runtime_dependency(%q<thor>, [">= 0"])
+  s.add_runtime_dependency(%q<activeresource>, "3.0.9")
+  s.add_runtime_dependency(%q<prawn>, "0.12.0")
+  s.add_runtime_dependency(%q<rainbow>, ">= 0")
+  s.add_runtime_dependency(%q<thor>, ">= 0")
+  s.add_development_dependency(%q<rspec>)
   s.homepage = "https://github.com/ywen/pivotal_to_pdf"
 end

data/spec/pivotal_to_pdf/configure_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+module PivotalToPdf
+  describe Configure do
+    describe ".new" do
+      let(:configurations) do
+        {
+          :project_id => "1233",
+          :token => "aaaaa",
+          :formatter => "PivotalToPdf::SomethingCrazy",
+          :something_else => "some other my own configs" 
+        }
+      end
+      before(:each) do
+        YAML.stub(:load_file).and_return configurations
+      end
+      
+      context "when the environment var PIVOTAL_TO_PDF_CONFIG_DIR is defined" do
+        before(:each) { ENV["PIVOTAL_TO_PDF_CONFIG_DIR"] = "/a/dir" }
+        after(:each) { ENV["PIVOTAL_TO_PDF_CONFIG_DIR"] = nil }
+        it "loads the file from the position" do
+          YAML.should_receive(:load_file).with("/a/dir/.pivotal.yml")
+          Configure.new
+        end
+      end
+      context "when the environment var PIVOTAL_TO_PDF_CONFIG_DIR is not defined" do
+        before(:each) { ENV["PIVOTAL_TO_PDF_CONFIG_DIR"] = nil }
+        it "loads the file from the HOME" do
+          YAML.should_receive(:load_file).with(File.expand_path("~/.pivotal.yml"))
+          Configure.new
+        end
+      end
+      context "defines methods for each key loaded from the config yaml file" do
+        {
+          :project_id => "1233",
+          :token => "aaaaa",
+          :formatter => "PivotalToPdf::SomethingCrazy",
+          :something_else => "some other my own configs" 
+        }.each do |key, value|
+          it "defines #{key} as a method and returns the value: #{value}" do
+            subject.send(key).should eq(value)
+          end
+        end
+      end
+
+    end
+  end
+end
+

data/spec/pivotal_to_pdf/formatter_factory_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+module PivotalToPdf
+  describe FormatterFactory do
+    describe ".current_formatter" do
+      before(:each) do
+        Configure.stub(:new).and_return config
+      end
+      
+      context "when the format_class is not defined" do
+        let(:config) { double :config }
+        it "returns the default formatter" do
+          FormatterFactory.formatter.should eq(PivotalToPdf::DefaultFormatter)
+        end
+      end
+      
+      context "when the format_class is defined" do
+        let(:config) { double :config, :formatter => "PivotalToPdf::AClass" }
+        before(:each) do
+          PivotalToPdf::AClass = Class.new
+        end
+        
+        it "returns the default formatter" do
+          FormatterFactory.formatter.should eq(PivotalToPdf::AClass)
+        end
+      end
+    end
+  end
+end

data/spec/pivotal_to_pdf_spec.rb

@@ -3,12 +3,25 @@ require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
 module PivotalToPdf
   describe Main do
     let(:writer) {double :writer, :write_to => true}
+    before(:each) do
+      FormatterFactory.stub(:formatter).and_return DefaultFormatter
+    end
+    
+    shared_examples "formatter fetching" do
+      it "asks the FormatterFactory for the formatter" do
+        FormatterFactory.should_receive(:formatter).and_return DefaultFormatter
+        method.call
+      end
+    end
     describe ".story" do
       let(:story) {double :story}
+      let(:method) { lambda{ Main.story 32 } }
       before(:each) do
         Story.stub(:find).and_return story
-        PivotalToPdf::PdfWriter.stub(:new).and_return writer
+        DefaultFormatter.stub(:new).and_return writer
       end
+
+      include_examples "formatter fetching"
       
       it "initiates a story" do
         Story.should_receive(:find).with(23).and_return story
@@ -16,7 +29,7 @@ module PivotalToPdf
       end
 
       it "build a pdf writer" do
-        PivotalToPdf::PdfWriter.should_receive(:new).with([ story ]).and_return writer
+        DefaultFormatter.should_receive(:new).with([ story ]).and_return writer
         Main.story 23
       end
 
@@ -28,10 +41,12 @@ module PivotalToPdf
     describe ".current_iteration" do
       let(:stories) {double :stories_from_iteration}
       let(:iteration) {double :iteration, :stories => stories}
+      let(:method) { lambda{ Main.current_iteration } }
       before(:each) do
         Iteration.stub(:find).and_return [iteration, double]
-        PivotalToPdf::PdfWriter.stub(:new).and_return writer
+        DefaultFormatter.stub(:new).and_return writer
       end
+      include_examples "formatter fetching"
       
       it "initiates an Iteration" do
         Iteration.should_receive(:find).with(:all, :params => {:group => "current"}).and_return [iteration]
@@ -39,7 +54,7 @@ module PivotalToPdf
       end
 
       it "build a pdf writer" do
-        PivotalToPdf::PdfWriter.should_receive(:new).with(stories).and_return writer
+        DefaultFormatter.should_receive(:new).with(stories).and_return writer
         Main.current_iteration
       end
 
@@ -52,18 +67,21 @@ module PivotalToPdf
     describe ".iteration" do
       let(:stories) {double :stories_from_iteration}
       let(:iteration) {double :iteration, :stories => stories}
+      let(:method) { lambda{ Main.iteration 13 } }
       before(:each) do
         Iteration.stub(:find).and_return [iteration, double]
-        PivotalToPdf::PdfWriter.stub(:new).and_return writer
+        DefaultFormatter.stub(:new).and_return writer
       end
 
+      include_examples "formatter fetching"
+
       it "fetches an Iteration, given the Iteration number (you have to minus to get the accurate iteration)" do
         Iteration.should_receive(:find).with(:all, :params => {:offset => 12, :limit => 1}).and_return [iteration]
         Main.iteration 13
       end
 
       it "build a pdf writer" do
-        PivotalToPdf::PdfWriter.should_receive(:new).with(stories).and_return writer
+        DefaultFormatter.should_receive(:new).with(stories).and_return writer
         Main.iteration 13
       end
 
@@ -75,10 +93,12 @@ module PivotalToPdf
 
     describe ".label" do
       let(:story) {double :story}
+      let(:method) { lambda{ Main.label "testing" } }
       before(:each) do
         Story.stub(:find).and_return story
-        PivotalToPdf::PdfWriter.stub(:new).and_return writer
+        DefaultFormatter.stub(:new).and_return writer
       end
+      include_examples "formatter fetching"
       
       it "initiates a label search" do
         # Kind of a null test here, not sure how else to spec it
@@ -87,7 +107,7 @@ module PivotalToPdf
       end
 
       it "build a pdf writer" do
-        PivotalToPdf::PdfWriter.should_receive(:new).with(story).and_return writer
+        DefaultFormatter.should_receive(:new).with(story).and_return writer
         Main.label "testing"
       end
 

data/spec/spec_helper.rb

@@ -1,23 +1,33 @@
-# 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}
+require 'rubygems'
+require 'spork'
+require 'rspec/core'
 
-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/
+Spork.prefork do
 
+  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.
+
+    # 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
+
+end
+
+Spork.each_run do
+  # 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}
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pivotal_to_pdf
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,33 +9,43 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-07 00:00:00.000000000 Z
+date: 2012-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
-  requirement: &70227699683300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 3.0.9
   type: :runtime
   prerelease: false
-  version_requirements: *70227699683300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.9
 - !ruby/object:Gem::Dependency
   name: prawn
-  requirement: &70227699682460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.12.0
   type: :runtime
   prerelease: false
-  version_requirements: *70227699682460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: rainbow
-  requirement: &70227699681540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70227699681540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70227699680800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,28 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70227699680800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Convert Pivotal Tracker Stories to 4x6 PDF for printing so that you can
   stick the card to your story board
 email:
@@ -73,19 +109,24 @@ files:
 - CHANGELOG
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - Manifest
 - README.md
 - Rakefile
 - bin/pivotal_to_pdf
 - lib/pivotal_to_pdf.rb
+- lib/pivotal_to_pdf/configure.rb
+- lib/pivotal_to_pdf/default_formatter.rb
+- lib/pivotal_to_pdf/formatter_factory.rb
 - lib/pivotal_to_pdf/iteration.rb
-- lib/pivotal_to_pdf/pdf_writer.rb
 - lib/pivotal_to_pdf/pivotal.rb
 - lib/pivotal_to_pdf/pt-workarounds.rb
 - lib/pivotal_to_pdf/simple_text_formatter.rb
 - lib/pivotal_to_pdf/story.rb
 - lib/pivotal_to_pdf/version.rb
 - pivotal_to_pdf.gemspec
+- spec/pivotal_to_pdf/configure_spec.rb
+- spec/pivotal_to_pdf/formatter_factory_spec.rb
 - spec/pivotal_to_pdf/simple_text_formatter_spec.rb
 - spec/pivotal_to_pdf/story_spec.rb
 - spec/pivotal_to_pdf_bin_spec.rb
@@ -104,9 +145,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1429925807640698784
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -115,11 +153,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Convert Pivotal Tracker Stories to 4x6 PDF cards
 test_files:
+- spec/pivotal_to_pdf/configure_spec.rb
+- spec/pivotal_to_pdf/formatter_factory_spec.rb
 - spec/pivotal_to_pdf/simple_text_formatter_spec.rb
 - spec/pivotal_to_pdf/story_spec.rb
 - spec/pivotal_to_pdf_bin_spec.rb