prawn 0.12.0 → 0.13.0

data/spec/extensions/encoding_helpers.rb

@@ -0,0 +1,10 @@
+module EncodingHelpers
+  def win1252_string(str)
+    ruby_19 { str.force_encoding("Windows-1252") }
+    str
+  end
+
+  def bin_string(str)
+    ruby_19 { str.force_encoding("ASCII-8BIT") } || ruby_18 { str }
+  end
+end

data/spec/extensions/mocha.rb

@@ -11,6 +11,7 @@
 
 class ParameterChecker < Mocha::ParametersMatcher
   def initialize(&matching_block)
+    @expected_parameters = [Mocha::ParameterMatchers::AnyParameters.new]
     @matching_block = matching_block
   end
 

data/spec/filters_spec.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+FILTERS = {
+  :FlateDecode    => {'test' => ruby_19 { "x\x9C+I-.\x01\x00\x04]\x01\xC1".force_encoding(Encoding::ASCII_8BIT) } || "x\x9C+I-.\x01\x00\x04]\x01\xC1" },
+  :DCTDecode      => {'test' => "test"}
+}
+
+FILTERS.each do |filter_name, examples|
+  filter = PDF::Core::Filters.const_get(filter_name)
+
+  describe "#{filter_name} filter" do
+    it "should encode stream" do
+      examples.each do |in_stream, out_stream|
+        filter.encode(in_stream).should == out_stream
+      end
+    end
+
+    it "should decode stream" do
+      examples.each do |in_stream, out_stream|
+        filter.decode(out_stream).should == in_stream
+      end
+    end
+
+    it "should be symmetric" do
+      examples.each do |in_stream, out_stream|
+        filter.decode(filter.encode(in_stream)).should == in_stream
+
+        filter.encode(filter.decode(out_stream)).should == out_stream
+      end
+    end
+  end
+end

data/spec/font_metric_cache_spec.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+require 'pathname'
+
+describe "Font metrics caching" do
+  let(:document) { Prawn::Document.new }
+
+  subject { Prawn::FontMetricCache.new( document ) }
+
+  it "should start with an empty cache" do
+    subject.instance_variable_get( :@cache ).should be_empty
+  end
+
+  it "should cache the width of the provided string" do
+    subject.width_of('M', {})
+
+    subject.instance_variable_get( :@cache ).should have(1).entry
+  end
+
+  it "should only cache a single copy of the same string" do
+    subject.width_of('M', {})
+    subject.width_of('M', {})
+
+    subject.instance_variable_get( :@cache ).should have(1).entry
+  end
+
+  it "should cache different copies for different strings" do
+    subject.width_of('M', {})
+    subject.width_of('W', {})
+
+    subject.instance_variable_get( :@cache ).should have(2).entries
+  end
+
+  it "should cache different copies of the same string with different font sizes" do
+    subject.width_of('M', {})
+
+    document.font_size 24
+    subject.width_of('M', {})
+
+    subject.instance_variable_get( :@cache ).should have(2).entries
+  end
+
+  it "should cache different copies of the same string with different fonts" do
+    subject.width_of('M', {})
+
+    document.font 'Courier'
+    subject.width_of('M', {})
+
+    subject.instance_variable_get( :@cache ).should have(2).entries
+  end
+end

data/spec/font_spec.rb

@@ -1,9 +1,9 @@
 # encoding: utf-8
 
-require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")           
-require 'iconv'
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+require 'pathname'
 
-describe "Font behavior" do  
+describe "Font behavior" do
 
   it "should default to Helvetica if no font is specified" do
     @pdf = Prawn::Document.new
@@ -12,6 +12,32 @@ describe "Font behavior" do
 
 end
 
+describe "Font objects" do
+
+  it "should be equal" do
+    font1 = Prawn::Document.new.font
+    font2 = Prawn::Document.new.font
+
+    font1.should eql( font2 )
+  end
+
+  it "should always be the same key" do
+    font1 = Prawn::Document.new.font
+    font2 = Prawn::Document.new.font
+
+    hash = Hash.new
+
+    hash[ font1 ] = "Original"
+    hash[ font2 ] = "Overwritten"
+
+    hash.size.should == 1
+
+    hash[ font1 ].should == "Overwritten"
+    hash[ font2 ].should == "Overwritten"
+  end
+
+end
+
 describe "#width_of" do
   it "should take character spacing into account" do
     create_pdf
@@ -24,11 +50,40 @@ describe "#width_of" do
   it "should exclude newlines" do
     create_pdf
     # Use a TTF font that has a non-zero width for \n
-    @pdf.font("#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf")
+    @pdf.font("#{Prawn::DATADIR}/fonts/gkai00mp.ttf")
 
     @pdf.width_of("\nhello world\n").should ==
       @pdf.width_of("hello world")
   end
+
+  it "should take formatting into account" do
+    create_pdf
+
+    normal_hello = @pdf.width_of("hello")
+    inline_bold_hello = @pdf.width_of("<b>hello</b>", :inline_format => true)
+    @pdf.font("Helvetica", :style => :bold) {
+      @bold_hello = @pdf.width_of("hello")
+    }
+
+    inline_bold_hello.should be > normal_hello
+    inline_bold_hello.should == @bold_hello
+  end
+
+  it "should accept :style as an argument" do
+    create_pdf
+
+    styled_bold_hello = @pdf.width_of("hello", :style => :bold)
+    @pdf.font("Helvetica", :style => :bold) {
+      @bold_hello = @pdf.width_of("hello")
+    }
+
+    styled_bold_hello.should == @bold_hello
+  end
+
+  # This is not a fully confirmed bug report... needs further investigation
+  it "should not treat minus as if it were a hyphen", :unresolved, :issue => 578 do
+    @pdf.width_of("-0.75").should be < @pdf.width_of("25.00")
+  end
 end
 
 describe "#font_size" do
@@ -41,38 +96,38 @@ end
 
 describe "font style support" do
   before(:each) { create_pdf }
-  
+
   it "should complain if there is no @current_page" do
     pdf_without_page = Prawn::Document.new(:skip_page_creation => true)
 
     lambda{ pdf_without_page.font "Helvetica" }.
-      should.raise(Prawn::Errors::NotOnPage)
+      should raise_error(Prawn::Errors::NotOnPage)
   end
-  
-  it "should allow specifying font style by style name and font family" do    
+
+  it "should allow specifying font style by style name and font family" do
     @pdf.font "Courier", :style => :bold
-    @pdf.text "In Courier bold"    
-    
+    @pdf.text "In Courier bold"
+
     @pdf.font "Courier", :style => :bold_italic
-    @pdf.text "In Courier bold-italic"   
-     
+    @pdf.text "In Courier bold-italic"
+
     @pdf.font "Courier", :style => :italic
-    @pdf.text "In Courier italic"    
-    
+    @pdf.text "In Courier italic"
+
     @pdf.font "Courier", :style => :normal
-    @pdf.text "In Normal Courier"  
-           
+    @pdf.text "In Normal Courier"
+
     @pdf.font "Helvetica"
-    @pdf.text "In Normal Helvetica"     
-    
+    @pdf.text "In Normal Helvetica"
+
     text = PDF::Inspector::Text.analyze(@pdf.render)
-    text.font_settings.map { |e| e[:name] }.should == 
-     [:"Courier-Bold", :"Courier-BoldOblique", :"Courier-Oblique", 
+    text.font_settings.map { |e| e[:name] }.should ==
+     [:"Courier-Bold", :"Courier-BoldOblique", :"Courier-Oblique",
       :Courier, :Helvetica]
   end
 
   it "should allow font familes to be defined in a single dfont" do
-    file = "#{Prawn::BASEDIR}/data/fonts/Action Man.dfont"
+    file = "#{Prawn::DATADIR}/fonts/Action Man.dfont"
     @pdf.font_families["Action Man"] = {
       :normal      => { :file => file, :font => "ActionMan" },
       :italic      => { :file => file, :font => "ActionMan-Italic" },
@@ -88,24 +143,39 @@ describe "font style support" do
     name = name.sub(/\w+\+/, "subset+")
     name.should == "subset+ActionMan-Italic"
   end
+
+  it "should accept Pathname objects for font files" do
+    file = Pathname.new( "#{Prawn::DATADIR}/fonts/Chalkboard.ttf" )
+    @pdf.font_families["Chalkboard"] = {
+      :normal => file
+    }
+
+    @pdf.font "Chalkboard"
+    @pdf.text "In Chalkboard"
+
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    name = text.font_settings.map { |e| e[:name] }.first.to_s
+    name = name.sub(/\w+\+/, "subset+")
+    name.should == "subset+Chalkboard"
+  end
 end
 
 describe "Transactional font handling" do
   before(:each) { create_pdf }
-  
+
   it "should allow setting of size directly when font is created" do
     @pdf.font "Courier", :size => 16
-    @pdf.font_size.should == 16 
+    @pdf.font_size.should == 16
   end
-  
+
   it "should allow temporary setting of a new font using a transaction" do
     @pdf.font "Helvetica", :size => 12
-    
+
     @pdf.font "Courier", :size => 16 do
       @pdf.font.name.should == "Courier"
       @pdf.font_size.should == 16
     end
-    
+
     @pdf.font.name.should == "Helvetica"
     @pdf.font_size.should == 12
   end
@@ -120,75 +190,76 @@ describe "Transactional font handling" do
 
     @pdf.font_size.should == 12
   end
-  
+
 end
 
 describe "Document#page_fonts" do
-  before(:each) { create_pdf } 
-  
+  before(:each) { create_pdf }
+
   it "should register fonts properly by page" do
     @pdf.font "Courier"; @pdf.text("hello")
     @pdf.font "Helvetica"; @pdf.text("hello")
     @pdf.font "Times-Roman"; @pdf.text("hello")
     ["Courier","Helvetica","Times-Roman"].each { |f|
       page_should_include_font(f)
-    }                                        
-    
-    @pdf.start_new_page    
+    }
+
+    @pdf.start_new_page
     @pdf.font "Helvetica"; @pdf.text("hello")
     page_should_include_font("Helvetica")
     page_should_not_include_font("Courier")
     page_should_not_include_font("Times-Roman")
-  end    
-  
+  end
+
   def page_includes_font?(font)
     @pdf.page.fonts.values.map { |e| e.data[:BaseFont] }.include?(font.to_sym)
-  end                             
-  
-  def page_should_include_font(font)    
-    assert_block("Expected page to include font: #{font}") do
-      page_includes_font?(font)
-    end
-  end   
-  
+  end
+
+  def page_should_include_font(font)
+    page_includes_font?(font).should be_true
+  end
+
   def page_should_not_include_font(font)
-    assert_block("Did not expect page to include font: #{font}") do
-      not page_includes_font?(font) 
-    end
+    page_includes_font?(font).should be_false
   end
-      
+
 end
-    
+
 describe "AFM fonts" do
-  
-  setup do
+
+  before do
     create_pdf
     @times = @pdf.find_font "Times-Roman"
-    @iconv = ::Iconv.new('Windows-1252', 'utf-8')
   end
-  
+
   it "should calculate string width taking into account accented characters" do
-    @times.compute_width_of(@iconv.iconv("é"), :size => 12).should == @times.compute_width_of("e", :size => 12)
+    input = win1252_string("\xE9")# é in win-1252
+    @times.compute_width_of(input, :size => 12).should == @times.compute_width_of("e", :size => 12)
   end
-  
+
   it "should calculate string width taking into account kerning pairs" do
-    @times.compute_width_of(@iconv.iconv("To"), :size => 12).should == 13.332
-    @times.compute_width_of(@iconv.iconv("To"), :size => 12, :kerning => true).should == 12.372
-    @times.compute_width_of(@iconv.iconv("Tö"), :size => 12, :kerning => true).should == 12.372
+    @times.compute_width_of(win1252_string("To"), :size => 12).should == 13.332
+    @times.compute_width_of(win1252_string("To"), :size => 12, :kerning => true).should == 12.372
+
+    input = win1252_string("T\xF6") # Tö in win-1252
+    @times.compute_width_of(input, :size => 12, :kerning => true).should == 12.372
   end
 
   it "should encode text without kerning by default" do
-    @times.encode_text(@iconv.iconv("To")).should == [[0, "To"]]
-    @times.encode_text(@iconv.iconv("Télé")).should == [[0, @iconv.iconv("Télé")]]
-    @times.encode_text(@iconv.iconv("Technology")).should == [[0, "Technology"]]
-    @times.encode_text(@iconv.iconv("Technology...")).should == [[0, "Technology..."]]
+    @times.encode_text(win1252_string("To")).should == [[0, "To"]]
+    input = win1252_string("T\xE9l\xE9") # Télé in win-1252
+    @times.encode_text(input).should == [[0, input]]
+    @times.encode_text(win1252_string("Technology")).should == [[0, "Technology"]]
+    @times.encode_text(win1252_string("Technology...")).should == [[0, "Technology..."]]
   end
 
   it "should encode text with kerning if requested" do
-    @times.encode_text(@iconv.iconv("To"), :kerning => true).should == [[0, ["T", 80, "o"]]]
-    @times.encode_text(@iconv.iconv("Télé"), :kerning => true).should == [[0, ["T", 70, @iconv.iconv("élé")]]]
-    @times.encode_text(@iconv.iconv("Technology"), :kerning => true).should == [[0, ["T", 70, "echnology"]]]
-    @times.encode_text(@iconv.iconv("Technology..."), :kerning => true).should == [[0, ["T", 70, "echnology", 65, "..."]]]
+    @times.encode_text(win1252_string("To"), :kerning => true).should == [[0, ["T", 80, "o"]]]
+    input  = win1252_string("T\xE9l\xE9") # Télé in win-1252
+    output = win1252_string("\xE9l\xE9")  # élé  in win-1252
+    @times.encode_text(input, :kerning => true).should == [[0, ["T", 70, output]]]
+    @times.encode_text(win1252_string("Technology"), :kerning => true).should == [[0, ["T", 70, "echnology"]]]
+    @times.encode_text(win1252_string("Technology..."), :kerning => true).should == [[0, ["T", 70, "echnology", 65, "..."]]]
   end
 
   describe "when normalizing encoding" do
@@ -196,13 +267,13 @@ describe "AFM fonts" do
     it "should not modify the original string when normalize_encoding() is used" do
       original = "Foo"
       normalized = @times.normalize_encoding(original)
-      assert ! original.equal?(normalized)
+      original.equal?(normalized).should be_false
     end
 
     it "should modify the original string when normalize_encoding!() is used" do
       original = "Foo"
       normalized = @times.normalize_encoding!(original)
-      assert original.equal?(normalized)
+      original.equal?(normalized).should be_true
     end
 
   end
@@ -212,7 +283,7 @@ describe "AFM fonts" do
     font_dict = zapf.send(:register, nil)
     font_dict.data[:Encoding].should == nil
   end
-  
+
 end
 
 describe "#glyph_present" do
@@ -220,50 +291,52 @@ describe "#glyph_present" do
 
   it "should return true when present in an AFM font" do
     font = @pdf.find_font("Helvetica")
-    font.glyph_present?("H").should.be true
+    font.glyph_present?("H").should be_true
   end
 
   it "should return false when absent in an AFM font" do
     font = @pdf.find_font("Helvetica")
-    font.glyph_present?("再").should.be false
+    font.glyph_present?("再").should be_false
   end
 
   it "should return true when present in a TTF font" do
-    font = @pdf.find_font("#{Prawn::BASEDIR}/data/fonts/Activa.ttf")
-    font.glyph_present?("H").should.be true
+    font = @pdf.find_font("#{Prawn::DATADIR}/fonts/Activa.ttf")
+    font.glyph_present?("H").should be_true
   end
 
   it "should return false when absent in a TTF font" do
-    font = @pdf.find_font("#{Prawn::BASEDIR}/data/fonts/Activa.ttf")
-    font.glyph_present?("再").should.be false
+    font = @pdf.find_font("#{Prawn::DATADIR}/fonts/Activa.ttf")
+    font.glyph_present?("再").should be_false
 
-    font = @pdf.find_font("#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf")
-    font.glyph_present?("€").should.be false
+    font = @pdf.find_font("#{Prawn::DATADIR}/fonts/gkai00mp.ttf")
+    font.glyph_present?("€").should be_false
   end
 end
 
 describe "TTF fonts" do
-  
-  setup do
+
+  before do
     create_pdf
-    @activa = @pdf.find_font "#{Prawn::BASEDIR}/data/fonts/Activa.ttf"
+    @activa = @pdf.find_font "#{Prawn::DATADIR}/fonts/Activa.ttf"
   end
-  
+
   it "should calculate string width taking into account accented characters" do
     @activa.compute_width_of("é", :size => 12).should == @activa.compute_width_of("e", :size => 12)
   end
-  
+
   it "should calculate string width taking into account kerning pairs" do
     @activa.compute_width_of("To", :size => 12).should == 15.228
     @activa.compute_width_of("To", :size => 12, :kerning => true).should == 12.996
   end
-  
+
   it "should encode text without kerning by default" do
     @activa.encode_text("To").should == [[0, "To"]]
 
-    tele = (RUBY_VERSION < '1.9') ? "T\216l\216" :
-      "T\216l\216".force_encoding("US-ASCII")
-    @activa.encode_text("Télé").should == [[0, tele]]
+    tele = "T\216l\216"
+    result = @activa.encode_text("Télé")
+    result.length.should == 1
+    result[0][0].should == 0
+    result[0][1].bytes.to_a.should == tele.bytes.to_a
 
     @activa.encode_text("Technology").should == [[0, "Technology"]]
     @activa.encode_text("Technology...").should == [[0, "Technology..."]]
@@ -278,38 +351,51 @@ describe "TTF fonts" do
     @activa.encode_text("Teχnology...", :kerning => true).should == [[0, ["T", 186.0, "e"]], [1, "!"], [0, ["nology", 88.0, "..."]]]
   end
 
+  it "should use the ascender, descender, and cap height from the TTF verbatim" do
+    # These metrics are relative to the font's own bbox. They should not be
+    # scaled with font size.
+    ref = @pdf.ref!({})
+    @activa.send :embed, ref, 0
+
+    # Pull out the embedded font descriptor
+    descriptor = ref.data[:FontDescriptor].data
+    descriptor[:Ascent].should == 804
+    descriptor[:Descent].should == -195
+    descriptor[:CapHeight].should == 804
+  end
+
   describe "when normalizing encoding" do
 
     it "should not modify the original string when normalize_encoding() is used" do
       original = "Foo"
       normalized = @activa.normalize_encoding(original)
-      assert ! original.equal?(normalized)
+      original.equal?(normalized).should be_false
     end
 
     it "should modify the original string when normalize_encoding!() is used" do
       original = "Foo"
       normalized = @activa.normalize_encoding!(original)
-      assert original.equal?(normalized)
+      original.equal?(normalized).should be_true
     end
 
   end
 
   describe "when used with snapshots or transactions" do
-    
+
     it "should allow TTF fonts to be used alongside document transactions" do
       lambda {
         Prawn::Document.new do
-          font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
+          font "#{Prawn::DATADIR}/fonts/DejaVuSans.ttf"
           text "Hi there"
           transaction { text "Nice, thank you" }
         end
-      }.should.not.raise
+      }.should_not raise_error
     end
 
     it "should allow TTF fonts to be used inside transactions" do
       pdf = Prawn::Document.new do
         transaction do
-          font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
+          font "#{Prawn::DATADIR}/fonts/DejaVuSans.ttf"
           text "Hi there"
         end
       end
@@ -321,13 +407,13 @@ describe "TTF fonts" do
     end
 
   end
-  
+
 end
 
 describe "DFont fonts" do
-  setup do
+  before do
     create_pdf
-    @file = "#{Prawn::BASEDIR}/data/fonts/Action Man.dfont"
+    @file = "#{Prawn::DATADIR}/fonts/Action Man.dfont"
   end
 
   it "should list all named fonts" do
@@ -357,16 +443,16 @@ describe "DFont fonts" do
   it "should cache font object based on selected font" do
     f1 = @pdf.find_font(@file, :font => "ActionMan")
     f2 = @pdf.find_font(@file, :font => "ActionMan-Bold")
-    assert_not_equal f1.object_id, f2.object_id
-    assert_equal f1.object_id, @pdf.find_font(@file, :font => "ActionMan").object_id
-    assert_equal f2.object_id, @pdf.find_font(@file, :font => "ActionMan-Bold").object_id
+    f2.object_id.should_not == f1.object_id
+    @pdf.find_font(@file, :font => "ActionMan").object_id.should == f1.object_id
+    @pdf.find_font(@file, :font => "ActionMan-Bold").object_id.should == f2.object_id
   end
 end
 
 describe "#character_count(text)" do
   it "should work on TTF fonts" do
     create_pdf
-    @pdf.font("#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf")
+    @pdf.font("#{Prawn::DATADIR}/fonts/gkai00mp.ttf")
     @pdf.font.character_count("こんにちは世界").should == 7
     @pdf.font.character_count("Hello, world!").should == 13
   end