prawn 0.12.0 → 0.13.0

data/lib/prawn/document.rb

@@ -7,7 +7,6 @@
 # This is free software. Please see the LICENSE and COPYING files for details.
 
 require "stringio"
-require "prawn/document/page_geometry"
 require "prawn/document/bounding_box"
 require "prawn/document/column_box"
 require "prawn/document/internals"
@@ -52,8 +51,8 @@ module Prawn
   #
   class Document
     include Prawn::Document::Internals
-    include Prawn::Core::Annotations
-    include Prawn::Core::Destinations
+    include PDF::Core::Annotations
+    include PDF::Core::Destinations
     include Prawn::Document::Snapshot
     include Prawn::Document::GraphicsState
     include Prawn::Document::Security
@@ -61,6 +60,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,8 +136,10 @@ 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]
+    # <tt>:text_formatter</tt>: The text formatter to use for <tt>:inline_format</tt>ted text [Prawn::Text::Formatted::Parser]
     #
     # Setting e.g. the :margin to 100 points and the :left_margin to 50 will result in margins
     # of 100 points on every side except for the left, where it will be 50.
@@ -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
@@ -174,17 +176,18 @@ module Prawn
       Prawn.verify_options [:page_size, :page_layout, :margin, :left_margin,
         :right_margin, :top_margin, :bottom_margin, :skip_page_creation,
         :compress, :skip_encoding, :background, :info,
-        :optimize_objects, :template], options
+        :optimize_objects, :template, :text_formatter], options
 
       # need to fix, as the refactoring breaks this
       # raise NotImplementedError if options[:skip_page_creation]
 
       self.class.extensions.reverse_each { |e| extend e }
-      @internal_state = Prawn::Core::DocumentState.new(options)
+      @internal_state = PDF::Core::DocumentState.new(options)
       @internal_state.populate_pages_from_store(self)
       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
@@ -192,6 +195,8 @@ module Prawn
 
       @page_number = 0
 
+      @text_formatter = options.delete(:text_formatter) || Text::Formatted::Parser
+
       options[:size] = options.delete(:page_size)
       options[:layout] = options.delete(:page_layout)
 
@@ -217,6 +222,7 @@ module Prawn
     attr_reader   :margins, :y
     attr_writer   :font_size
     attr_accessor :page_number
+    attr_accessor :text_formatter
 
     def state
       @internal_state
@@ -241,6 +247,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
@@ -252,14 +261,14 @@ module Prawn
                       :layout  => options[:layout] || last_page_layout,
                       :margins => last_page_margins}
       if last_page
-        new_graphic_state = last_page.graphic_state.dup
+        new_graphic_state = last_page.graphic_state.dup  if last_page.graphic_state
         #erase the color space so that it gets reset on new page for fussy pdf-readers
-        new_graphic_state.color_space = {}
+        new_graphic_state.color_space = {} if new_graphic_state
         page_options.merge!(:graphic_state => new_graphic_state)
       end
       merge_template_options(page_options, options) if options[:template]
 
-      state.page = Prawn::Core::Page.new(self, page_options)
+      state.page = PDF::Core::Page.new(self, page_options)
 
       apply_margin_options(options)
       generate_margin_box
@@ -272,12 +281,13 @@ module Prawn
 
       state.page.new_content_stream if options[:template]
       use_graphic_settings(options[:template])
+      forget_text_rendering_mode! if options[:template]
 
       unless options[:orphan]
         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
@@ -348,19 +358,23 @@ module Prawn
       self.y = original_y
     end
 
-    # Renders the PDF document to string
+    # Renders the PDF document to string.
+    # Pass an open file descriptor to render to file.
     #
-    def render
-      output = StringIO.new
+    def render(output = StringIO.new)
       finalize_all_page_contents
 
       render_header(output)
       render_body(output)
       render_xref(output)
       render_trailer(output)
-      str = output.string
-      str.force_encoding("ASCII-8BIT") if str.respond_to?(:force_encoding)
-      str
+      if output.instance_of?(StringIO)
+        str = output.string
+        str.force_encoding("ASCII-8BIT") if str.respond_to?(:force_encoding)
+        return str
+      else
+        return nil
+      end
     end
 
     # Renders the PDF document to file.
@@ -369,7 +383,7 @@ module Prawn
     #
     def render_file(filename)
       Kernel.const_defined?("Encoding") ? mode = "wb:ASCII-8BIT" : mode = "wb"
-      File.open(filename,mode) { |f| f << render }
+      File.open(filename,mode) { |f| render(f) }
     end
 
     # The bounds method returns the current bounding box you are currently in,
@@ -539,15 +553,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 +572,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 +591,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 +603,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 +612,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 +626,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 +640,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 +654,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
@@ -697,5 +711,9 @@ module Prawn
          end
       end
     end
+
+    def font_metric_cache #:nodoc:
+      @font_metric_cache ||= FontMetricCache.new( self )
+    end
   end
 end

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

@@ -17,9 +17,9 @@ module Prawn
     # number of :columns and a :spacer (in points) between columns.
     #
     # Defaults are :columns = 3 and :spacer = font_size
-    # 
+    #
     # Under PDF::Writer, "spacer" was known as "gutter"
-    # 
+    #
     def column_box(*args, &block)
       init_column_box(block) do |parent_box|
         map_to_absolute!(args[0])
@@ -40,7 +40,7 @@ module Prawn
 
       @bounding_box = parent_box
     end
-    
+
     # Implements the necessary functionality to allow Document#column_box to
     # work.
     #
@@ -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
+        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,9 +91,15 @@ 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 
+      def move_past_bottom
         @current_column = (@current_column + 1) % @columns
         @document.y = @y
         if 0 == @current_column
@@ -89,6 +107,26 @@ module Prawn
         end
       end
 
+      # Override the padding functions so as not to split the padding amount
+      # between all columns on the page.
+
+      def add_left_padding(left_padding)
+        @total_left_padding += left_padding
+        @x += left_padding
+      end
+
+      def subtract_left_padding(left_padding)
+        @total_left_padding -= left_padding
+        @x -= left_padding
+      end
+
+      def add_right_padding(right_padding)
+        @total_right_padding += right_padding
+      end
+
+      def subtract_right_padding(right_padding)
+        @total_right_padding -= right_padding
+      end
     end
   end
 end

data/lib/prawn/document/graphics_state.rb

@@ -8,69 +8,6 @@
 #
 
 module Prawn
-  class GraphicStateStack
-    attr_accessor :stack
-    
-    def initialize(previous_state = nil)
-      self.stack = [GraphicState.new(previous_state)]
-    end
-    
-    def save_graphic_state(graphic_state = nil)
-      stack.push(GraphicState.new(graphic_state || current_state))
-    end
-    
-    def restore_graphic_state
-      if stack.empty?
-        raise Prawn::Errors::EmptyGraphicStateStack, 
-          "\n You have reached the end of the graphic state stack" 
-      end
-      stack.pop
-    end
-    
-    def current_state
-      stack.last
-    end
-    
-    def present?
-      stack.size > 0
-    end
-
-    def empty?
-      stack.empty?
-    end
-      
-  end
-  
-  class GraphicState
-    attr_accessor :color_space, :dash, :cap_style, :join_style, :line_width, :fill_color, :stroke_color
-    
-    def initialize(previous_state = nil)
-      @color_space = previous_state ? previous_state.color_space.dup : {}
-      @fill_color = previous_state ? previous_state.fill_color : "000000"
-      @stroke_color = previous_state ? previous_state.stroke_color : "000000"
-      @dash = previous_state ? previous_state.dash : { :dash => nil, :space => nil, :phase => 0 }
-      @cap_style = previous_state ? previous_state.cap_style : :butt
-      @join_style = previous_state ? previous_state.join_style : :miter
-      @line_width = previous_state ? previous_state.line_width : 1
-    end
-    
-    def dash_setting
-      "[#{@dash[:dash]} #{@dash[:space]}] #{@dash[:phase]} d"
-    end
-  end
-  
-  module Core
-    class Page
-      module GraphicsState
-      
-        def graphic_state
-          stack.current_state
-        end
-    
-      end
-    end
-  end
-  
   class Document
     module GraphicsState
 
@@ -93,15 +30,15 @@ module Prawn
       #     text "rotated text"
       #   end
       #
-      
+
       def open_graphics_state
         add_content "q"
       end
-      
+
       def close_graphics_state
         add_content "Q"
       end
-        
+
       def save_graphics_state(graphic_state = nil)
         graphic_stack.save_graphic_state(graphic_state)
         open_graphics_state
@@ -115,22 +52,22 @@ module Prawn
       # restores the state to those values
       def restore_graphics_state
         if graphic_stack.empty?
-          raise Prawn::Errors::EmptyGraphicStateStack, 
-            "\n You have reached the end of the graphic state stack" 
+          raise PDF::Core::Errors::EmptyGraphicStateStack,
+            "\n You have reached the end of the graphic state stack"
         end
-        close_graphics_state 
+        close_graphics_state
         graphic_stack.restore_graphic_state
       end
-      
+
       def graphic_stack
         state.page.stack
       end
-      
+
       def graphic_state
         save_graphics_state unless graphic_stack.current_state
-        graphic_stack.current_state 
+        graphic_stack.current_state
       end
-      
+
     end
   end
 end