prawn 0.2.3 → 0.3.0

data/spec/images_spec.rb

@@ -17,7 +17,6 @@ describe "the image() function" do
     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  
@@ -36,5 +35,34 @@ describe "the image() function" do
     
     info.height.should == 453
   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/measurement_units_spec.rb

@@ -0,0 +1,23 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")           
+require "prawn/measurement_extensions"
+
+describe "Measurement units" do
+  
+  it "should convert units to PostScriptPoints" do
+    1.mm.should.be.close(2.834645669, 0.000000001)
+    1.mm.should == (72 / 25.4)
+    2.mm.should == (2 * 72 / 25.4)
+    3.mm.should == 3 * 72 / 25.4
+    -3.mm.should == -3 * 72/25.4
+    1.cm.should == 10 * 72 / 25.4
+    1.dm.should == 100 * 72 / 25.4
+    1.m.should == 1000 * 72 / 25.4
+    
+    1.in.should == 72
+    1.ft.should == 72 * 12
+    1.yd.should == 72 * 12 * 3
+    1.pt.should == 1
+  end
+  
+end
+  

data/spec/metrics_spec.rb

@@ -1,12 +1,13 @@
 # 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 "iconv"
 
 describe "adobe font metrics" do
   
   setup do
     @times = Prawn::Font::Metrics["Times-Roman"]
-    @iconv = Iconv.new('ISO-8859-1', 'utf-8')
+    @iconv = ::Iconv.new('ISO-8859-1', 'utf-8')
   end
   
   it "should calculate string width taking into account accented characters" do

data/spec/name_tree_spec.rb

@@ -0,0 +1,103 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+def tree_dump(tree)
+  if tree.is_a?(Prawn::NameTree::Node)
+    "[" + tree.children.map { |child| tree_dump(child) }.join(",") + "]"
+  else
+    "#{tree.name}=#{tree.value}"
+  end
+end
+
+def tree_add(tree, *args)
+  args.each do |(name, value)|
+    tree.add(name, value)
+  end
+end
+
+def tree_value(name, value)
+  Prawn::NameTree::Value.new(name, value)
+end
+
+class RefExposingDocument < Prawn::Document
+  attr_reader :objects
+end
+
+describe "Name Tree" do     
+  before(:each) { create_pdf(RefExposingDocument) }
+
+  it "should have no children when first initialized" do
+    node = Prawn::NameTree::Node.new(@pdf, 3)
+    node.children.length.should == 0
+  end
+
+  it "should have no subtrees while child limit is not reached" do
+    node = Prawn::NameTree::Node.new(@pdf, 3)
+    tree_add(node, ["one", 1], ["two", 2], ["three", 3])
+    tree_dump(node).should == "[one=1,three=3,two=2]"
+  end
+
+  it "should split into subtrees when limit is exceeded" do
+    node = Prawn::NameTree::Node.new(@pdf, 3)
+    tree_add(node, ["one", 1], ["two", 2], ["three", 3], ["four", 4])
+    tree_dump(node).should == "[[four=4,one=1],[three=3,two=2]]"
+  end
+
+  it "should create a two new references when root is split" do
+    ref_count = @pdf.objects.length
+    node = Prawn::NameTree::Node.new(@pdf, 3)
+    tree_add(node, ["one", 1], ["two", 2], ["three", 3], ["four", 4])
+    @pdf.objects.length.should.equal ref_count+2
+  end
+  
+  it "should create a one new reference when subtree is split" do
+    node = Prawn::NameTree::Node.new(@pdf, 3)
+    tree_add(node, ["one", 1], ["two", 2], ["three", 3], ["four", 4])
+
+    ref_count = @pdf.objects.length # save when root is split
+    tree_add(node, ["five", 5], ["six", 6], ["seven", 7])
+    tree_dump(node).should == "[[five=5,four=4,one=1],[seven=7,six=6],[three=3,two=2]]"
+    @pdf.objects.length.should.equal ref_count+1
+  end
+
+  it "should keep tree balanced when subtree split cascades to root" do
+    node = Prawn::NameTree::Node.new(@pdf, 3)
+    tree_add(node, ["one", 1], ["two", 2], ["three", 3], ["four", 4])
+    tree_add(node, ["five", 5], ["six", 6], ["seven", 7], ["eight", 8])
+    tree_dump(node).should == "[[[eight=8,five=5],[four=4,one=1]],[[seven=7,six=6],[three=3,two=2]]]"
+  end
+
+  it "should emit only :Names key with to_hash if root is only node" do
+    node = Prawn::NameTree::Node.new(@pdf, 3)
+    tree_add(node, ["one", 1], ["two", 2], ["three", 3])
+    node.to_hash.should.equal(
+      { :Names => [tree_value("one", 1), tree_value("three", 3), tree_value("two", 2)] }
+    )
+  end
+
+  it "should emit only :Kids key with to_hash if root has children" do
+    node = Prawn::NameTree::Node.new(@pdf, 3)
+    tree_add(node, ["one", 1], ["two", 2], ["three", 3], ["four", 4])
+    node.to_hash.should.equal({ :Kids => node.children.map { |child| child.ref } })
+  end
+
+  it "should emit :Limits and :Names keys with to_hash for leaf node" do
+    node = Prawn::NameTree::Node.new(@pdf, 3)
+    tree_add(node, ["one", 1], ["two", 2], ["three", 3], ["four", 4])
+    node.children.first.to_hash.should.equal(
+      { :Limits => %w(four one),
+        :Names => [tree_value("four", 4), tree_value("one", 1)] }
+    )
+  end
+
+  it "should emit :Limits and :Kids keys with to_hash for inner node" do
+    node = Prawn::NameTree::Node.new(@pdf, 3)
+    tree_add(node, ["one", 1], ["two", 2], ["three", 3], ["four", 4])
+    tree_add(node, ["five", 5], ["six", 6], ["seven", 7], ["eight", 8])
+    tree_add(node, ["nine", 9], ["ten", 10], ["eleven", 11], ["twelve", 12])
+    tree_add(node, ["thirteen", 13], ["fourteen", 14], ["fifteen", 15], ["sixteen", 16])
+    node.children.first.to_hash.should.equal(
+      { :Limits => %w(eight one),
+        :Kids => node.children.first.children.map { |child| child.ref } }
+    )
+  end
+end

data/spec/pdf_object_spec.rb

@@ -58,14 +58,15 @@ describe "PDF Object Serialization" do
   end  
 
   it "should convert a Ruby array to PDF Array when outside a content stream" do
+    bar = "\xFE\xFF" + "Bar".unpack("U*").pack("n*")
     Prawn::PdfObject([1,2,3]).should == "[1 2 3]"
     PDF::Inspector.parse(Prawn::PdfObject([[1,2],:foo,"Bar"], false)).should ==  
-      [[1,2],:foo, "\xFE\xFF\x00B\x00a\x00r"]
+      [[1,2],:foo, bar]
   end  
  
   it "should convert a Ruby hash to a PDF Dictionary when inside a content stream" do
     dict = Prawn::PdfObject( {:foo  => :bar, 
-                              "baz"  => [1,2,3], 
+                              "baz" => [1,2,3], 
                               :bang => {:a => "what", :b => [:you, :say] }}, true )     
 
     res = PDF::Inspector.parse(dict)           
@@ -77,15 +78,16 @@ describe "PDF Object Serialization" do
   end      
 
   it "should convert a Ruby hash to a PDF Dictionary when outside a content stream" do
+    what = "\xFE\xFF" + "what".unpack("U*").pack("n*")
     dict = Prawn::PdfObject( {:foo  => :bar, 
-                              "baz"  => [1,2,3], 
+                              "baz" => [1,2,3], 
                               :bang => {:a => "what", :b => [:you, :say] }}, false )
 
     res = PDF::Inspector.parse(dict)           
 
     res[:foo].should == :bar
     res[:baz].should == [1,2,3]
-    res[:bang].should == { :a => "\xFE\xFF\x00w\x00h\x00a\x00t", :b => [:you, :say] }
+    res[:bang].should == { :a => what, :b => [:you, :say] }
 
   end      
   
@@ -98,5 +100,13 @@ describe "PDF Object Serialization" do
     ref = Prawn::Reference(1,true)
     Prawn::PdfObject(ref).should == ref.to_s
   end
-  
+
+  it "should convert a NameTree::Node to a PDF hash" do
+    node = Prawn::NameTree::Node.new(Prawn::Document.new, 10)
+    node.add "hello", 1.0
+    node.add "world", 2.0
+    data = Prawn::PdfObject(node)
+    res = PDF::Inspector.parse(data)
+    res.should == {:Names => ["hello", 1.0, "world", 2.0]}
+  end
 end

data/spec/png_spec.rb

@@ -14,7 +14,7 @@ describe "When reading a greyscale PNG file (color type 0)" do
   before(:each) do
     @filename = "#{Prawn::BASEDIR}/data/images/web-links.png"
     @data_filename = "#{Prawn::BASEDIR}/data/images/web-links.dat"
-    @img_data = File.read_binary(@filename) 
+    @img_data = File.binread(@filename) 
   end
 
   it "should read the attributes from the header chunk correctly" do
@@ -31,7 +31,7 @@ describe "When reading a greyscale PNG file (color type 0)" do
 
   it "should read the image data chunk correctly" do
     png = Prawn::Images::PNG.new(@img_data)
-    data = File.read_binary(@data_filename)
+    data = File.binread(@data_filename)
     png.img_data.should == data
   end
 end
@@ -40,7 +40,7 @@ describe "When reading a greyscale PNG file with transparency (color type 0)" do
 
   before(:each) do
     @filename = "#{Prawn::BASEDIR}/data/images/ruport_type0.png"
-    @img_data = File.read_binary(@filename)
+    @img_data = File.binread(@filename)
   end
 
   # In a greyscale type 0 PNG image, the tRNS chunk should contain a single value
@@ -58,7 +58,7 @@ describe "When reading an RGB PNG file (color type 2)" do
   before(:each) do
     @filename = "#{Prawn::BASEDIR}/data/images/ruport.png"
     @data_filename = "#{Prawn::BASEDIR}/data/images/ruport_data.dat"
-    @img_data = File.read_binary(@filename)
+    @img_data = File.binread(@filename)
   end
 
   it "should read the attributes from the header chunk correctly" do
@@ -75,7 +75,7 @@ describe "When reading an RGB PNG file (color type 2)" do
 
   it "should read the image data chunk correctly" do
     png = Prawn::Images::PNG.new(@img_data)
-    data = File.read_binary(@data_filename)
+    data = File.binread(@data_filename)
     png.img_data.should == data
   end
 end
@@ -84,7 +84,7 @@ describe "When reading an RGB PNG file with transparency (color type 2)" do
 
   before(:each) do
     @filename = "#{Prawn::BASEDIR}/data/images/arrow2.png"
-    @img_data = File.read_binary(@filename)
+    @img_data = File.binread(@filename)
   end
 
   # In a RGB type 2 PNG image, the tRNS chunk should contain a single RGB value
@@ -105,7 +105,7 @@ describe "When reading an indexed color PNG file (color type 3)" do
   before(:each) do
     @filename = "#{Prawn::BASEDIR}/data/images/rails.png"
     @data_filename = "#{Prawn::BASEDIR}/data/images/rails.dat"
-    @img_data = File.read_binary(@filename) 
+    @img_data = File.binread(@filename) 
   end
 
   it "should read the attributes from the header chunk correctly" do
@@ -122,7 +122,7 @@ describe "When reading an indexed color PNG file (color type 3)" do
 
   it "should read the image data chunk correctly" do
     png = Prawn::Images::PNG.new(@img_data)
-    data = File.read_binary(@data_filename)
+    data = File.binread(@data_filename)
     png.img_data.should == data
   end
 end
@@ -133,7 +133,7 @@ describe "When reading a greyscale+alpha PNG file (color type 4)" do
     @filename = "#{Prawn::BASEDIR}/data/images/page_white_text.png"
     @data_filename = "#{Prawn::BASEDIR}/data/images/page_white_text.dat"
     @alpha_data_filename = "#{Prawn::BASEDIR}/data/images/page_white_text.alpha"
-    @img_data = File.read_binary(@filename)
+    @img_data = File.binread(@filename)
   end
 
   it "should read the attributes from the header chunk correctly" do
@@ -150,13 +150,13 @@ describe "When reading a greyscale+alpha PNG file (color type 4)" do
 
   it "should correctly return the raw image data (with no alpha channel) from the image data chunk" do
     png = Prawn::Images::PNG.new(@img_data)
-    data = File.read_binary(@data_filename)
+    data = File.binread(@data_filename)
     png.img_data.should == data
   end
 
   it "should correctly extract the alpha channel data from the image data chunk" do
     png = Prawn::Images::PNG.new(@img_data)
-    data = File.read_binary(@alpha_data_filename) 
+    data = File.binread(@alpha_data_filename) 
     png.alpha_channel.should == data
   end
 end
@@ -167,7 +167,7 @@ describe "When reading an RGB+alpha PNG file (color type 6)" do
     @filename = "#{Prawn::BASEDIR}/data/images/dice.png"
     @data_filename = "#{Prawn::BASEDIR}/data/images/dice.dat"
     @alpha_data_filename = "#{Prawn::BASEDIR}/data/images/dice.alpha"
-    @img_data = File.read_binary(@filename)  
+    @img_data = File.binread(@filename)  
   end
 
   it "should read the attributes from the header chunk correctly" do
@@ -184,13 +184,13 @@ describe "When reading an RGB+alpha PNG file (color type 6)" do
 
   it "should correctly return the raw image data (with no alpha channel) from the image data chunk" do
     png = Prawn::Images::PNG.new(@img_data)
-    data = File.read_binary(@data_filename)   
+    data = File.binread(@data_filename)   
     png.img_data.should == data
   end
 
   it "should correctly extract the alpha channel data from the image data chunk" do
     png = Prawn::Images::PNG.new(@img_data)
-    data = File.read_binary(@alpha_data_filename)
+    data = File.binread(@alpha_data_filename)
     png.alpha_channel.should == data
   end
 end

data/spec/spec_helper.rb

@@ -9,13 +9,15 @@ $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
 $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'vendor','pdf-inspector','lib')
 require "prawn"
 
+Prawn.debug = true
+
 gem 'pdf-reader', ">=0.7.3"
 require "pdf/reader"          
 require "pdf/inspector"
 
-def create_pdf
-  @pdf = Prawn::Document.new(:left_margin   => 0,
-                             :right_margin  => 0,
-                             :top_margin    => 0,
-                             :bottom_margin => 0)
-end    
+def create_pdf(klass=Prawn::Document)
+  @pdf = klass.new(:left_margin   => 0,
+                   :right_margin  => 0,
+                   :top_margin    => 0,
+                   :bottom_margin => 0)
+end    

data/spec/table_spec.rb

@@ -75,6 +75,29 @@ end
 
 describe "A table's content" do
 
+  it "should not cause an error if rendering the very first row causes a page break" do
+    Prawn::Document.new( :page_layout => :portrait ) do
+      arr = Array(1..5).collect{|i| ["cell #{i}"] }
+
+      move_down( y - (bounds.absolute_bottom + 3) )
+
+      lambda {
+        table( arr,
+            :font_size          => 9, 
+            :horizontal_padding => 3,
+            :vertical_padding   => 3,
+            :border_width       => 0.05,
+            :border_style       => :none,
+            :row_colors         => %w{ffffff eeeeee},
+            :widths             => {0 =>110},
+            :position           => :left,
+            :headers            => ["exploding header"],
+            :align              => :left,
+            :align_headers      => :center)
+      }.should.not.raise
+    end
+  end
+
   it "should output content cell by cell, row by row" do
     data = [["foo","bar"],["baz","bang"]]
     @pdf = Prawn::Document.new
@@ -136,4 +159,21 @@ describe "An invalid table" do
       @pdf.table(@bad_data)
     end
   end
+
+  it "should raise an EmptyTableError with empty table data" do
+    lambda {
+      data = []
+      @pdf = Prawn::Document.new
+      @pdf.table(data)
+    }.should.raise( Prawn::Errors::EmptyTable )
+  end   
+
+  it "should raise an EmptyTableError with nil table data" do
+    lambda {
+      data = nil
+      @pdf = Prawn::Document.new
+      @pdf.table(data)
+    }.should.raise( Prawn::Errors::EmptyTable )
+  end   
+
 end

data/spec/text_spec.rb

@@ -112,23 +112,25 @@ describe "when drawing text" do
      it "should raise an exception when a utf-8 incompatible string is rendered" do
        str = "Blah \xDD"
        str.force_encoding("ASCII-8BIT")
-       lambda { @pdf.text str }.should.raise(Prawn::Errors::IncompatibleStringEncoding)
+       lambda { @pdf.text str }.should.raise(ArgumentError)
      end
      it "should not raise an exception when a shift-jis string is rendered" do 
+       puts "\nFIXME: SJIS not working on 1.9 right now due to TTFunk issue"
+       return
        datafile = "#{Prawn::BASEDIR}/data/shift_jis_text.txt"  
        sjis_str = File.open(datafile, "r:shift_jis") { |f| f.gets } 
        @pdf.font("#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf")
-       lambda { @pdf.text sjis_str }.should.not.raise(Prawn::Errors::IncompatibleStringEncoding)
+       lambda { @pdf.text sjis_str }.should.not.raise(ArgumentError)
      end
    else
      # Handle non utf-8 string encodings in a sane way on non-M17N aware VMs
      it "should raise an exception when a corrupt utf-8 string is rendered" do
        str = "Blah \xDD"
-       lambda { @pdf.text str }.should.raise(Prawn::Errors::IncompatibleStringEncoding)
+       lambda { @pdf.text str }.should.raise(ArgumentError)
      end
      it "should raise an exception when a shift-jis string is rendered" do
        sjis_str = File.read("#{Prawn::BASEDIR}/data/shift_jis_text.txt")
-       lambda { @pdf.text sjis_str }.should.raise(Prawn::Errors::IncompatibleStringEncoding)
+       lambda { @pdf.text sjis_str }.should.raise(ArgumentError)
      end
    end