prawn-core 0.7.2 → 0.8.4

data/spec/repeater_spec.rb

@@ -64,11 +64,28 @@ describe "Repeaters" do
     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
 

data/spec/snapshot_spec.rb

@@ -69,16 +69,16 @@ describe "Prawn::Document#transaction" do
   # 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 = current_page.identifier
-      old_page_content_id = page_content.identifier
+      old_page_object_id = page.dictionary.identifier
+      old_page_content_id = page.content.identifier
 
       transaction do
         start_new_page
         rollback
       end
 
-      current_page.identifier.should == old_page_object_id
-      page_content.identifier.should == old_page_content_id
+      page.dictionary.identifier.should == old_page_object_id
+      page.content.identifier.should == old_page_content_id
     end
 
   end
@@ -92,7 +92,7 @@ describe "Prawn::Document#transaction" do
       end
 
       # should be the exact same object, not a clone
-      current_page.data[:Contents].should == page_content
+      page.dictionary.data[:Contents].should == page.content
     end
 
   end
@@ -101,7 +101,7 @@ describe "Prawn::Document#transaction" do
 
     it "should properly commit if no error is raised" do
       pdf = Prawn::Document.new do
-        create_stamp("test_stamp") { text "This is shown", :at => [0,0] }
+        create_stamp("test_stamp") { draw_text "This is shown", :at => [0,0] }
         transaction do
           stamp("test_stamp")
         end
@@ -111,7 +111,7 @@ describe "Prawn::Document#transaction" do
 
     it "should properly rollback when #rollback is called" do
       pdf = Prawn::Document.new do
-        create_stamp("test_stamp") { text "This is not shown", :at => [0,0] }
+        create_stamp("test_stamp") { draw_text "This is not shown", :at => [0,0] }
 
         transaction do
           stamp("test_stamp")

data/spec/span_spec.rb

@@ -4,10 +4,14 @@ require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
 
 describe "drawing span" do    
   
-  before(:each) {
+  def setup
     Prawn.debug = false
     create_pdf
-  }   
+  end
+
+  def teardown
+    Prawn.debug = true
+  end
 
   it "should only accept :position as option in debug mode" do
     Prawn.debug = true

data/spec/spec_helper.rb

@@ -3,15 +3,19 @@
 puts "Prawn specs: Running on Ruby Version: #{RUBY_VERSION}"
 
 require "rubygems"
-require "test/spec"                                                
-require "mocha"
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib') 
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'vendor','pdf-inspector','lib')
 require "prawn/core"
 
 Prawn.debug = true
 
-gem 'pdf-reader', ">=0.7.3"
+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"
 

data/spec/stamp_spec.rb

@@ -19,6 +19,19 @@ describe "create_stamp before any page is added" do
   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

data/spec/text_at_spec.rb

@@ -0,0 +1,119 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "#draw_text" do
+  before(:each) { create_pdf }
+
+  it "should raise ArgumentError if :at option omitted" do
+    lambda { @pdf.draw_text("hai", { }) }.should.raise(ArgumentError)
+  end
+
+  it "should raise ArgumentError if :align option included" do
+    lambda { @pdf.draw_text("hai", :at => [0, 0], :align => :center) }.should.raise(ArgumentError)
+  end
+
+  it "should default to 12 point helvetica" do
+    @pdf.draw_text("Blah", :at => [100,100])
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.font_settings[0][:name].should == :Helvetica
+    text.font_settings[0][:size].should == 12
+    text.strings.first.should == "Blah"
+  end
+
+  it "should allow setting font size" do
+    @pdf.draw_text("Blah", :at => [100,100], :size => 16)
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.font_settings[0][:size].should == 16
+  end
+
+  it "should allow setting a default font size" do
+    @pdf.font_size = 16
+    @pdf.draw_text("Blah", :at => [0, 0])
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.font_settings[0][:size].should == 16
+  end
+
+  it "should allow overriding default font for a single instance" do
+    @pdf.font_size = 16
+
+    @pdf.draw_text("Blah", :size => 11, :at => [0, 0])
+    @pdf.draw_text("Blaz", :at => [0, 0])
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.font_settings[0][:size].should == 11
+    text.font_settings[1][:size].should == 16
+  end
+
+  it "should allow setting a font size transaction with a block" do
+    @pdf.font_size 16 do
+      @pdf.draw_text('Blah', :at => [0, 0])
+    end
+
+    @pdf.draw_text('blah', :at => [0, 0])
+
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.font_settings[0][:size].should == 16
+    text.font_settings[1][:size].should == 12
+  end
+
+  it "should allow manual setting the font size " +
+    "when in a font size block" do
+    @pdf.font_size(16) do
+      @pdf.draw_text('Foo', :at => [0, 0])
+      @pdf.draw_text('Blah', :size => 11, :at => [0, 0])
+      @pdf.draw_text('Blaz', :at => [0, 0])
+    end
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.font_settings[0][:size].should == 16
+    text.font_settings[1][:size].should == 11
+    text.font_settings[2][:size].should == 16
+  end
+
+  it "should allow registering of built-in font_settings on the fly" do
+    @pdf.font "Times-Roman"
+    @pdf.draw_text("Blah", :at => [100,100], :at => [0, 0])
+    @pdf.font "Courier"
+    @pdf.draw_text("Blaz", :at => [150,150], :at => [0, 0])
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.font_settings[0][:name].should == :"Times-Roman"
+    text.font_settings[1][:name].should == :Courier
+  end
+
+  it "should raise an exception when an unknown font is used" do
+    lambda { @pdf.font "Pao bu" }.should.raise(Prawn::Errors::UnknownFont)
+  end
+
+  it "should correctly render a utf-8 string when using a built-in font" do
+    str = "©" # copyright symbol
+    @pdf.draw_text(str, :at => [0, 0])
+
+    # grab the text from the rendered PDF and ensure it matches
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.strings.first.should == str
+  end
+
+  if "spec".respond_to?(:encode!)
+    # Handle non utf-8 string encodings in a sane way on M17N aware VMs
+    it "should raise an exception when a utf-8 incompatible string is rendered" do
+      str = "Blah \xDD"
+      str.force_encoding("ASCII-8BIT")
+      lambda { @pdf.draw_text(str, :at => [0, 0]) }.should.raise(ArgumentError)
+    end
+    it "should not raise an exception when a shift-jis string is rendered" do
+      datafile = "#{Prawn::BASEDIR}/data/shift_jis_text.txt"
+      sjis_str = File.open(datafile, "r:shift_jis") { |f| f.gets }
+      @pdf.font("#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf")
+      lambda { @pdf.draw_text(sjis_str, :at => [0, 0]) }.should.not.raise(ArgumentError)
+    end
+  else
+    # Handle non utf-8 string encodings in a sane way on non-M17N aware VMs
+    it "should raise an exception when a corrupt utf-8 string is rendered" do
+      str = "Blah \xDD"
+      lambda { @pdf.draw_text(str, :at => [0, 0]) }.should.raise(ArgumentError)
+    end
+    it "should raise an exception when a shift-jis string is rendered" do
+      sjis_str = File.read("#{Prawn::BASEDIR}/data/shift_jis_text.txt")
+      lambda { @pdf.draw_text(sjis_str, :at => [0, 0]) }.should.raise(ArgumentError)
+    end
+  end
+end

data/spec/text_box_spec.rb

@@ -3,7 +3,7 @@
 require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
 
 
-describe "Text::Box" do
+describe "Text::Box#render" do
   it "should not fail if height is smaller than 1 line" do
     create_pdf
     @text = "Oh hai text rect. " * 10
@@ -15,9 +15,6 @@ describe "Text::Box" do
     text_box.render
     text_box.text.should == ""
   end
-end
-
-describe "Text::Box#render" do
   it "should draw content to the page" do
     create_pdf
     @text = "Oh hai text rect. " * 10
@@ -27,6 +24,28 @@ describe "Text::Box#render" do
     text = PDF::Inspector::Text.analyze(@pdf.render)
     text.strings.should.not.be.empty
   end
+  it "should not draw a transformation matrix" do
+    create_pdf
+    @text = "Oh hai text rect. " * 10
+    @options = { :document => @pdf }
+    text_box = Prawn::Text::Box.new(@text, @options)
+    text_box.render()
+    matrices = PDF::Inspector::Graphics::Matrix.analyze(@pdf.render)
+    matrices.matrices.length.should == 0
+  end
+end
+
+describe "Text::Box#render(:single_line => true)" do
+  it "should draw only one line to the page" do
+    create_pdf
+    @text = "Oh hai text rect. " * 10
+    @options = { :document => @pdf,
+                 :single_line => true }
+    text_box = Prawn::Text::Box.new(@text, @options)
+    text_box.render()
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.strings.length.should == 1
+  end
 end
 
 describe "Text::Box#render(:dry_run => true)" do
@@ -39,6 +58,170 @@ describe "Text::Box#render(:dry_run => true)" do
     text = PDF::Inspector::Text.analyze(@pdf.render)
     text.strings.should.be.empty
   end
+  it "subsequent calls to render should not raise an ArgumentError exception" do
+    create_pdf
+    @text = "™©"
+    @options = { :document => @pdf }
+    text_box = Prawn::Text::Box.new(@text, @options)
+    text_box.render(:dry_run => true)
+    lambda { text_box.render }.should.not.raise(ArgumentError)
+  end
+end
+
+describe "Text::Box#render with :rotate option of 30)" do
+  before(:each) do
+    create_pdf
+    rotate = 30
+    @x = 300
+    @y = 70
+    @width = 100
+    @height = 50
+    @cos = Math.cos(rotate * Math::PI / 180)
+    @sin = Math.sin(rotate * Math::PI / 180)
+    @text = "Oh hai text rect. " * 10
+    @options = { :document => @pdf,
+                 :rotate => rotate,
+                 :at => [@x, @y],
+                 :width => @width,
+                 :height => @height }
+  end
+  context ":rotate_around option of :center" do
+    it "should draw content to the page rotated about the center of the text" do
+      @options[:rotate_around] = :center
+      text_box = Prawn::Text::Box.new(@text, @options)
+      text_box.render()
+
+      matrices = PDF::Inspector::Graphics::Matrix.analyze(@pdf.render)
+      x = @x + @width / 2
+      y = @y - @height / 2
+      x_prime = x * @cos - y * @sin
+      y_prime = x * @sin + y * @cos
+      matrices.matrices[0].should == [1, 0, 0, 1,
+                                      reduce_precision(x - x_prime),
+                                      reduce_precision(y - y_prime)]
+      matrices.matrices[1].should == [reduce_precision(@cos),
+                                      reduce_precision(@sin),
+                                      reduce_precision(-@sin),
+                                      reduce_precision(@cos), 0, 0]
+
+      text = PDF::Inspector::Text.analyze(@pdf.render)
+      text.strings.should.not.be.empty
+    end
+  end
+  context ":rotate_around option of :upper_left" do
+    it "should draw content to the page rotated about the upper left corner of the text" do
+      @options[:rotate_around] = :upper_left
+      text_box = Prawn::Text::Box.new(@text, @options)
+      text_box.render()
+
+      matrices = PDF::Inspector::Graphics::Matrix.analyze(@pdf.render)
+      x = @x
+      y = @y
+      x_prime = x * @cos - y * @sin
+      y_prime = x * @sin + y * @cos
+      matrices.matrices[0].should == [1, 0, 0, 1,
+                                      reduce_precision(x - x_prime),
+                                      reduce_precision(y - y_prime)]
+      matrices.matrices[1].should == [reduce_precision(@cos),
+                                      reduce_precision(@sin),
+                                      reduce_precision(-@sin),
+                                      reduce_precision(@cos), 0, 0]
+
+      text = PDF::Inspector::Text.analyze(@pdf.render)
+      text.strings.should.not.be.empty
+    end
+  end
+  context "default :rotate_around" do
+    it "should draw content to the page rotated about the upper left corner of the text" do
+      text_box = Prawn::Text::Box.new(@text, @options)
+      text_box.render()
+
+      matrices = PDF::Inspector::Graphics::Matrix.analyze(@pdf.render)
+      x = @x
+      y = @y
+      x_prime = x * @cos - y * @sin
+      y_prime = x * @sin + y * @cos
+      matrices.matrices[0].should == [1, 0, 0, 1,
+                                      reduce_precision(x - x_prime),
+                                      reduce_precision(y - y_prime)]
+      matrices.matrices[1].should == [reduce_precision(@cos),
+                                      reduce_precision(@sin),
+                                      reduce_precision(-@sin),
+                                      reduce_precision(@cos), 0, 0]
+
+      text = PDF::Inspector::Text.analyze(@pdf.render)
+      text.strings.should.not.be.empty
+    end
+  end
+  context ":rotate_around option of :upper_right" do
+    it "should draw content to the page rotated about the upper right corner of the text" do
+      @options[:rotate_around] = :upper_right
+      text_box = Prawn::Text::Box.new(@text, @options)
+      text_box.render()
+
+      matrices = PDF::Inspector::Graphics::Matrix.analyze(@pdf.render)
+      x = @x + @width
+      y = @y
+      x_prime = x * @cos - y * @sin
+      y_prime = x * @sin + y * @cos
+      matrices.matrices[0].should == [1, 0, 0, 1,
+                                      reduce_precision(x - x_prime),
+                                      reduce_precision(y - y_prime)]
+      matrices.matrices[1].should == [reduce_precision(@cos),
+                                      reduce_precision(@sin),
+                                      reduce_precision(-@sin),
+                                      reduce_precision(@cos), 0, 0]
+
+      text = PDF::Inspector::Text.analyze(@pdf.render)
+      text.strings.should.not.be.empty
+    end
+  end
+  context ":rotate_around option of :lower_right" do
+    it "should draw content to the page rotated about the lower right corner of the text" do
+      @options[:rotate_around] = :lower_right
+      text_box = Prawn::Text::Box.new(@text, @options)
+      text_box.render()
+
+      matrices = PDF::Inspector::Graphics::Matrix.analyze(@pdf.render)
+      x = @x + @width
+      y = @y - @height
+      x_prime = x * @cos - y * @sin
+      y_prime = x * @sin + y * @cos
+      matrices.matrices[0].should == [1, 0, 0, 1,
+                                      reduce_precision(x - x_prime),
+                                      reduce_precision(y - y_prime)]
+      matrices.matrices[1].should == [reduce_precision(@cos),
+                                      reduce_precision(@sin),
+                                      reduce_precision(-@sin),
+                                      reduce_precision(@cos), 0, 0]
+
+      text = PDF::Inspector::Text.analyze(@pdf.render)
+      text.strings.should.not.be.empty
+    end
+  end
+  context ":rotate_around option of :lower_left" do
+    it "should draw content to the page rotated about the lower left corner of the text" do
+      @options[:rotate_around] = :lower_left
+      text_box = Prawn::Text::Box.new(@text, @options)
+      text_box.render()
+
+      matrices = PDF::Inspector::Graphics::Matrix.analyze(@pdf.render)
+      x = @x
+      y = @y - @height
+      x_prime = x * @cos - y * @sin
+      y_prime = x * @sin + y * @cos
+      matrices.matrices[0].should == [1, 0, 0, 1,
+                                      reduce_precision(x - x_prime),
+                                      reduce_precision(y - y_prime)]
+      matrices.matrices[1].should == [reduce_precision(@cos),
+                                      reduce_precision(@sin),
+                                      reduce_precision(-@sin),
+                                      reduce_precision(@cos), 0, 0]
+
+      text = PDF::Inspector::Text.analyze(@pdf.render)
+      text.strings.should.not.be.empty
+    end
+  end
 end
 
 describe "Text::Box default height" do
@@ -112,6 +295,56 @@ describe "Text::Box with text than can fit in the box with :ellipses overflow an
   end
 end
 
+
+
+describe "Text::Box printing UTF-8 string with higher bit characters" do
+  before(:each) do
+    create_pdf    
+    @text = "©"
+    # not enough height to print any text, so we can directly compare against
+    # the input string
+    bounding_height = 1.0
+    options = {
+      :height => bounding_height,
+      :document => @pdf
+    }
+    @text_box = Prawn::Text::Box.new(@text, options)
+  end
+  describe "when using a TTF font" do
+    it "unprinted text should be in UTF-8 encoding" do
+      @pdf.font("#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf")
+      remaining_text = @text_box.render
+      remaining_text.should == @text
+    end
+    it "subsequent calls to Text::Box need not include the" +
+       " :skip_encoding => true option" do
+      @pdf.font("#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf")
+      remaining_text = @text_box.render
+      lambda {
+        @pdf.text_box(remaining_text, :document => @pdf)
+      }.should.not.raise(ArgumentError)
+    end
+  end
+  describe "when using an AFM font" do
+    it "unprinted text should be in WinAnsi encoding" do
+      remaining_text = @text_box.render
+      remaining_text.should == @pdf.font.normalize_encoding(@text)
+    end
+    it "subsequent calls to Text::Box must include the" +
+       " :skip_encoding => true option" do
+      remaining_text = @text_box.render
+      lambda {
+        @pdf.text_box(remaining_text, :document => @pdf)
+      }.should.raise(ArgumentError)
+      lambda {
+        @pdf.text_box(remaining_text, :skip_encoding => true,
+                                      :document => @pdf)
+      }.should.not.raise(ArgumentError)
+    end
+  end
+end
+          
+
 describe "Text::Box with more text than can fit in the box" do
   before(:each) do
     create_pdf    
@@ -148,6 +381,22 @@ describe "Text::Box with more text than can fit in the box" do
       @text_box.render
       @bounding_height.should.be.close(@text_box.height, @pdf.font.height)
     end
+    context "with :rotate option" do
+      it "unrendered text should be the same as when not rotated" do
+        remaining_text = @text_box.render
+
+        rotate = 30
+        x = 300
+        y = 70
+        width = @options[:width]
+        height = @options[:height]
+        @options[:document] = @pdf
+        @options[:rotate] = rotate
+        @options[:at] = [x, y]
+        rotated_text_box = Prawn::Text::Box.new(@text, @options)
+        rotated_text_box.render.should == remaining_text
+      end
+    end
   end
   
   context "ellipses overflow" do
@@ -348,3 +597,7 @@ describe 'Text::Box wrapping' do
   end
   
 end
+
+def reduce_precision(float)
+  ("%.5f" % float).to_f
+end