prawn 0.11.1 → 0.15.0

data/spec/repeater_spec.rb

@@ -10,14 +10,14 @@ describe "Repeaters" do
 
     r = repeater(doc, :all) { :do_nothing }
 
-    assert_equal orig_count + 1,  Prawn::Repeater.count
+    Prawn::Repeater.count.should == orig_count + 1
   end
 
   it "must provide an :all filter" do
     doc = sample_document
     r = repeater(doc, :all) { :do_nothing }
 
-    assert (1..doc.page_count).all? { |i| r.match?(i) }
+    (1..doc.page_count).all? { |i| r.match?(i) }.should be_true
   end
 
   it "must provide an :odd filter" do
@@ -26,29 +26,29 @@ describe "Repeaters" do
 
     odd, even = (1..doc.page_count).partition { |e| e % 2 == 1 }
 
-    assert odd.all? { |i| r.match?(i) }
-    assert ! even.any? { |i| r.match?(i) }
+    odd.all? { |i| r.match?(i) }.should be_true
+    even.any? { |i| r.match?(i) }.should be_false
   end
 
   it "must be able to filter by an array of page numbers" do
     doc = sample_document
     r = repeater(doc, [1,2,7]) { :do_nothing }
 
-    assert_equal [1,2,7], (1..10).select { |i| r.match?(i) }
+    (1..10).select { |i| r.match?(i) }.should == [1,2,7]
   end
 
   it "must be able to filter by a range of page numbers" do
     doc = sample_document
     r = repeater(doc, 2..4) { :do_nothing }
 
-    assert_equal [2,3,4], (1..10).select { |i| r.match?(i) }
+    (1..10).select { |i| r.match?(i) }.should == [2,3,4]
   end
 
   it "must be able to filter by an arbitrary proc" do
     doc = sample_document
     r = repeater(doc, lambda { |x| x == 1 or x % 3 == 0 })
 
-    assert_equal [1,3,6,9], (1..10).select { |i| r.match?(i) }
+    (1..10).select { |i| r.match?(i) }.should == [1,3,6,9]
   end
 
   it "must try to run a stamp if the page number matches" do
@@ -58,7 +58,7 @@ describe "Repeaters" do
     repeater(doc, :odd).run(3)
   end
 
-  it "must not try to run a stamp if the page number matches" do
+  it "must not try to run a stamp unless the page number matches" do
     doc = sample_document
 
     doc.expects(:stamp).never
@@ -72,6 +72,20 @@ describe "Repeaters" do
     (1..10).each { |p| repeater(doc, :all, true){:do_nothing}.run(p) }
   end
 
+  it "must try to run a block if the page number matches" do
+    doc = sample_document
+
+    doc.expects(:draw_text).twice
+    (1..10).each { |p| repeater(doc, [1,2], true){doc.draw_text "foo"}.run(p) }
+  end
+
+  it "must not try to run a block unless the page number matches" do
+    doc = sample_document
+
+    doc.expects(:draw_text).never
+    repeater(doc, :odd, true){doc.draw_text "foo"}.run(2)
+  end
+
   it "must treat any block as a closure" do
     doc = sample_document
 
@@ -81,7 +95,7 @@ describe "Repeaters" do
     end
 
     text = PDF::Inspector::Text.analyze(doc.render)
-    assert_equal (1..10).to_a.map{|p| "Page #{p}"}, text.strings
+    text.strings.should == (1..10).to_a.map{|p| "Page #{p}"}
   end
 
   it "must treat any block as a closure (Document.new instance_eval form)" do
@@ -96,7 +110,7 @@ describe "Repeaters" do
     end
 
     text = PDF::Inspector::Text.analyze(doc.render)
-    assert_equal (1..10).to_a.map{|p| "Page #{p}"}, text.strings
+    text.strings.should == (1..10).to_a.map{|p| "Page #{p}"}
   end
 
   def sample_document
@@ -136,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
 
@@ -66,10 +66,10 @@ describe "Document encryption" do
         should == 0b1111_1111_1111_1111_1111_1111_1101_1111
     end
 
-    it "should raise ArgumentError if invalid option is provided" do
+    it "should raise_error ArgumentError if invalid option is provided" do
       lambda {
         doc_with_permissions(:modify_document => false)
-      }.should.raise(ArgumentError)
+      }.should raise_error(ArgumentError)
     end
 
   end
@@ -89,7 +89,7 @@ describe "Document encryption" do
     end
 
     it "should calculate the correct owner hash" do
-      @pdf.owner_password_hash.unpack("H*").first.should.match(/^61CA855012/i)
+      @pdf.owner_password_hash.unpack("H*").first.should match(/^61CA855012/i)
     end
 
     it "should calculate the correct user hash" do
@@ -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/snapshot_spec.rb

@@ -23,7 +23,7 @@ describe "Prawn::Document#transaction" do
     end
     text = PDF::Inspector::Text.analyze(pdf.render)
     text.strings.should == []
-  end 
+  end
 
   it "should return true/false value indicating success of the transaction" do
     Prawn::Document.new do
@@ -34,7 +34,7 @@ describe "Prawn::Document#transaction" do
       success.should == false
     end
   end
-  
+
   it "should support nested transactions" do
     pdf = Prawn::Document.new do
       transaction do
@@ -76,7 +76,7 @@ describe "Prawn::Document#transaction" do
         rescue Prawn::Errors::CannotGroup
           add_lines(pdf)
         end
-      end.should.not.raise#(Prawn::Document::Snapshot::RollbackTransaction)
+      end.should_not raise_error#(Prawn::Document::Snapshot::RollbackTransaction)
     end
   end
 
@@ -112,7 +112,39 @@ describe "Prawn::Document#transaction" do
     end
 
   end
-  
+
+  it "should restore bounds on rollback" do
+    Prawn::Document.new(:page_layout => :landscape) do
+      size = [bounds.width, bounds.height]
+      transaction do
+        start_new_page :layout => :portrait
+        rollback
+      end
+      [bounds.width, bounds.height].should == size
+    end
+  end
+
+  it "should set new bounding box on start_new_page with different layout" do
+    Prawn::Document.new(:page_layout => :landscape) do
+      size = [bounds.width, bounds.height]
+      transaction do
+        start_new_page
+        rollback
+      end
+
+      start_new_page :layout => :portrait
+      [bounds.width, bounds.height].should == size.reverse
+    end
+  end
+
+  it "should work with dests" do
+    Prawn::Document.new do |pdf|
+      pdf.add_dest("dest", pdf.dest_fit_horizontally(pdf.cursor, pdf.page))
+      pdf.text("Hello world")
+      lambda { pdf.transaction{} }.should_not raise_error
+    end
+  end
+
   describe "with a stamp dictionary present" do
 
     it "should properly commit if no error is raised" do
@@ -134,8 +166,8 @@ describe "Prawn::Document#transaction" do
           rollback
         end
       end
-      pdf.render.should.not =~ /\/Stamp1 Do/
-    end 
+      pdf.render.should_not =~ /\/Stamp1 Do/
+    end
 
   end
 

data/spec/soft_mask_spec.rb

@@ -0,0 +1,117 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+module SoftMaskHelper
+  def make_soft_mask
+    @pdf.save_graphics_state do
+      @pdf.soft_mask do
+        if block_given?
+          yield
+        else
+          @pdf.fill_color '808080'
+          @pdf.fill_rectangle [100, 100], 200, 200
+        end
+      end
+
+      @pdf.fill_color '000000'
+      @pdf.fill_rectangle [0, 0], 200, 200
+    end
+  end
+end
+
+describe "Document with soft masks" do
+
+  include SoftMaskHelper
+
+  it "should have PDF version at least 1.4" do
+    create_pdf
+    make_soft_mask
+    str = @pdf.render
+    str[0,8].should == "%PDF-1.4"
+  end
+
+  it "should create a new extended graphics state for each unique soft mask" do
+    create_pdf
+
+    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 [10, 10], 200, 200
+    end
+
+    extgstates = PDF::Inspector::ExtGState.analyze(@pdf.render).extgstates
+    extgstates.length.should == 2
+  end
+
+  it "a new extended graphics state should contain soft mask with drawing instructions" do
+    create_pdf
+
+    make_soft_mask do
+      @pdf.fill_color '808080'
+      @pdf.fill_rectangle [100, 100], 200, 200
+    end
+
+    extgstate = PDF::Inspector::ExtGState.analyze(@pdf.render).extgstates.first
+    extgstate[:soft_mask][:G].data.should == "q\n/DeviceRGB cs\n0.000 0.000 0.000 scn\n/DeviceRGB CS\n0.000 0.000 0.000 SCN\n1 w\n0 J\n0 j\n[ ] 0 d\n/DeviceRGB cs\n0.502 0.502 0.502 scn\n100.000 -100.000 200.000 200.000 re\nf\nQ\n"
+  end
+
+  it "should not create duplicate extended graphics states" do
+    create_pdf
+
+    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
+
+    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,24 +2,24 @@
 
 require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
 
-describe "drawing span" do    
-  
-  def setup
+describe "drawing span" do
+
+  before do
     Prawn.debug = false
     create_pdf
   end
 
-  def teardown
+  after do
     Prawn.debug = true
   end
 
   it "should only accept :position as option in debug mode" do
     Prawn.debug = true
-    lambda { @pdf.span(350, {:x => 3}) {} }.should.raise(Prawn::Errors::UnknownOption)
+    lambda { @pdf.span(350, {:x => 3}) {} }.should raise_error(Prawn::Errors::UnknownOption)
   end
 
   it "should have raise an error if :position is invalid" do
-    lambda { @pdf.span(350, :position => :x) {} }.should.raise(ArgumentError)
+    lambda { @pdf.span(350, :position => :x) {} }.should raise_error(ArgumentError)
   end
 
   it "should restore the margin box when bounding box exits" do
@@ -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

@@ -2,29 +2,53 @@
 
 puts "Prawn specs: Running on Ruby Version: #{RUBY_VERSION}"
 
-require "rubygems"
 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
 
-require "test/spec"
-require "mocha"
+#require "test/spec"
+require "rspec"
+require "mocha/api"
 require "pdf/reader"
 require "pdf/inspector"
 
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/extensions/ and its subdirectories.
+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
   public :map_to_absolute
 end
 
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[extensions mocha]))
-

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(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(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
 
@@ -33,42 +34,42 @@ describe "#stamp_at" do
 end
 
 describe "Document with a stamp" do
-  it "should raise NameTaken error when attempt to create stamp "+
+  it "should raise_error NameTaken error when attempt to create stamp "+
      "with same name as an existing stamp" do
     create_pdf
     @pdf.create_stamp("MyStamp")
     lambda {
       @pdf.create_stamp("MyStamp")
-    }.should.raise(Prawn::Errors::NameTaken)
+    }.should raise_error(Prawn::Errors::NameTaken)
   end
-  
-  it "should raise InvalidName error when attempt to create "+
+
+  it "should raise_error InvalidName error when attempt to create "+
      "stamp with a blank name" do
     create_pdf
     lambda {
       @pdf.create_stamp("")
-    }.should.raise(Prawn::Errors::InvalidName)
+    }.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
   end
 
   it "calling stamp with a name that does not match an existing stamp "+
-     "should raise UndefinedObjectName" do
+     "should raise_error UndefinedObjectName" do
     create_pdf
     @pdf.create_stamp("MyStamp")
     lambda {
       @pdf.stamp("OtherStamp")
-    }.should.raise(Prawn::Errors::UndefinedObjectName)
+    }.should raise_error(Prawn::Errors::UndefinedObjectName)
   end
 
   it "stamp should be drawn into the document each time stamp is called" do
@@ -99,13 +100,13 @@ describe "Document with a stamp" do
     objects = output.split("endobj")
     objects.each do |object|
       if object =~ /\/Type \/Page$/
-        object.should.not =~ /\/ExtGState/
+        object.should_not =~ /\/ExtGState/
       elsif object =~ /\/Type \/XObject$/
         object.should =~ /\/ExtGState/
       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
@@ -139,10 +140,10 @@ describe "Document with a stamp" do
     @pdf.stamp("MyStamp")
     stamps = PDF::Inspector::XObject.analyze(@pdf.render)
     stamp_stream = stamps.xobject_streams[:Stamp1].data
-    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"
+    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)
@@ -152,8 +153,6 @@ describe "Document with a stamp" do
     @pdf.stamp("MyStamp")
     stamps = PDF::Inspector::XObject.analyze(@pdf.render)
     stamp_stream = stamps.xobject_streams[:Stamp1].data
-    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
-    
-
 end