prawn 0.12.0 → 0.13.0

data/lib/prawn/document/internals.rb

@@ -7,26 +7,26 @@
 # This is free software. Please see the LICENSE and COPYING files for details.
 
 module Prawn
-  class Document     
-    
+  class Document
+
     # This module exposes a few low-level PDF features for those who want
     # to extend Prawn's core functionality.  If you are not comfortable with
     # low level PDF functionality as defined by Adobe's specification, chances
-    # are you won't need anything you find here.  
+    # are you won't need anything you find here.
     #
-    module Internals    
-      
+    module Internals
+
       # Creates a new Prawn::Reference and adds it to the Document's object
-      # list.  The +data+ argument is anything that Prawn::PdfObject() can convert. 
+      # list.  The +data+ argument is anything that Prawn::PdfObject() can convert.
+      #
+      # Returns the identifier which points to the reference in the ObjectStore
       #
-      # Returns the identifier which points to the reference in the ObjectStore   
-      # 
       def ref(data)
         ref!(data).identifier
-      end                                               
+      end
 
       # Like ref, but returns the actual reference instead of its identifier.
-      # 
+      #
       # While you can use this to build up nested references within the object
       # tree, it is recommended to persist only identifiers, and them provide
       # helper methods to look up the actual references in the ObjectStore
@@ -42,21 +42,21 @@ module Prawn
       # of if it's hidden behind a Prawn::Reference, wrap it in deref().
       #
       def deref(obj)
-        obj.is_a?(Prawn::Core::Reference) ? obj.data : obj
+        obj.is_a?(PDF::Core::Reference) ? obj.data : obj
       end
 
       # Appends a raw string to the current page content.
-      #                               
-      #  # Raw line drawing example:           
+      #
+      #  # Raw line drawing example:
       #  x1,y1,x2,y2 = 100,500,300,550
-      #  pdf.add_content("%.3f %.3f m" % [ x1, y1 ])  # move 
+      #  pdf.add_content("%.3f %.3f m" % [ x1, y1 ])  # move
       #  pdf.add_content("%.3f %.3f l" % [ x2, y2 ])  # draw path
-      #  pdf.add_content("S") # stroke                    
+      #  pdf.add_content("S") # stroke
       #
       def add_content(str)
         save_graphics_state if graphic_state.nil?
         state.page.content << str << "\n"
-      end  
+      end
 
       # The Name dictionary (PDF spec 3.6.3) for this document. It is
       # lazily initialized, so that documents that do not need a name
@@ -67,7 +67,7 @@ module Prawn
       end
 
       # Returns true if the Names dictionary is in use for this document.
-      # 
+      #
       def names?
         state.store.root.data[:Names]
       end
@@ -87,8 +87,8 @@ module Prawn
             state.on_page_create_callback = nil
          end
       end
-      
-      private      
+
+      private
 
       # adds a new, empty content stream to each page. Used in templating so
       # that imported content streams can be left pristine
@@ -100,6 +100,7 @@ module Prawn
           apply_margin_options(options)
           generate_margin_box
           use_graphic_settings(options[:template])
+          forget_text_rendering_mode!
         end
       end
 
@@ -156,18 +157,18 @@ module Prawn
       # Write out the PDF Trailer, as per spec 3.4.4
       #
       def render_trailer(output)
-        trailer_hash = {:Size => state.store.size + 1, 
+        trailer_hash = {:Size => state.store.size + 1,
                         :Root => state.store.root,
                         :Info => state.store.info}
         trailer_hash.merge!(state.trailer) if state.trailer
 
         output << "trailer\n"
-        output << Prawn::Core::PdfObject(trailer_hash) << "\n"
-        output << "startxref\n" 
+        output << PDF::Core::PdfObject(trailer_hash) << "\n"
+        output << "startxref\n"
         output << @xref_offset << "\n"
         output << "%%EOF" << "\n"
       end
-                 
+
     end
   end
 end

data/lib/prawn/document/snapshot.rb

@@ -27,7 +27,7 @@ module Prawn
       # +rollback+ is called or a RollbackTransaction exception is raised
       # inside the block, all actions taken inside the block will be rolled
       # back (with the exception of y-position, which you must restore
-      # yourself). 
+      # yourself).
       #
       # Returns true on success, or false if the transaction was rolled back.
       #
@@ -41,7 +41,7 @@ module Prawn
       end
 
       private
-      
+
       # Takes a current snapshot of the document's state, sufficient to
       # reconstruct it after it was amended.
       #
@@ -50,12 +50,11 @@ module Prawn
         # monotonically as data is added to the document, so we share that
         # between the old and new copies.
         {:page_content    => state.page.content.deep_copy,
-         :current_page    => state.page.dictionary.deep_copy(share=[:Parent]),
+         :current_page    => state.page.dictionary.deep_copy([:Parent]),
          :bounds          => bounds.deep_copy,
          :page_number     => page_number,
-         :page_kids       => state.store.pages.data[:Kids].map{|kid| kid.identifier},
-         :dests           => names? && 
-                             Marshal.load(Marshal.dump(names.data[:Dests]))}
+         :page_kids       => state.store.pages.data[:Kids].compact.map{|kid| kid.identifier},
+         :dests           => names? && names.data[:Dests].deep_copy}
       end
 
       # Rolls the page state back to the state of the given snapshot.
@@ -81,7 +80,7 @@ module Prawn
         self.bounds = BoundingBox.restore_deep_copy(shot[:bounds], self)
 
         if shot[:dests]
-          names.data[:Dests] = shot[:dests] 
+          names.data[:Dests] = shot[:dests]
         end
       end
 

data/lib/prawn/document/span.rb

@@ -8,8 +8,8 @@
 
 module Prawn
   class Document
-    # A span is a special purpose bounding box that allows a column of 
-    # elements to be positioned relative to the margin_box.  
+    # A span is a special purpose bounding box that allows a column of
+    # elements to be positioned relative to the margin_box.
     #
     # Arguments:
     # +width+:: The width of the column in PDF points
@@ -17,23 +17,23 @@ module Prawn
     # Options:
     # <tt>:position</tt>:: One of :left, :center, :right or an x offset
     #
-    # This method is typically used for flowing a column of text from one 
+    # This method is typically used for flowing a column of text from one
     # page to the next.
     #
     #  span(350, :position => :center) do
     #    text "Here's some centered text in a 350 point column. " * 100
     #  end
-    #  
+    #
     def span(width, options={})
       Prawn.verify_options [:position], options
-      original_position = self.y      
-     
+      original_position = self.y
+
       # FIXME: Any way to move this upstream?
       left_boundary = case(options[:position] || :left)
       when :left
         margin_box.absolute_left
       when :center
-        margin_box.absolute_left + margin_box.width / 2.0 - width /2.0
+        margin_box.absolute_left + margin_box.width / 2.0 - width / 2.0
       when :right
         margin_box.absolute_right - width
       when Numeric
@@ -41,15 +41,15 @@ module Prawn
       else
         raise ArgumentError, "Invalid option for :position"
       end
-      
+
       # we need to bust out of whatever nested bounding boxes we're in.
       canvas do
-        bounding_box([left_boundary, 
+        bounding_box([left_boundary,
                       margin_box.absolute_top], :width => width) do
           self.y = original_position
           yield
         end
-      end          
+      end
     end
   end
 end

data/lib/prawn/encoding.rb

@@ -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,10 +81,10 @@ module Prawn
         ocircumflex   otilde         odieresis      divide
         oslash        ugrave         uacute         ucircumflex
         udieresis     yacute         thorn          ydieresis
-      ]    
-      
+      ]
+
       def initialize
-        @mapping_file = "#{Prawn::BASEDIR}/data/encodings/win_ansi.txt"
+        @mapping_file = "#{Prawn::DATADIR}/encodings/win_ansi.txt"
         load_mapping if self.class.mapping.empty?
       end
 
@@ -100,7 +100,7 @@ module Prawn
         # Replace anything else with an underscore
         self.class.mapping[codepoint] || 95
       end
-      
+
       def self.mapping
         @mapping ||= {}
       end
@@ -111,7 +111,7 @@ module Prawn
         RUBY_VERSION >= "1.9" ? mode = "r:BINARY" : mode = "r"
         File.open(@mapping_file, mode) 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,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.rb

@@ -9,6 +9,7 @@
 require "prawn/font/afm"
 require "prawn/font/ttf"
 require "prawn/font/dfont"
+require "prawn/font_metric_cache"
 
 module Prawn
 
@@ -38,7 +39,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 +50,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?
@@ -134,18 +135,18 @@ module Prawn
     # 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 
-    
+    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:
@@ -179,7 +180,7 @@ module Prawn
     # custom ones, like :thin, and use them in font calls.
     #
     def font_families
-      @font_families ||= Hash.new.merge!(
+      @font_families ||= {}.merge!(
         { "Courier"     => { :bold        => "Courier-Bold",
                              :italic      => "Courier-Oblique",
                              :bold_italic => "Courier-BoldOblique",
@@ -217,8 +218,35 @@ module Prawn
     # it and redefine the width calculation behavior.
     #++
     def width_of(string, options={})
-      font.compute_width_of(string, options) +
-        (character_spacing * font.character_count(string))
+      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
+
+    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
 
@@ -240,7 +268,7 @@ module Prawn
     # will be passed through to Font::AFM.new()
     #
     def self.load(document,name,options={})
-      case name
+      case name.to_s
       when /\.ttf$/i   then TTF.new(document, name, options)
       when /\.dfont$/i then DFont.new(document, name, options)
       when /\.afm$/i   then AFM.new(document, name, options)
@@ -260,7 +288,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
@@ -278,14 +306,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)
@@ -331,6 +351,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