prawn 1.0.0.rc2 → 1.0.0

data/spec/grid_spec.rb

@@ -1,46 +1,57 @@
 # encoding: utf-8
-require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper") 
+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
-  
+
+  it "should allow re-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
+    @pdf.define_grid(:columns => 3, :rows => 6, :gutter => 0.1)
+    @pdf.grid.columns.should == 3
+    @pdf.grid.rows.should == 6
+    @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, 
+        :columns => @num_columns,
+        :rows => @num_rows,
         :gutter => @gutter
       )
     end
-    
+
     it "should compute the column width" do
-      (@pdf.grid.column_width * @num_columns.to_f + 
+      (@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 + 
+      (@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 - 
+      grid_width = (@pdf.bounds.width.to_f -
         (@gutter * (@num_columns - 1).to_f )) / @num_columns.to_f
-      grid_height = (@pdf.bounds.height.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)
 
@@ -64,7 +75,7 @@ describe "A document's grid" do
       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]

data/spec/image_handler_spec.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "ImageHandler" do
+  let(:image_handler) { Prawn::ImageHandler.new }
+
+  let(:handler_a) { mock("Handler A") }
+  let(:handler_b) { mock("Handler B") }
+
+  it "finds the image handler for an image" do
+    handler_a.expects(:can_render? => true)
+
+    image_handler.register(handler_a)
+    image_handler.register(handler_b)
+
+    handler = image_handler.find("arbitrary blob")
+    handler.should == handler_a
+  end
+
+  it "can prepend handlers" do
+    handler_b.expects(:can_render? => true)
+
+    image_handler.register(handler_a)
+    image_handler.register!(handler_b)
+
+    handler = image_handler.find("arbitrary blob")
+    handler.should == handler_b
+  end
+
+  it "can unregister a handler" do
+    handler_b.expects(:can_render? => true)
+
+    image_handler.register(handler_a)
+    image_handler.register(handler_b)
+
+    image_handler.unregister(handler_a)
+
+    handler = image_handler.find('arbitrary blob')
+    handler.should == handler_b
+  end
+
+  it "raises an error when no matching handler is found" do
+    handler_a.expects(:can_render? => false)
+    handler_b.expects(:can_render? => false)
+
+    image_handler.register(handler_a)
+    image_handler.register(handler_b)
+
+    expect { image_handler.find("arbitrary blob") }.
+       to(raise_error(Prawn::Errors::UnsupportedImageType))
+  end
+
+end

data/spec/images_spec.rb

@@ -1,40 +1,40 @@
 # encoding: utf-8
 
-require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")  
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
 require 'set'
 require 'pathname'
 
 describe "the image() function" do
 
   before(:each) do
-    @filename = "#{Prawn::DATADIR}/images/pigs.jpg" 
+    @filename = "#{Prawn::DATADIR}/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  
-  
+  end
+
   it "should return the image info object" do
     info =  @pdf.image(@filename)
-    
+
     info.should be_a_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
 
@@ -51,6 +51,23 @@ describe "the image() function" do
     info.height.should == 453
   end
 
+  context "setting the length of the bytestream" do
+    it "should correctly work with images from Pathname objects" do
+      info = @pdf.image(Pathname.new(@filename))
+      expect(@pdf).to have_parseable_xobjects
+    end
+
+    it "should correctly work with images from IO objects" do
+      info = @pdf.image(File.open(@filename, 'rb'))
+      expect(@pdf).to have_parseable_xobjects
+    end
+
+    it "should correctly work with images from IO objects not set to mode rb" do
+      info = @pdf.image(File.open(@filename, 'r'))
+      expect(@pdf).to have_parseable_xobjects
+    end
+  end
+
   it "should raise_error an UnsupportedImageType if passed a BMP" do
     filename = "#{Prawn::DATADIR}/images/tru256.bmp"
     lambda { @pdf.image filename, :at => [100,100] }.should raise_error(Prawn::Errors::UnsupportedImageType)
@@ -66,36 +83,32 @@ describe "the image() function" do
     @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
+  it "should embed 16-bit alpha channels for 16-bit PNGs" do
     @pdf.image "#{Prawn::DATADIR}/images/16bit.png"
 
     output = @pdf.render
     output.should =~ /\/BitsPerComponent 16/
-    output.should =~ /\/BitsPerComponent 8/
+    output.should_not =~ /\/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::Reader::ObjectHash.new(output)
     pages = hash.values.find {|obj| obj.is_a?(Hash) && obj[:Type] == :Pages}[:Kids]
-    pages.size.should == 2 
+    pages.size.should == 2
     hash[pages[0]][:Resources][:XObject].keys.should == [:I1]
     hash[pages[1]][:Resources][:XObject].keys.should == [:I2]
-  end 
-  
+  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::Reader::ObjectHash.new(output)
     pages = hash.values.find {|obj| obj.is_a?(Hash) && obj[:Type] == :Pages}[:Kids]
-    pages.size.should == 1 
+    pages.size.should == 1
     Set.new(hash[pages[0]][:Resources][:XObject].keys).should ==
       Set.new([:I1, :I2])
   end
@@ -106,7 +119,7 @@ describe "the image() function" do
       @pdf.image @filename
     end
   end
-  
+
   describe ":fit option" do
     it "should fit inside the defined constraints" do
       info = @pdf.image @filename, :fit => [100,400]

data/spec/inline_formatted_text_parser_spec.rb

@@ -1,135 +1,159 @@
 # -*- coding: utf-8 -*-
 require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
 
-describe "Text::Formatted::Parser#to_array" do
+describe "Text::Formatted::Parser#format" do
   it "should handle sup" do
     string = "<sup>superscript</sup>"
-    array = Prawn::Text::Formatted::Parser.to_array(string)
+    array = Prawn::Text::Formatted::Parser.format(string)
     array[0].should == { :text => "superscript",
                          :styles => [:superscript],
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => 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 = Prawn::Text::Formatted::Parser.format(string)
     array[0].should == { :text => "subscript",
                          :styles => [:subscript],
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => 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 = Prawn::Text::Formatted::Parser.format(string)
     array[0].should == { :text => "red text",
                          :styles => [],
                          :color => "ff0000",
                          :link => nil,
                          :anchor => nil,
+                         :local => 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 = Prawn::Text::Formatted::Parser.format(string)
     array[0].should == { :text => "red text",
                          :styles => [],
                          :color => "ff0000",
                          :link => nil,
                          :anchor => nil,
+                         :local => 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 = Prawn::Text::Formatted::Parser.format(string)
     array[0].should == { :text => "magenta text",
                          :styles => [],
                          :color => [0, 100, 0, 0],
                          :link => nil,
                          :anchor => nil,
+                         :local => 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 = Prawn::Text::Formatted::Parser.format(string)
     array[0].should == { :text => "Courier text",
                          :styles => [],
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => 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 = Prawn::Text::Formatted::Parser.format(string)
     array[0].should == { :text => "14 point text",
                          :styles => [],
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => 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 = Prawn::Text::Formatted::Parser.format(string)
     array[0].should == { :text => "extra character spacing",
                          :styles => [],
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => 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 = Prawn::Text::Formatted::Parser.format(string)
     array[0].should == { :text => "external link",
                          :styles => [],
                          :color => nil,
                          :link => "http://example.com",
                          :anchor => nil,
+                         :local => nil,
+                         :font => nil,
+                         :size => nil,
+                         :character_spacing => nil }
+  end
+  it "should handle local links" do
+    string = "<link local='/home/example/foo.bar'>local link</link>"
+    array = Prawn::Text::Formatted::Parser.format(string)
+    array[0].should == { :text => "local link",
+                         :styles => [],
+                         :color => nil,
+                         :link => nil,
+                         :anchor => nil,
+                         :local => "/home/example/foo.bar",
                          :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 = Prawn::Text::Formatted::Parser.format(string)
     array[0].should == { :text => "internal link",
                          :styles => [],
                          :color => nil,
                          :link => nil,
                          :anchor => "ToC",
+                         :local => nil,
                          :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 = Prawn::Text::Formatted::Parser.format(string)
     array[0].should == { :text => "©",
                          :styles => [:bold],
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => nil,
                          :font => nil,
                          :size => nil,
                          :character_spacing => nil }
@@ -138,6 +162,7 @@ describe "Text::Formatted::Parser#to_array" do
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => nil,
                          :font => nil,
                          :size => nil,
                          :character_spacing => nil }
@@ -146,55 +171,60 @@ describe "Text::Formatted::Parser#to_array" do
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => 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 = Prawn::Text::Formatted::Parser.format(string)
     array[1].should == { :text => "<, >, and &",
                          :styles => [:bold],
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => 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 = Prawn::Text::Formatted::Parser.format(string)
     array[1].should == { :text => "sized",
                          :styles => [],
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => 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 = Prawn::Text::Formatted::Parser.format(string)
     array[1].should == { :text => "sized",
                          :styles => [],
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => 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 = Prawn::Text::Formatted::Parser.format(string)
 
     array[0].should == { :text => "hello ",
                          :styles => [],
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => nil,
                          :font => nil,
                          :size => nil,
                          :character_spacing => nil }
@@ -203,6 +233,7 @@ describe "Text::Formatted::Parser#to_array" do
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => nil,
                          :font => nil,
                          :size => nil,
                          :character_spacing => nil }
@@ -211,6 +242,7 @@ describe "Text::Formatted::Parser#to_array" do
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => nil,
                          :font => nil,
                          :size => nil,
                          :character_spacing => nil }
@@ -219,6 +251,7 @@ describe "Text::Formatted::Parser#to_array" do
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => nil,
                          :font => nil,
                          :size => nil,
                          :character_spacing => nil }
@@ -227,6 +260,7 @@ describe "Text::Formatted::Parser#to_array" do
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => nil,
                          :font => nil,
                          :size => nil,
                          :character_spacing => nil }
@@ -235,19 +269,21 @@ describe "Text::Formatted::Parser#to_array" do
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => 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 = Prawn::Text::Formatted::Parser.format(string)
 
     array[0].should == { :text => "bold",
                          :styles => [:bold],
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => nil,
                          :font => nil,
                          :size => nil,
                          :character_spacing => nil }
@@ -256,19 +292,21 @@ describe "Text::Formatted::Parser#to_array" do
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => 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 = Prawn::Text::Formatted::Parser.format(string)
 
     array[0].should == { :text => "italic",
                          :styles => [:italic],
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => nil,
                          :font => nil,
                          :size => nil,
                          :character_spacing => nil }
@@ -277,19 +315,21 @@ describe "Text::Formatted::Parser#to_array" do
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => 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 = Prawn::Text::Formatted::Parser.format(string)
 
     array[0].should == { :text => "link",
                          :styles => [],
                          :color => nil,
                          :link => "http://example.com",
                          :anchor => nil,
+                         :local => nil,
                          :font => nil,
                          :size => nil,
                          :character_spacing => nil }
@@ -298,13 +338,14 @@ describe "Text::Formatted::Parser#to_array" do
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => nil,
                          :font => nil,
                          :size => nil,
                          :character_spacing => nil }
   end
 
   it "should turn <br>, <br/> into newline" do
-    array = Prawn::Text::Formatted::Parser.to_array("hello<br>big<br/>world")
+    array = Prawn::Text::Formatted::Parser.format("hello<br>big<br/>world")
     array.map { |frag| frag[:text] }.join.should == "hello\nbig\nworld"
   end
 end
@@ -318,6 +359,7 @@ describe "Text::Formatted::Parser#to_string" do
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => nil,
                          :font => nil,
                          :size => nil,
                          :character_spacing => nil }]
@@ -330,6 +372,7 @@ describe "Text::Formatted::Parser#to_string" do
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => nil,
                          :font => nil,
                          :size => nil,
                          :character_spacing => nil }]
@@ -342,6 +385,7 @@ describe "Text::Formatted::Parser#to_string" do
                          :color => "ff0000",
                          :link => nil,
                          :anchor => nil,
+                         :local => nil,
                          :font => nil,
                          :size => nil,
                          :character_spacing => nil }]
@@ -354,6 +398,7 @@ describe "Text::Formatted::Parser#to_string" do
                          :color => [0, 100, 0, 0],
                          :link => nil,
                          :anchor => nil,
+                         :local => nil,
                          :font => nil,
                          :size => nil,
                          :character_spacing => nil }]
@@ -366,6 +411,7 @@ describe "Text::Formatted::Parser#to_string" do
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => nil,
                          :font => "Courier",
                          :size => nil,
                          :character_spacing => nil }]
@@ -378,6 +424,7 @@ describe "Text::Formatted::Parser#to_string" do
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => nil,
                          :font => nil,
                          :size => 14,
                          :character_spacing => nil }]
@@ -390,6 +437,7 @@ describe "Text::Formatted::Parser#to_string" do
                          :color => nil,
                          :link => nil,
                          :anchor => nil,
+                         :local => nil,
                          :font => nil,
                          :size => nil,
                          :character_spacing => 2.5 }]
@@ -401,6 +449,7 @@ describe "Text::Formatted::Parser#to_string" do
                :color => nil,
                :link => "http://example.com",
                :anchor => nil,
+               :local => nil,
                :font => nil,
                :size => nil,
                :character_spacing => nil }]