prawn-core 0.7.2 → 0.8.4

data/lib/prawn/document/annotations.rb

@@ -21,9 +21,9 @@ module Prawn
       # +options+ must be a Hash describing the annotation.
       #
       def annotate(options)
-        current_page.data[:Annots] ||= []
+        page.dictionary.data[:Annots] ||= []
         options = sanitize_annotation_hash(options)
-        current_page.data[:Annots] << ref!(options)
+        page.dictionary.data[:Annots] << ref!(options)
         return options
       end
 

data/lib/prawn/document/bounding_box.rb

@@ -15,6 +15,9 @@ module Prawn
     # A bounding box serves two important purposes:
     # * Provide bounds for flowing text, starting at a given point
     # * Translate the origin (0,0) for graphics primitives
+    #
+    # A point and :width must be provided. :height is optional. 
+    # (See stretchyness below)
     # 
     # ==Positioning
     # 
@@ -153,7 +156,7 @@ module Prawn
     #
     def bounding_box(*args, &block)    
       init_bounding_box(block) do |_|
-        translate!(args[0])     
+        map_to_absolute!(args[0])     
         @bounding_box = BoundingBox.new(self, *args)   
       end
     end 
@@ -167,9 +170,9 @@ module Prawn
     #
     def canvas(&block)     
       init_bounding_box(block, :hold_position => true) do |_|
-        @bounding_box = BoundingBox.new(self, [0,page_dimensions[3]], 
-          :width => page_dimensions[2], 
-          :height => page_dimensions[3] 
+        @bounding_box = BoundingBox.new(self, [0,page.dimensions[3]], 
+          :width => page.dimensions[2], 
+          :height => page.dimensions[3] 
         ) 
       end
     end  
@@ -198,10 +201,17 @@ module Prawn
     class BoundingBox
       
       def initialize(parent, point, options={}) #:nodoc:   
+        unless options[:width]
+          raise ArgumentError, "BoundingBox needs the :width option to be set"
+        end
+
         @parent = parent
         @x, @y = point
         @width, @height = options[:width], options[:height]
-      end     
+	      @stretched_height = nil
+      end
+
+      attr_reader :parent
       
       # The translated origin (x,y-height) which describes the location
       # of the bottom left corner of the bounding box
@@ -214,7 +224,7 @@ module Prawn
       # 
       # Example, position some text 3 pts from the left of the containing box:
       # 
-      #  text('hello', :at => [(bounds.left + 3), 0])
+      #  draw_text('hello', :at => [(bounds.left + 3), 0])
       #
       def left
         0
@@ -245,7 +255,7 @@ module Prawn
       # 
       # Example, position some text 3 pts from the right of the containing box:
       # 
-      #  text('hello', :at => [(bounds.right - 3), 0])
+      #  draw_text('hello', :at => [(bounds.right - 3), 0])
       #
       def right
         @width
@@ -255,7 +265,7 @@ module Prawn
       #
       # Example, position some text 3 pts from the top of the containing box:
       # 
-      #  text('hello', :at => [0, (bounds.top - 3)])
+      #  draw_text('hello', :at => [0, (bounds.top - 3)])
       #
       def top
         height
@@ -265,7 +275,7 @@ module Prawn
       #
       # Example, position some text 3 pts from the bottom of the containing box:
       # 
-      #  text('hello', :at => [0, (bounds.bottom + 3)])
+      #  draw_text('hello', :at => [0, (bounds.bottom + 3)])
       #
       def bottom
         0

data/lib/prawn/document/column_box.rb

@@ -9,20 +9,21 @@ require "prawn/document/bounding_box"
 module Prawn
   class Document
 
-     # A column box is a bounding box with the additional property that when
-     # text flows past the bottom, it will wrap first to another column on the
-     # same page, and only flow to the next page when all the columns are
-     # filled.
-     #
-     # column_box accepts the same parameters as bounding_box, as well as the
-     # 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"
+    # A column box is a bounding box with the additional property that when
+    # text flows past the bottom, it will wrap first to another column on the
+    # same page, and only flow to the next page when all the columns are
+    # filled.
+    #
+    # column_box accepts the same parameters as bounding_box, as well as the
+    # 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 |_|
-        translate!(args[0])
+        map_to_absolute!(args[0])
         @bounding_box = ColumnBox.new(self, *args)
       end
     end

data/lib/prawn/document/graphics_state.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+#
+# graphics_state.rb: Implements graphics state saving and restoring
+#
+# Copyright January 2010, Michael Witrant. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+
+module Prawn
+  class Document
+    module GraphicsState
+
+      # Pushes the current graphics state on to the graphics state stack so we
+      # can restore it when finished with a change we want to isolate (such as
+      # modifying the transformation matrix). Used in pairs with
+      # restore_graphics_state or passed a block
+      #
+      # Example without a block:
+      #   
+      #   save_graphics_state
+      #   rotate 30
+      #   text "rotated text"
+      #   restore_graphics_state
+      #
+      # Example with a block:
+      #   
+      #   save_graphics_state do
+      #     rotate 30
+      #     text "rotated text"
+      #   end
+      #
+      def save_graphics_state
+        add_content "q"
+        if block_given?
+          yield
+          restore_graphics_state
+        end
+      end
+
+      # Pops the last saved graphics state off the graphics state stack and
+      # restores the state to those values
+      def restore_graphics_state
+        add_content "Q"
+      end
+
+    end
+  end
+end

data/lib/prawn/document/internals.rb

@@ -37,18 +37,6 @@ module Prawn
         @store.ref(data)
       end
 
-      # Grabs the reference for the current page content
-      #
-      def page_content
-        @active_stamp_stream || @store[@page_content]
-      end
-
-      # Grabs the reference for the current page
-      #
-      def current_page
-        @active_stamp_dictionary || @store[@current_page]
-      end
-      
       # Appends a raw string to the current page content.
       #                               
       #  # Raw line drawing example:           
@@ -58,32 +46,8 @@ module Prawn
       #  pdf.add_content("S") # stroke                    
       #
       def add_content(str)
-        page_content << str << "\n"
+        page.content << str << "\n"
       end  
-
-      # The Resources dictionary for the current page
-      #
-      def page_resources
-        current_page.data[:Resources] ||= {}
-      end
-      
-      # The Font dictionary for the current page
-      #
-      def page_fonts
-        page_resources[:Font] ||= {}
-      end
-       
-      # The XObject dictionary for the current page
-      #
-      def page_xobjects
-        page_resources[:XObject] ||= {}
-      end
-
-      # The ExtGState dictionary for the current page
-      #
-      def page_ext_gstates
-        page_resources[:ExtGState] ||= {}
-      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
@@ -127,15 +91,16 @@ module Prawn
         (1..page_count).each do |i|
           go_to_page i
           repeaters.each { |r| r.run(i) }
-          add_content "Q"
-          page_content.compress_stream if compression_enabled?
-          page_content.data[:Length] = page_content.stream.size
+          restore_graphics_state
+          page.content.compress_stream if compression_enabled?
+          page.content.data[:Length] = page.content.stream.size
         end
       end
 
       # raise the PDF version of the file we're going to generate.
       # A private method, designed for internal use when the user adds a feature
       # to their document that requires a particular version.
+      #
       def min_version(min)
         @version = min if min > @version
       end

data/lib/prawn/document/page_geometry.rb

@@ -131,23 +131,6 @@ module Prawn
              "LETTER" => [612.00, 792.00],
             "TABLOID" => [792.00, 1224.00] }
 
-
-      # Returns the width and height of the current page in PDF points.
-      # Usually, you'll want the dimensions of the bounding_box or 
-      # margin_box instead.
-      #
-      def page_dimensions
-        coords = SIZES[page_size] || page_size
-        [0,0] + case(page_layout)
-        when :portrait
-          coords
-        when :landscape
-          coords.reverse
-        else
-          raise Prawn::Errors::InvalidPageLayout,
-            "Layout must be either :portrait or :landscape"
-        end
-      end
-    end
+   end
   end
 end

data/lib/prawn/document/snapshot.rb

@@ -5,6 +5,7 @@
 # Copyright August 2009, Brad Ediger.  All Rights Reserved.
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
+
 require 'delegate'
 
 module Prawn
@@ -43,9 +44,10 @@ module Prawn
       
       # Takes a current snapshot of the document's state, sufficient to
       # reconstruct it after it was amended.
+      #
       def take_snapshot
-        {:page_content    => Marshal.load(Marshal.dump(page_content)),
-         :current_page    => Marshal.load(Marshal.dump(current_page)),
+        {:page_content    => Marshal.load(Marshal.dump(page.content)),
+         :current_page    => Marshal.load(Marshal.dump(page.dictionary)),
          :page_number     => @page_number,
          :page_kids       => @store.pages.data[:Kids].map{|kid| kid.identifier},
          :dests           => names? && 
@@ -53,17 +55,20 @@ module Prawn
       end
 
       # Rolls the page state back to the state of the given snapshot.
+      #
       def restore_snapshot(shot)
         # Because these objects are referenced by identifier from the Pages
         # dictionary, we can't just restore them over the current refs in
         # page_content and current_page. We have to restore them over the old
         # ones.
-        @page_content = shot[:page_content].identifier
-        page_content.replace shot[:page_content]
+        page.content = shot[:page_content].identifier
+        page.content.replace shot[:page_content]
 
-        @current_page = shot[:current_page].identifier
-        current_page.replace shot[:current_page]
-        current_page.data[:Contents] = page_content
+        page.dictionary = shot[:current_page].identifier
+        page.dictionary.replace shot[:current_page]
+        page.dictionary.data[:Contents] = page.content
+
+        @page_number = shot[:page_number]
 
         @page_number = shot[:page_number]
 

data/lib/prawn/errors.rb

@@ -32,6 +32,11 @@ module Prawn
      #
      CannotFit = Class.new(StandardError)
 
+     # Raised if group() is called with a block that is too big to be
+     # rendered in the current context.
+     #
+     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
@@ -61,5 +66,18 @@ 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)
+    
   end
 end   

data/lib/prawn/font.rb

@@ -5,6 +5,7 @@
 # Copyright May 2008, Gregory Brown / James Healy. All Rights Reserved.
 #
 # 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"
@@ -47,7 +48,7 @@ module Prawn
     def font(name=nil, options={})
       return((defined?(@font) && @font) || font("Helvetica")) if name.nil?
 
-      raise Errors::NotOnPage unless current_page
+      raise Errors::NotOnPage if pages.empty? && !page.in_stamp_stream?
       new_font = find_font(name, options)
 
       if block_given?
@@ -277,6 +278,7 @@ module Prawn
     # 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)
     # version, see normalize_encoding!.
+    #
     def normalize_encoding(string)
       raise NotImplementedError, "subclasses of Prawn::Font must implement #normalize_encoding"
     end
@@ -307,7 +309,7 @@ module Prawn
     #
     def add_to_current_page(subset)
       @references[subset] ||= register(subset)
-      @document.page_fonts.merge!(identifier_for(subset) => @references[subset])
+      @document.page.fonts.merge!(identifier_for(subset) => @references[subset])
     end
 
     def identifier_for(subset) #:nodoc:

data/lib/prawn/font/afm.rb

@@ -1,3 +1,11 @@
+# encoding: utf-8
+
+# prawn/font/afm.rb : Implements AFM font support for Prawn
+#
+# Copyright May 2008, Gregory Brown / James Healy.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
 require 'prawn/encoding'
 
 module Prawn

data/lib/prawn/font/dfont.rb

@@ -1,3 +1,11 @@
+# encoding: utf-8
+#
+# font.rb : The Prawn font class
+#
+# Copyright November 2008, Jamis Buck. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
 require 'prawn/font/ttf'
 
 module Prawn
@@ -11,16 +19,16 @@ module Prawn
       # list is not necessarily the font at index 0 in the file.
       #
       def self.named_fonts(file)
-        TTFunk::ResourceFile.open(file) do |file|
-          return file.resources_for("sfnt")
+        TTFunk::ResourceFile.open(file) do |f|
+          return f.resources_for("sfnt")
         end
       end
 
       # Returns the number of fonts contained in the dfont file.
       #
       def self.font_count(file)
-        TTFunk::ResourceFile.open(file) do |file|
-          return file.map["sfnt"][:list].length
+        TTFunk::ResourceFile.open(file) do |f|
+          return f.map["sfnt"][:list].length
         end
       end
 

data/lib/prawn/font/ttf.rb

@@ -1,3 +1,12 @@
+# encoding: utf-8
+
+# prawn/font/ttf.rb : Implements AFM font support for Prawn
+#
+# 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.
+
 require 'ttfunk'
 require 'ttfunk/subset_collection'