prawn 1.0.0.rc2 → 1.0.0

data/spec/reference_spec.rb

@@ -3,90 +3,10 @@
 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
-
-    cref.stream.size.should be < 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
-
-  it "should have Length if stream present" do
-    ref = Prawn::Core::Reference(7, {})
-    ref << "Hello"
-
-    ref.data[:Length].should == 5
-  end
-
-  it "should update Length when stream is updated" do
-    ref = Prawn::Core::Reference(7, {})
-    ref << "Hello"
-    ref.data[:Length].should == 5
-
-    ref << " world"
-    ref.data[:Length].should == 11
-  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
+      pdf.ref!({}).is_a?(PDF::Core::Reference).should == true
     end
 
     it "should return an identifier on ref" do
@@ -99,7 +19,7 @@ describe "A Reference object" do
       pdf = Prawn::Document.new :compress => false
       ref = pdf.ref!({})
       ref << 'Hello'
-      ref.data[:Length].should == 5
+      ref.stream.data[:Length].should == 5
     end
   end
 end

data/spec/repeater_spec.rb

@@ -150,7 +150,7 @@ describe "Repeaters" do
         text.strings.include?("cap_style: round").should == false
         text.strings.include?("cap_style: butt").should == true
       end
-      
+
     end
 
   end

data/spec/security_spec.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 require "tempfile"
 
-require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper") 
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
 
 describe "Document encryption" do
 
@@ -31,9 +31,9 @@ describe "Document encryption" do
     end
 
   end
-  
+
   describe "Setting permissions" do
-    
+
     def doc_with_permissions(permissions)
       pdf = Prawn::Document.new
 
@@ -106,21 +106,53 @@ describe "Document encryption" do
   describe "EncryptedPdfObject" do
 
     it "should delegate to PdfObject for simple types" do
-      Prawn::Core::EncryptedPdfObject(true, nil, nil, nil).should == "true"
-      Prawn::Core::EncryptedPdfObject(42, nil, nil, nil).should == "42"
+      PDF::Core::EncryptedPdfObject(true, nil, nil, nil).should == "true"
+      PDF::Core::EncryptedPdfObject(42, nil, nil, nil).should == "42"
     end
 
     it "should encrypt strings properly" do
-      Prawn::Core::EncryptedPdfObject("foo", "12345", 123, 0).should == "<4ad6e3>"
+      PDF::Core::EncryptedPdfObject("foo", "12345", 123, 0).should == "<4ad6e3>"
+    end
+
+    it "should encrypt literal strings properly" do
+       PDF::Core::EncryptedPdfObject(PDF::Core::LiteralString.new("foo"), "12345", 123, 0).should == bin_string("(J\xD6\xE3)")
+       PDF::Core::EncryptedPdfObject(PDF::Core::LiteralString.new("lhfbqg3do5u0satu3fjf"), nil, 123, 0).should == bin_string("(\xF1\x8B\\(\b\xBB\xE18S\x130~4*#\\(%\x87\xE7\x8E\\\n)")
+    end
+
+    it "should encrypt time properly" do
+       PDF::Core::EncryptedPdfObject(Time.utc(2050, 04, 26, 10, 17, 10), "12345", 123, 0).should == bin_string("(h\x83\xBE\xDC\xEC\x99\x0F\xD7\\)%\x13\xD4$\xB8\xF0\x16\xB8\x80\xC5\xE91+\xCF)")
     end
 
     it "should properly handle compound types" do
-      Prawn::Core::EncryptedPdfObject({:Bar => "foo"}, "12345", 123, 0).should ==
+      PDF::Core::EncryptedPdfObject({:Bar => "foo"}, "12345", 123, 0).should ==
         "<< /Bar <4ad6e3>\n>>"
-      Prawn::Core::EncryptedPdfObject(["foo", "bar"], "12345", 123, 0).should ==
+      PDF::Core::EncryptedPdfObject(["foo", "bar"], "12345", 123, 0).should ==
         "[<4ad6e3> <4ed8fe>]"
     end
-    
+
+  end
+
+  describe "Reference#encrypted_object" do
+    it "should encrypt references properly" do
+      ref = PDF::Core::Reference(1,["foo"])
+      ref.encrypted_object(nil).should == "1 0 obj\n[<4fca3f>]\nendobj\n"
+    end
+
+    it "should encrypt references with streams properly" do
+      ref = PDF::Core::Reference(1, {})
+      ref << 'foo'
+      result = bin_string("1 0 obj\n<< /Length 3\n>>\nstream\nO\xCA?\nendstream\nendobj\n")
+      ref.encrypted_object(nil).should == result
+    end
+  end
+
+  describe "String#encrypted_object" do
+    it "should encrypt stream properly" do
+      stream = PDF::Core::Stream.new
+      stream << "foo"
+      result = bin_string("stream\nO\xCA?\nendstream\n")
+      stream.encrypted_object(nil, 1, 0).should == result
+    end
   end
 
 end

data/spec/soft_mask_spec.rb

@@ -74,44 +74,4 @@ describe "Document with soft masks" do
     extgstates = PDF::Inspector::ExtGState.analyze(@pdf.render).extgstates
     extgstates.length.should == 1
   end
-
-  it "should not have objects that are not used for extended graphic state" do
-    @pdf = Prawn::Document.new(:margin => 0, :optimize_objects => true)
-
-    make_soft_mask do
-      @pdf.fill_color '808080'
-      @pdf.fill_rectangle [100, 100], 200, 200
-    end
-
-    make_soft_mask do
-      @pdf.fill_color '808080'
-      @pdf.fill_rectangle [100, 100], 200, 200
-    end
-
-    reader = PDF::Reader.new(StringIO.open(@pdf.render))
-
-    groups = reader.objects.select { |obj|
-      o = obj[1]
-      o.is_a?(Hash) && o[:Type] == :Group
-    }
-    groups.length.should == 1
-
-    forms = reader.objects.select { |obj|
-      o = obj[1]
-      o.is_a?(PDF::Reader::Stream) && o.hash[:Type] == :XObject && o.hash[:Subtype] == :Form
-    }
-    forms.length.should == 1
-
-    masks = reader.objects.select { |obj|
-      o = obj[1]
-      o.is_a?(Hash) && o[:Type] == :Mask
-    }
-    masks.length.should == 1
-
-    ext_g_states = reader.objects.select { |obj|
-      o = obj[1]
-      o.is_a?(Hash) && o[:Type] == :ExtGState
-    }
-    ext_g_states.length.should == 1
-  end
 end

data/spec/span_spec.rb

@@ -2,8 +2,8 @@
 
 require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
 
-describe "drawing span" do    
-  
+describe "drawing span" do
+
   before do
     Prawn.debug = false
     create_pdf
@@ -28,9 +28,8 @@ describe "drawing span" do
     @pdf.span(350, :position => :center) do
       @pdf.text "Here's some centered text in a 350 point column. " * 100
     end
-    
+
     @pdf.bounds.should == margin_box
-    
   end
 
   it "should do create a margin box" do
@@ -38,12 +37,8 @@ describe "drawing span" do
     margin_box = @pdf.span(350, :position => :center) do
       @pdf.text "Here's some centered text in a 350 point column. " * 100
     end
-    
+
     margin_box.top.should == 792.0
-    margin_box.bottom.should == 0    
-    
-  end  
-  
+    margin_box.bottom.should == 0
+  end
 end
-
-  

data/spec/spec_helper.rb

@@ -5,7 +5,14 @@ puts "Prawn specs: Running on Ruby Version: #{RUBY_VERSION}"
 require "bundler"
 Bundler.setup
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib') 
+if ENV["COVERAGE"]
+  require "simplecov"
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+end
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require "prawn"
 
 Prawn.debug = true
@@ -23,11 +30,22 @@ Dir[File.dirname(__FILE__) + "/extensions/**/*.rb"].each {|f| require f }
 RSpec.configure do |config|
   config.mock_framework = :mocha
   config.include EncodingHelpers
+  config.treat_symbols_as_metadata_keys_with_true_values = true
 end
 
 def create_pdf(klass=Prawn::Document)
   @pdf = klass.new(:margin => 0)
-end    
+end
+
+RSpec::Matchers.define :have_parseable_xobjects do
+  match do |actual|
+    expect { PDF::Inspector::XObject.analyze(actual.render) }.not_to raise_error
+    true
+  end
+  failure_message_for_should do |actual|
+    "expected that #{actual}'s XObjects could be successfully parsed"
+  end
+end
 
 # Make some methods public to assist in testing
 module Prawn::Graphics

data/spec/stamp_spec.rb

@@ -3,19 +3,20 @@ require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
 describe "create_stamp before any page is added" do
   it "should work with the font class" do
     @pdf = Prawn::Document.new(:skip_page_creation => true)
-    lambda {
-      @pdf.create_stamp("my_stamp") do
-        @pdf.font.height
-      end
-    }.should_not raise_error(Prawn::Errors::NotOnPage)
+
+    # If anything goes wrong, Prawn::Errors::NotOnPage will be raised
+    @pdf.create_stamp("my_stamp") do
+      @pdf.font.height
+    end
   end
+
   it "should work with setting color" do
     @pdf = Prawn::Document.new(:skip_page_creation => true)
-    lambda {
-      @pdf.create_stamp("my_stamp") do
-        @pdf.fill_color = 'ff0000'
-      end
-    }.should_not raise_error(Prawn::Errors::NotOnPage)
+
+    # If anything goes wrong, Prawn::Errors::NotOnPage will be raised
+    @pdf.create_stamp("my_stamp") do
+      @pdf.fill_color = 'ff0000'
+    end
   end
 end
 
@@ -41,7 +42,7 @@ describe "Document with a stamp" do
       @pdf.create_stamp("MyStamp")
     }.should raise_error(Prawn::Errors::NameTaken)
   end
-  
+
   it "should raise_error InvalidName error when attempt to create "+
      "stamp with a blank name" do
     create_pdf
@@ -49,14 +50,14 @@ describe "Document with a stamp" do
       @pdf.create_stamp("")
     }.should raise_error(Prawn::Errors::InvalidName)
   end
-  
+
   it "a new XObject should be defined for each stamp created" do
     create_pdf
     @pdf.create_stamp("MyStamp")
     @pdf.create_stamp("AnotherStamp")
     @pdf.stamp("MyStamp")
     @pdf.stamp("AnotherStamp")
-    
+
     inspector = PDF::Inspector::XObject.analyze(@pdf.render)
     xobjects = inspector.page_xobjects.last
     xobjects.length.should == 2
@@ -105,7 +106,7 @@ describe "Document with a stamp" do
       end
     end
   end
-  
+
   it "stamp stream should be wrapped in a graphic state" do
     create_pdf
     @pdf.create_stamp("MyStamp") do
@@ -115,11 +116,11 @@ describe "Document with a stamp" do
     stamps = PDF::Inspector::XObject.analyze(@pdf.render)
     stamps.xobject_streams[:Stamp1].data.chomp.should =~ /q(.|\s)*Q\Z/
   end
-  
+
   it "should not add to the page graphic state stack " do
     create_pdf
     @pdf.state.page.stack.stack.size.should == 1
-    
+
     @pdf.create_stamp("MyStamp") do
       @pdf.save_graphics_state
       @pdf.save_graphics_state
@@ -129,7 +130,7 @@ describe "Document with a stamp" do
     end
     @pdf.state.page.stack.stack.size.should == 1
   end
-  
+
   it "should be able to change fill and stroke colors within the stamp stream" do
     create_pdf
     @pdf.create_stamp("MyStamp") do
@@ -142,7 +143,7 @@ describe "Document with a stamp" do
     stamp_stream.should include("/DeviceCMYK cs\n1.000 1.000 0.200 0.000 scn")
     stamp_stream.should include("/DeviceCMYK CS\n1.000 1.000 0.200 0.000 SCN")
   end
-  
+
   it "should save the color space even when same as current page color space" do
     create_pdf
     @pdf.stroke_color(100, 100, 20, 0)
@@ -154,6 +155,4 @@ describe "Document with a stamp" do
     stamp_stream = stamps.xobject_streams[:Stamp1].data
     stamp_stream.should include("/DeviceCMYK CS\n1.000 1.000 0.200 0.000 SCN")
   end
-    
-
 end

data/spec/stroke_styles_spec.rb

@@ -7,7 +7,7 @@ describe "When stroking with default settings" do
   it "cap_style should be :butt" do
     @pdf.cap_style.should == :butt
   end
-  
+
   it "join_style should be :miter" do
     @pdf.join_style.should == :miter
   end
@@ -19,12 +19,12 @@ end
 
 describe "Cap styles" do
   before(:each) { create_pdf }
-  
+
   it "should be able to use assignment operator" do
     @pdf.cap_style = :round
     @pdf.cap_style.should == :round
   end
-  
+
   describe "#cap_style(:butt)" do
     it "rendered PDF should include butt style cap" do
       @pdf.cap_style(:butt)
@@ -60,12 +60,12 @@ end
 
 describe "Join styles" do
   before(:each) { create_pdf }
-  
+
   it "should be able to use assignment operator" do
     @pdf.join_style = :round
     @pdf.join_style.should == :round
   end
-  
+
   describe "#join_style(:miter)" do
     it "rendered PDF should include miter style join" do
       @pdf.join_style(:miter)
@@ -101,7 +101,7 @@ end
 
 describe "Dashes" do
   before(:each) { create_pdf }
-  
+
    it "should be able to use assignment operator" do
      @pdf.dash = 2
      @pdf.should be_dashed
@@ -143,6 +143,24 @@ describe "Dashes" do
     end
   end
 
+  describe "setting a dash by using an array" do
+    it "dash and spaces should be set from the array" do
+      @pdf.dash([1,2,3,4])
+      dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+      dashes.stroke_dash.should == [[1, 2, 3, 4], 0]
+    end
+    it "space options has to be ignored" do
+      @pdf.dash([1,2,3,4], :space => 3)
+      dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+      dashes.stroke_dash.should == [[1, 2, 3, 4], 0]
+    end
+    it "phase options should be correctly used" do
+      @pdf.dash([1,2,3,4], :phase => 3)
+      dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+      dashes.stroke_dash.should == [[1, 2, 3, 4], 3]
+    end
+  end
+
   describe "clearing stroke dash" do
     it "should restore solid line" do
       @pdf.dash(2)
@@ -151,7 +169,7 @@ describe "Dashes" do
       dashes.stroke_dash.should == [[], 0]
     end
   end
- 
+
   it "should carry the current dash settings over to new pages" do
     @pdf.dash(2)
     @pdf.start_new_page
@@ -159,19 +177,19 @@ describe "Dashes" do
     dashes.stroke_dash_count.should == 2
     dashes.stroke_dash.should == [[2, 2], 0]
   end
-  
+
   describe "#dashed?" do
-    
+
     it "an initial document should not be dashed" do
       @pdf.dashed?.should == false
     end
-    
+
     it "should return true if any of the currently active settings are dashed" do
       @pdf.dash(2)
       @pdf.save_graphics_state
       @pdf.dashed?.should == true
     end
-    
+
     it "should return false if the document was most recently undashed" do
       @pdf.dash(2)
       @pdf.save_graphics_state
@@ -179,7 +197,7 @@ describe "Dashes" do
       @pdf.save_graphics_state
       @pdf.dashed?.should == false
     end
-    
+
     it "should return true when restoring to a state that was dashed" do
       @pdf.dash(2)
       @pdf.save_graphics_state
@@ -187,7 +205,7 @@ describe "Dashes" do
       @pdf.restore_graphics_state
       @pdf.dashed?.should == true
     end
-    
+
   end
 
 end