pdf-storycards 0.0.1 → 0.1.0

data/History.txt

@@ -1,3 +1,10 @@
+== 0.1 / 2008-02-09
+
+* Reads stories from STDIN, writes PDF to STDOUT, makes for more Unix-friendly command line tool and more usable library class
+* Turned off munging of story narrative into a sentence by default
+* Introduced concept of metadata (colon-separated name value pairs) that are parsed out of tops of stories (before Story: ...) and the ability to specify metadata keys for the lower left and/or lower right of the cards -- the corresponding values will be printed there.
+* Added a real-world example script: printing cards from Thoughtworks Studio's Mingle. In examples/mingle_cards.rb.
+
 == 0.0.1 / 2007-12-27
 
 * Initial release

data/Manifest.txt

@@ -3,15 +3,24 @@ Manifest.txt
 README.txt
 Rakefile
 bin/stories2cards
+examples/mingle_cards.rb
 lib/pdf/storycards.rb
 lib/pdf/storycards/scenario.rb
 lib/pdf/storycards/story.rb
 lib/pdf/storycards/story_capturing_mediator.rb
+lib/pdf/storycards/story_parser.rb
+lib/pdf/storycards/text_file_filter.rb
 lib/pdf/storycards/writer.rb
 spec/addition
 spec/calculator_stories
+spec/calculator_stories_with_metadata
+spec/not_a_text_file.gif
+spec/not_a_text_file.jpg
 spec/pdf/storycards/story_capturing_mediator_spec.rb
+spec/pdf/storycards/story_parser_spec.rb
 spec/pdf/storycards/story_spec.rb
+spec/pdf/storycards/text_file_filter_spec.rb
 spec/pdf/storycards/writer_spec.rb
 spec/rspec_suite.rb
 spec/spec_helper.rb
+spec/subtraction_with_metadata

data/README.txt

@@ -1,24 +1,29 @@
 PDF StoryCards
-    by Luke Melia
-    http://www.lukemelia.com/
+    RDoc <http://pdf-storycards.rubyforge.org/>
+    Tracker <http://rubyforge.org/projects/pdf-storycards/>
+    by Luke Melia <http://www.lukemelia.com/>
 
 == DESCRIPTION:
   
-Provides a script and library to parses stories saved in the RSpec
-plain text story format and saves a PDF file with printable 3"x5"
-index cards suitable for using in agile planning and prioritization.
+Provides a script and library to parse stories saved in the RSpec
+plain text story format and creates a PDF file with printable 3"x5"
+index cards suitable for using in Agile planning and prioritization.
 
 == FEATURES/PROBLEMS:
   
 * Create a PDF with each page as a 3x5 sheet, or as 4 cards per 8.5 x 11 sheet
-* Currently reads stories from a single file.
-* TODO: Take a directory and find all stories in it
-* TODO: Take stories via STDIN
+* Included script reads stories from STDIN and writes PDF to STDOUT
 * TODO: Improve test coverage
+* TODO: Improve documentation
 
 == SYNOPSIS:
 
-  StorycardPdfWriter.make_pdf("/tmp/stories.txt", "/tmp/storycards.pdf", :style => :card_1up)
+  From the command line with
+    stories2cards < /path/to/stories.txt
+  
+  Or via Ruby
+    story_text = File.read('my_story')
+    pdf_content = PDF::Storycards::Writer.make_pdf(story_text, :style => :card_1up)
 
 == REQUIREMENTS:
 
@@ -27,13 +32,13 @@ index cards suitable for using in agile planning and prioritization.
 
 == INSTALL:
 
-sudo gem install storycards
+sudo gem install pdf-storycards
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2007 Luke Melia
+Copyright (c) 2007-2008 Luke Melia
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -13,11 +13,12 @@ Hoe.new('pdf-storycards', PDF::Storycards::VERSION) do |p|
   p.author = 'Luke Melia'
   p.email = 'luke@lukemelia.com'
   p.summary = 'Utilities for generating printable story cards for agile planning and measurement'
-  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
-  # p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.description = p.paragraphs_of('README.txt', 1..5).join("\n\n")
+  p.url = 'http://rubyforge.org/projects/pdf-storycards/'
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
   p.extra_deps << ['pdf-writer', '>= 1.1.7']
   p.extra_deps << ['rspec', '>= 1.1.1']
+  p.remote_rdoc_dir = '' # Release to root
 end
 
 # vim: syntax=Ruby

data/bin/stories2cards

@@ -9,31 +9,34 @@
 #   This command outputs a PDF consisting of one card for each story and
 #   narrative defined in stories.txt and saves it as stories.pdf
 #
-#     stories2cards stories.txt
+#     stories2cards < stories.txt
 #
 #   Other examples
 #
-#     stories2cards stories.txt -o /tmp/cards.pdf
-#     stories2cards stories.txt --style=4up
+#     stories2cards -o /tmp/cards.pdf < stories.txt
+#     stories2cards --style=4up < stories.txt 
 #
 # == Usage 
-#   stories2cards [options] text_file_with_stories
+#   stories2cards [options] < text_file_with_stories
 #
 #   For help use stories2cards -h
 #
 # == Options
 #   -h, --help           Displays help message
 #   -v, --version        Display the version, then exit
-#   -o, --output=PATH    Specify the path to the PDF file
-#                        to be created, defaults to storycards.pdf
+#   -o, --output=PATH    (optional) Specify the path to the PDF file
+#                        to be created, writes to stdout by default
 #   -s, --style=1up|4up  Defaults to 1up
-#   -b, --[no-]borders   Print borders (only has effect with 4up style
+#   -l, --lowerleft=key  (optional) MetaData key for value to be printed in lower left
+#   -r, --lowerright=key (optional) MetaData key for value to be printed in lower right
+#   -b, --[no-]borders   Print borders (only has effect with 4up style)
+#   -m, --makesentences, Make english narratives into sentences
 #
 # == Author
 #   Luke Melia
 #
 # == Copyright
-#   Copyright (c) 2007 Luke Melia. Licensed under the MIT License
+#   Copyright (c) 2007-2008 Luke Melia. Licensed under the MIT License
 #   http://www.opensource.org/licenses/mit-license.php
 
 require 'optparse' 
@@ -56,20 +59,21 @@ class App
 
   attr_reader :options
 
-  def initialize(arguments, stdin)
+  def initialize(arguments, stdin, stdout)
     @arguments = arguments
     @stdin = stdin
+    @stdout = stdout
 
     # Set defaults
     @options = OpenStruct.new
-    @options.output = "storycards.pdf"
     @options.style = :"1up"
   end
   
   # Parse options, check arguments, then process the command
    def run
      if parsed_options? && arguments_valid?
-       process_arguments            
+       process_arguments
+       @story_text = @stdin.read
        process_command
      else
        output_usage
@@ -86,7 +90,10 @@ class App
      opts.on('-h', '--help') { output_help }
      opts.on('-o', '--output [PATH]') { |path| @options.output = path }
      opts.on('-s', '--style [STYLE]', [:"1up", :"4up"]) { |style| @options.style = style }
-     opts.on("-b", "--[no-]borders", "Print borders") { |b| options.borders = b }
+     opts.on('-l', '--lowerleft [METADATA_KEY]') { |metadata_key| @options.lower_left = metadata_key }
+     opts.on('-r', '--lowerright [METADATA_KEY]') { |metadata_key| @options.lower_right = metadata_key }
+     opts.on("-b", "--[no-]borders", "Print borders") { |b| @options.borders = b }
+     opts.on('-m', '--makesentences', "Make english narratives into sentences") { |m| @options.make_sentences = m }
      opts.parse!(@arguments) rescue return false
 
      true      
@@ -94,14 +101,12 @@ class App
 
    # True if required arguments were provided
    def arguments_valid?
-     return false unless @arguments.length == 1
-     return false unless File.exists?(@arguments[0])
+     return false if @arguments.length > 0
      return true
    end
 
    # Setup the arguments
    def process_arguments
-     @source_file = @arguments[0]
    end
 
    def output_help
@@ -118,12 +123,18 @@ class App
    end
 
    def process_command
-     style = :card_1up if @options.style == :"1up"
-     style = :letter_4up if @options.style == :"4up"
-     PDF::Storycards::Writer.make_pdf(@source_file, @options.output, :style => style)
+     @options.style = :card_1up if @options.style == :"1up"
+     @options.style = :letter_4up if @options.style == :"4up"
+     options_as_hash = @options.instance_variable_get('@table')
+     pdf_text = PDF::Storycards::Writer.make_pdf(@story_text, options_as_hash)
+     if @options.output
+       File.open(@options.output, 'w') {|f| f.write(pdf_text) }
+     else
+       @stdout.print pdf_text
+     end
   end
-   end
+end
 
 # Create and run the application
-app = App.new(ARGV, STDIN)
+app = App.new(ARGV, $stdin, $stdout)
 app.run

data/examples/mingle_cards.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'active_record'
+require 'pdf/storycards'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "mysql",
+  :host     => "localhost",
+  :username => "root",
+  :password => "",
+  :database => "mingle"
+)
+
+target_sprint_number = 4
+
+class WeplayLaunchCard < ActiveRecord::Base
+end
+
+cards = WeplayLaunchCard.find(:all, :conditions => ["card_type_name = 'story' AND cp_target_sprint_number = ?", target_sprint_number], :order => 'cp_storyrank')
+stories = cards.collect do |card|
+  story = "CardNumber: #{card.number}\n"
+  story << "Estimate: #{card.cp_estimated_effort}\n\n" unless card.cp_estimated_effort.nil? 
+  story << "Story: #{card.name}\n\n"
+  story << "  #{card.description.gsub("\n","\n  ")}\n\n" unless card.description.nil?
+  story
+end
+story_text = stories.join(".\n")
+
+pdf_text = PDF::Storycards::Writer.make_pdf(story_text, :style => :letter_4up, :borders => true, :lower_left => 'Estimate', :lower_right => 'CardNumber')
+$stdout.print pdf_text

data/lib/pdf/storycards.rb

@@ -1,10 +1,12 @@
 module PDF
   module Storycards
-    VERSION = '0.0.1'
+    VERSION = '0.1.0'
   end
 end
 
+require 'pdf/storycards/text_file_filter'
 require 'pdf/storycards/scenario'
 require 'pdf/storycards/story'
 require 'pdf/storycards/story_capturing_mediator'
+require 'pdf/storycards/story_parser'
 require 'pdf/storycards/writer'

data/lib/pdf/storycards/story.rb

@@ -1,7 +1,10 @@
 module PDF
   module Storycards
+    # The string Story#narrative is imbued with a method called to_sentence, which formats the
+    # story narrative as a single sentence without newlines.
     class Story
       def initialize(title, narrative)
+        @meta_data = {}
         @title = title
         @narrative = narrative
         def @narrative.to_sentence
@@ -10,7 +13,8 @@ module PDF
         @scenarios = []
       end
   
-      attr_accessor :title, :narrative
+      attr_reader :title, :narrative
+      attr_accessor :meta_data
             
       def add_scenario(scenario)
         @scenarios << scenario

data/lib/pdf/storycards/story_capturing_mediator.rb

@@ -1,8 +1,5 @@
 # RSpec's story parser needs to be constructed with a Mediator. The mediator defined in the class
 # below simply collects stories and exposes the collection as StoryCapturingMediator#stories.
-#
-# It also sprinkles in a magic method on Story#narrative called to_sentence, which formats the
-# story narrative as a single sentence without newlines.
 module PDF
   module Storycards
 

data/lib/pdf/storycards/story_parser.rb

@@ -0,0 +1,41 @@
+module PDF
+  module Storycards
+    class StoryParser
+      
+      def parse_stories(story_text)
+        all_stories = []
+        story_groups = story_text.split(/^\.$/)
+        story_groups.each do |story_group|
+          all_stories << parse_story_group(story_group)
+        end
+        return all_stories.flatten
+      end
+      
+      def parse_story_group(story_text)
+        meta_data = extract_meta_data(story_text)
+        story_mediator = StoryCapturingMediator.new
+        rspec_story_parser = Spec::Story::Runner::StoryParser.new(story_mediator)
+        rspec_story_parser.parse(story_text.split("\n"))
+        stories = story_mediator.stories
+        stories.each do |story|
+          story.meta_data = meta_data
+        end
+        stories
+      end
+      
+      def extract_meta_data(story_text)
+        meta_data = {}
+        story_text.split("\n").each do |line|
+          match_data = /^([^ :]+):(.*)$/.match(line)
+          unless match_data.nil?
+            name = match_data[1].strip
+            value = match_data[2].strip
+            break if name == 'Story'
+            meta_data[name] = value
+          end
+        end
+        meta_data
+      end
+    end
+  end
+end

data/lib/pdf/storycards/text_file_filter.rb

@@ -0,0 +1,31 @@
+module PDF
+  module Storycards
+    class TextFileFilter
+      include Enumerable
+      
+      def initialize(*paths)
+        @paths = paths
+        @text_files = paths.select{|path| nonbinary?(path)}
+        @text_files.map!{ |path| Pathname.new(path).cleanpath.to_s }
+      end
+      
+      def each(&block)
+        @text_files.each(&block)
+      end
+      
+      private
+      
+      NON_ASCII_PRINTABLE = /[^\x20-\x7e\s]/
+
+      def nonbinary?(path, size = 1024)
+        open(path) do |io|
+          while buf = io.read(size)
+            return false if NON_ASCII_PRINTABLE =~ buf
+          end
+          return true
+        end
+      end
+      
+    end
+  end
+end

data/lib/pdf/storycards/writer.rb

@@ -5,12 +5,14 @@ module PDF
   module Storycards
     class Writer
     
-      def self.make_pdf( path, output_path = 'storycards.pdf', opts = {} )
-        output_path = 'storycards.pdf' if output_path.nil?
+      CARD_WIDTH = PDF::Writer.in2pts(5)
+      CARD_HEIGHT = PDF::Writer.in2pts(3)
+    
+      def self.make_pdf( story_text, opts )
         opts[:style] = :card_1up unless opts[:style]
-        opts[:border] = false unless opts[:border]
+        opts[:borders] = false unless opts[:borders]
   
-        stories = self.parse_stories(path)
+        stories = StoryParser.new.parse_stories(story_text)
   
         if opts[:style] == :card_1up
           pdf = PDF::Writer.new(:paper => [7.62, 12.7], :orientation => :landscape) #3x5 card
@@ -18,18 +20,16 @@ module PDF
           pdf.move_pointer(-60)
       
           stories.each_with_index do |story, index|
-            pdf.y = 0 if index > 0
-            print_card_text(pdf, story)
+            pdf.start_new_page if index > 0
+            print_card_corners(pdf, story, opts[:lower_left], opts[:lower_right], 0, 0)
+            print_card_text(pdf, story, 0, opts[:make_sentences])
           end
       
-          pdf.save_as(output_path)
-          return output_path
+          return pdf.render
       
         elsif opts[:style] == :letter_4up
       
           pdf = PDF::Writer.new(:paper => "LETTER", :orientation => :landscape)
-          card_width = PDF::Writer.in2pts(5)
-          card_height = PDF::Writer.in2pts(3)
           margin = PDF::Writer.in2pts(0.33)
           gutter = margin
           padding = 10
@@ -37,54 +37,64 @@ module PDF
           pdf.start_columns(2, gutter)
           stories.each_with_index do |story, index|
 
-            is_laying_out_left_hand_column = (index < 2)
+            is_laying_out_left_hand_column = (index % 4 < 2)
             if is_laying_out_left_hand_column
               rect_x = margin
             else
-              rect_x = pdf.page_width - margin - card_width
+              rect_x = pdf.page_width - margin - CARD_WIDTH
             end
 
             is_laying_out_top_row = (index % 2 == 0)
             if is_laying_out_top_row
               pdf.start_new_page unless index == 0
               pdf.y = pdf.page_height - margin - padding
-              rect_y = pdf.page_height - margin - card_height
+              rect_y = pdf.page_height - margin - CARD_HEIGHT
             else
               rect_y = margin
-              pdf.y = margin + card_height - padding
+              pdf.y = margin + CARD_HEIGHT - padding
             end
         
-            print_border(pdf, rect_x, rect_y, card_width, card_height) if opts[:border]
-            print_card_text(pdf, story, padding)
+            print_border(pdf, rect_x, rect_y) if opts[:borders]
+            print_card_corners(pdf, story, opts[:lower_left], opts[:lower_right], rect_x, rect_y)
+            print_card_text(pdf, story, padding, opts[:make_sentences])
           end
 
-          pdf.save_as(output_path)
-          return output_path
+          return pdf.render
       
+        else
+          raise "Unknown style: #{opts[:style]}"
         end
       end
       private
   
-      def self.print_border(pdf, x, y, width, height)
+      def self.print_border(pdf, x, y)
         pdf.stroke_color(Color::RGB::Black)
         pdf.stroke_style(PDF::Writer::StrokeStyle.new(1))
-        pdf.rectangle(rect_x, rect_y, card_width, card_height).close_stroke                                       
-      end
-  
-      def self.parse_stories(path)
-        story_mediator = StoryCapturingMediator.new
-        story_parser = Spec::Story::Runner::StoryParser.new(story_mediator)
-        story_text = File.read(path)
-        story_parser.parse(story_text.split("\n"))
-        return story_mediator.stories
+        pdf.rectangle(x, y, CARD_WIDTH, CARD_HEIGHT).close_stroke                                       
       end
-  
-      def self.print_card_text(pdf, story, padding = 0)
+
+      def self.print_card_text(pdf, story, padding = 0, make_sentences = false)
+        top = pdf.y
         pdf.text "<b>#{story.title}</b>", :font_size => 18, :justification => :center,
                                               :left => padding, :right => padding
         pdf.move_pointer(12)
-        pdf.text story.narrative.to_sentence, :justification => :left, :font_size => 14,
-                                              :left => padding, :right => padding      
+        narrative = story.narrative
+        narrative = narrative.to_sentence if make_sentences
+        pdf.text narrative, :justification => :left, :font_size => 14,
+                                              :left => padding, :right => padding
+      end
+      
+      def self.print_card_corners(pdf, story, lower_left_meta_data_key, lower_right_meta_data_key, card_x, card_y)
+        text_y = card_y + 16 + 8
+        text_width = CARD_WIDTH/2 - PDF::Writer.in2pts(0.4)
+        if story.meta_data[lower_left_meta_data_key]
+          text_x = card_x + PDF::Writer.in2pts(0.4)
+          pdf.add_text_wrap text_x, text_y, text_width, story.meta_data[lower_left_meta_data_key], 16, :left
+        end
+        if story.meta_data[lower_right_meta_data_key]
+          text_x = card_x + CARD_WIDTH/2
+          pdf.add_text_wrap text_x, text_y, text_width, story.meta_data[lower_right_meta_data_key], 16, :right
+        end
       end
     end
   end

data/spec/calculator_stories_with_metadata

@@ -0,0 +1,56 @@
+This is a story about a calculator. The text up here above the Story: declaration
+won't be processed, so you can write whatever you wish!
+
+CardNumber: 12
+Estimate: Very Easy
+
+Story: simple multiplication
+
+  As an accountant
+  I want to multiply numbers
+  So that I can count beans
+
+  Scenario: multiply one and one
+    Given a value of 1
+    And a multiplier of 1
+    
+    When the multiplier is applied to the value
+    
+    Then the product should be 1
+    And the corks should be popped
+  
+.
+CardNumber: 15
+Estimate: Very Hard
+
+Story: simple subtraction
+
+  As an accountant
+  I want to subtract numbers
+  So that I can count beans
+
+  Scenario: subtract one minus one
+    Given an argument of 1
+    And an argument of 1
+
+    When the second argument is subtracted from the first argument
+
+    Then the different should be 0
+    And the corks should be popped
+
+  Scenario: subtract two from five
+    Given an argument of 5
+    And an argument of 2
+
+    When the second argument is subtracted from the first argument
+
+    Then the difference should be 3
+    Then it should snow
+
+  Scenario: subtract two more
+    GivenScenario subtract two from five
+    And an argument of 2
+
+    When the result is reduced by the argument
+
+    Then the result should be 1

data/spec/pdf/storycards/story_parser_spec.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+module PDF
+  class Writer
+    def save_as(path)
+      #no op
+    end
+  end
+end
+
+describe PDF::Storycards::Writer do
+  
+  before(:all) do
+    @single_story_path = File.dirname(__FILE__) + '/../../addition'
+    @single_story_with_meta_data_path = File.dirname(__FILE__) + '/../../subtraction_with_metadata'
+    @multiple_stories_with_meta_data_path = File.dirname(__FILE__) + '/../../calculator_stories_with_metadata'
+  end
+  
+  it "should parse an example plain text story file and create a new story" do
+    story_text = File.read(@single_story_path)
+    stories = PDF::Storycards::StoryParser.new.parse_stories(story_text)
+    stories.first.title.should == 'simple addition'
+    stories.first.narrative.should == "As an accountant\nI want to add numbers\nSo that I can count beans"
+  end  
+  
+  it "should parse extract metadata from plain text story file and set it on the story" do
+    story_text = File.read(@single_story_with_meta_data_path)
+    stories = PDF::Storycards::StoryParser.new.parse_stories(story_text)
+    stories.first.meta_data['CardNumber'].should == '152'
+    stories.first.meta_data['Estimate'].should == 'Medium'
+  end  
+  
+  it "should treat a single . on a line as a separator between story groups" do
+    story_text = File.read(@multiple_stories_with_meta_data_path)
+    stories = PDF::Storycards::StoryParser.new.parse_stories(story_text)
+    stories.first.title.should == 'simple multiplication'
+    stories.first.meta_data['CardNumber'].should == '12'
+    stories.first.meta_data['Estimate'].should == 'Very Easy'
+    stories.last.title.should == 'simple subtraction'
+    stories.last.meta_data['CardNumber'].should == '15'
+    stories.last.meta_data['Estimate'].should == 'Very Hard'
+  end  
+end

data/spec/pdf/storycards/text_file_filter_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+require 'pathname'
+
+describe PDF::Storycards::TextFileFilter do
+  before(:all) do
+    @text_file_path_1 = File.dirname(__FILE__) + '/../../addition'
+    @text_file_clean_path_1 = Pathname.new(@text_file_path_1).cleanpath.to_s
+    @text_file_path_2 = File.dirname(__FILE__) + '/../../calculator_stories'
+    @non_text_file_path_1 = File.dirname(__FILE__) + '/../../not_a_text_file.jpg'
+    @non_text_file_clean_path_1 = Pathname.new(@non_text_file_path_1).cleanpath.to_s
+    @non_text_file_path_2 = File.dirname(__FILE__) + '/../../not_a_text_file.gif'
+    @directory = File.dirname(__FILE__) + '/../../../'
+  end
+    
+  it "should expose an empty collection when initialized with nothing" do
+    filter = PDF::Storycards::TextFileFilter.new()
+    filter.map.should == []
+  end
+  
+  it "should expose a collection of the clean path to one text file when initialized with only that text file" do
+    filter = PDF::Storycards::TextFileFilter.new(@text_file_path_1)
+    filter.map.should == [@text_file_clean_path_1]
+  end
+  
+  it "should expose an empty collection when initialized with a single non-text file" do
+    filter = PDF::Storycards::TextFileFilter.new(@non_text_file_path_1)
+    filter.map.should == []
+  end
+  
+end

data/spec/pdf/storycards/writer_spec.rb

@@ -11,28 +11,22 @@ end
 describe PDF::Storycards::Writer do
   
   before(:all) do
-    @single_story_path = File.dirname(__FILE__) + '/../../addition'
-    @multiple_stories_path = File.dirname(__FILE__) + '/../../calculator_stories'
-  end
-  
-  it "should parse an example plain text story file and create a new story" do
-    stories = PDF::Storycards::Writer.send(:parse_stories, @single_story_path)
-    stories.first.title.should == 'simple addition'
-    stories.first.narrative.should == "As an accountant\nI want to add numbers\nSo that I can count beans"
+    multiple_stories_path = File.dirname(__FILE__) + '/../../calculator_stories'
+    @story_text = File.read(multiple_stories_path)
   end
   
   it "should not print border when printing 1-up" do
     PDF::Storycards::Writer.should_not_receive(:print_border)
-    PDF::Storycards::Writer.make_pdf(@multiple_stories_path, 'storycards.pdf', :style => :card_1up)
+    PDF::Storycards::Writer.make_pdf(@story_text, :output => 'storycards.pdf', :style => :card_1up)
   end
 
   it "should not print border when printing 4-up with default options" do
     PDF::Storycards::Writer.should_not_receive(:print_border)
-    PDF::Storycards::Writer.make_pdf(@multiple_stories_path, 'storycards.pdf', :style => :letter_4up)
+    PDF::Storycards::Writer.make_pdf(@story_text, :output => 'storycards.pdf', :style => :letter_4up)
   end
 
   it "should print border when printing 4-up with border option set to true" do
     PDF::Storycards::Writer.should_receive(:print_border).twice
-    PDF::Storycards::Writer.make_pdf(@multiple_stories_path, 'storycards.pdf', :style => :letter_4up, :border => true)
+    PDF::Storycards::Writer.make_pdf(@story_text, :output => 'storycards.pdf', :style => :letter_4up, :borders => true)
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'stringio'
 require 'spec'
 require 'spec/mocks'

data/spec/subtraction_with_metadata

@@ -0,0 +1,40 @@
+This is a story about a calculator. The text up here above the Story: declaration
+won't be processed, so you can write whatever you wish!
+
+There is some metadata below. It's also above the Story: declaration, so it won't be
+processed by storyrunner, but pdf-storycards can work with it.
+
+CardNumber: 152
+Estimate: Medium
+
+Story: simple subtraction
+
+  As an accountant
+  I want to subtract numbers
+  So that I can count beans
+
+  Scenario: subtract one minus one
+    Given an argument of 1
+    And an argument of 1
+
+    When the second argument is subtracted from the first argument
+
+    Then the different should be 0
+    And the corks should be popped
+
+  Scenario: subtract two from five
+    Given an argument of 5
+    And an argument of 2
+
+    When the second argument is subtracted from the first argument
+
+    Then the difference should be 3
+    Then it should snow
+
+  Scenario: subtract two more
+    GivenScenario subtract two from five
+    And an argument of 2
+
+    When the result is reduced by the argument
+
+    Then the result should be 1

metadata

@@ -1,21 +1,80 @@
 --- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
 name: pdf-storycards
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
+date: 2008-02-10 00:00:00 -05:00
+summary: Utilities for generating printable story cards for agile planning and measurement
+require_paths: 
+- lib
+email: luke@lukemelia.com
+homepage: http://rubyforge.org/projects/pdf-storycards/
+rubyforge_project: pdf-storycards
+description: "== DESCRIPTION:  Provides a script and library to parse stories saved in the RSpec plain text story format and creates a PDF file with printable 3\"x5\" index cards suitable for using in Agile planning and prioritization.  == FEATURES/PROBLEMS:  * Create a PDF with each page as a 3x5 sheet, or as 4 cards per 8.5 x 11 sheet * Included script reads stories from STDIN and writes PDF to STDOUT * TODO: Improve test coverage * TODO: Improve documentation  == SYNOPSIS:  From the command line with stories2cards < /path/to/stories.txt  Or via Ruby story_text = File.read('my_story') pdf_content = PDF::Storycards::Writer.make_pdf(story_text, :style => :card_1up)  == REQUIREMENTS:"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
 platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
 authors: 
 - Luke Melia
-autorequire: 
-bindir: bin
-cert_chain: []
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/stories2cards
+- examples/mingle_cards.rb
+- lib/pdf/storycards.rb
+- lib/pdf/storycards/scenario.rb
+- lib/pdf/storycards/story.rb
+- lib/pdf/storycards/story_capturing_mediator.rb
+- lib/pdf/storycards/story_parser.rb
+- lib/pdf/storycards/text_file_filter.rb
+- lib/pdf/storycards/writer.rb
+- spec/addition
+- spec/calculator_stories
+- spec/calculator_stories_with_metadata
+- spec/not_a_text_file.gif
+- spec/not_a_text_file.jpg
+- spec/pdf/storycards/story_capturing_mediator_spec.rb
+- spec/pdf/storycards/story_parser_spec.rb
+- spec/pdf/storycards/story_spec.rb
+- spec/pdf/storycards/text_file_filter_spec.rb
+- spec/pdf/storycards/writer_spec.rb
+- spec/rspec_suite.rb
+- spec/spec_helper.rb
+- spec/subtraction_with_metadata
+test_files: []
+
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: 
+- stories2cards
+extensions: []
+
+requirements: []
 
-date: 2007-12-29 00:00:00 -05:00
-default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: pdf-writer
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -24,7 +83,7 @@ dependencies:
 - !ruby/object:Gem::Dependency 
   name: rspec
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -33,66 +92,9 @@ dependencies:
 - !ruby/object:Gem::Dependency 
   name: hoe
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.4.0
+        version: 1.5.0
     version: 
-description: "== FEATURES/PROBLEMS:  * Create a PDF with each page as a 3x5 sheet, or as 4 cards per 8.5 x 11 sheet * Currently reads stories from a single file. * TODO: Take a directory and find all stories in it * TODO: Take stories via STDIN * TODO: Improve test coverage  == SYNOPSIS:  StorycardPdfWriter.make_pdf(\"/tmp/stories.txt\", \"/tmp/storycards.pdf\", :style => :card_1up)  == REQUIREMENTS:"
-email: luke@lukemelia.com
-executables: 
-- stories2cards
-extensions: []
-
-extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
-files: 
-- History.txt
-- Manifest.txt
-- README.txt
-- Rakefile
-- bin/stories2cards
-- lib/pdf/storycards.rb
-- lib/pdf/storycards/scenario.rb
-- lib/pdf/storycards/story.rb
-- lib/pdf/storycards/story_capturing_mediator.rb
-- lib/pdf/storycards/writer.rb
-- spec/addition
-- spec/calculator_stories
-- spec/pdf/storycards/story_capturing_mediator_spec.rb
-- spec/pdf/storycards/story_spec.rb
-- spec/pdf/storycards/writer_spec.rb
-- spec/rspec_suite.rb
-- spec/spec_helper.rb
-has_rdoc: true
-homepage: http://www.zenspider.com/ZSS/Products/pdf-storycards/
-post_install_message: 
-rdoc_options: 
-- --main
-- README.txt
-require_paths: 
-- lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-requirements: []
-
-rubyforge_project: pdf-storycards
-rubygems_version: 1.0.1
-signing_key: 
-specification_version: 2
-summary: Utilities for generating printable story cards for agile planning and measurement
-test_files: []
-