prawn 0.12.0 → 0.13.0

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
 
@@ -139,13 +139,12 @@ describe "Prawn::Document#transaction" do
 
   it "should work with dests" do
     Prawn::Document.new do |pdf|
-      pdf.add_dest("dest", pdf.dest_fit_horizontally(pdf.cursor,
-                                                     pdf.page.dictionary))
+      pdf.add_dest("dest", pdf.dest_fit_horizontally(pdf.cursor, pdf.page))
       pdf.text("Hello world")
-      lambda { pdf.transaction{} }.should.not.raise
+      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
@@ -167,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,46 @@
 
 puts "Prawn specs: Running on Ruby Version: #{RUBY_VERSION}"
 
-require "rubygems"
 require "bundler"
 Bundler.setup
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib') 
+$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

data/spec/stream_spec.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "Stream object" do
+  it "should compress a stream upon request" do
+    stream = PDF::Core::Stream.new
+    stream << "Hi There " * 20
+
+    cstream = PDF::Core::Stream.new
+    cstream << "Hi There " * 20
+    cstream.compress!
+
+    cstream.filtered_stream.length.should be < stream.length,
+      "compressed stream expected to be smaller than source but wasn't"
+    cstream.data[:Filter].should == [:FlateDecode]
+  end
+
+  it "should expose sompression state" do
+    stream = PDF::Core::Stream.new
+    stream << "Hello"
+    stream.compress!
+
+    stream.should be_compressed
+  end
+
+  it "should detect from filters if stream is compressed" do
+    stream = PDF::Core::Stream.new
+    stream << "Hello"
+    stream.filters << :FlateDecode
+
+    stream.should be_compressed
+  end
+
+  it "should have Length if in data" do
+    stream = PDF::Core::Stream.new
+    stream << "hello"
+
+    stream.data[:Length].should == 5
+  end
+
+  it "should update Length when updated" do
+    stream = PDF::Core::Stream.new
+    stream << "hello"
+    stream.data[:Length].should == 5
+
+    stream << " world"
+    stream.data[:Length].should == 11
+  end
+
+  it "should corecly handle decode params" do
+    stream = PDF::Core::Stream.new
+    stream << "Hello"
+    stream.filters << { :FlateDecode => { :Predictor => 15 } }
+
+    stream.data[:DecodeParms].should == [{ :Predictor => 15 }]
+  end
+end