prawn 0.11.1 → 0.15.0

data/lib/prawn/errors.rb

@@ -8,25 +8,18 @@
 #
 module Prawn
   module Errors
-     
-     # This error is raised when Prawn::PdfObject() encounters a Ruby object it
-     # cannot convert to PDF
+     # Raised when a table is spanned in an impossible way.
      #
-     FailedObjectConversion = Class.new(StandardError)
-     
-     # This error is raised when Document#page_layout is set to anything
-     # other than :portrait or :landscape            
-     #
-     InvalidPageLayout = Class.new(StandardError)       
-     
-     # This error is raised when a method requiring a current page is called 
+     InvalidTableSpan = Class.new(StandardError)
+
+     # This error is raised when a method requiring a current page is called
      # without being on a page.
      #
      NotOnPage = Class.new(StandardError)
-     
-     # This error is raised when Prawn cannot find a specified font   
+
+     # This error is raised when Prawn cannot find a specified font
      #
-     UnknownFont = Class.new(StandardError)   
+     UnknownFont = Class.new(StandardError)
 
      # Raised when Prawn is asked to draw something into a too-small box
      #
@@ -35,18 +28,18 @@ module Prawn
      # Raised if group() is called with a block that is too big to be
      # rendered in the current context.
      #
-     CannotGroup = Class.new(StandardError) 
+     CannotGroup = Class.new(StandardError)
 
      # This error is raised when Prawn is being used on a M17N aware VM,
      # and the user attempts to add text that isn't compatible with UTF-8
      # to their document
      #
      IncompatibleStringEncoding = Class.new(StandardError)
-     
+
      # This error is raised when Prawn encounters an unknown key in functions
      # that accept an options hash.  This usually means there is a typo in your
      # code or that the option you are trying to use has a different name than
-     # what you have specified. 
+     # what you have specified.
      #
      UnknownOption = Class.new(StandardError)
 
@@ -66,26 +59,22 @@ module Prawn
     # This error is raised when an object is attempted to be
     # referenced by name, but no such name is associated with an object
     UndefinedObjectName = Class.new(StandardError)
-    
+
     # This error is raised when a required option has not been set
     RequiredOption = Class.new(StandardError)
-    
+
     # This error is raised when a requested outline item with a given title does not exist
     UnknownOutlineTitle = Class.new(StandardError)
 
     # This error is raised when a block is required, but not provided
     BlockRequired = Class.new(StandardError)
-    
+
     # This error is rased when a graphics method is called with improper arguments
     InvalidGraphicsPath = Class.new(StandardError)
-    
-    # This error is raised when Prawn fails to load a template file
-    #
-    TemplateError = Class.new(StandardError)
-    
-    # This error is raise when trying to restore a graphic state that 
+
+    # Raised when unrecognized content is provided for a table cell.
     #
-    EmptyGraphicStateStack = Class.new(StandardError)
-    
+    UnrecognizedTableContent = Class.new(StandardError)
+
   end
-end   
+end

data/lib/prawn/font/afm.rb

@@ -6,10 +6,13 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require 'prawn/encoding'
+require_relative '../../prawn/encoding'
 
 module Prawn
   class Font
+
+    # @private
+
     class AFM < Font
       BUILT_INS = %w[ Courier Helvetica Times-Roman Symbol ZapfDingbats
                       Courier-Bold Courier-Oblique Courier-BoldOblique
@@ -27,8 +30,8 @@ module Prawn
           @metrics_path ||= [
             ".", "/usr/lib/afm",
             "/usr/local/lib/afm",
-            "/usr/openwin/lib/fonts/afm/",
-             Prawn::BASEDIR+'/data/fonts/']
+            "/usr/openwin/lib/fonts/afm",
+             Prawn::DATADIR+'/fonts']
         end
       end
 
@@ -41,16 +44,20 @@ module Prawn
 
         super
 
-        @attributes     = {}
-        @glyph_widths   = {}
-        @bounding_boxes = {}
-        @kern_pairs     = {}
+        @@winansi   ||= Prawn::Encoding::WinAnsi.new # parse data/encodings/win_ansi.txt once only
+        @@font_data ||= SynchronizedCache.new        # parse each ATM font file once only
 
         file_name = @name.dup
         file_name << ".afm" unless file_name =~ /\.afm$/
         file_name = file_name[0] == ?/ ? file_name : find_font(file_name)
 
-        parse_afm(file_name)
+        font_data = @@font_data[file_name] ||= parse_afm(file_name)
+        @glyph_widths    = font_data[:glyph_widths]
+        @glyph_table     = font_data[:glyph_table]
+        @bounding_boxes  = font_data[:bounding_boxes]
+        @kern_pairs      = font_data[:kern_pairs]
+        @kern_pair_table = font_data[:kern_pair_table]
+        @attributes      = font_data[:attributes]
 
         @ascender  = @attributes["ascender"].to_i
         @descender = @attributes["descender"].to_i
@@ -87,13 +94,19 @@ module Prawn
       # is replaced with a string in WinAnsi encoding.
       #
       def normalize_encoding(text)
-        enc = Prawn::Encoding::WinAnsi.new
+        enc = @@winansi
         text.unpack("U*").collect { |i| enc[i] }.pack("C*")
       rescue ArgumentError
         raise Prawn::Errors::IncompatibleStringEncoding,
           "Arguments to text methods must be UTF-8 encoded"
       end
 
+      # Returns the number of characters in +str+ (a WinAnsi-encoded string).
+      #
+      def character_count(str)
+        str.length
+      end
+
       # Perform any changes to the string that need to happen
       # before it is rendered to the canvas. Returns an array of
       # subset "chunks", where each chunk is an array of two elements.
@@ -144,6 +157,7 @@ module Prawn
       end
 
       def parse_afm(file_name)
+        data    = {:glyph_widths => {}, :bounding_boxes => {}, :kern_pairs => {}, :attributes => {}}         
         section = []
 
         File.foreach(file_name) do |line|
@@ -160,27 +174,41 @@ module Prawn
           when ["FontMetrics", "CharMetrics"]
             next unless line =~ /^CH?\s/
 
-            name                  = line[/\bN\s+(\.?\w+)\s*;/, 1]
-            @glyph_widths[name]   = line[/\bWX\s+(\d+)\s*;/, 1].to_i
-            @bounding_boxes[name] = line[/\bB\s+([^;]+);/, 1].to_s.rstrip
+            name                        = line[/\bN\s+(\.?\w+)\s*;/, 1]
+            data[:glyph_widths][name]   = line[/\bWX\s+(\d+)\s*;/, 1].to_i
+            data[:bounding_boxes][name] = line[/\bB\s+([^;]+);/, 1].to_s.rstrip
           when ["FontMetrics", "KernData", "KernPairs"]
             next unless line =~ /^KPX\s+(\.?\w+)\s+(\.?\w+)\s+(-?\d+)/
-            @kern_pairs[[$1, $2]] = $3.to_i
+            data[:kern_pairs][[$1, $2]] = $3.to_i
           when ["FontMetrics", "KernData", "TrackKern"],
             ["FontMetrics", "Composites"]
             next
           else
-            parse_generic_afm_attribute(line)
+            parse_generic_afm_attribute(line, data)
           end
         end
+        
+        # process data parsed from AFM file to build tables which
+        #   will be used when measuring and kerning text
+        data[:glyph_table] = (0..255).map do |i|
+          data[:glyph_widths][Encoding::WinAnsi::CHARACTERS[i]].to_i
+        end
+
+        character_hash = Hash[Encoding::WinAnsi::CHARACTERS.zip((0..Encoding::WinAnsi::CHARACTERS.size).to_a)]
+        data[:kern_pair_table] = data[:kern_pairs].inject({}) do |h,p|
+          h[p[0].map { |n| character_hash[n] }] = p[1]
+          h
+        end
+
+        data.each_value { |hash| hash.freeze }
+        data.freeze
       end
 
-      def parse_generic_afm_attribute(line)
+      def parse_generic_afm_attribute(line, hash)
         line =~ /(^\w+)\s+(.*)/
         key, value = $1.to_s.downcase, $2
 
-        @attributes[key] =  @attributes[key] ?
-        Array(@attributes[key]) << value : value
+        hash[:attributes][key] = hash[:attributes][key] ? Array(hash[:attributes][key]) << value : value
       end
 
       # converts a string into an array with spacing offsets
@@ -192,43 +220,26 @@ module Prawn
         kerned = [[]]
         last_byte = nil
 
-        kern_pairs = latin_kern_pairs_table
-
-        string.unpack("C*").each do |byte|
-          if k = last_byte && kern_pairs[[last_byte, byte]]
+        string.each_byte do |byte|
+          if k = last_byte && @kern_pair_table[[last_byte, byte]]
             kerned << -k << [byte]
           else
             kerned.last << byte
-          end         
+          end
           last_byte = byte
         end
 
-        kerned.map { |e| 
+        kerned.map { |e|
           e = (Array === e ? e.pack("C*") : e)
-          e.respond_to?(:force_encoding) ? e.force_encoding("Windows-1252") : e  
+          e.respond_to?(:force_encoding) ? e.force_encoding(::Encoding::Windows_1252) : e
         }
       end
-
-      def latin_kern_pairs_table
-        @kern_pairs_table ||= @kern_pairs.inject({}) do |h,p|
-          h[p[0].map { |n| Encoding::WinAnsi::CHARACTERS.index(n) }] = p[1]
-          h
-        end
-      end
-
-      def latin_glyphs_table
-        @glyphs_table ||= (0..255).map do |i|
-          @glyph_widths[Encoding::WinAnsi::CHARACTERS[i]].to_i
-        end
-      end
       
       private
       
       def unscaled_width_of(string)
-        glyph_table = latin_glyphs_table
-        
-        string.unpack("C*").inject(0) do |s,r|
-          s + glyph_table[r]
+        string.bytes.inject(0) do |s,r|
+          s + @glyph_table[r]
         end
       end
     end

data/lib/prawn/font/dfont.rb

@@ -6,12 +6,13 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 #
-require 'prawn/font/ttf'
+require_relative 'ttf'
 
 module Prawn
   class Font
+    # @private
     class DFont < TTF
-      
+
       # Returns a list of the names of all named fonts in the given dfont file.
       # Note that fonts are not required to be named in a dfont file, so the
       # list may be empty even if the file does contain fonts. Also, note that
@@ -32,7 +33,7 @@ module Prawn
         end
       end
 
-      private 
+      private
 
       def read_ttf_file
         TTFunk::File.from_dfont(@name, @options[:font] || 0)

data/lib/prawn/font/ttf.rb

@@ -2,7 +2,7 @@
 
 # prawn/font/ttf.rb : Implements AFM font support for Prawn
 #
-# Copyright May 2008, Gregory Brown / James Healy / Jamis Buck  
+# Copyright May 2008, Gregory Brown / James Healy / Jamis Buck
 # All Rights Reserved.
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
@@ -12,13 +12,15 @@ require 'ttfunk/subset_collection'
 
 module Prawn
   class Font
+
+    # @private
     class TTF < Font
       attr_reader :ttf, :subsets
 
       def unicode?
         true
       end
-      
+
       def initialize(document, name, options={})
         super
 
@@ -26,8 +28,8 @@ module Prawn
         @subsets          = TTFunk::SubsetCollection.new(@ttf)
 
         @attributes       = {}
-        @bounding_boxes   = {} 
-        @char_widths      = {}   
+        @bounding_boxes   = {}
+        @char_widths      = {}
         @has_kerning_data = @ttf.kerning.exists? && @ttf.kerning.tables.any?
 
         @ascender         = Integer(@ttf.ascent * scale_factor)
@@ -42,26 +44,26 @@ module Prawn
           kern(string).inject(0) do |s,r|
             if r.is_a?(Numeric)
               s - r
-            else 
+            else
               r.inject(s) { |s2, u| s2 + character_width_by_code(u) }
             end
           end * scale
         else
-          string.unpack("U*").inject(0) do |s,r|
+          string.codepoints.inject(0) do |s,r|
             s + character_width_by_code(r)
           end * scale
         end
-      end   
-     
+      end
+
       # The font bbox, as an array of integers
-      # 
+      #
       def bbox
         @bbox ||= @ttf.bbox.map { |i| Integer(i * scale_factor) }
       end
 
       # Returns true if the font has kerning data, false otherwise
       def has_kerning_data?
-        @has_kerning_data 
+        @has_kerning_data
       end
 
       # Perform any changes to the string that need to happen
@@ -77,7 +79,7 @@ module Prawn
 
         if options[:kerning]
           last_subset = nil
-          kern(text).inject([]) do |result, element| 
+          kern(text).inject([]) do |result, element|
             if element.is_a?(Numeric)
               result.last[1] = [result.last[1]] unless result.last[1].is_a?(Array)
               result.last[1] << element
@@ -102,7 +104,7 @@ module Prawn
           @subsets.encode(text.unpack("U*"))
         end
       end
-      
+
       def basename
         @basename ||= @ttf.name.postscript_name
       end
@@ -126,7 +128,7 @@ module Prawn
       def cap_height
         @cap_height ||= begin
           height = @ttf.os2.exists? && @ttf.os2.cap_height || 0
-          height == 0 ? ascender : height
+          height == 0 ? @ascender : height
         end
       end
 
@@ -160,42 +162,34 @@ module Prawn
       end
 
       def normalize_encoding(text)
-        if text.respond_to?(:encode)
-          # if we're running under a M17n aware VM, ensure the string provided is
-          # UTF-8 (by converting it if necessary)
-          begin
-            text.encode("UTF-8")
-          rescue
-            raise Prawn::Errors::IncompatibleStringEncoding, "Encoding " +
+        begin
+          text.encode(::Encoding::UTF_8)
+        rescue => e
+          puts e
+          raise Prawn::Errors::IncompatibleStringEncoding, "Encoding " +
             "#{text.encoding} can not be transparently converted to UTF-8. " +
             "Please ensure the encoding of the string you are attempting " +
             "to use is set correctly"
-          end
-        else
-          # on a non M17N aware VM, use unpack as a hackish way to verify the
-          # string is valid utf-8. I thought it was better than loading iconv
-          # though.
-          begin
-            text.unpack("U*")
-            return text.dup
-          rescue
-            raise Prawn::Errors::IncompatibleStringEncoding, "The string you " +
-              "are attempting to render is not encoded in valid UTF-8."
-          end
         end
       end
 
       def glyph_present?(char)
-        code = char.unpack("U*").first
+        code = char.codepoints.first
         cmap[code] > 0
       end
 
+      # Returns the number of characters in +str+ (a UTF-8-encoded string).
+      #
+      def character_count(str)
+        str.length
+      end
+
       private
 
       def cmap
         @cmap ||= @ttf.cmap.unicode.first or raise("no unicode cmap for font")
       end
-      
+
       # +string+ must be UTF8-encoded.
       #
       # Returns an array. If an element is a numeric, it represents the
@@ -204,7 +198,7 @@ module Prawn
       def kern(string)
         a = []
 
-        string.unpack("U*").each do |r|
+        string.each_codepoint do |r|
           if a.empty?
             a << [r]
           elsif (kern = kern_pairs_table[[cmap[a.last.last], cmap[r]]])
@@ -231,10 +225,15 @@ module Prawn
         @hmtx ||= @ttf.horizontal_metrics
       end
 
-      def character_width_by_code(code)    
+      def character_width_by_code(code)
         return 0 unless cmap[code]
+
+        # Some TTF fonts have nonzero widths for \n (UTF-8 / ASCII code: 10).
+        # Patch around this as we'll never be drawing a newline with a width.
+        return 0.0 if code == 10
+
         @char_widths[code] ||= Integer(hmtx.widths[cmap[code]] * scale_factor)
-      end                   
+      end
 
       def scale_factor
         @scale ||= 1000.0 / @ttf.header.units_per_em
@@ -244,7 +243,7 @@ module Prawn
         temp_name = @ttf.name.postscript_name.gsub("\0","").to_sym
         ref = @document.ref!(:Type => :Font, :BaseFont => temp_name)
 
-        # Embed the font metrics in the document after everything has been 
+        # Embed the font metrics in the document after everything has been
         # drawn, just before the document is emitted.
         @document.before_render { |doc| embed(ref, subset) }
 
@@ -265,12 +264,9 @@ module Prawn
 
         raise "Can't detect a postscript name for #{file}" if basename.nil?
 
-        compressed_font = Zlib::Deflate.deflate(font_content)
-
-        fontfile = @document.ref!(:Length => compressed_font.size,
-                                 :Length1 => font_content.size,
-                                 :Filter => :FlateDecode )
-        fontfile << compressed_font
+        fontfile = @document.ref!(:Length1 => font_content.size)
+        fontfile.stream << font_content
+        fontfile.stream.compress!
 
         descriptor = @document.ref!(:Type        => :FontDescriptor,
                                    :FontName    => basename.to_sym,
@@ -279,8 +275,8 @@ module Prawn
                                    :Flags       => pdf_flags,
                                    :StemV       => stemV,
                                    :ItalicAngle => italic_angle,
-                                   :Ascent      => ascender,
-                                   :Descent     => descender,
+                                   :Ascent      => @ascender,
+                                   :Descent     => @descender,
                                    :CapHeight   => cap_height,
                                    :XHeight     => x_height)
 
@@ -301,7 +297,7 @@ module Prawn
         map = @subsets[subset].to_unicode_map
 
         ranges = [[]]
-        lines = map.keys.sort.inject("") do |s, code|
+        map.keys.sort.inject("") do |s, code|
           ranges << [] if ranges.last.length >= 100
           unicode = map[code]
           ranges.last << "<%02x><%04x>" % [code, unicode]
@@ -315,7 +311,7 @@ module Prawn
 
         cmap = @document.ref!({})
         cmap << to_unicode_cmap
-        cmap.compress_stream
+        cmap.stream.compress!
 
         reference.data.update(:Subtype => :TrueType,
                               :BaseFont => basename.to_sym,