prawn 0.11.1.pre → 0.11.1

data/lib/prawn/text/formatted/parser.rb

@@ -90,7 +90,7 @@ module Prawn
 
             string = hash[:text].gsub("&", "&amp;").gsub(">", "&gt;").gsub("<", "&lt;")
             prefix + string + suffix
-          end.join("")
+          end.join
         end
 
         def self.array_paragraphs(array) #:nodoc:
@@ -111,6 +111,7 @@ module Prawn
             end
           end
           paragraphs << paragraph unless paragraph.empty?
+          paragraphs
         end
 
         private

data/prawn.gemspec

@@ -1,12 +1,12 @@
 # Version numbering: http://wiki.github.com/sandal/prawn/development-roadmap
-PRAWN_VERSION = "0.11.1.pre" 
+PRAWN_VERSION = "0.11.1"
 
 Gem::Specification.new do |spec|
   spec.name = "prawn"
   spec.version = PRAWN_VERSION
   spec.platform = Gem::Platform::RUBY
   spec.summary = "A fast and nimble PDF generator for Ruby"
-  spec.files =  Dir.glob("{examples,lib,spec,vendor,data}/**/**/*") +
+  spec.files =  Dir.glob("{examples,lib,spec,data}/**/**/*") +
                       ["Rakefile", "prawn.gemspec"]
   spec.require_path = "lib"
   spec.required_ruby_version = '>= 1.8.7'
@@ -17,12 +17,28 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = %w{HACKING README LICENSE COPYING}
   spec.rdoc_options << '--title' << 'Prawn Documentation' <<
                        '--main'  << 'README' << '-q'
-  spec.author = "Gregory Brown"
-  spec.email = "  gregory.t.brown@gmail.com"
+  spec.authors = ["Gregory Brown","Brad Ediger","Daniel Nelson","Jonathen Greenberg","James Healy"]
+  spec.email = ["gregory.t.brown@gmail.com","brad@bradediger.com","dnelson@bluejade.com","greenberg@entryway.net","jimmy@deefa.com"]
   spec.rubyforge_project = "prawn"
-  spec.add_dependency('pdf-reader', '>=0.8.1')
+  spec.add_dependency('pdf-reader', '>=0.9.0')
+  spec.add_dependency('ttfunk', '~>1.0.0')
   spec.homepage = "http://prawn.majesticseacreature.com"
   spec.description = <<END_DESC
   Prawn is a fast, tiny, and nimble PDF generator for Ruby
+END_DESC
+  spec.post_install_message = <<END_DESC
+
+  ********************************************
+
+
+  A lot has changed since 0.8.4
+
+  Please read the changelog for details:
+
+  https://github.com/sandal/prawn/wiki/CHANGELOG
+
+
+  ********************************************
+
 END_DESC
 end

data/spec/bounding_box_spec.rb

@@ -9,26 +9,26 @@ describe "A bounding box" do
     @y      = 125
     @width  = 50
     @height = 75
-    @box = Prawn::Document::BoundingBox.new(nil, [@x,@y], :width  => @width,
-                                                          :height => @height )
+    @box = Prawn::Document::BoundingBox.new(nil, nil, [@x,@y],
+      :width  => @width, :height => @height )
   end
 
   it "should have an anchor at (x, y - height)" do
-    @box.anchor.should == [@x,@y-@height]           
+    @box.anchor.should == [@x,@y-@height]
   end
 
   it "should have a left boundary of 0" do
     @box.left.should == 0
   end
-  
+
   it "should have a right boundary equal to the width" do
     @box.right.should == @width
   end
-  
+
   it "should have a top boundary of height" do
     @box.top.should == @height
   end
-  
+
   it "should have a bottom boundary of 0" do
     @box.bottom.should == 0
   end
@@ -52,15 +52,15 @@ describe "A bounding box" do
   it "should have an absolute left boundary of x" do
     @box.absolute_left.should == @x
   end
-  
+
   it "should have an absolute right boundary of x + width" do
     @box.absolute_right.should == @x + @width
   end
-  
+
   it "should have an absolute top boundary of y" do
     @box.absolute_top.should == @y
   end
-  
+
   it "should have an absolute bottom boundary of y - height" do
     @box.absolute_bottom.should == @y - @height
   end
@@ -82,16 +82,16 @@ describe "A bounding box" do
   end
 
   it "should require width to be set" do
-    assert_raises(ArgumentError) do
-      Prawn::Document::BoundingBox.new(nil, [100,100])
-    end
+    lambda do
+      Prawn::Document::BoundingBox.new(nil, nil, [100,100])
+    end.should.raise(ArgumentError)
   end
 
 end
 
-describe "drawing bounding boxes" do    
-  
-  before(:each) { create_pdf }   
+describe "drawing bounding boxes" do
+
+  before(:each) { create_pdf }
 
   it "should restore the margin box when bounding box exits" do
     margin_box = @pdf.bounds
@@ -105,7 +105,7 @@ describe "drawing bounding boxes" do
   end
 
   it "should restore the parent bounding box when calls are nested" do
-    @pdf.bounding_box [100,500], :width => 300, :height => 300 do 
+    @pdf.bounding_box [100,500], :width => 300, :height => 300 do
 
       @pdf.bounds.absolute_top.should  == 500 + @pdf.margin_box.absolute_bottom
       @pdf.bounds.absolute_left.should == 100 + @pdf.margin_box.absolute_left
@@ -121,14 +121,14 @@ describe "drawing bounding boxes" do
       @pdf.bounds.absolute_left.should == 100 + @pdf.margin_box.absolute_left
 
     end
-  end   
-  
-  it "should calculate a height if none is specified" do 
+  end
+
+  it "should calculate a height if none is specified" do
     @pdf.bounding_box([100, 500], :width => 100) do
-      @pdf.text "The rain in Spain falls mainly on the plains." 
-    end     
-    
-    @pdf.y.should.be.close 458.384, 0.001 
+      @pdf.text "The rain in Spain falls mainly on the plains."
+    end
+
+    @pdf.y.should.be.close 458.384, 0.001
   end
 
   it "should keep track of the max height the box was stretched to" do
@@ -137,9 +137,9 @@ describe "drawing bounding boxes" do
       @pdf.move_up 15
     end
 
-    assert_equal 100, box.height
+    box.height.should == 100
   end
-  
+
 end
 
 describe "Indentation" do
@@ -175,16 +175,49 @@ describe "Indentation" do
     end
   end
 
+  it "should maintain left indentation across a page break" do
+    original_left = @pdf.bounds.absolute_left
+
+    @pdf.indent(20) do
+      @pdf.bounds.absolute_left.should == original_left + 20
+      @pdf.start_new_page
+      @pdf.bounds.absolute_left.should == original_left + 20
+    end
+
+    @pdf.bounds.absolute_left.should == original_left
+  end
+
+  it "should maintain right indentation across a page break" do
+    original_width = @pdf.bounds.width
+
+    @pdf.indent(0, 20) do
+      @pdf.bounds.width.should == original_width - 20
+      @pdf.start_new_page
+      @pdf.bounds.width.should == original_width - 20
+    end
+
+    @pdf.bounds.width.should == original_width
+  end
+
+  it "optionally allows adjustment of the right bound as well" do
+    @pdf.bounding_box([100,100], :width => 200) do
+      @pdf.indent(20, 30) do
+        @pdf.bounds.absolute_left.should == 120
+        @pdf.bounds.width.should == 150
+      end
+      @pdf.bounds.absolute_left.should == 100
+      @pdf.bounds.width.should == 200
+    end
+  end
 end
 
 describe "A canvas" do
   before(:each) { create_pdf }
-  
+
   it "should use whatever the last set y position is" do
     @pdf.canvas do
       @pdf.bounding_box([100,500],:width => 200) { @pdf.move_down 50 }
     end
     @pdf.y.should == 450
   end
-end      
-  
+end

data/spec/cell_spec.rb

@@ -34,10 +34,21 @@ describe "Prawn::Table::Cell" do
       @pdf.cell(:content => "text").should.be.a.kind_of Prawn::Table::Cell
     end
 
-    it "should generate an empty cell from nil content" do
-      c = @pdf.cell(:content => nil)
+    it "should convert nil, Numeric, and Date values to strings" do
+      [nil, 123, 123.45, Date.today].each do |value|
+        c = @pdf.cell(:content => value)
+        c.should.be.a.kind_of Prawn::Table::Cell::Text
+        c.content.should == value.to_s
+      end
+    end
+
+    it "should allow inline styling with a hash argument" do
+      # used for table([[{:text => "...", :font_style => :bold, ...}, ...]])
+      c = Prawn::Table::Cell.make(@pdf,
+                                  {:content => 'hello', :font_style => :bold})
       c.should.be.a.kind_of Prawn::Table::Cell::Text
-      c.content.should == ""
+      c.content.should == "hello"
+      c.font.name.should == 'Helvetica-Bold'
     end
 
     it "should draw text at the given point plus padding, with the given " +
@@ -50,7 +61,7 @@ describe "Prawn::Table::Cell" do
                 :at => [10, 20],
                 :padding => [30, 40],
                 :size => 7, 
-                :style => :bold)
+                :font_style => :bold)
     end
   end
   
@@ -65,6 +76,19 @@ describe "Prawn::Table::Cell" do
     end
   end
 
+  describe "#style" do
+    include CellHelpers
+
+    it "should set each property in turn" do
+      c = cell(:content => "text")
+
+      c.expects(:padding=).with(50)
+      c.expects(:size=).with(7)
+
+      c.style(:padding => 50, :size => 7)
+    end
+  end
+
   describe "cell width" do
     include CellHelpers
 
@@ -119,6 +143,21 @@ describe "Prawn::Table::Cell" do
         (5 * @pdf.height_of("text"))
     end
 
+    it "should defer min_width's evaluation of padding" do
+      c = cell(:content => "text", :padding => 100)
+      c.padding = 0
+
+      # Make sure we use the new value of padding in calculating min_width
+      c.min_width.should.be < 100
+    end
+
+    it "should defer min_width's evaluation of size" do
+      c = cell(:content => "text", :size => 50)
+      c.size = 8
+      c.padding = 0
+      c.min_width.should.be < 10
+    end
+
   end
 
   describe "cell height" do
@@ -224,12 +263,31 @@ describe "Prawn::Table::Cell" do
 
       @pdf.stubs(:fill_color)
       @pdf.expects(:fill_color).with('123456')
-      @pdf.expects(:fill_rectangle).with do |(x, y), w, h|
-        close?(x, 0) && close?(y, @pdf.cursor) && 
-          close?(w, 29.344) && close?(h, 23.872)
+      @pdf.expects(:fill_rectangle).checking do |(x, y), w, h|
+        x.should.be.close(0, 0.01)
+        y.should.be.close(@pdf.cursor, 0.01)
+        w.should.be.close(29.344, 0.01)
+        h.should.be.close(23.872, 0.01)
       end
       @pdf.cell(:content => "text", :background_color => '123456')
     end
+
+    it "should draw the background in the right place if cell is drawn at a " +
+       "different location" do
+      @pdf.stubs(:mask).yields
+      @pdf.expects(:mask).with(:fill_color).yields
+
+      @pdf.stubs(:fill_color)
+      @pdf.expects(:fill_color).with('123456')
+      @pdf.expects(:fill_rectangle).checking do |(x, y), w, h|
+        x.should.be.close(12.0, 0.01)
+        y.should.be.close(34.0, 0.01)
+        w.should.be.close(29.344, 0.01)
+        h.should.be.close(23.872, 0.01)
+      end
+      c = @pdf.make_cell(:content => "text", :background_color => '123456')
+      c.draw([12.0, 34.0])
+    end
   end
 
   describe "color" do
@@ -263,33 +321,94 @@ describe "Prawn::Table::Cell" do
     # do any FP closeness arithmetic. Can plug in that math later if this goes
     # wrong.
     it "should draw top border when requested" do
-      @pdf.expects(:stroke_line).with { |*from_and_to|
-        #                                  from: x  y to: x  y
-        from_and_to.flatten.map{|x| x.round} == [0, 720, 29, 720]
-      }
+      @pdf.expects(:stroke_line).checking do |from, to|
+        @pdf.map_to_absolute(from).map{|x| x.round}.should == [36, 756]
+        @pdf.map_to_absolute(to).map{|x| x.round}.should == [65, 756]
+      end
       @pdf.cell(:content => "text", :borders => [:top])
     end
 
     it "should draw bottom border when requested" do
-      @pdf.expects(:stroke_line).with { |*from_and_to|
-        from_and_to.flatten.map{|x| x.round} == [0, 696, 29, 696]
-      }
+      @pdf.expects(:stroke_line).checking do |from, to|
+        @pdf.map_to_absolute(from).map{|x| x.round}.should == [36, 732]
+        @pdf.map_to_absolute(to).map{|x| x.round}.should == [65, 732]
+      end
       @pdf.cell(:content => "text", :borders => [:bottom])
     end
 
     it "should draw left border when requested" do
-      @pdf.expects(:stroke_line).with { |*from_and_to|
-        from_and_to.flatten.map{|x| x.round} == [0, 721, 0, 696]
-      }
+      @pdf.expects(:stroke_line).checking do |from, to|
+        @pdf.map_to_absolute(from).map{|x| x.round}.should == [36, 756]
+        @pdf.map_to_absolute(to).map{|x| x.round}.should == [36, 732]
+      end
       @pdf.cell(:content => "text", :borders => [:left])
     end
 
     it "should draw right border when requested" do
-      @pdf.expects(:stroke_line).with { |*from_and_to|
-        from_and_to.flatten.map{|x| x.round} == [29, 721, 29, 696]
-      }
+      @pdf.expects(:stroke_line).checking do |from, to|
+        @pdf.map_to_absolute(from).map{|x| x.round}.should == [65, 756]
+        @pdf.map_to_absolute(to).map{|x| x.round}.should == [65, 732]
+      end
       @pdf.cell(:content => "text", :borders => [:right])
     end
+
+    it "should draw borders at the same location when in or out of bbox" do
+      @pdf.expects(:stroke_line).checking do |from, to|
+        @pdf.map_to_absolute(from).map{|x| x.round}.should == [36, 756]
+        @pdf.map_to_absolute(to).map{|x| x.round}.should == [65, 756]
+      end
+      @pdf.bounding_box([0, @pdf.cursor], :width => @pdf.bounds.width) do
+        @pdf.cell(:content => "text", :borders => [:top])
+      end
+    end
+
+    it "should set border color with :border_..._color" do
+      @pdf.ignores(:stroke_color=).with("000000")
+      @pdf.expects(:stroke_color=).with("ff0000")
+
+      c = @pdf.cell(:content => "text", :border_top_color => "ff0000")
+      c.border_top_color.should == "ff0000"
+      c.border_colors[0].should == "ff0000"
+    end
+
+    it "should set border colors with :border_color" do
+      @pdf.ignores(:stroke_color=).with("000000")
+      @pdf.expects(:stroke_color=).with("ff0000")
+      @pdf.expects(:stroke_color=).with("00ff00")
+      @pdf.expects(:stroke_color=).with("0000ff")
+      @pdf.expects(:stroke_color=).with("ff00ff")
+
+      c = @pdf.cell(:content => "text",
+        :border_color => %w[ff0000 00ff00 0000ff ff00ff])
+
+      c.border_colors.should == %w[ff0000 00ff00 0000ff ff00ff]
+    end
+
+    it "border_..._width should return 0 if border not selected" do
+      c = @pdf.cell(:content => "text", :borders => [:top])
+      c.border_bottom_width.should == 0
+    end
+
+    it "should set border width with :border_..._width" do
+      @pdf.ignores(:line_width=).with(1)
+      @pdf.expects(:line_width=).with(2)
+
+      c = @pdf.cell(:content => "text", :border_bottom_width => 2)
+      c.border_bottom_width.should == 2
+      c.border_widths[2].should == 2
+    end
+
+    it "should set border widths with :border_width" do
+      @pdf.ignores(:line_width=).with(1)
+      @pdf.expects(:line_width=).with(2)
+      @pdf.expects(:line_width=).with(3)
+      @pdf.expects(:line_width=).with(4)
+      @pdf.expects(:line_width=).with(5)
+
+      c = @pdf.cell(:content => "text",
+        :border_width => [2, 3, 4, 5])
+      c.border_widths.should == [2, 3, 4, 5]
+    end
   end
 
   describe "Text cell attributes" do
@@ -300,8 +419,22 @@ describe "Prawn::Table::Cell" do
 
       box = Prawn::Text::Box.new("text", :document => @pdf)
 
-      Prawn::Text::Box.expects(:new).with do |text, options|
-        text == "text" && options[:align] == :right
+      Prawn::Text::Box.expects(:new).checking do |text, options|
+        text.should == "text"
+        options[:align].should == :right
+      end.at_least_once.returns(box)
+
+      c.draw
+    end
+
+    it "should use font_style for Text::Box#style" do
+      c = cell(:content => "text", :font_style => :bold)
+
+      box = Prawn::Text::Box.new("text", :document => @pdf)
+
+      Prawn::Text::Box.expects(:new).checking do |text, options|
+        text.should == "text"
+        options[:style].should == :bold
       end.at_least_once.returns(box)
 
       c.draw
@@ -312,10 +445,15 @@ describe "Prawn::Table::Cell" do
 
       box = Prawn::Text::Formatted::Box.new([], :document => @pdf)
 
-      Prawn::Text::Formatted::Box.expects(:new).with do |array, options|
-        array[0][:text] == "foo " && array[0][:styles] == [] &&
-          array[1][:text] == "bar" && array[1][:styles] == [:bold] &&
-          array[2][:text] == " baz" && array[2][:styles] == []
+      Prawn::Text::Formatted::Box.expects(:new).checking do |array, options|
+        array[0][:text].should == "foo "
+        array[0][:styles].should == []
+
+        array[1][:text].should == "bar"
+        array[1][:styles].should == [:bold]
+
+        array[2][:text].should == " baz"
+        array[2][:styles].should == []
       end.at_least_once.returns(box)
 
       c.draw
@@ -326,9 +464,9 @@ describe "Prawn::Table::Cell" do
   describe "Font handling" do
     include CellHelpers
 
-    it "should allow only :style to be specified, defaulting to the" +
+    it "should allow only :font_style to be specified, defaulting to the " +
        "document's font" do
-      c = cell(:content => "text", :style => :bold)
+      c = cell(:content => "text", :font_style => :bold)
       c.font.name.should == 'Helvetica-Bold'
     end
 
@@ -339,7 +477,7 @@ describe "Prawn::Table::Cell" do
 
     it "should allow style to be changed after initialize" do
       c = cell(:content => "text")
-      c.style = :bold
+      c.font_style = :bold
       c.font.name.should == 'Helvetica-Bold'
     end
 
@@ -350,7 +488,7 @@ describe "Prawn::Table::Cell" do
 
     it "should use the metrics of the selected font (even if it is a variant " +
        "of the document's font) to calculate width" do
-      c = cell(:content => "text", :style => :bold)
+      c = cell(:content => "text", :font_style => :bold)
       font = @pdf.find_font('Helvetica-Bold')
       c.content_width.should == font.compute_width_of("text")
     end