piglop-prawn 0.10.2.1

data/spec/outline_spec.rb

@@ -0,0 +1,229 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper") 
+
+describe "Outline" do
+  before(:each) do
+    @pdf = Prawn::Document.new() do
+      text "Page 1. This is the first Chapter. "
+      start_new_page
+      text "Page 2. More in the first Chapter. "
+      start_new_page
+      define_outline do
+        section 'Chapter 1', :page => 1, :closed => true do 
+          page 1, :title => 'Page 1'
+          page 2, :title => 'Page 2'
+        end
+      end
+    end
+  end
+  describe "#generate_outline" do 
+    before(:each) do
+      render_and_find_objects
+    end
+  
+    it "should create a root outline dictionary item" do
+      assert_not_nil @outline_root
+    end
+    
+    it "should set the first and last top items of the root outline dictionary item" do
+      referenced_object(@outline_root[:First]).should == @section_1
+      referenced_object(@outline_root[:Last]).should == @section_1
+    end
+  
+    describe "#create_outline_item" do
+      it "should create outline items for each section and page" do
+        [@section_1, @page_1, @page_2].each {|item| assert_not_nil item}
+      end
+    end
+  
+    describe "#set_relations, #set_variables_for_block, and #reset_parent" do
+      it "should link sibling items" do
+        referenced_object(@page_1[:Next]).should == @page_2
+        referenced_object(@page_2[:Prev]).should == @page_1
+      end
+    
+      it "should link child items to parent item" do
+        [@page_1, @page_2].each {|page| referenced_object(page[:Parent]).should == @section_1 }
+      end
+    
+      it "should set the first and last child items for parent item" do
+        referenced_object(@section_1[:First]).should == @page_1
+        referenced_object(@section_1[:Last]).should == @page_2
+      end
+    end
+  
+    describe "#increase_count" do
+    
+      it "should add the count of all descendant items" do
+        @outline_root[:Count].should == 3
+        @section_1[:Count].should.abs == 2
+        @page_1[:Count].should == 0
+        @page_2[:Count].should == 0
+      end
+    
+    end
+    
+    describe "closed option" do
+      
+      it "should set the item's integer count to negative" do
+        @section_1[:Count].should == -2
+      end
+      
+    end
+
+  end
+  
+  describe "#outline.add_section" do
+    before(:each) do
+      @pdf.start_new_page
+      @pdf.text "Page 3. An added section "
+      @pdf.outline.add_section do
+        section 'Added Section', :page => 3 do
+          page 3, :title => 'Page 3'
+        end
+      end
+      render_and_find_objects
+    end
+    
+    it "should add new outline items to document" do
+      [@section_2, @page_3].each { |item| assert_not_nil item}
+    end
+    
+    it "should reset the last items for root outline dictionary" do
+      referenced_object(@outline_root[:First]).should == @section_1
+      referenced_object(@outline_root[:Last]).should == @section_2
+    end
+    
+    it "should reset the next relation for the previous last top level item" do
+      referenced_object(@section_1[:Next]).should == @section_2
+    end
+    
+    it "should set the previous relation of the addded to section" do
+      referenced_object(@section_2[:Prev]).should == @section_1
+    end
+    
+    it "should increase the count of root outline dictionary" do
+      @outline_root[:Count].should == 5
+    end
+      
+  end
+  
+  describe "#outline.insert_section_after" do
+    describe "inserting in the middle of another section" do
+      before(:each) do
+        @pdf.go_to_page 1
+        @pdf.start_new_page
+        @pdf.text "Inserted Page"
+        @pdf.outline.insert_section_after 'Page 1' do 
+          page page_number, :title => "Inserted Page"
+        end
+        render_and_find_objects
+      end
+
+      it "should insert new outline items to document" do
+        assert_not_nil @inserted_page
+      end
+
+      it "should adjust the count of all ancestors" do    
+        @outline_root[:Count].should == 4
+        @section_1[:Count].should.abs == 3
+      end
+      
+      describe "#adjust_relations" do
+        
+        it "should reset the sibling relations of adjoining items to inserted item" do
+          referenced_object(@page_1[:Next]).should == @inserted_page
+          referenced_object(@page_2[:Prev]).should == @inserted_page
+        end
+
+        it "should set the sibling relation of added item to adjoining items" do
+          referenced_object(@inserted_page[:Next]).should == @page_2
+          referenced_object(@inserted_page[:Prev]).should == @page_1
+        end
+        
+        it "should not affect the first and last relations of parent item" do
+          referenced_object(@section_1[:First]).should == @page_1
+          referenced_object(@section_1[:Last]).should == @page_2
+        end
+        
+      end
+      
+    end
+    
+    describe "inserting at the end of another section" do
+      before(:each) do
+        @pdf.go_to_page 2
+         @pdf.start_new_page
+         @pdf.text "Inserted Page"
+         @pdf.outline.insert_section_after 'Page 2' do 
+           page page_number, :title => "Inserted Page"
+         end
+         render_and_find_objects
+      end
+      
+      describe "#adjust_relations" do
+        
+        it "should reset the sibling relations of adjoining item to inserted item" do
+           referenced_object(@page_2[:Next]).should == @inserted_page
+        end
+
+        it "should set the sibling relation of added item to adjoining items" do
+          assert_nil referenced_object(@inserted_page[:Next])
+          referenced_object(@inserted_page[:Prev]).should == @page_2
+        end
+        
+        it "should adjust the last relation of parent item" do
+          referenced_object(@section_1[:Last]).should == @inserted_page
+        end
+
+      end
+    end
+    
+    it "should require an existing title" do 
+      assert_raise Prawn::Errors::UnknownOutlineTitle do
+        @pdf.go_to_page 1
+        @pdf.start_new_page
+        @pdf.text "Inserted Page"
+        @pdf.outline.insert_section_after 'Wrong page' do 
+          page page_number, :title => "Inserted Page"
+        end
+        render_and_find_objects
+      end
+    end
+    
+  end
+  
+  describe "#page" do
+    it "should require a title option to be set" do
+      assert_raise Prawn::Errors::RequiredOption do
+        @pdf = Prawn::Document.new() do
+          text "Page 1. This is the first Chapter. "
+          define_outline do
+            page 1, :title => nil
+          end
+        end
+      end
+    end
+  end
+end
+
+def render_and_find_objects
+  output = StringIO.new(@pdf.render, 'r+')
+  @hash = PDF::Hash.new(output)
+  @outline_root = @hash.values.find {|obj| obj.is_a?(Hash) && obj[:Type] == :Outlines}
+  @pages = @hash.values.find {|obj| obj.is_a?(Hash) && obj[:Type] == :Pages}[:Kids]
+  @section_1 = find_by_title('Chapter 1')
+  @page_1 = find_by_title('Page 1')
+  @page_2 = find_by_title('Page 2')
+  @section_2 = find_by_title('Added Section')
+  @page_3 = find_by_title('Page 3')
+  @inserted_page = find_by_title('Inserted Page')
+end
+
+def find_by_title(title)
+  @hash.values.find {|obj| obj.is_a?(Hash) && obj[:Title] == title}
+end
+
+def referenced_object(reference)
+  @hash[reference]
+end
+  

data/spec/pdf_object_spec.rb

@@ -0,0 +1,127 @@
+# encoding: ASCII-8BIT
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+# See PDF Reference, Sixth Edition (1.7) pp51-60 for details 
+describe "PDF Object Serialization" do     
+              
+  it "should convert Ruby's nil to PDF null" do
+    Prawn::Core::PdfObject(nil).should == "null"
+  end
+  
+  it "should convert Ruby booleans to PDF booleans" do
+    Prawn::Core::PdfObject(true).should  == "true"
+    Prawn::Core::PdfObject(false).should == "false"
+  end
+                                          
+  it "should convert a Ruby number to PDF number" do
+    Prawn::Core::PdfObject(1).should == "1"
+    Prawn::Core::PdfObject(1.214112421).should == "1.214112421" 
+  end
+  
+  it "should convert a Ruby time object to a PDF timestamp" do
+    t = Time.now
+    Prawn::Core::PdfObject(t).should == t.strftime("(D:%Y%m%d%H%M%S%z").chop.chop + "'00')"
+  end
+  
+  it "should convert a Ruby string to PDF string when inside a content stream" do       
+    s = "I can has a string"
+    PDF::Inspector.parse(Prawn::Core::PdfObject(s, true)).should == s
+  end                      
+
+  it "should convert a Ruby string to a UTF-16 PDF string when outside a content stream" do       
+    s = "I can has a string"
+    s_utf16 = "\xFE\xFF" + s.unpack("U*").pack("n*")
+    PDF::Inspector.parse(Prawn::Core::PdfObject(s, false)).should == s_utf16
+  end                      
+
+  it "should pass through bytes regardless of content stream status for ByteString" do
+    Prawn::Core::PdfObject(Prawn::Core::ByteString.new("\xDE\xAD\xBE\xEF")).upcase.
+      should == "<DEADBEEF>"
+  end
+  
+  it "should escape parens when converting from Ruby string to PDF" do
+    s =  'I )(can has a string'      
+    PDF::Inspector.parse(Prawn::Core::PdfObject(s, true)).should == s
+  end               
+  
+  it "should handle ruby escaped parens when converting to PDF string" do
+    s = 'I can \\)( has string'
+    PDF::Inspector.parse(Prawn::Core::PdfObject(s, true)).should == s  
+  end      
+  
+  it "should convert a Ruby symbol to PDF name" do
+    Prawn::Core::PdfObject(:my_symbol).should == "/my_symbol"
+    Prawn::Core::PdfObject(:"A;Name_With-Various***Characters?").should ==
+     "/A;Name_With-Various***Characters?"
+  end
+ 
+  it "should convert a whitespace or delimiter containing Ruby symbol to a PDF name" do
+    Prawn::Core::PdfObject(:"my symbol").should == "/my#20symbol"
+    Prawn::Core::PdfObject(:"my#symbol").should == "/my#23symbol"
+    Prawn::Core::PdfObject(:"my/symbol").should == "/my#2Fsymbol"
+    Prawn::Core::PdfObject(:"my(symbol").should == "/my#28symbol"
+    Prawn::Core::PdfObject(:"my)symbol").should == "/my#29symbol"
+    Prawn::Core::PdfObject(:"my<symbol").should == "/my#3Csymbol"
+    Prawn::Core::PdfObject(:"my>symbol").should == "/my#3Esymbol"
+  end
+  
+  it "should convert a Ruby array to PDF Array when inside a content stream" do
+    Prawn::Core::PdfObject([1,2,3]).should == "[1 2 3]"
+    PDF::Inspector.parse(Prawn::Core::PdfObject([[1,2],:foo,"Bar"], true)).should ==  
+      [[1,2],:foo, "Bar"]
+  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::Core::PdfObject([1,2,3]).should == "[1 2 3]"
+    PDF::Inspector.parse(Prawn::Core::PdfObject([[1,2],:foo,"Bar"], false)).should ==  
+      [[1,2],:foo, bar]
+  end  
+ 
+  it "should convert a Ruby hash to a PDF Dictionary when inside a content stream" do
+    dict = Prawn::Core::PdfObject( {:foo  => :bar, 
+                              "baz" => [1,2,3], 
+                              :bang => {:a => "what", :b => [:you, :say] }}, true )     
+
+    res = PDF::Inspector.parse(dict)           
+
+    res[:foo].should == :bar
+    res[:baz].should == [1,2,3]
+    res[:bang].should == { :a => "what", :b => [:you, :say] }
+
+  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::Core::PdfObject( {:foo  => :bar, 
+                              "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 => what, :b => [:you, :say] }
+
+  end      
+  
+  it "should not allow keys other than strings or symbols for PDF dicts" do
+    lambda { Prawn::Core::PdfObject(:foo => :bar, :baz => :bang, 1 => 4) }.
+      should.raise(Prawn::Errors::FailedObjectConversion) 
+  end  
+  
+  it "should convert a Prawn::Reference to a PDF indirect object reference" do
+    ref = Prawn::Core::Reference(1,true)
+    Prawn::Core::PdfObject(ref).should == ref.to_s
+  end
+
+  it "should convert a NameTree::Node to a PDF hash" do
+    node = Prawn::Core::NameTree::Node.new(Prawn::Document.new, 10)
+    node.add "hello", 1.0
+    node.add "world", 2.0
+    data = Prawn::Core::PdfObject(node)
+    res = PDF::Inspector.parse(data)
+    res.should == {:Names => ["hello", 1.0, "world", 2.0]}
+  end
+end

data/spec/png_spec.rb

@@ -0,0 +1,237 @@
+# encoding: ASCII-8BIT
+
+# Spec'ing the PNG class. Not complete yet - still needs to check the
+# contents of palette and transparency to ensure they're correct.
+# Need to find files that have these sections first.
+#
+# see http://www.w3.org/TR/PNG/ for a detailed description of the PNG spec,
+# particuarly Table 11.1 for the different color types
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+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.binread(@filename)
+  end
+
+  it "should read the attributes from the header chunk correctly" do
+    png = Prawn::Images::PNG.new(@img_data)
+
+    png.width.should == 21
+    png.height.should == 14
+    png.bits.should == 8
+    png.color_type.should == 0
+    png.compression_method.should == 0
+    png.filter_method.should == 0
+    png.interlace_method.should == 0
+  end
+
+  it "should read the image data chunk correctly" do
+    png = Prawn::Images::PNG.new(@img_data)
+    data = File.binread(@data_filename)
+    png.img_data.should == data
+  end
+end
+
+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.binread(@filename)
+  end
+
+  # In a greyscale type 0 PNG image, the tRNS chunk should contain a single value
+  # that indicates the color that should be interpreted as transparent.
+  #
+  # http://www.w3.org/TR/PNG/#11tRNS
+  it "should read the tRNS chunk correctly" do
+    png = Prawn::Images::PNG.new(@img_data)
+    png.transparency[:grayscale].should == 255
+  end
+end
+
+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.binread(@filename)
+  end
+
+  it "should read the attributes from the header chunk correctly" do
+    png = Prawn::Images::PNG.new(@img_data)
+
+    png.width.should == 258
+    png.height.should == 105
+    png.bits.should == 8
+    png.color_type.should == 2
+    png.compression_method.should == 0
+    png.filter_method.should == 0
+    png.interlace_method.should == 0
+  end
+
+  it "should read the image data chunk correctly" do
+    png = Prawn::Images::PNG.new(@img_data)
+    data = File.binread(@data_filename)
+    png.img_data.should == data
+  end
+end
+
+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.binread(@filename)
+  end
+
+  # In a RGB type 2 PNG image, the tRNS chunk should contain a single RGB value
+  # that indicates the color that should be interpreted as transparent. In this
+  # case it's green.
+  #
+  # http://www.w3.org/TR/PNG/#11tRNS
+  it "should read the tRNS chunk correctly" do
+    png = Prawn::Images::PNG.new(@img_data)
+    png.transparency[:rgb].should == [0, 255, 0]
+  end
+end
+
+# TODO: describe "When reading an indexed color PNG file wiih transparency (color type 3)"
+
+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.binread(@filename)
+  end
+
+  it "should read the attributes from the header chunk correctly" do
+    png = Prawn::Images::PNG.new(@img_data)
+
+    png.width.should == 50
+    png.height.should == 64
+    png.bits.should == 8
+    png.color_type.should == 3
+    png.compression_method.should == 0
+    png.filter_method.should == 0
+    png.interlace_method.should == 0
+  end
+
+  it "should read the image data chunk correctly" do
+    png = Prawn::Images::PNG.new(@img_data)
+    data = File.binread(@data_filename)
+    png.img_data.should == data
+  end
+end
+
+describe "When reading a greyscale+alpha PNG file (color type 4)" do
+
+  before(:each) 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.binread(@filename)
+  end
+
+  it "should read the attributes from the header chunk correctly" do
+    png = Prawn::Images::PNG.new(@img_data)
+
+    png.width.should == 16
+    png.height.should == 16
+    png.bits.should == 8
+    png.color_type.should == 4
+    png.compression_method.should == 0
+    png.filter_method.should == 0
+    png.interlace_method.should == 0
+  end
+
+  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)
+    png.split_alpha_channel!
+    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)
+    png.split_alpha_channel!
+    data = File.binread(@alpha_data_filename)
+    png.alpha_channel.should == data
+  end
+end
+
+describe "When reading an RGB+alpha PNG file (color type 6)" do
+
+  before(:each) 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.binread(@filename)
+  end
+
+  it "should read the attributes from the header chunk correctly" do
+    png = Prawn::Images::PNG.new(@img_data)
+
+    png.width.should == 320
+    png.height.should == 240
+    png.bits.should == 8
+    png.color_type.should == 6
+    png.compression_method.should == 0
+    png.filter_method.should == 0
+    png.interlace_method.should == 0
+  end
+
+  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)
+    png.split_alpha_channel!
+    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)
+    png.split_alpha_channel!
+    data = File.binread(@alpha_data_filename)
+    png.alpha_channel.should == data
+  end
+end
+
+describe "When reading a 16bit RGB+alpha PNG file (color type 6)" do
+
+  before(:each) do
+    @filename = "#{Prawn::BASEDIR}/data/images/16bit.png"
+    @data_filename = "#{Prawn::BASEDIR}/data/images/16bit.dat"
+    # alpha channel truncated to 8-bit
+    @alpha_data_filename = "#{Prawn::BASEDIR}/data/images/16bit.alpha"
+    @img_data = File.binread(@filename)
+  end
+
+  it "should read the attributes from the header chunk correctly" do
+    png = Prawn::Images::PNG.new(@img_data)
+
+    png.width.should == 32
+    png.height.should == 32
+    png.bits.should == 16
+    png.color_type.should == 6
+    png.compression_method.should == 0
+    png.filter_method.should == 0
+    png.interlace_method.should == 0
+  end
+
+  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)
+    png.split_alpha_channel!
+    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)
+    png.split_alpha_channel!
+    data = File.binread(@alpha_data_filename)
+    png.alpha_channel.should == data
+  end
+end

data/spec/reference_spec.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "A Reference object" do
+  it "should produce a PDF reference on #to_s call" do
+    ref = Prawn::Core::Reference(1,true)
+    ref.to_s.should == "1 0 R"
+  end                                        
+  
+  it "should allow changing generation number" do
+    ref = Prawn::Core::Reference(1,true)
+    ref.gen = 1
+    ref.to_s.should == "1 1 R"
+  end
+  
+  it "should generate a valid PDF object for the referenced data" do
+    ref = Prawn::Core::Reference(2,[1,"foo"]) 
+    ref.object.should == "2 0 obj\n#{Prawn::Core::PdfObject([1,"foo"])}\nendobj\n" 
+  end             
+  
+  it "should automatically open a stream when #<< is used" do
+     ref = Prawn::Core::Reference(1, :Length => 41)
+     ref << "BT\n/F1 12 Tf\n72 712 Td\n( A stream ) Tj\nET"   
+     ref.object.should == "1 0 obj\n<< /Length 41\n>>\nstream"+
+                           "\nBT\n/F1 12 Tf\n72 712 Td\n( A stream ) Tj\nET" +
+                           "\nendstream\nendobj\n"
+  end
+
+  it "should compress a stream upon request" do
+    ref = Prawn::Core::Reference(2,{})
+    ref << "Hi There " * 20
+
+    cref = Prawn::Core::Reference(2,{})
+    cref << "Hi There " * 20
+    cref.compress_stream
+
+    assert cref.stream.size < ref.stream.size, 
+      "compressed stream expected to be smaller than source but wasn't"
+    cref.data[:Filter].should == :FlateDecode
+  end
+
+  it "should copy the data and stream from another ref on #replace" do
+    from = Prawn::Core::Reference(3, {:foo => 'bar'})
+    from << "has a stream too"
+
+    to = Prawn::Core::Reference(4, {:foo => 'baz'})
+    to.replace from
+
+    # should preserve identifier but copy data and stream
+    to.identifier.should == 4
+    to.data.should == from.data
+    to.stream.should == from.stream
+  end
+
+  it "should copy a compressed stream from a compressed ref on #replace" do
+    from = Prawn::Core::Reference(5, {:foo => 'bar'})
+    from << "has a stream too " * 20
+    from.compress_stream
+
+    to = Prawn::Core::Reference(6, {:foo => 'baz'})
+    to.replace from
+
+    to.identifier.should == 6
+    to.data.should == from.data
+    to.stream.should == from.stream
+    to.compressed?.should == true
+  end
+
+  describe "generated via Prawn::Document" do
+    it "should return a proper reference on ref!" do
+      pdf = Prawn::Document.new
+      pdf.ref!({}).is_a?(Prawn::Core::Reference).should == true
+    end
+
+    it "should return an identifier on ref" do
+      pdf = Prawn::Document.new
+      r = pdf.ref({})
+      r.is_a?(Integer).should == true
+    end
+  end
+end