prawn 0.8.4 → 0.11.1.pre

data/spec/grid_spec.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper") 
+
+describe "A document's grid" do
+  before do
+    @pdf = Prawn::Document.new
+  end
+  
+  it "should allow definition of a grid" do
+    @pdf.define_grid(:columns => 5, :rows => 8, :gutter => 0.1)
+    @pdf.grid.columns.should == 5
+    @pdf.grid.rows.should == 8
+    @pdf.grid.gutter.should == 0.1
+  end
+  
+  describe "when a grid is defined" do
+    before do
+      @num_columns = 5
+      @num_rows = 8
+      @gutter = 10.0
+      @pdf.define_grid(
+        :columns => @num_columns, 
+        :rows => @num_rows, 
+        :gutter => @gutter
+      )
+    end
+    
+    it "should compute the column width" do
+      (@pdf.grid.column_width * @num_columns.to_f + 
+        @gutter * (@num_columns - 1).to_f).should == @pdf.bounds.width
+    end
+    
+    it "should compute the row height" do
+      (@pdf.grid.row_height * @num_rows.to_f + 
+        @gutter * (@num_rows - 1).to_f).should == @pdf.bounds.height
+    end
+
+    it "should give the edges of a grid box" do
+      grid_width = (@pdf.bounds.width.to_f - 
+        (@gutter * (@num_columns - 1).to_f )) / @num_columns.to_f
+      grid_height = (@pdf.bounds.height.to_f - 
+        (@gutter * (@num_rows - 1).to_f ))/ @num_rows.to_f
+      
+      exp_tl_x = (grid_width + @gutter.to_f) * 4.0
+      exp_tl_y = @pdf.bounds.height.to_f - (grid_height + @gutter.to_f)
+
+      @pdf.grid(1,4).top_left.should      == [exp_tl_x, exp_tl_y]
+      @pdf.grid(1,4).top_right.should     == [exp_tl_x + grid_width, exp_tl_y]
+      @pdf.grid(1,4).bottom_left.should   == [exp_tl_x, exp_tl_y - grid_height]
+      @pdf.grid(1,4).bottom_right.should  == [exp_tl_x + grid_width, exp_tl_y - grid_height]
+    end
+
+    it "should give the edges of a multiple grid boxes" do
+      # Hand verified.  Cheating a bit.  Don't tell.
+      @pdf.grid([1,3], [2,5]).top_left.should     == [330.0, 628.75]
+      @pdf.grid([1,3], [2,5]).top_right.should    == [650.0, 628.75]
+      @pdf.grid([1,3], [2,5]).bottom_left.should  == [330.0, 456.25]
+      @pdf.grid([1,3], [2,5]).bottom_right.should == [650.0, 456.25]
+    end
+
+    it "should draw outlines without changing global default colors to grid color" do
+      @pdf.grid.show_all('cccccc')
+
+      colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render)
+      colors.fill_color.should.not   == [0.8,0.8,0.8]
+      colors.stroke_color.should.not == [0.8,0.8,0.8]
+      
+      # Hardcoded default color as I haven't been able to come up with a stable converter
+      # between fill_color without lots code.
+      colors.fill_color.should   == [0.0,0.0,0.0]
+      colors.stroke_color.should == [0.0,0.0,0.0]
+    end
+
+    it "should draw outlines without curent color settings" do
+      @pdf.fill_color "ccff00"
+      @pdf.stroke_color "ffcc00"
+
+      @pdf.grid.show_all
+
+      colors = PDF::Inspector::Graphics::Color.analyze(@pdf.render)
+      colors.fill_color.should   == [0.8,1.0,0.0]
+      colors.stroke_color.should == [1.0,0.8,0.0]
+    end
+  end
+end

data/spec/images_spec.rb

@@ -0,0 +1,117 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")  
+
+describe "the image() function" do
+
+  before(:each) do
+    @filename = "#{Prawn::BASEDIR}/data/images/pigs.jpg" 
+    create_pdf
+  end
+
+  it "should only embed an image once, even if it's added multiple times" do
+    @pdf.image @filename, :at => [100,100]
+    @pdf.image @filename, :at => [300,300]
+           
+    output = @pdf.render
+    images = PDF::Inspector::XObject.analyze(output)
+    # there should be 2 images in the page resources
+    images.page_xobjects.first.size.should == 2
+    # but only 1 image xobject
+    output.scan(/\/Type \/XObject/).size.should == 1
+  end  
+  
+  it "should return the image info object" do
+    info =  @pdf.image(@filename)
+    
+    info.should.be.kind_of(Prawn::Images::JPG)
+    
+    info.height.should == 453
+  end
+  
+  it "should accept IO objects" do
+    file = File.open(@filename, "rb")
+    info = @pdf.image(file)
+    
+    info.height.should == 453
+  end
+
+  it "should raise an UnsupportedImageType if passed a BMP" do
+    filename = "#{Prawn::BASEDIR}/data/images/tru256.bmp"
+    lambda { @pdf.image filename, :at => [100,100] }.should.raise(Prawn::Errors::UnsupportedImageType)
+  end
+
+  it "should raise an UnsupportedImageType if passed an interlaced PNG" do
+    filename = "#{Prawn::BASEDIR}/data/images/dice_interlaced.png"
+    lambda { @pdf.image filename, :at => [100,100] }.should.raise(Prawn::Errors::UnsupportedImageType)
+  end
+
+  it "should bump PDF version to 1.5 or greater on embedding 16-bit PNGs" do
+    @pdf.image "#{Prawn::BASEDIR}/data/images/16bit.png"
+    @pdf.state.version.should >= 1.5
+  end
+
+  # to support Adobe Reader, which apparently doesn't handle 16-bit alpha
+  # channels. Verified experimentally [BE] but not confirmed in documentation
+  # or anything. OS X Preview handles those files just fine.
+  #
+  it "should embed 8-bit alpha channels for 16-bit PNGs" do
+    @pdf.image "#{Prawn::BASEDIR}/data/images/16bit.png"
+
+    output = @pdf.render
+    output.should =~ /\/BitsPerComponent 16/
+    output.should =~ /\/BitsPerComponent 8/
+  end
+  
+  it "should flow an image to a new page if it will not fit on a page" do
+    @pdf.image @filename, :fit => [600, 600]
+    @pdf.image @filename, :fit => [600, 600]
+    output = StringIO.new(@pdf.render, 'r+')
+    hash = PDF::Hash.new(output)
+    pages = hash.values.find {|obj| obj.is_a?(Hash) && obj[:Type] == :Pages}[:Kids]
+    pages.size.should == 2 
+    hash[pages[0]][:Resources][:XObject].keys.should == [:I1]
+    hash[pages[1]][:Resources][:XObject].keys.should == [:I2]
+  end 
+  
+  it "should not flow an image to a new page if it will fit on one page" do
+    @pdf.image @filename, :fit => [400, 400]
+    @pdf.image @filename, :fit => [400, 400]
+    output = StringIO.new(@pdf.render, 'r+')
+    hash = PDF::Hash.new(output)
+    pages = hash.values.find {|obj| obj.is_a?(Hash) && obj[:Type] == :Pages}[:Kids]
+    pages.size.should == 1 
+    hash[pages[0]][:Resources][:XObject].keys.should == [:I1, :I2] 
+  end
+  
+  describe ":fit option" do
+    it "should fit inside the defined constraints" do
+      info = @pdf.image @filename, :fit => [100,400]
+      info.scaled_width.should <= 100
+      info.scaled_height.should <= 400
+
+      info = @pdf.image @filename, :fit => [400,100]
+      info.scaled_width.should <= 400
+      info.scaled_height.should <= 100
+
+      info = @pdf.image @filename, :fit => [604,453]
+      info.scaled_width.should == 604
+      info.scaled_height.should == 453
+    end
+    it "should move text position" do
+      @y = @pdf.y
+      info = @pdf.image @filename, :fit => [100,400]
+      @pdf.y.should < @y
+    end
+  end
+
+  describe ":at option" do
+    it "should not move text position" do
+      @y = @pdf.y
+      info = @pdf.image @filename, :at => [100,400]
+      @pdf.y.should == @y
+    end
+  end
+
+end
+

data/spec/inline_formatted_text_parser_spec.rb

@@ -0,0 +1,502 @@
+# -*- coding: utf-8 -*-
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "Text::Formatted::Parser#to_array" do
+  it "should handle sup" do
+    string = "<sup>superscript</sup>"
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+    array[0].should == { :text => "superscript",
+                         :styles => [:superscript],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+  end
+  it "should handle sub" do
+    string = "<sub>subscript</sub>"
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+    array[0].should == { :text => "subscript",
+                         :styles => [:subscript],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+  end
+  it "should handle rgb" do
+    string = "<color rgb='#ff0000'>red text</color>"
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+    array[0].should == { :text => "red text",
+                         :styles => [],
+                         :color => "ff0000",
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+  end
+  it "# should be optional in rgb" do
+    string = "<color rgb='ff0000'>red text</color>"
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+    array[0].should == { :text => "red text",
+                         :styles => [],
+                         :color => "ff0000",
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+  end
+  it "should handle cmyk" do
+    string = "<color c='0' m='100' y='0' k='0'>magenta text</color>"
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+    array[0].should == { :text => "magenta text",
+                         :styles => [],
+                         :color => [0, 100, 0, 0],
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+  end
+  it "should handle fonts" do
+    string = "<font name='Courier'>Courier text</font>"
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+    array[0].should == { :text => "Courier text",
+                         :styles => [],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => "Courier",
+                         :size => nil,
+                         :character_spacing => nil }
+  end
+  it "should handle size" do
+    string = "<font size='14'>14 point text</font>"
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+    array[0].should == { :text => "14 point text",
+                         :styles => [],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => 14,
+                         :character_spacing => nil }
+  end
+  it "should handle character_spacing" do
+    string = "<font character_spacing='2.5'>extra character spacing</font>"
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+    array[0].should == { :text => "extra character spacing",
+                         :styles => [],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => 2.5 }
+  end
+  it "should handle links" do
+    string = "<link href='http://example.com'>external link</link>"
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+    array[0].should == { :text => "external link",
+                         :styles => [],
+                         :color => nil,
+                         :link => "http://example.com",
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+  end
+  it "should handle anchors" do
+    string = "<link anchor='ToC'>internal link</link>"
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+    array[0].should == { :text => "internal link",
+                         :styles => [],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => "ToC",
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+  end
+  it "should handle higher order characters properly" do
+    string = "<b>©\n©</b>"
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+    array[0].should == { :text => "©",
+                         :styles => [:bold],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+    array[1].should == { :text => "\n",
+                         :styles => [:bold],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+    array[2].should == { :text => "©",
+                         :styles => [:bold],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+  end
+  it "should convert &lt; &gt;, and &amp; to <, >, and &, respectively" do
+    string = "hello <b>&lt;, &gt;, and &amp;</b>"
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+    array[1].should == { :text => "<, >, and &",
+                         :styles => [:bold],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+  end
+  it "should handle double qoutes around tag attributes" do
+    string = 'some <font size="14">sized</font> text'
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+    array[1].should == { :text => "sized",
+                         :styles => [],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => 14,
+                         :character_spacing => nil }
+  end
+  it "should handle single qoutes around tag attributes" do
+    string = "some <font size='14'>sized</font> text"
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+    array[1].should == { :text => "sized",
+                         :styles => [],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => 14,
+                         :character_spacing => nil }
+  end
+  it "should construct a formatted text array from a string" do
+    string = "hello <b>world\nhow <i>are</i></b> you?"
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+
+    array[0].should == { :text => "hello ",
+                         :styles => [],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+    array[1].should == { :text => "world",
+                         :styles => [:bold],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+    array[2].should == { :text => "\n",
+                         :styles => [:bold],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+    array[3].should == { :text => "how ",
+                         :styles => [:bold],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+    array[4].should == { :text => "are",
+                         :styles => [:bold, :italic],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+    array[5].should == { :text => " you?",
+                         :styles => [],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+  end
+  it "should accept <strong> as an alternative to <b>" do
+    string = "<strong>bold</strong> not bold"
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+
+    array[0].should == { :text => "bold",
+                         :styles => [:bold],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+    array[1].should == { :text => " not bold",
+                         :styles => [],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+  end
+  it "should accept <em> as an alternative to <i>" do
+    string = "<em>italic</em> not italic"
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+
+    array[0].should == { :text => "italic",
+                         :styles => [:italic],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+    array[1].should == { :text => " not italic",
+                         :styles => [],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+  end
+  it "should accept <a> as an alternative to <link>" do
+    string = "<a href='http://example.com'>link</a> not a link"
+    array = Prawn::Text::Formatted::Parser.to_array(string)
+
+    array[0].should == { :text => "link",
+                         :styles => [],
+                         :color => nil,
+                         :link => "http://example.com",
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+    array[1].should == { :text => " not a link",
+                         :styles => [],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+  end
+end
+
+
+describe "Text::Formatted::Parser#to_string" do
+  it "should handle sup" do
+    string = "<sup>superscript</sup>"
+    array = [{ :text => "superscript",
+                         :styles => [:superscript],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }]
+    Prawn::Text::Formatted::Parser.to_string(array).should == string
+  end
+  it "should handle sub" do
+    string = "<sub>subscript</sub>"
+    array = [{ :text => "subscript",
+                         :styles => [:subscript],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }]
+    Prawn::Text::Formatted::Parser.to_string(array).should == string
+  end
+  it "should handle rgb" do
+    string = "<color rgb='ff0000'>red text</color>"
+    array = [{ :text => "red text",
+                         :styles => [],
+                         :color => "ff0000",
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }]
+    Prawn::Text::Formatted::Parser.to_string(array).should == string
+  end
+  it "should handle cmyk" do
+    string = "<color c='0' m='100' y='0' k='0'>magenta text</color>"
+    array = [{ :text => "magenta text",
+                         :styles => [],
+                         :color => [0, 100, 0, 0],
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }]
+    Prawn::Text::Formatted::Parser.to_string(array).should == string
+  end
+  it "should handle fonts" do
+    string = "<font name='Courier'>Courier text</font>"
+    array = [{ :text => "Courier text",
+                         :styles => [],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => "Courier",
+                         :size => nil,
+                         :character_spacing => nil }]
+    Prawn::Text::Formatted::Parser.to_string(array).should == string
+  end
+  it "should handle size" do
+    string = "<font size='14'>14 point text</font>"
+    array = [{ :text => "14 point text",
+                         :styles => [],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => 14,
+                         :character_spacing => nil }]
+    Prawn::Text::Formatted::Parser.to_string(array).should == string
+  end
+  it "should handle character spacing" do
+    string = "<font character_spacing='2.5'>2.5 extra character spacing</font>"
+    array = [{ :text => "2.5 extra character spacing",
+                         :styles => [],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => 2.5 }]
+    Prawn::Text::Formatted::Parser.to_string(array).should == string
+  end
+  it "should handle links" do
+    array = [{ :text => "external link",
+               :styles => [],
+               :color => nil,
+               :link => "http://example.com",
+               :anchor => nil,
+               :font => nil,
+               :size => nil,
+               :character_spacing => nil }]
+    string = "<link href='http://example.com'>external link</link>"
+    Prawn::Text::Formatted::Parser.to_string(array).should == string
+  end
+  it "should handle anchors" do
+    array = [{ :text => "internal link",
+               :styles => [],
+               :color => nil,
+               :link => nil,
+               :anchor => "ToC",
+               :font => nil,
+               :size => nil,
+               :character_spacing => nil }]
+    string = "<link anchor='ToC'>internal link</link>"
+    Prawn::Text::Formatted::Parser.to_string(array).should == string
+  end
+  it "should convert <, >, and & to &lt; &gt;, and &amp;, respectively" do
+    array = [{ :text => "hello ",
+               :styles => [],
+               :color => nil,
+               :link => nil,
+               :font => nil,
+               :size => nil,
+               :character_spacing => nil },
+            { :text => "<, >, and &",
+               :styles => [:bold],
+               :color => nil,
+               :link => nil,
+               :font => nil,
+               :size => nil,
+               :character_spacing => nil }]
+    string = "hello <b>&lt;, &gt;, and &amp;</b>"
+    Prawn::Text::Formatted::Parser.to_string(array).should == string
+  end
+  it "should construct an HTML-esque string from a formatted" +
+    " text array" do
+    array = [
+             { :text => "hello ",
+               :styles => [],
+               :color => nil,
+               :link => nil,
+               :font => nil,
+               :size => 14,
+               :character_spacing => nil },
+             { :text => "world",
+               :styles => [:bold],
+               :color => nil,
+               :link => nil,
+               :font => nil,
+               :size => nil,
+               :character_spacing => nil },
+             { :text => "\n",
+               :styles => [:bold],
+               :color => nil,
+               :link => nil,
+               :font => nil,
+               :size => nil,
+               :character_spacing => nil },
+             { :text => "how ",
+               :styles => [:bold],
+               :color => nil,
+               :link => nil,
+               :font => nil,
+               :size => nil,
+               :character_spacing => nil },
+             { :text => "are",
+               :styles => [:bold, :italic],
+               :color => nil,
+               :link => nil,
+               :font => nil,
+               :size => nil,
+               :character_spacing => nil },
+             { :text => " you?",
+               :styles => [],
+               :color => nil,
+               :link => nil,
+               :font => nil,
+               :size => nil,
+               :character_spacing => nil }
+             ]
+    string = "<font size='14'>hello </font><b>world</b><b>\n</b><b>how </b><b><i>are</i></b> you?"
+    Prawn::Text::Formatted::Parser.to_string(array).should == string
+  end
+end
+
+describe "Text::Formatted::Parser#array_paragraphs" do
+  it "should group fragments separated by newlines" do
+    array = [{ :text => "\nhello\nworld" },
+             { :text => "\n\n" },
+             { :text => "how" },
+             { :text => "are" },
+             { :text => "you" }]
+    target = [[{ :text => "\n"}],
+              [{ :text => "hello" }],
+              [{ :text => "world" }],
+              [{ :text => "\n"}],
+              [{ :text => "how" },
+               { :text => "are" },
+               { :text => "you" }]]
+    Prawn::Text::Formatted::Parser.array_paragraphs(array).should == target
+  end
+end