pivotal_to_pdf 1.3.1 → 1.3.2

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p194

data/Gemfile

@@ -3,7 +3,7 @@ gem 'rainbow'
 gem 'activeresource', "3.0.9"
 gem 'prawn'
 gem 'thor'
-gem "pivotal_to_pdf-formatters"
+gem "pivotal_to_pdf-formatters", ">=0.0.4"
 group :test do
   gem 'rspec'
   gem "guard-spork"

data/Gemfile.lock

@@ -26,23 +26,23 @@ GEM
       guard (>= 0.10.0)
       spork (>= 0.8.4)
     i18n (0.5.0)
-    pdf-reader (1.1.0)
+    pdf-reader (1.1.1)
       Ascii85 (~> 1.0.0)
       ruby-rc4
-    pivotal_to_pdf-formatters (0.0.1)
+    pivotal_to_pdf-formatters (0.0.4)
     prawn (0.12.0)
       pdf-reader (>= 0.9.0)
       ttfunk (~> 1.0.2)
     rainbow (1.1.3)
     rake (0.9.2.2)
-    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)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.0)
+    rspec-expectations (2.11.1)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
+    rspec-mocks (2.11.1)
     ruby-rc4 (0.1.5)
     spork (0.9.0)
     thor (0.14.6)
@@ -56,7 +56,7 @@ DEPENDENCIES
   growl-rspec
   guard-rspec
   guard-spork
-  pivotal_to_pdf-formatters
+  pivotal_to_pdf-formatters (>= 0.0.4)
   prawn
   rainbow
   rake

data/README.md

@@ -2,6 +2,7 @@ pivotal_to_pdf -- print the stories from pivotal tracker to a PDF file
 ====================================
 
 [![Build Status](https://secure.travis-ci.org/ywen/pivotal_to_pdf.png)](http://travis-ci.org/ywen/pivotal_to_pdf)
+[![Code Quality](https://codeclimate.com/badge.png)](https://codeclimate.com/github/ywen/pivotal_to_pdf)
 
 ## 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.
@@ -19,7 +20,7 @@ a sample .pivotal.yml:
 ```yaml
 token: your-api-token-of-pivotal-tracker
 project_id: your-ptroject-id
-formatter: PivotalToPdf::DefaultFormatter
+formatter: PivotalToPdf::Formatters::Default
 ```
 
 The meaning of the ```formatter``` key will be explained in the next section

data/lib/pivotal_to_pdf.rb

@@ -6,9 +6,10 @@ require 'active_resource'
 require "pivotal_to_pdf-formatters"
 require 'pivotal_to_pdf/configure'
 require 'pivotal_to_pdf/formatter_factory'
-require 'pivotal_to_pdf/simple_text_formatter'
+require 'pivotal_to_pdf/text_formatters/simple_markup'
 require 'pivotal_to_pdf/pivotal'
 require 'pivotal_to_pdf/iteration'
+require 'pivotal_to_pdf/text'
 require 'pivotal_to_pdf/story'
 require 'pivotal_to_pdf/pt-workarounds'
 

data/lib/pivotal_to_pdf/story.rb

@@ -1,8 +1,8 @@
 module PivotalToPdf
   class Story < Pivotal
-    def label_text
+    def formatted_labels
       return "" if !self.respond_to?(:labels) || self.labels.nil? || self.labels.empty?
-      labels
+      formatted_output :labels
     end
 
     def points
@@ -28,7 +28,7 @@ module PivotalToPdf
     private
 
     def formatted_output(field)
-      SimpleTextFormatter.new(send(field)).output
+      Text.new(send(field)).to_s
     end
 
     ["feature", "bug", "chore", "release"].each do |type_str|

data/lib/pivotal_to_pdf/text.rb

@@ -0,0 +1,34 @@
+module PivotalToPdf
+  class Text
+    class << self
+      def formatting_classes
+        [ TextFormatters::SimpleMarkup ]
+      end
+    end
+
+    attr_reader :string
+    protected :string
+
+    def initialize(string)
+      @string = string
+    end
+
+    def ==(other)
+      string == other.string
+    end
+
+    def hash
+      string.hash
+    end
+
+    def to_s
+      output = string
+      self.class.formatting_classes.each do |klass|
+        output = klass.new(output).output
+      end
+      output
+    end
+  end
+
+end
+

data/lib/pivotal_to_pdf/text_formatters/simple_markup.rb

@@ -0,0 +1,15 @@
+module PivotalToPdf
+  module TextFormatters
+    class SimpleMarkup
+      attr_reader :string
+      private :string
+      def initialize(string)
+        @string = string.to_s
+      end
+
+      def output
+        string.gsub( /\*(.*)\*/,"<b>\\1</b>").gsub(/_(.*)_/, "<i>\\1</i>")
+      end
+    end
+  end
+end

data/lib/pivotal_to_pdf/version.rb

@@ -1,3 +1,3 @@
 module PivotalToPdf
-  VERSION = "1.3.1"
+  VERSION = "1.3.2"
 end

data/spec/pivotal_to_pdf/configure_spec.rb

@@ -38,7 +38,7 @@ module PivotalToPdf
           :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)
+            expect(subject.send(key)).to eq(value)
           end
         end
       end

data/spec/pivotal_to_pdf/formatter_factory_spec.rb

@@ -10,7 +10,7 @@ module PivotalToPdf
       context "when the format_class is not defined" do
         let(:config) { double :config }
         it "returns the default formatter" do
-          FormatterFactory.formatter.should eq(PivotalToPdf::Formatters::Default)
+          expect(FormatterFactory.formatter).to eq(PivotalToPdf::Formatters::Default)
         end
       end
       
@@ -21,7 +21,7 @@ module PivotalToPdf
         end
         
         it "returns the default formatter" do
-          FormatterFactory.formatter.should eq(PivotalToPdf::AClass)
+          expect(FormatterFactory.formatter).to eq(PivotalToPdf::AClass)
         end
       end
     end

data/spec/pivotal_to_pdf/story_spec.rb

@@ -2,51 +2,35 @@ require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
 
 module PivotalToPdf
   describe Story do
-    subject {Story.new :labels => [], :story_type => nil, :name => "a name"}
+    subject {
+      Story.new :labels => "test1 test2", :story_type => nil, :name => "a name", :description => "a description"
+    }
     let(:formatter) {double :formatter, :output => nil}
-    describe "#label_text" do
-      describe "and there is no label" do
+    describe "#formatted_labels" do
+      context "and there is no label" do
         it "should return blank string" do
           story = Story.new
-          story.label_text.should == ""
+          expect(story.formatted_labels).to eq("")
         end
       end
-      describe "and labels is empty" do
+
+      context "and labels is empty" do
         it "should return blank string" do
-          subject.label_text.should == ""
+          subject.labels = ""
+          expect(subject.formatted_labels).to eq("")
         end
       end
-      describe "and labels is nil" do
+
+      context "and labels is nil" do
         it "should return blank string" do
           subject.labels = nil
-          subject.label_text.should == ""
+          expect(subject.formatted_labels).to eq("")
         end
       end
 
-      describe "and when there are less than 3 labels" do
-        it "should return them in a nice format" do
-          subject.labels="test1, test2"
-          subject.label_text.should == "test1, test2"
-        end
-      end
     end
 
-    describe "#formatted_name" do
-      it "should ask the text formatter format the name" do
-        SimpleTextFormatter.should_receive(:new).with("a name").and_return formatter
-        formatter.should_receive(:output).and_return "new name"
-        subject.formatted_name.should == "new name"
-      end
-    end
-
-    describe "#formatted_description" do
-      it "should ask the text formatter format the description" do
-        subject.description = "a description"
-        SimpleTextFormatter.should_receive(:new).with("a description").and_return formatter
-        formatter.should_receive(:output).and_return "new desc"
-        subject.formatted_description.should == "new desc"
-      end
-    end
+    it_converts_string_through_text_class_on :name, :description, :labels
 
     describe "#points" do
       describe "and the story is a bug" do
@@ -54,7 +38,7 @@ module PivotalToPdf
           subject.story_type = "bug"
         end
         it "should return nil" do
-          subject.points.should be_nil
+          expect(subject.points).to be_nil
         end
       end
       describe "and the story is a release" do
@@ -62,7 +46,7 @@ module PivotalToPdf
           subject.story_type = "release"
         end
         it "should return nil" do
-          subject.points.should be_nil
+          expect(subject.points).to be_nil
         end
       end
       describe "and the story is a feature" do
@@ -71,7 +55,7 @@ module PivotalToPdf
         end
         describe "and the story is not respond_to estimate" do
           it "should return Not yet estimated" do
-            subject.points.should == "Points: Not yet estimated"
+            expect(subject.points).to eq("Points: Not yet estimated")
           end
         end
 
@@ -79,13 +63,13 @@ module PivotalToPdf
           let(:story) {Story.new :story_type => "feature", :estimate => -1}
           describe "and the estimate is -1" do
             it "should return not yet estimated" do
-              subject.points.should == "Points: Not yet estimated"
+              expect(subject.points).to eq("Points: Not yet estimated")
             end
           end
           describe "and the estimate is not -1" do
             it "should return the points" do
               subject.estimate = 5
-              subject.points.should == "Points: 5"
+              expect(subject.points).to eq("Points: 5")
             end
           end
         end
@@ -95,19 +79,19 @@ module PivotalToPdf
     describe "#story_color" do
       it "should return green for features" do
         subject.story_type = "feature"
-        subject.story_color.should == "52D017"
+        expect(subject.story_color).to eq("52D017")
       end
       it "should return red for bugs" do
         subject.story_type = "bug"
-        subject.story_color.should == "FF0000"
+        expect(subject.story_color).to eq("FF0000")
       end
       it "should return yellow for chores" do
         subject.story_type = "chore"
-        subject.story_color.should == "FFFF00"
+        expect(subject.story_color).to eq("FFFF00")
       end
       it "should return black for releases" do
         subject.story_type = "release"
-        subject.story_color.should == "000000"
+        expect(subject.story_color).to eq("000000")
       end
     end
   end

data/spec/pivotal_to_pdf/text_formatters/simple_markup_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+
+module PivotalToPdf
+  module TextFormatters
+    describe SimpleMarkup do
+      describe "#output" do
+        let(:formatter) {described_class.new "a text"}
+        context "when there is no special formatting" do
+          it "should return the string" do
+            expect(formatter.output).to eq("a text")
+          end
+        end
+        context "when there is bold special formatting" do
+          let(:formatter) {described_class.new "a *special test* text"}
+          it "should return the string converted" do
+            expect(formatter.output).to eq("a <b>special test</b> text")
+          end
+        end
+        context "when there is italic special formatting" do
+          let(:formatter) {described_class.new "a _special test_ text"}
+          it "should return the string converted" do
+            expect(formatter.output).to eq("a <i>special test</i> text")
+          end
+        end
+        context "when the text to format is nil" do
+          let(:formatter) {described_class.new nil}
+          it "should convert to an empty string" do
+            expect(formatter.output).to be_empty
+          end
+        end
+      end
+    end
+  end
+end

data/spec/pivotal_to_pdf/text_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+module PivotalToPdf
+  describe Text do
+    subject { Text.new "text" }
+
+    describe ".formatting_classes" do
+      it "returns formatting classes" do
+        expect(Text.formatting_classes).to eq(
+          [ TextFormatters::SimpleMarkup ]
+        )
+      end
+    end
+
+    describe "#==" do
+      context "when another text's string matches" do
+        it "is equal to the other" do
+          expect(subject).to eq(Text.new("text"))
+        end
+      end
+
+      context "when another text's string doesn't " do
+        it "is not equal to the other" do
+          expect(subject).not_to eq(Text.new("text2"))
+        end
+      end
+    end
+
+    describe "#hash" do
+      it "returns strig's hash value" do
+        expect(subject.hash).to eq("text".hash)
+      end
+    end
+
+    describe "#to_s" do
+      let(:formatter1) { double :formatter1, :output => "text2"}
+      let(:formatter2) { double :formatter2, :output => "text3"}
+      let(:klass1) { double :format_class1, :new => formatter1 }
+      let(:klass2) { double :format_class2, :new => formatter2 }
+
+      before(:each) do
+        Text.stub(:formatting_classes).and_return [klass1, klass2]
+      end
+      
+      it "asks each formatting class's output in order" do
+        klass1.should_receive(:new).with("text").and_return formatter1
+        klass2.should_receive(:new).with("text2").and_return formatter2
+        expect(subject.to_s).to eq("text3")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -3,23 +3,13 @@ require 'spork'
 require 'rspec/core'
 
 Spork.prefork do
-
+  Dir["#{File.dirname(__FILE__)}/support/**/*.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.expect_with :rspec do |c|
+      c.syntax = :expect
+    end
     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.
+    config.extend Macros
   end
 
 end
@@ -27,7 +17,6 @@ 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

data/spec/support/macros/it_converts_string_through_text_class_on.rb

@@ -0,0 +1,22 @@
+module Macros
+  def it_converts_string_through_text_class_on(*fields)
+    fields.each do |field|
+      describe "#formatted_#{field}" do
+        let(:text) { double :text, :to_s => "formatedd #{field}"}
+        before(:each) do
+          PivotalToPdf::Text.stub(:new).and_return text
+        end
+        
+        it "sends the string to Text class" do
+          PivotalToPdf::Text.should_receive(:new).with(subject.send(field)).and_return text
+          subject.send("formatted_#{field}")
+        end
+
+        it "returns Text.to_s" do
+          text.should_receive(:to_s).and_return "formatted #{field}"
+          expect(subject.send("formatted_#{field}")).to eq("formatted #{field}")
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pivotal_to_pdf
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-23 00:00:00.000000000 Z
+date: 2012-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pivotal_to_pdf-formatters
@@ -119,6 +119,7 @@ files:
 - .bundle/config
 - .gitignore
 - .pivotal.yml.sample
+- .rbenv-version
 - .rspec
 - .rvmrc
 - .travis.yml
@@ -136,17 +137,20 @@ files:
 - lib/pivotal_to_pdf/iteration.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/text.rb
+- lib/pivotal_to_pdf/text_formatters/simple_markup.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/text_formatters/simple_markup_spec.rb
+- spec/pivotal_to_pdf/text_spec.rb
 - spec/pivotal_to_pdf_bin_spec.rb
 - spec/pivotal_to_pdf_spec.rb
 - spec/spec_helper.rb
+- spec/support/macros/it_converts_string_through_text_class_on.rb
 - tasks/spec.rb
 homepage: https://github.com/ywen/pivotal_to_pdf
 licenses: []
@@ -175,8 +179,11 @@ 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/text_formatters/simple_markup_spec.rb
+- spec/pivotal_to_pdf/text_spec.rb
 - spec/pivotal_to_pdf_bin_spec.rb
 - spec/pivotal_to_pdf_spec.rb
 - spec/spec_helper.rb
+- spec/support/macros/it_converts_string_through_text_class_on.rb
+has_rdoc: 

data/lib/pivotal_to_pdf/simple_text_formatter.rb

@@ -1,13 +0,0 @@
-module PivotalToPdf
-  class SimpleTextFormatter
-    attr_reader :string
-    private :string
-    def initialize(string)
-      @string = string.to_s
-    end
-
-    def output
-      string.gsub( /\*(.*)\*/,"<b>\\1</b>").gsub(/_(.*)_/, "<i>\\1</i>")
-    end
-  end
-end

data/spec/pivotal_to_pdf/simple_text_formatter_spec.rb

@@ -1,32 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
-
-module PivotalToPdf
-  describe SimpleTextFormatter do
-    describe "#output" do
-      let(:formatter) {SimpleTextFormatter.new "a text"}
-      context "when there is no special formatting" do
-        it "should return the string" do
-          formatter.output.should == "a text"
-        end
-      end
-      context "when there is bold special formatting" do
-	let(:formatter) {SimpleTextFormatter.new "a *special test* text"}
-        it "should return the string converted" do
-          formatter.output.should == "a <b>special test</b> text"
-        end
-      end
-      context "when there is italic special formatting" do
-        let(:formatter) {SimpleTextFormatter.new "a _special test_ text"}
-        it "should return the string converted" do
-          formatter.output.should == "a <i>special test</i> text"
-        end
-      end
-      context "when the text to format is nil" do
-        let(:formatter) {SimpleTextFormatter.new nil}
-        it "should convert to an empty string" do
-          formatter.output.should be_empty
-        end
-      end
-    end
-  end
-end