prawn 0.15.0 → 1.0.0.rc1

data/spec/jpg_spec.rb

@@ -4,18 +4,18 @@
 # contents of palette and transparency to ensure they're correct.
 # Need to find files that have these sections first.
 
-require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")  
 
 describe "When reading a JPEG file" do
 
   before(:each) do
-    @filename = "#{Prawn::DATADIR}/images/pigs.jpg"
+    @filename = "#{Prawn::BASEDIR}/data/images/pigs.jpg"
     @img_data = File.open(@filename, "rb") { |f| f.read }
   end
-
+   
   it "should read the basic attributes correctly" do
     jpg = Prawn::Images::JPG.new(@img_data)
-
+    
     jpg.width.should == 604
     jpg.height.should == 453
     jpg.bits.should == 8

data/spec/line_wrap_spec.rb

@@ -5,8 +5,8 @@ require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
 describe "Core::Text::Formatted::LineWrap#wrap_line" do
   before(:each) do
     create_pdf
-    @arranger = Prawn::Text::Formatted::Arranger.new(@pdf)
-    @line_wrap = Prawn::Text::Formatted::LineWrap.new
+    @arranger = Prawn::Core::Text::Formatted::Arranger.new(@pdf)
+    @line_wrap = Prawn::Core::Text::Formatted::LineWrap.new
     @one_word_width = 50
   end
   it "should strip leading and trailing spaces" do
@@ -30,7 +30,7 @@ describe "Core::Text::Formatted::LineWrap#wrap_line" do
                                  :document => @pdf)
     string.should == "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
   end
-  it "should raise_error CannotFit if a too-small width is given" do
+  it "should raise CannotFit if a too-small width is given" do
     array = [{ :text => " hello world, " },
              { :text => "goodbye  ", :style => [:bold] }]
     @arranger.format_array = array
@@ -38,7 +38,7 @@ describe "Core::Text::Formatted::LineWrap#wrap_line" do
       @line_wrap.wrap_line(:arranger => @arranger,
                            :width => 1,
                            :document => @pdf)
-    end.should raise_error(Prawn::Errors::CannotFit)
+    end.should.raise(Prawn::Errors::CannotFit)
   end
 
   it "should break on space" do
@@ -51,7 +51,7 @@ describe "Core::Text::Formatted::LineWrap#wrap_line" do
   end
 
   it "should break on zero-width space" do
-    @pdf.font("#{Prawn::DATADIR}/fonts/DejaVuSans.ttf")
+    @pdf.font("#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf")
     array = [{ :text => "hello#{Prawn::Text::ZWSP}world" }]
     @arranger.format_array = array
     string = @line_wrap.wrap_line(:arranger => @arranger,
@@ -61,7 +61,7 @@ describe "Core::Text::Formatted::LineWrap#wrap_line" do
   end
 
   it "should not display zero-width space" do
-    @pdf.font("#{Prawn::DATADIR}/fonts/DejaVuSans.ttf")
+    @pdf.font("#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf")
     array = [{ :text => "hello#{Prawn::Text::ZWSP}world" }]
     @arranger.format_array = array
     string = @line_wrap.wrap_line(:arranger => @arranger,
@@ -113,11 +113,11 @@ describe "Core::Text::Formatted::LineWrap#wrap_line" do
                                   :width => @one_word_width,
                                   :document => @pdf)
     expected = @pdf.font.normalize_encoding("hello#{Prawn::Text::SHY}")
-    expected.force_encoding(Encoding::UTF_8)
+    expected.force_encoding("utf-8") if "".respond_to?(:force_encoding)
     string.should == expected
 
-    @pdf.font("#{Prawn::DATADIR}/fonts/DejaVuSans.ttf")
-    @line_wrap = Prawn::Text::Formatted::LineWrap.new
+    @pdf.font("#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf")
+    @line_wrap = Prawn::Core::Text::Formatted::LineWrap.new
 
     string = "hello#{Prawn::Text::SHY}world"
     array = [{ :text => string }]
@@ -137,8 +137,8 @@ describe "Core::Text::Formatted::LineWrap#wrap_line" do
                                   :document => @pdf)
     string.should == "helloworld"
 
-    @pdf.font("#{Prawn::DATADIR}/fonts/DejaVuSans.ttf")
-    @line_wrap = Prawn::Text::Formatted::LineWrap.new
+    @pdf.font("#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf")
+    @line_wrap = Prawn::Core::Text::Formatted::LineWrap.new
 
     string = "hello#{Prawn::Text::SHY}world"
     array = [{ :text => string }]
@@ -166,8 +166,8 @@ describe "Core::Text::Formatted::LineWrap#wrap_line" do
                                   :document => @pdf)
     string.should == "hello"
 
-    @pdf.font("#{Prawn::DATADIR}/fonts/DejaVuSans.ttf")
-    @line_wrap = Prawn::Text::Formatted::LineWrap.new
+    @pdf.font("#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf")
+    @line_wrap = Prawn::Core::Text::Formatted::LineWrap.new
     enough_width_for_hello_world = 68
 
     array = [{ :text => "hello world" }]
@@ -202,11 +202,11 @@ describe "Core::Text::Formatted::LineWrap#wrap_line" do
                                   :width => @one_word_width,
                                   :document => @pdf)
     expected = @pdf.font.normalize_encoding("hello#{Prawn::Text::SHY}")
-    expected.force_encoding(Encoding::UTF_8)
+    expected.force_encoding("utf-8") if "".respond_to?(:force_encoding)
     string.should == expected
 
-    @pdf.font("#{Prawn::DATADIR}/fonts/DejaVuSans.ttf")
-    @line_wrap = Prawn::Text::Formatted::LineWrap.new
+    @pdf.font("#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf")
+    @line_wrap = Prawn::Core::Text::Formatted::LineWrap.new
 
     string = "hello#{Prawn::Text::SHY}-"
     array = [{ :text => string }]
@@ -229,8 +229,8 @@ end
 describe "Core::Text::Formatted::LineWrap#space_count" do
   before(:each) do
     create_pdf
-    @arranger = Prawn::Text::Formatted::Arranger.new(@pdf)
-    @line_wrap = Prawn::Text::Formatted::LineWrap.new
+    @arranger = Prawn::Core::Text::Formatted::Arranger.new(@pdf)
+    @line_wrap = Prawn::Core::Text::Formatted::LineWrap.new
   end
   it "should return the number of spaces in the last wrapped line" do
     array = [{ :text => "hello world, " },
@@ -255,7 +255,7 @@ end
 describe "Core::Text::Formatted::LineWrap" do
   before(:each) do
     create_pdf
-    @arranger = Prawn::Text::Formatted::Arranger.new(@pdf)
+    @arranger = Prawn::Core::Text::Formatted::Arranger.new(@pdf)
     array = [{ :text => "hello\nworld\n\n\nhow are you?" },
              { :text => "\n" },
              { :text => "\n" },
@@ -265,7 +265,7 @@ describe "Core::Text::Formatted::LineWrap" do
              { :text => "\n" },
              { :text => "" }]
     @arranger.format_array = array
-    @line_wrap = Prawn::Text::Formatted::LineWrap.new
+    @line_wrap = Prawn::Core::Text::Formatted::LineWrap.new
   end
   it "should only return an empty string if nothing fit or there" +
      "was nothing to wrap" do
@@ -273,23 +273,23 @@ describe "Core::Text::Formatted::LineWrap" do
       line = @line_wrap.wrap_line(:arranger => @arranger,
                                  :width => 200,
                                  :document => @pdf)
-      line.should_not be_empty
+      line.should.not.be.empty
     end
     line = @line_wrap.wrap_line(:arranger => @arranger,
                                :width => 200,
                                :document => @pdf)
-    line.should be_empty
+    line.should.be.empty
   end
 end
 
 describe "Core::Text::Formatted::LineWrap#paragraph_finished?" do
   before(:each) do
     create_pdf
-    @arranger = Prawn::Text::Formatted::Arranger.new(@pdf)
-    @line_wrap = Prawn::Text::Formatted::LineWrap.new
+    @arranger = Prawn::Core::Text::Formatted::Arranger.new(@pdf)
+    @line_wrap = Prawn::Core::Text::Formatted::LineWrap.new
     @one_word_width = 50
   end
-  it "should be_false when the last printed line is not the end of the paragraph" do
+  it "should be false when the last printed line is not the end of the paragraph" do
     array = [{ :text => "hello world" }]
     @arranger.format_array = array
     string = @line_wrap.wrap_line(:arranger => @arranger,
@@ -298,7 +298,7 @@ describe "Core::Text::Formatted::LineWrap#paragraph_finished?" do
 
     @line_wrap.paragraph_finished?.should == false
   end
-  it "should be_true when the last printed line is the last fragment to print" do
+  it "should be true when the last printed line is the last fragment to print" do
     array = [{ :text => "hello world" }]
     @arranger.format_array = array
     string = @line_wrap.wrap_line(:arranger => @arranger,
@@ -310,7 +310,7 @@ describe "Core::Text::Formatted::LineWrap#paragraph_finished?" do
 
     @line_wrap.paragraph_finished?.should == true
   end
-  it "should be_true when a newline exists on the current line" do
+  it "should be true when a newline exists on the current line" do
     array = [{ :text => "hello\n world" }]
     @arranger.format_array = array
     string = @line_wrap.wrap_line(:arranger => @arranger,
@@ -319,7 +319,7 @@ describe "Core::Text::Formatted::LineWrap#paragraph_finished?" do
 
     @line_wrap.paragraph_finished?.should == true
   end
-  it "should be_true when a newline exists in the next fragment" do
+  it "should be true when a newline exists in the next fragment" do
     array = [{ :text => "hello " },
              { :text => " \n" },
              { :text => "world" }]

data/spec/measurement_units_spec.rb

@@ -1,10 +1,10 @@
-require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+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_within(0.000000001).of(2.834645669)
+    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
@@ -12,12 +12,12 @@ describe "Measurement units" do
     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/name_tree_spec.rb

@@ -0,0 +1,112 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+def tree_dump(tree)
+  if tree.is_a?(Prawn::Core::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::Core::NameTree::Value.new(name, value)
+end
+
+class RefExposingDocument < Prawn::Document
+  def object_store
+    state.store
+  end
+end
+
+describe "Name Tree" do     
+  before(:each) { create_pdf(RefExposingDocument) }
+
+  it "should have no children when first initialized" do
+    node = Prawn::Core::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::Core::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::Core::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.object_store.length
+    node = Prawn::Core::NameTree::Node.new(@pdf, 3)
+    tree_add(node, ["one", 1], ["two", 2], ["three", 3], ["four", 4])
+    @pdf.object_store.length.should.equal ref_count+2
+  end
+  
+  it "should create a one new reference when subtree is split" do
+    node = Prawn::Core::NameTree::Node.new(@pdf, 3)
+    tree_add(node, ["one", 1], ["two", 2], ["three", 3], ["four", 4])
+
+    ref_count = @pdf.object_store.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.object_store.length.should.equal ref_count+1
+  end
+
+  it "should keep tree balanced when subtree split cascades to root" do
+    node = Prawn::Core::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 maintain order of already properly ordered nodes" do
+    node = Prawn::Core::NameTree::Node.new(@pdf, 3)
+    tree_add(node, ["eight", 8], ["five", 5], ["four", 4], ["one", 1])
+    tree_add(node, ['seven', 7], ['six', 6], ['three', 3], ['two', 2])
+    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::Core::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::Core::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::Core::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::Core::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/object_store_spec.rb

@@ -4,18 +4,60 @@ require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
 
 describe "Prawn::ObjectStore" do
   before(:each) do
-    @store = PDF::Core::ObjectStore.new
+    @store = Prawn::Core::ObjectStore.new
   end
 
   it "should create required roots by default, including info passed to new" do
-    store = PDF::Core::ObjectStore.new(:info => {:Test => 3})
+    store = Prawn::Core::ObjectStore.new(:info => {:Test => 3})
     store.size.should == 3 # 3 default roots
     store.info.data[:Test].should == 3
     store.pages.data[:Count].should == 0
     store.root.data[:Pages].should == store.pages
   end
 
- 
+  it "should import objects from an existing PDF" do
+    filename = "#{Prawn::BASEDIR}/spec/data/curves.pdf"
+    store = Prawn::Core::ObjectStore.new(:template => filename)
+    store.size.should == 5
+  end
+
+  it "should point to existing roots when importing objects from an existing PDF" do
+    filename = "#{Prawn::BASEDIR}/spec/data/curves.pdf"
+    store = Prawn::Core::ObjectStore.new(:template => filename)
+    store.info.class.should == Prawn::Core::Reference
+    store.root.class.should == Prawn::Core::Reference
+  end
+
+  it "should initialize with pages when importing objects from an existing PDF" do
+    filename = "#{Prawn::BASEDIR}/spec/data/curves.pdf"
+    store = Prawn::Core::ObjectStore.new(:template => filename)
+    store.pages.data[:Count].should == 1
+  end
+
+  it "should import all objects from a PDF that has an indirect reference in a stream dict" do
+    filename = "#{Prawn::BASEDIR}/data/pdfs/indirect_reference.pdf"
+    store = Prawn::Core::ObjectStore.new(:template => filename)
+    store.size.should == 8
+  end
+
+  it "should raise ArgumentError when given a file that doesn exist as a template" do
+    filename = "not_really_there.pdf"
+
+    lambda { Prawn::Core::ObjectStore.new(:template => filename) }.should.raise(ArgumentError)
+  end
+
+  it "should raise Prawn::Errors::TemplateError when given a non PDF as a template" do
+    filename = "#{Prawn::BASEDIR}/data/images/dice.png"
+
+    lambda { Prawn::Core::ObjectStore.new(:template => filename) }.should.raise(Prawn::Errors::TemplateError)
+  end
+
+  it "should raise Prawn::Errors::TemplateError when given an encrypted PDF as a template" do
+    filename = "#{Prawn::BASEDIR}/data/pdfs/encrypted.pdf"
+
+    lambda { Prawn::Core::ObjectStore.new(:template => filename) }.should.raise(Prawn::Errors::TemplateError)
+  end
+
   it "should add to its objects when ref() is called" do
     count = @store.size
     @store.ref("blah")
@@ -23,7 +65,7 @@ describe "Prawn::ObjectStore" do
   end
 
   it "should accept push with a Prawn::Reference" do
-    r = PDF::Core::Reference(123, "blah")
+    r = Prawn::Core::Reference(123, "blah")
     @store.push(r)
     @store[r.identifier].should == r
   end
@@ -40,17 +82,11 @@ describe "Prawn::ObjectStore" do
     end
     @store.map{|ref| ref.identifier}[-3..-1].should == [10, 11, 12]
   end
-
-  it "should accept option to disabling PDF scaling in PDF clients" do
-    @store = PDF::Core::ObjectStore.new(:print_scaling => :none)
-    @store.root.data[:ViewerPreferences].should == {:PrintScaling => :None}
-  end
-
 end
 
 describe "Prawn::ObjectStore#compact" do
   it "should do nothing to an ObjectStore with all live refs" do
-    store = PDF::Core::ObjectStore.new
+    store = Prawn::Core::ObjectStore.new
     store.info.data[:Blah] = store.ref(:some => "structure")
     old_size = store.size
     store.compact
@@ -59,23 +95,76 @@ describe "Prawn::ObjectStore#compact" do
   end
 
   it "should remove dead objects, renumbering live objects from 1" do
-    store = PDF::Core::ObjectStore.new
+    store = Prawn::Core::ObjectStore.new
     store.ref(:some => "structure")
     old_size = store.size
     store.compact
-
-    store.size.should be < old_size
+    
+    store.size.should.be < old_size
     store.map{ |o| o.identifier }.should == (1..store.size).to_a
   end
 
   it "should detect and remove dead objects that were once live" do
-    store = PDF::Core::ObjectStore.new
+    store = Prawn::Core::ObjectStore.new
     store.info.data[:Blah] = store.ref(:some => "structure")
     store.info.data[:Blah] = :overwritten
     old_size = store.size
     store.compact
-
-    store.size.should be < old_size
+    
+    store.size.should.be < old_size
     store.map{ |o| o.identifier }.should == (1..store.size).to_a
   end
 end
+
+describe "Prawn::ObjectStorie#object_id_for_page" do
+  it "should return the object ID of an imported template page" do
+    filename = "#{Prawn::BASEDIR}/data/pdfs/hexagon.pdf"
+    store = Prawn::Core::ObjectStore.new(:template => filename)
+    store.object_id_for_page(0).should == 4
+  end
+
+  it "should return the object ID of the first imported template page" do
+    filename = "#{Prawn::BASEDIR}/data/pdfs/two_hexagons.pdf"
+    store = Prawn::Core::ObjectStore.new(:template => filename)
+    store.object_id_for_page(1).should == 4
+  end
+
+  it "should return the object ID of the last imported template page" do
+    filename = "#{Prawn::BASEDIR}/data/pdfs/two_hexagons.pdf"
+    store = Prawn::Core::ObjectStore.new(:template => filename)
+    store.object_id_for_page(-1).should == 6
+  end
+
+  it "should return the object ID of the first page of a template that uses nested Pages" do
+    filename = "#{Prawn::BASEDIR}/data/pdfs/nested_pages.pdf"
+    store = Prawn::Core::ObjectStore.new(:template => filename)
+    store.object_id_for_page(1).should == 5
+  end
+
+  it "should return the object ID of the last page of a template that uses nested Pages" do
+    filename = "#{Prawn::BASEDIR}/data/pdfs/nested_pages.pdf"
+    store = Prawn::Core::ObjectStore.new(:template => filename)
+    store.object_id_for_page(-1).should == 8
+  end
+
+  it "should return nil if given an invalid page number" do
+    filename = "#{Prawn::BASEDIR}/data/pdfs/hexagon.pdf"
+    store = Prawn::Core::ObjectStore.new(:template => filename)
+    store.object_id_for_page(10).should == nil
+  end
+
+  it "should return nil if given an invalid page number" do
+    store = Prawn::Core::ObjectStore.new
+    store.object_id_for_page(10).should == nil
+  end
+
+  it "should accept a stream instead of a filename" do
+    example = Prawn::Document.new()
+    example.text "An example doc, created in memory"
+    example.start_new_page
+    StringIO.open(example.render) do |stream|
+      @pdf = Prawn::Core::ObjectStore.new(:template => stream)
+    end
+    @pdf.page_count.should == 2
+  end
+end