prawn 1.0.0.rc1 → 1.0.0.rc2

data/lib/prawn/core/reference.rb

@@ -34,7 +34,9 @@ module Prawn
       
       def <<(data)
         raise 'Cannot add data to a stream that is compressed' if @compressed
-        (@stream ||= "") << data  
+        (@stream ||= "") << data
+        @data[:Length] = @stream.length
+        @stream
       end  
       
       def to_s            
@@ -44,7 +46,7 @@ module Prawn
       def compress_stream
         @stream = Zlib::Deflate.deflate(@stream)
         @data[:Filter] = :FlateDecode
-        @data[:Length] ||= @stream.length
+        @data[:Length] = @stream.length
         @compressed = true
       end
 
@@ -100,6 +102,8 @@ module Prawn
           obj.values.map{|v| [v] + referenced_objects(v) }
         when Array
           obj.map{|v| [v] + referenced_objects(v) }
+        when OutlineRoot, OutlineItem
+          referenced_objects(obj.to_hash)
         else []
         end.flatten.grep(self.class)
       end

data/lib/prawn/core/text.rb

@@ -131,11 +131,11 @@ module Prawn
       #
       # Call with an empty array to turn off fallback fonts
       #
-      # file = "#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf"
+      # file = "#{Prawn::DATADIR}/fonts/gkai00mp.ttf"
       # font_families["Kai"] = {
       #   :normal => { :file => file, :font => "Kai" }
       # }
-      # file = "#{Prawn::BASEDIR}/data/fonts/Action Man.dfont"
+      # file = "#{Prawn::DATADIR}/fonts/Action Man.dfont"
       # font_families["Action Man"] = {
       #   :normal      => { :file => file, :font => "ActionMan" },
       # }
@@ -186,10 +186,10 @@ module Prawn
       #
       def text_rendering_mode(mode=nil)
         return @text_rendering_mode || :fill if mode.nil?
-        unless MODES.keys.include?(mode)
+        unless MODES.key?(mode)
           raise ArgumentError, "mode must be between one of #{MODES.keys.join(', ')} (#{mode})"
         end
-        original_mode = text_rendering_mode
+        original_mode = @text_rendering_mode || :fill
         if original_mode == mode
           yield
         else

data/lib/prawn/core/text/formatted/line_wrap.rb

@@ -71,6 +71,9 @@ module Prawn
           def apply_font_settings_and_add_fragment_to_line(fragment)
             result = nil
             @arranger.apply_font_settings do
+              # if font has changed from Unicode to non-Unicode, or vice versa, the characters used for soft hyphens
+              #   and zero-width spaces will be different
+              set_soft_hyphen_and_zero_width_space
               result = add_fragment_to_line(fragment)
             end
             result
@@ -141,11 +144,11 @@ module Prawn
           end
 
           def soft_hyphen
-            @document.font.normalize_encoding(Prawn::Text::SHY)
+            @soft_hyphen
           end
 
           def zero_width_space
-            @document.font.unicode? ? Prawn::Text::ZWSP : ""
+            @zero_width_space 
           end
 
           def line_empty?
@@ -168,6 +171,14 @@ module Prawn
             @line_full = false
           end
 
+          def set_soft_hyphen_and_zero_width_space
+            # this is done once per fragment, after the font settings for the fragment are applied --
+            #   it could actually be skipped if the font hasn't changed
+            font = @document.font
+            @soft_hyphen = font.normalize_encoding(Prawn::Text::SHY) 
+            @zero_width_space = font.unicode? ? Prawn::Text::ZWSP : ""
+          end
+
           def fragment_finished(fragment)
             if fragment == "\n"
               @newline_encountered = true
@@ -231,20 +242,24 @@ module Prawn
           end
 
           def wrap_by_char(segment)
-            if @document.font.unicode?
-              segment.unpack("U*").each do |char_int|
-                break unless append_char([char_int].pack("U"))
+            # this conditional is only necessary for Ruby 1.8 compatibility
+            # String#unicode_characters is a helper which iterates over UTF-8 characters
+            #   under Ruby 1.9, it is implemented simply by aliasing #each_char
+            font = @document.font
+            if font.unicode?
+              segment.unicode_characters do |char|
+                break unless append_char(char,font)
               end
             else
               segment.each_char do |char|
-                break unless append_char(char)
+                break unless append_char(char,font)
               end
             end
           end
 
-          def append_char(char)
+          def append_char(char,font)
             # kerning doesn't make sense in the context of a single character
-            char_width = @document.width_of(char)
+            char_width = font.compute_width_of(char)
 
             if @accumulated_width + char_width <= @width
               @accumulated_width += char_width

data/lib/prawn/document.rb

@@ -61,6 +61,7 @@ module Prawn
     include Prawn::Graphics
     include Prawn::Images
     include Prawn::Stamp
+    include Prawn::SoftMask
 
     # Any module added to this array will be included into instances of
     # Prawn::Document at the per-object level.  These will also be inherited by
@@ -136,6 +137,7 @@ module Prawn
     # <tt>:compress</tt>:: Compresses content streams before rendering them [false]
     # <tt>:optimize_objects</tt>:: Reduce number of PDF objects in output, at expense of render time [false]
     # <tt>:background</tt>:: An image path to be used as background on all pages [nil]
+    # <tt>:background_scale</tt>:: Backgound image scale [1] [nil]
     # <tt>:info</tt>:: Generic hash allowing for custom metadata properties [nil]
     # <tt>:template</tt>:: The path to an existing PDF file to use as a template [nil]
     #
@@ -166,7 +168,7 @@ module Prawn
     #   pdf = Prawn::Document.new(:page_size => [200, 300])
     #
     #   # New document, with background
-    #   pdf = Prawn::Document.new(:background => "#{Prawn::BASEDIR}/data/images/pigs.jpg")
+    #   pdf = Prawn::Document.new(:background => "#{Prawn::DATADIR}/images/pigs.jpg")
     #
     def initialize(options={},&block)
       options = options.dup
@@ -185,6 +187,7 @@ module Prawn
       min_version(state.store.min_version) if state.store.min_version
 
       @background = options[:background]
+      @background_scale = options[:background_scale] || 1
       @font_size  = 12
 
       @bounding_box  = nil
@@ -241,6 +244,9 @@ module Prawn
     #
     #  pdf.start_new_page(:template => multipage_template.pdf, :template_page => 2)
     #
+    # Note: templates get indexed by either the object_id of the filename or stream
+    # entered so that if you reuse the same template multiple times be sure to use the
+    # same instance for more efficient use of resources and smaller rendered pdfs.
     def start_new_page(options = {})
       if last_page = state.page
         last_page_size    = last_page.size
@@ -277,7 +283,7 @@ module Prawn
         state.insert_page(state.page, @page_number)
         @page_number += 1
 
-        canvas { image(@background, :at => bounds.top_left) } if @background
+        canvas { image(@background, :scale => @background_scale, :at => bounds.top_left) } if @background
         @y = @bounding_box.absolute_top
 
         float do
@@ -539,15 +545,15 @@ module Prawn
     # through existing pages after they are created.
     #
     # Parameters are:
-    # 
-    # <tt>string</tt>:: Template string for page number wording.  
+    #
+    # <tt>string</tt>:: Template string for page number wording.
     #                   Should include '<page>' and, optionally, '<total>'.
     # <tt>options</tt>:: A hash for page numbering and text box options.
-    #     <tt>:page_filter</tt>:: A filter to specify which pages to place page numbers on.  
+    #     <tt>:page_filter</tt>:: A filter to specify which pages to place page numbers on.
     #                             Refer to the method 'page_match?'
     #     <tt>:start_count_at</tt>:: The starting count to increment pages from.
     #     <tt>:total_pages</tt>:: If provided, will replace <total> with the value given.
-    #                             Useful to override the total number of pages when using 
+    #                             Useful to override the total number of pages when using
     #                             the start_count_at option.
     #     <tt>:color</tt>:: Text fill color.
     #
@@ -558,7 +564,7 @@ module Prawn
     #          five.
     #
     #   Prawn::Document.generate("page_with_numbering.pdf") do
-    #     number_pages "<page> in a total of <total>", 
+    #     number_pages "<page> in a total of <total>",
     #                                          {:start_count_at => 5,
     #                                           :page_filter => lambda{ |pg| pg != 1 },
     #                                           :at => [bounds.right - 50, 0],
@@ -577,8 +583,8 @@ module Prawn
       total_pages = opts.delete(:total_pages)
       txtcolor = opts.delete(:color)
       # An explicit height so that we can draw page numbers in the margins
-      opts[:height] = 50
-      
+      opts[:height] = 50 unless opts.has_key?(:height)
+
       start_count = false
       pseudopage = 0
       (1..page_count).each do |p|
@@ -589,7 +595,7 @@ module Prawn
                        else
                          start_count_at.to_i
                        end
-        end        
+        end
         if page_match?(page_filter, p)
           go_to_page(p)
           # have to use fill_color here otherwise text reverts back to default fill color
@@ -598,13 +604,13 @@ module Prawn
           str = string.gsub("<page>","#{pseudopage}").gsub("<total>","#{total_pages}")
           text_box str, opts
           start_count = true  # increment page count as soon as first match found
-        end 
+        end
         pseudopage += 1 if start_count
       end
     end
 
     # Provides a way to execute a block of code repeatedly based on a
-    # page_filter.  
+    # page_filter.
     #
     # Available page filters are:
     #   :all         repeats on every page
@@ -612,7 +618,7 @@ module Prawn
     #   :even        repeats on even pages
     #   some_array   repeats on every page listed in the array
     #   some_range   repeats on every page included in the range
-    #   some_lambda  yields page number and repeats for true return values 
+    #   some_lambda  yields page number and repeats for true return values
     def page_match?(page_filter, page_number)
       case page_filter
       when :all
@@ -626,7 +632,7 @@ module Prawn
       when Proc
         page_filter.call(page_number)
       end
-    end  
+    end
 
 
     # Returns true if content streams will be compressed before rendering,
@@ -640,7 +646,7 @@ module Prawn
 
     def merge_template_options(page_options, options)
       object_id = state.store.import_page(options[:template], options[:template_page] || 1)
-      page_options.merge!(:object_id => object_id )
+      page_options.merge!(:object_id => object_id, :page_template => true)
     end
 
     # setting override_settings to true ensures that a new graphic state does not end up using

data/lib/prawn/document/bounding_box.rb

@@ -154,10 +154,10 @@ module Prawn
     # Of course, if you use canvas, you will be responsible for ensuring that
     # you remain within the printable area of your document.
     #
-    def bounding_box(*args, &block)
+    def bounding_box(pt, *args, &block)
       init_bounding_box(block) do |parent_box|
-        map_to_absolute!(args[0])
-        @bounding_box = BoundingBox.new(self, parent_box, *args)
+        pt = map_to_absolute(pt)
+        @bounding_box = BoundingBox.new(self, parent_box, pt, *args)
       end
     end
 

data/lib/prawn/document/column_box.rb

@@ -53,17 +53,23 @@ module Prawn
         @current_column = 0
       end
 
-      # The column width, not the width of the whole box.  Used to calculate
-      # how long a line of text can be.
+      # The column width, not the width of the whole box,
+      # before left and/or right padding
+      def bare_column_width
+        (@width - @spacer * (@columns - 1)) / @columns
+      end
+
+      # The column width after padding.
+      # Used to calculate how long a line of text can be.
       #
       def width
-        super / @columns - @spacer - @total_left_padding - @total_right_padding
+        bare_column_width - (@total_left_padding + @total_right_padding)
       end
 
       # Column width including the spacer.
       #
       def width_of_column
-        width + @spacer
+        bare_column_width + @spacer
       end
 
       # x coordinate of the left edge of the current column
@@ -72,6 +78,12 @@ module Prawn
         absolute_left + (width_of_column * @current_column)
       end
 
+      # Relative position of the left edge of the current column
+      #
+      def left
+        width_of_column * @current_column
+      end
+
       # x co-orordinate of the right edge of the current column
       #
       def right_side
@@ -79,6 +91,12 @@ module Prawn
         absolute_right - (width_of_column * columns_from_right)
       end
 
+      # Relative position of the right edge of the current column.
+      #
+      def right
+        left + width
+      end
+
       # Moves to the next column or starts a new page if currently positioned at
       # the rightmost column.
       def move_past_bottom 

data/lib/prawn/document/snapshot.rb

@@ -53,7 +53,7 @@ module Prawn
          :current_page    => state.page.dictionary.deep_copy(share=[:Parent]),
          :bounds          => bounds.deep_copy,
          :page_number     => page_number,
-         :page_kids       => state.store.pages.data[:Kids].map{|kid| kid.identifier},
+         :page_kids       => state.store.pages.data[:Kids].compact.map{|kid| kid.identifier},
          :dests           => names? && names.data[:Dests].deep_copy}
       end
 

data/lib/prawn/encoding.rb

@@ -84,7 +84,7 @@ module Prawn
       ]    
       
       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
 

data/lib/prawn/errors.rb

@@ -18,6 +18,10 @@ module Prawn
      # 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 
      # without being on a page.

data/lib/prawn/font.rb

@@ -257,7 +257,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)

data/lib/prawn/font/afm.rb

@@ -7,6 +7,7 @@
 # This is free software. Please see the LICENSE and COPYING files for details.
 
 require 'prawn/encoding'
+require 'afm'
 
 module Prawn
   class Font
@@ -27,8 +28,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,26 +42,28 @@ 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] ||= ::AFM::Font.new(file_name)
+        @glyph_table     = build_glyph_table(font_data)
+        @kern_pairs      = font_data.kern_pairs
+        @kern_pair_table = build_kern_pair_table(@kern_pairs)
+        @attributes      = font_data.metadata
 
-        @ascender  = @attributes["ascender"].to_i
-        @descender = @attributes["descender"].to_i
+        @ascender  = @attributes["Ascender"].to_i
+        @descender = @attributes["Descender"].to_i
         @line_gap  = Float(bbox[3] - bbox[1]) - (@ascender - @descender)
       end
 
       # The font bbox, as an array of integers
       #
       def bbox
-        @bbox ||= @attributes['fontbbox'].split(/\s+/).map { |e| Integer(e) }
+        @bbox ||= @attributes['FontBBox'].split(/\s+/).map { |e| Integer(e) }
       end
 
       # NOTE: String *must* be encoded as WinAnsi
@@ -86,8 +89,8 @@ module Prawn
       # string. Changes the encoding in-place, so the argument itself
       # is replaced with a string in WinAnsi encoding.
       #
-      def normalize_encoding(text)
-        enc = Prawn::Encoding::WinAnsi.new
+      def normalize_encoding(text) 
+        enc = @@winansi
         text.unpack("U*").collect { |i| enc[i] }.pack("C*")
       rescue ArgumentError
         raise Prawn::Errors::IncompatibleStringEncoding,
@@ -138,7 +141,7 @@ module Prawn
       end
 
       def symbolic?
-        attributes["characterset"] == "Special"
+        attributes["CharacterSet"] == "Special"
       end
 
       def find_font(file)
@@ -149,46 +152,6 @@ module Prawn
            self.class.metrics_path.join("\n")
       end
 
-      def parse_afm(file_name)
-        section = []
-
-        File.foreach(file_name) do |line|
-          case line
-          when /^Start(\w+)/
-            section.push $1
-            next
-          when /^End(\w+)/
-            section.pop
-            next
-          end
-
-          case section
-          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
-          when ["FontMetrics", "KernData", "KernPairs"]
-            next unless line =~ /^KPX\s+(\.?\w+)\s+(\.?\w+)\s+(-?\d+)/
-            @kern_pairs[[$1, $2]] = $3.to_i
-          when ["FontMetrics", "KernData", "TrackKern"],
-            ["FontMetrics", "Composites"]
-            next
-          else
-            parse_generic_afm_attribute(line)
-          end
-        end
-      end
-
-      def parse_generic_afm_attribute(line)
-        line =~ /(^\w+)\s+(.*)/
-        key, value = $1.to_s.downcase, $2
-
-        @attributes[key] =  @attributes[key] ?
-        Array(@attributes[key]) << value : value
-      end
-
       # converts a string into an array with spacing offsets
       # bewteen characters that need to be kerned
       #
@@ -198,10 +161,8 @@ 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.bytes do |byte|
+          if k = last_byte && @kern_pair_table[[last_byte, byte]]
             kerned << -k << [byte]
           else
             kerned.last << byte
@@ -214,30 +175,27 @@ module Prawn
           e.respond_to?(:force_encoding) ? e.force_encoding("Windows-1252") : e  
         }
       end
-
-      def latin_kern_pairs_table
-        return @kern_pairs_table if defined?(@kern_pairs_table)
-        
+      
+      def build_kern_pair_table(kern_pairs)
         character_hash = Hash[Encoding::WinAnsi::CHARACTERS.zip((0..Encoding::WinAnsi::CHARACTERS.size).to_a)]
-        @kern_pairs_table = @kern_pairs.inject({}) do |h,p|
-          h[p[0].map { |n| character_hash[n] }] = p[1]
+        kern_pairs.inject({}) do |h,p|
+          h[
+            [character_hash[p[0]], character_hash[p[1]]]
+          ] = p[2]
           h
         end
       end
 
-      def latin_glyphs_table
-        @glyphs_table ||= (0..255).map do |i|
-          @glyph_widths[Encoding::WinAnsi::CHARACTERS[i]].to_i
+      def build_glyph_table(font_data)
+        (0..255).map do |char|
+          metrics = font_data.metrics_for(char)
+          metrics ? metrics[:wx] : 0
         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