piglop-prawn 0.10.2.1

data/spec/repeater_spec.rb

@@ -0,0 +1,96 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")           
+
+describe "Repeaters" do
+
+  it "creates a stamp and increments Prawn::Repeater.count on initialize" do
+    orig_count = Prawn::Repeater.count
+
+    doc = sample_document
+    doc.expects(:create_stamp).with("prawn_repeater(#{orig_count})")
+
+    r = repeater(doc, :all) { :do_nothing }
+
+    assert_equal orig_count + 1,  Prawn::Repeater.count 
+  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) }
+  end
+
+  it "must provide an :odd filter" do
+    doc = sample_document
+    r = repeater(doc, :odd) { :do_nothing }
+
+    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) }
+  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) }
+  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) }
+  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) }
+  end
+
+  it "must try to run a stamp if the page number matches" do
+    doc = sample_document
+    doc.expects(:stamp)
+
+    repeater(doc, :odd).run(3)
+  end
+
+  it "must not try to run a stamp if the page number matches" do
+    doc = sample_document
+
+    doc.expects(:stamp).never
+    repeater(doc, :odd).run(2)
+  end
+  
+  it "must not try to run a stamp if dynamic is selected" do
+    doc = sample_document
+
+    doc.expects(:stamp).never
+    (1..10).each { |p| repeater(doc, :all, true){:do_nothing}.run(p) }
+  end
+  
+  it "must render the block in context of page when dynamic is selected" do
+    doc = sample_document
+
+    doc.repeat(:all, :dynamic => true) do 
+      draw_text page_number, :at => [500, 0]
+    end
+
+    text = PDF::Inspector::Text.analyze(doc.render)  
+    assert_equal (1..10).to_a.map{|p| p.to_s}, text.strings 
+  end
+
+  def sample_document
+    doc = Prawn::Document.new(:skip_page_creation => true)
+    10.times { |e| doc.start_new_page }
+    doc
+  end
+
+  def repeater(*args, &b)
+    Prawn::Repeater.new(*args,&b)
+  end
+
+end

data/spec/security_spec.rb

@@ -0,0 +1,120 @@
+# encoding: utf-8
+require "tempfile"
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper") 
+
+describe "Document encryption" do
+
+  describe "Password padding" do
+
+    include Prawn::Document::Security
+
+    it "should truncate long passwords" do
+      pw = "Long long string" * 30
+      padded = pad_password(pw)
+      padded.length.should == 32
+      padded.should == pw[0, 32]
+    end
+
+    it "should pad short passwords" do
+      pw = "abcd"
+      padded = pad_password(pw)
+      padded.length.should == 32
+      padded.should == pw + Prawn::Document::Security::PasswordPadding[0, 28]
+    end
+
+    it "should fully pad null passwords" do
+      pw = ""
+      padded = pad_password(pw)
+      padded.length.should == 32
+      padded.should == Prawn::Document::Security::PasswordPadding
+    end
+
+  end
+  
+  describe "Setting permissions" do
+    
+    def doc_with_permissions(permissions)
+      pdf = Prawn::Document.new
+
+      class << pdf
+        # Make things easier to test
+        public :permissions_value
+      end
+
+      pdf.encrypt_document(:permissions => permissions)
+      pdf
+    end
+
+    it "should default to full permissions" do
+      doc_with_permissions({}).permissions_value.should == 0xFFFFFFFF
+      doc_with_permissions(:print_document     => true,
+                           :modify_contents    => true,
+                           :copy_contents      => true,
+                           :modify_annotations => true).permissions_value.
+        should == 0xFFFFFFFF
+    end
+
+    it "should clear the appropriate bits for each permission flag" do
+      doc_with_permissions(:print_document => false).permissions_value.
+        should == 0b1111_1111_1111_1111_1111_1111_1111_1011
+      doc_with_permissions(:modify_contents => false).permissions_value.
+        should == 0b1111_1111_1111_1111_1111_1111_1111_0111
+      doc_with_permissions(:copy_contents => false).permissions_value.
+        should == 0b1111_1111_1111_1111_1111_1111_1110_1111
+      doc_with_permissions(:modify_annotations => false).permissions_value.
+        should == 0b1111_1111_1111_1111_1111_1111_1101_1111
+    end
+
+  end
+
+  describe "Encryption keys" do
+    # Since PDF::Reader doesn't read encrypted PDF files, we just take the
+    # roundabout method of verifying each step of the encryption. This works
+    # fine because the encryption method is deterministic.
+
+    before(:each) do
+      @pdf = Prawn::Document.new
+      class << @pdf
+        public :owner_password_hash, :user_password_hash, :user_encryption_key
+      end
+      @pdf.encrypt_document :user_password => 'foo', :owner_password => 'bar',
+        :permissions => { :print_document => false }
+    end
+
+    it "should calculate the correct owner hash" do
+      @pdf.owner_password_hash.unpack("H*").first.should.match(/^61CA855012/i)
+    end
+
+    it "should calculate the correct user hash" do
+      @pdf.user_password_hash.unpack("H*").first.should =~ /^6BC8C51031/i
+    end
+
+    it "should calculate the correct user_encryption_key" do
+      @pdf.user_encryption_key.unpack("H*").first.upcase.should == "B100AB6429"
+    end
+
+
+  end
+
+  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"
+    end
+
+    it "should encrypt strings properly" do
+      Prawn::Core::EncryptedPdfObject("foo", "12345", 123, 0).should == "<4ad6e3>"
+    end
+
+    it "should properly handle compound types" do
+      Prawn::Core::EncryptedPdfObject({:Bar => "foo"}, "12345", 123, 0).should ==
+        "<< /Bar <4ad6e3>\n>>"
+      Prawn::Core::EncryptedPdfObject(["foo", "bar"], "12345", 123, 0).should ==
+        "[<4ad6e3> <4ed8fe>]"
+    end
+    
+  end
+
+end

data/spec/snapshot_spec.rb

@@ -0,0 +1,138 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "Prawn::Document#transaction" do
+
+  it "should properly commit if no error is raised" do
+    pdf = Prawn::Document.new do
+      transaction do
+        text "This is shown"
+      end
+    end
+    text = PDF::Inspector::Text.analyze(pdf.render)
+    text.strings.should == ["This is shown"]
+  end
+
+  it "should not display text if transaction is rolled back" do
+    pdf = Prawn::Document.new do
+      transaction do
+        text "This is not shown"
+        rollback
+      end
+    end
+    text = PDF::Inspector::Text.analyze(pdf.render)
+    text.strings.should == []
+  end 
+
+  it "should return true/false value indicating success of the transaction" do
+    Prawn::Document.new do
+      success = transaction { }
+      success.should == true
+
+      success = transaction { rollback }
+      success.should == false
+    end
+  end
+  
+  it "should support nested transactions" do
+    pdf = Prawn::Document.new do
+      transaction do
+        text "This is shown"
+        transaction do
+          text "and this is not"
+          rollback
+        end
+        text "and this is"
+      end
+    end
+    text = PDF::Inspector::Text.analyze(pdf.render)
+    text.strings.should == ["This is shown", "and this is"]
+  end
+
+  it "should allow rollback of multiple pages" do
+    pdf = Prawn::Document.new do
+      transaction do
+        5.times { start_new_page }
+        text "way out there and will never be shown"
+        rollback
+      end
+      text "This is the real text, only one page"
+    end
+
+    pages = PDF::Inspector::Page.analyze(pdf.render).pages
+    pages.size.should == 1
+  end
+
+  # Because the Pages object, when restored, points to the snapshotted pages
+  # by identifier, we have to restore the snapshot into the same page objects,
+  # or else old pages will appear in the post-rollback document.
+  it "should restore the pages into the same objects" do
+    Prawn::Document.new do
+      old_page_object_id = state.page.dictionary.identifier
+      old_page_content_id = state.page.content.identifier
+
+      transaction do
+        start_new_page
+        rollback
+      end
+
+      state.page.dictionary.identifier.should == old_page_object_id
+      state.page.content.identifier.should == old_page_content_id
+    end
+
+  end
+
+  it "page object should refer to the page_content object after restore" do
+
+    Prawn::Document.new do
+      transaction do
+        start_new_page
+        rollback
+      end
+
+      # should be the exact same object, not a clone
+      state.page.dictionary.data[:Contents].should == state.page.content
+    end
+
+  end
+  
+  describe "with a stamp dictionary present" do
+
+    it "should properly commit if no error is raised" do
+      pdf = Prawn::Document.new do
+        create_stamp("test_stamp") { draw_text "This is shown", :at => [0,0] }
+        transaction do
+          stamp("test_stamp")
+        end
+      end
+      pdf.render.should =~ /\/Stamp1 Do/
+    end
+
+    it "should properly rollback when #rollback is called" do
+      pdf = Prawn::Document.new do
+        create_stamp("test_stamp") { draw_text "This is not shown", :at => [0,0] }
+
+        transaction do
+          stamp("test_stamp")
+          rollback
+        end
+      end
+      pdf.render.should.not =~ /\/Stamp1 Do/
+    end 
+
+  end
+
+  it "should restore page_number on rollback" do
+    Prawn::Document.new do
+      transaction do
+        5.times { start_new_page }
+        rollback
+      end
+
+      page_number.should == 1
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+puts "Prawn specs: Running on Ruby Version: #{RUBY_VERSION}"
+
+require "rubygems"
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib') 
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'vendor',
+                             'pdf-inspector','lib')
+require "prawn"
+
+Prawn.debug = true
+
+ruby_19 do
+  gem "test-unit", "=1.2.3"
+end
+require "test/spec"
+require "mocha"
+
+gem 'pdf-reader', ">=0.8"
+require "pdf/reader"          
+require "pdf/inspector"
+
+def create_pdf(klass=Prawn::Document)
+  @pdf = klass.new(:margin => 0)
+end    
+

data/spec/stamp_spec.rb

@@ -0,0 +1,108 @@
+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)
+  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)
+  end
+end
+
+describe "#stamp_at" do
+  it "should work" do
+    create_pdf
+    @pdf.create_stamp("MyStamp")
+    @pdf.stamp_at("MyStamp", [100, 200])
+    # I had modified PDF::Inspector::XObject to receive the
+    # invoke_xobject message and count the number of times it was
+    # called, but it was only called once, so I reverted checking the
+    # output with a regular expression
+    @pdf.render.should =~ /\/Stamp1 Do.*?/m
+  end
+end
+
+describe "Document with a stamp" do
+  it "should raise 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)
+  end
+  
+  it "should raise InvalidName error when attempt to create "+
+     "stamp with a blank name" do
+    create_pdf
+    lambda {
+      @pdf.create_stamp("")
+    }.should.raise(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
+    create_pdf
+    @pdf.create_stamp("MyStamp")
+    lambda {
+      @pdf.stamp("OtherStamp")
+    }.should.raise(Prawn::Errors::UndefinedObjectName)
+  end
+
+  it "stamp should be drawn into the document each time stamp is called" do
+    create_pdf
+    @pdf.create_stamp("MyStamp")
+    @pdf.stamp("MyStamp")
+    @pdf.stamp("MyStamp")
+    @pdf.stamp("MyStamp")
+    # I had modified PDF::Inspector::XObject to receive the
+    # invoke_xobject message and count the number of times it was
+    # called, but it was only called once, so I reverted checking the
+    # output with a regular expression
+    @pdf.render.should =~ /(\/Stamp1 Do.*?){3}/m
+  end
+
+  it "resources added during stamp creation should be added to the "+
+     "stamp XObject, not the page" do
+    create_pdf
+    @pdf.create_stamp("MyStamp") do
+      @pdf.transparent(0.5) { @pdf.circle_at([100, 100], :radius => 10)}
+    end
+    @pdf.stamp("MyStamp")
+
+    # Inspector::XObject does not give information about resources, so
+    # resorting to string matching
+
+    output = @pdf.render
+    objects = output.split("endobj")
+    objects.each do |object|
+      if object =~ /\/Type \/Page$/
+        object.should.not =~ /\/ExtGState/
+      elsif object =~ /\/Type \/XObject$/
+        object.should =~ /\/ExtGState/
+      end
+    end
+  end
+end

data/spec/stroke_styles_spec.rb

@@ -0,0 +1,163 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "When stroking with default settings" do
+  before(:each) { create_pdf }
+  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
+
+  it "dashed? should be false" do
+    @pdf.should.not.be.dashed
+  end
+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)
+      cap_style = PDF::Inspector::Graphics::CapStyle.analyze(@pdf.render).cap_style
+      cap_style.should == 0
+    end
+  end
+
+  describe "#cap_style(:round)" do
+    it "rendered PDF should include round style cap" do
+      @pdf.cap_style(:round)
+      cap_style = PDF::Inspector::Graphics::CapStyle.analyze(@pdf.render).cap_style
+      cap_style.should == 1
+    end
+  end
+
+  describe "#cap_style(:projecting_square)" do
+    it "rendered PDF should include projecting_square style cap" do
+      @pdf.cap_style(:projecting_square)
+      cap_style = PDF::Inspector::Graphics::CapStyle.analyze(@pdf.render).cap_style
+      cap_style.should == 2
+    end
+  end
+
+  it "should carry the current cap style settings over to new pages" do
+    @pdf.cap_style(:round)
+    @pdf.start_new_page
+    cap_styles = PDF::Inspector::Graphics::CapStyle.analyze(@pdf.render)
+    cap_styles.cap_style_count.should == 2
+    cap_styles.cap_style.should == 1
+  end
+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)
+      join_style = PDF::Inspector::Graphics::JoinStyle.analyze(@pdf.render).join_style
+      join_style.should == 0
+    end
+  end
+
+  describe "#join_style(:round)" do
+    it "rendered PDF should include round style join" do
+      @pdf.join_style(:round)
+      join_style = PDF::Inspector::Graphics::JoinStyle.analyze(@pdf.render).join_style
+      join_style.should == 1
+    end
+  end
+
+  describe "#join_style(:bevel)" do
+    it "rendered PDF should include bevel style join" do
+      @pdf.join_style(:bevel)
+      join_style = PDF::Inspector::Graphics::JoinStyle.analyze(@pdf.render).join_style
+      join_style.should == 2
+    end
+  end
+
+  it "should carry the current join style settings over to new pages" do
+    @pdf.join_style(:round)
+    @pdf.start_new_page
+    join_styles = PDF::Inspector::Graphics::JoinStyle.analyze(@pdf.render)
+    join_styles.join_style_count.should == 2
+    join_styles.join_style.should == 1
+  end
+end
+
+describe "Dashes" do
+  before(:each) { create_pdf }
+  
+   it "should be able to use assignment operator" do
+     @pdf.dash = 2
+     @pdf.should.be.dashed
+  end
+
+  describe "setting a dash" do
+    it "dashed? should be true" do
+      @pdf.dash(2)
+      @pdf.should.be.dashed
+    end
+    it "rendered PDF should include a stroked dash" do
+      @pdf.dash(2)
+      dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+      dashes.stroke_dash.should == [[2, 2], 0]
+    end
+  end
+
+  describe "setting a dash by passing a single argument" do
+    it "space between dashes should be the same length as the dash in the rendered PDF" do
+      @pdf.dash(2)
+      dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+      dashes.stroke_dash.should == [[2, 2], 0]
+    end
+  end
+
+  describe "with a space option that differs from the first argument" do
+    it "space between dashes in the rendered PDF should be different length than the length of the dash" do
+      @pdf.dash(2, :space => 3)
+      dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+      dashes.stroke_dash.should == [[2, 3], 0]
+    end
+  end
+
+  describe "with a non-zero phase option" do
+    it "rendered PDF should include a non-zero phase" do
+      @pdf.dash(2, :phase => 1)
+      dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+      dashes.stroke_dash.should == [[2, 2], 1]
+    end
+  end
+
+  describe "clearing stroke dash" do
+    it "should restore solid line" do
+      @pdf.dash(2)
+      @pdf.undash
+      dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+      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
+    dashes = PDF::Inspector::Graphics::Dash.analyze(@pdf.render)
+    dashes.stroke_dash_count.should == 2
+    dashes.stroke_dash.should == [[2, 2], 0]
+  end
+
+end