prawn 1.0.0.rc2 → 1.0.0

data/lib/prawn/encoding.rb

@@ -5,7 +5,7 @@
 # This is free software. Please see the LICENSE and COPYING files for details.
 #
 module Prawn
-  module Encoding
+  module Encoding # @private
     # Map between unicode and WinAnsiEnoding
     #
     class WinAnsi #:nodoc:
@@ -18,7 +18,7 @@ module Prawn
         .notdef       .notdef        .notdef        .notdef
         .notdef       .notdef        .notdef        .notdef
         .notdef       .notdef        .notdef        .notdef
-        
+
         space         exclam         quotedbl       numbersign
         dollar        percent        ampersand      quotesingle
         parenleft     parenright     asterisk       plus
@@ -54,7 +54,7 @@ module Prawn
         quotedblright bullet         endash         emdash
         tilde         trademark      scaron         guilsinglright
         oe            .notdef        zcaron         ydieresis
-       
+
         space         exclamdown     cent           sterling
         currency      yen            brokenbar      section
         dieresis      copyright      ordfeminine    guillemotleft
@@ -81,8 +81,8 @@ module Prawn
         ocircumflex   otilde         odieresis      divide
         oslash        ugrave         uacute         ucircumflex
         udieresis     yacute         thorn          ydieresis
-      ]    
-      
+      ]
+
       def initialize
         @mapping_file = "#{Prawn::DATADIR}/encodings/win_ansi.txt"
         load_mapping if self.class.mapping.empty?
@@ -100,7 +100,7 @@ module Prawn
         # Replace anything else with an underscore
         self.class.mapping[codepoint] || 95
       end
-      
+
       def self.mapping
         @mapping ||= {}
       end
@@ -108,10 +108,9 @@ module Prawn
       private
 
       def load_mapping
-        RUBY_VERSION >= "1.9" ? mode = "r:BINARY" : mode = "r"
-        File.open(@mapping_file, mode) do |f|
+        File.open(@mapping_file, "r:BINARY") do |f|
           f.each do |l|
-            m, single_byte, unicode = *l.match(/([0-9A-Za-z]+);([0-9A-F]{4})/)
+            _, single_byte, unicode = *l.match(/([0-9A-Za-z]+);([0-9A-F]{4})/)
             self.class.mapping["0x#{unicode}".hex] = "0x#{single_byte}".hex if single_byte
           end
         end

data/lib/prawn/errors.rb

@@ -8,29 +8,18 @@
 #
 module Prawn
   module Errors
-     
-     # This error is raised when Prawn::PdfObject() encounters a Ruby object it
-     # cannot convert to PDF
-     #
-     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)       
-
      # Raised when a table is spanned in an impossible way.
      #
      InvalidTableSpan = Class.new(StandardError)
-     
-     # This error is raised when a method requiring a current page is called 
+
+     # 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
      #
@@ -39,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)
 
@@ -70,30 +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 
-    #
-    EmptyGraphicStateStack = Class.new(StandardError)
 
     # Raised when unrecognized content is provided for a table cell.
     #
     UnrecognizedTableContent = Class.new(StandardError)
-    
+
   end
-end   
+end

data/lib/prawn/font.rb

@@ -6,13 +6,16 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 #
-require "prawn/font/afm"
-require "prawn/font/ttf"
-require "prawn/font/dfont"
+require_relative "font/afm"
+require_relative "font/ttf"
+require_relative "font/dfont"
+require_relative "font_metric_cache"
 
 module Prawn
 
   class Document
+    # @group Stable API
+
     # Without arguments, this returns the currently selected font. Otherwise,
     # it sets the current font. When a block is used, the font is applied
     # transactionally and is rolled back when the block exits.
@@ -23,8 +26,8 @@ module Prawn
     #     font "Times-Roman"
     #     text "Now using Times-Roman"
     #
-    #     font("Chalkboard.ttf") do
-    #       text "Using TTF font from file Chalkboard.ttf"
+    #     font("DejaVuSans.ttf") do
+    #       text "Using TTF font from file DejaVuSans.ttf"
     #       font "Courier", :style => :bold
     #       text "You see this in bold Courier"
     #     end
@@ -38,7 +41,7 @@ module Prawn
     #
     # If a ttf font is specified, the glyphs necessary to render your document
     # will be embedded in the rendered PDF. This should be your preferred option
-    # in most cases. It will increase the size of the resulting file, but also 
+    # in most cases. It will increase the size of the resulting file, but also
     # make it more portable.
     #
     # The options parameter is an optional hash providing size and style. To use
@@ -49,9 +52,9 @@ module Prawn
       return((defined?(@font) && @font) || font("Helvetica")) if name.nil?
 
       if state.pages.empty? && !state.page.in_stamp_stream?
-        raise Prawn::Errors::NotOnPage 
+        raise Prawn::Errors::NotOnPage
       end
-      
+
       new_font = find_font(name.to_s, options)
 
       if block_given?
@@ -66,7 +69,10 @@ module Prawn
       @font
     end
 
+    # @method font_size(points=nil)
+    #
     # When called with no argument, returns the current font size.
+    #
     # When called with a single argument but no block, sets the current font
     # size.  When a block is used, the font size is applied transactionally and
     # is rolled back when the block exits.  You may still change the font size
@@ -97,59 +103,44 @@ module Prawn
       @font_size = size_before_yield
     end
 
-    # Sets the font directly, given an actual Font object
-    # and size.
-    #
-    def set_font(font, size=nil) # :nodoc:
-      @font = font
-      @font_size = size if size
+    # Sets the font size
+    def font_size=(size)
+      font_size(size)
     end
 
-    # Saves the current font, and then yields. When the block
-    # finishes, the original font is restored.
+    # Returns the width of the given string using the given font. If :size is not
+    # specified as one of the options, the string is measured using the current
+    # font size. You can also pass :kerning as an option to indicate whether
+    # kerning should be used when measuring the width (defaults to +false+).
     #
-    def save_font
-      @font ||= find_font("Helvetica")
-      original_font = @font
-      original_size = @font_size
-
-      yield
-    ensure
-      set_font(original_font, original_size) if original_font
-    end
-
-    # Looks up the given font using the given criteria. Once a font has been
-    # found by that matches the criteria, it will be cached to subsequent lookups
-    # for that font will return the same object.
+    # Note that the string _must_ be encoded properly for the font being used.
+    # For AFM fonts, this is WinAnsi. For TTF, make sure the font is encoded as
+    # UTF-8. You can use the Font#normalize_encoding method to make sure strings
+    # are in an encoding appropriate for the current font.
     #--
-    # Challenges involved: the name alone is not sufficient to uniquely identify
-    # a font (think dfont suitcases that can hold multiple different fonts in a
-    # single file). Thus, the :name key is included in the cache key.
-    #
-    # It is further complicated, however, since fonts in some formats (like the
-    # dfont suitcases) can be identified either by numeric index, OR by their
-    # name within the suitcase, and both should hash to the same font object
-    # (to avoid the font being embedded multiple times). This is not yet implemented,
-    # which means if someone selects a font both by name, and by index, the
-    # font will be embedded twice. Since we do font subsetting, this double
-    # embedding won't be catastrophic, just annoying.
-    # ++
-    def find_font(name, options={}) #:nodoc: 
-      if font_families.key?(name) 
-        family, name = name, font_families[name][options[:style] || :normal] 
-        if name.is_a?(Hash) 
-          options = options.merge(name) 
-          name = options[:file] 
-        end 
-      end 
-      key = "#{name}:#{options[:font] || 0}" 
-      font_registry[key] ||= Font.load(self, name, options.merge(:family => family)) 
-    end 
-    
-    # Hash of Font objects keyed by names
+    # For the record, this method used to be a method of Font (and still delegates
+    # to width computations on Font). However, having the primary interface for
+    # calculating string widths exist on Font made it tricky to write extensions
+    # for Prawn in which widths are computed differently (e.g., taking formatting
+    # tags into account, or the like).
     #
-    def font_registry #:nodoc:
-      @font_registry ||= {}
+    # By putting width_of here, on Document itself, extensions may easily override
+    # it and redefine the width calculation behavior.
+    #++
+    def width_of(string, options={})
+      if p = options[:inline_format]
+        p = [] unless p.is_a?(Array)
+
+        # Build up an Arranger with the entire string on one line, finalize it,
+        # and find its width.
+        arranger = Prawn::Text::Formatted::Arranger.new(self, options)
+        arranger.consumed = self.text_formatter.format(string, *p)
+        arranger.finalize_line
+
+        arranger.line_width
+      else
+        width_of_string(string, options)
+      end
     end
 
     # Hash that maps font family names to their styled individual font names.
@@ -173,13 +164,12 @@ module Prawn
     # wish to support.
     #
     # By default the styles :bold, :italic, :bold_italic, and :normal are
-    # defined for fonts "Courier", "Times-Roman" and "Helvetica".
-    #
-    # You probably want to provide those four styles, but are free to define
-    # custom ones, like :thin, and use them in font calls.
+    # defined for fonts "Courier", "Times-Roman" and "Helvetica". When
+    # defining your own font families, you can map any or all of these
+    # styles to whatever font files you'd like.
     #
     def font_families
-      @font_families ||= Hash.new.merge!(
+      @font_families ||= {}.merge!(
         { "Courier"     => { :bold        => "Courier-Bold",
                              :italic      => "Courier-Oblique",
                              :bold_italic => "Courier-BoldOblique",
@@ -197,45 +187,79 @@ module Prawn
         })
     end
 
-    # Returns the width of the given string using the given font. If :size is not
-    # specified as one of the options, the string is measured using the current
-    # font size. You can also pass :kerning as an option to indicate whether
-    # kerning should be used when measuring the width (defaults to +false+).
+    # @group Experimental API
+
+    # Sets the font directly, given an actual Font object
+    # and size.
     #
-    # Note that the string _must_ be encoded properly for the font being used.
-    # For AFM fonts, this is WinAnsi. For TTF, make sure the font is encoded as
-    # UTF-8. You can use the Font#normalize_encoding method to make sure strings
-    # are in an encoding appropriate for the current font.
-    #--
-    # For the record, this method used to be a method of Font (and still delegates
-    # to width computations on Font). However, having the primary interface for
-    # calculating string widths exist on Font made it tricky to write extensions
-    # for Prawn in which widths are computed differently (e.g., taking formatting
-    # tags into account, or the like).
+    def set_font(font, size=nil) # :nodoc:
+      @font = font
+      @font_size = size if size
+    end
+
+    # Saves the current font, and then yields. When the block
+    # finishes, the original font is restored.
     #
-    # By putting width_of here, on Document itself, extensions may easily override
-    # it and redefine the width calculation behavior.
-    #++
-    def width_of(string, options={})
-      if options[:inline_format]
-        # Build up an Arranger with the entire string on one line, finalize it,
-        # and find its width.
-        arranger = Core::Text::Formatted::Arranger.new(self, options)
-        arranger.consumed = Text::Formatted::Parser.to_array(string)
-        arranger.finalize_line
+    def save_font
+      @font ||= find_font("Helvetica")
+      original_font = @font
+      original_size = @font_size
 
-        arranger.line_width
-      else
-        f = if options[:style]
-              # override style with :style => :bold
-              find_font(@font ? @font.name : 'Helvetica',
-                        :style => options[:style])
-            else
-              font
-            end
-        f.compute_width_of(string, options) +
-          (character_spacing * font.character_count(string))
+      yield
+    ensure
+      set_font(original_font, original_size) if original_font
+    end
+
+    # Looks up the given font using the given criteria. Once a font has been
+    # found by that matches the criteria, it will be cached to subsequent lookups
+    # for that font will return the same object.
+    #--
+    # Challenges involved: the name alone is not sufficient to uniquely identify
+    # a font (think dfont suitcases that can hold multiple different fonts in a
+    # single file). Thus, the :name key is included in the cache key.
+    #
+    # It is further complicated, however, since fonts in some formats (like the
+    # dfont suitcases) can be identified either by numeric index, OR by their
+    # name within the suitcase, and both should hash to the same font object
+    # (to avoid the font being embedded multiple times). This is not yet implemented,
+    # which means if someone selects a font both by name, and by index, the
+    # font will be embedded twice. Since we do font subsetting, this double
+    # embedding won't be catastrophic, just annoying.
+    # ++
+    #
+    # @private
+    def find_font(name, options={}) #:nodoc:
+      if font_families.key?(name)
+        family, name = name, font_families[name][options[:style] || :normal]
+        if name.is_a?(::Hash)
+          options = options.merge(name)
+          name = options[:file]
+        end
       end
+      key = "#{name}:#{options[:font] || 0}"
+      font_registry[key] ||= Font.load(self, name, options.merge(:family => family))
+    end
+
+    # Hash of Font objects keyed by names
+    #
+    def font_registry #:nodoc:
+      @font_registry ||= {}
+    end
+
+    private
+
+    def width_of_inline_formatted_string(string, options={})
+      # Build up an Arranger with the entire string on one line, finalize it,
+      # and find its width.
+      arranger = Prawn::Text::Formatted::Arranger.new(self, options)
+      arranger.consumed = Text::Formatted::Parser.format(string)
+      arranger.finalize_line
+
+      arranger.line_width
+    end
+
+    def width_of_string(string, options={})
+      font_metric_cache.width_of( string, options )
     end
   end
 
@@ -277,7 +301,7 @@ module Prawn
       @references = {}
     end
 
-    # The size of the font ascender in PDF points 
+    # The size of the font ascender in PDF points
     #
     def ascender
       @ascender / 1000.0 * size
@@ -295,14 +319,6 @@ module Prawn
       @line_gap / 1000.0 * size
     end
 
-    def identifier_for(subset)
-      "#{@identifier}.#{subset}".to_sym
-    end
-
-    def inspect
-      "#{self.class.name}< #{name}: #{size} >"
-    end
-
     # Normalizes the encoding of the string to an encoding supported by the
     # font. The string is expected to be UTF-8 going in. It will be re-encoded
     # and the new string will be returned. For an in-place (destructive)
@@ -348,6 +364,22 @@ module Prawn
       "#{self.class.name}< #{name}: #{size} >"
     end
 
+    # Return a hash (as in Object#hash) for the font based on the output of
+    # #inspect. This is required since font objects are used as keys in hashes
+    # that cache certain values (See
+    # Prawn::Table::Text#styled_with_of_single_character)
+    #
+    def hash #:nodoc:
+      [ self.class, self.name, self.family, size ].hash
+    end
+
+    # Compliments the #hash implementation above
+    #
+    def eql?( other ) #:nodoc:
+      self.class == other.class && self.name == other.name &&
+        self.family == other.family && size == other.send(:size)
+    end
+
     private
 
     # generate a font identifier that hasn't been used on the curretn page yet