prawn-core 0.7.2 → 0.8.4

data/examples/text/simple_text_ttf.rb

@@ -7,7 +7,7 @@ require "#{File.dirname(__FILE__)}/../example_helper.rb"
 Prawn::Document.generate "simple_text_ttf.pdf" do       
   fill_color "0000ff"
   font "#{Prawn::BASEDIR}/data/fonts/comicsans.ttf" 
-  text "Hello World", :at => [200,720], :size => 32         
+  draw_text "Hello World", :at => [200,720], :size => 32         
 
   font "#{Prawn::BASEDIR}/data/fonts/Chalkboard.ttf"
 

data/lib/prawn/byte_string.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+
 module Prawn
   # This is used to differentiate strings that must be encoded as
   # a byte string, such as binary data from encrypted strings.

data/lib/prawn/core.rb

@@ -4,6 +4,9 @@
 # Copyright April 2008, Gregory Brown. All Rights Reserved.
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
+
+require "set"
+
 %w[ttfunk/lib].each do |dep|
   $LOAD_PATH.unshift(File.dirname(__FILE__) + "/../../vendor/#{dep}")
 end
@@ -18,14 +21,17 @@ rescue LoadError
 end
 
 module Prawn
+  extend self
+
   file = __FILE__
   file = File.readlink(file) if File.symlink?(file)
-  dir = File.dirname(file)
+  dir  = File.dirname(file)
                           
   # The base source directory for Prawn as installed on the system
+  #
   BASEDIR = File.expand_path(File.join(dir, '..', '..'))
   
-  VERSION = "0.7.2"
+  VERSION = "0.8.4"
   
   extend self
 
@@ -40,9 +46,8 @@ module Prawn
   #
   attr_accessor :debug
   
-  def verify_options(accepted,actual) #:nodoc:
+  def verify_options(accepted, actual) #:nodoc:
     return unless debug || $DEBUG
-    require "set"
     unless (act=Set[*actual.keys]).subset?(acc=Set[*accepted])
       raise Prawn::Errors::UnknownOption,
         "\nDetected unknown option(s): #{(act - acc).to_a.inspect}\n" <<
@@ -71,8 +76,9 @@ end
  
 require "prawn/compatibility"
 require "prawn/errors"
+require "prawn/core/page"
+require "prawn/core/object_store"
 require "prawn/pdf_object"
-require "prawn/object_store"
 require "prawn/text"
 require "prawn/graphics"
 require "prawn/images"
@@ -85,3 +91,4 @@ require "prawn/font"
 require "prawn/encoding"
 require "prawn/measurements"
 require "prawn/repeater"
+require "prawn/outline"

data/lib/prawn/core/object_store.rb

@@ -0,0 +1,99 @@
+# encoding: utf-8
+
+# prawn/core/object_store.rb : Implements PDF object repository for Prawn
+#
+# Copyright August 2009, Brad Ediger.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+module Prawn
+  module Core
+    class ObjectStore #:nodoc:
+
+      include Enumerable
+
+      BASE_OBJECTS = %w[info pages root]
+
+      def initialize(info={})
+        @objects = {}
+        @identifiers = []
+        
+        # Create required PDF roots
+        @info    = ref(info).identifier
+        @pages   = ref(:Type => :Pages, :Count => 0, :Kids => []).identifier
+        @root    = ref(:Type => :Catalog, :Pages => pages).identifier
+      end
+   
+      def ref(data, &block)
+        push(size + 1, data, &block)
+      end                                               
+
+      %w[info pages root].each do |name|
+        define_method(name) do
+          @objects[instance_variable_get("@#{name}")]
+        end
+      end
+
+      # Adds the given reference to the store and returns the reference object.
+      # If the object provided is not a Prawn::Reference, one is created from the
+      # arguments provided.
+      #
+      def push(*args, &block)
+        reference = if args.first.is_a?(Prawn::Reference)
+                args.first
+              else
+                Prawn::Reference.new(*args, &block)
+              end
+        @objects[reference.identifier] = reference
+        @identifiers << reference.identifier
+        reference
+      end
+
+      alias_method :<<, :push
+
+      def each
+        @identifiers.each do |id|
+          yield @objects[id]
+        end
+      end
+
+      def [](id)
+        @objects[id]
+      end
+
+      def size
+        @identifiers.size
+      end
+      alias_method :length, :size
+
+      def compact
+        # Clear live markers
+        each { |o| o.live = false }
+
+        # Recursively mark reachable objects live, starting from the roots
+        # (the only objects referenced in the trailer)
+        root.mark_live
+        info.mark_live
+
+        # Renumber live objects to eliminate gaps (shrink the xref table)
+        if @objects.any?{ |_, o| !o.live }
+          new_id = 1
+          new_objects = {}
+          new_identifiers = []
+
+          each do |obj|
+            if obj.live
+              obj.identifier = new_id
+              new_objects[new_id] = obj
+              new_identifiers << new_id
+              new_id += 1
+            end
+          end
+
+          @objects = new_objects
+          @identifiers = new_identifiers
+        end
+      end
+    end
+  end
+end

data/lib/prawn/core/page.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+
+# prawn/core/page.rb : Implements low-level representation of a PDF page
+#
+# Copyright February 2010, Gregory Brown.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+module Prawn
+  module Core
+    class Page #:nodoc:
+      def initialize(document, options={})
+        @document = document
+        @size     = options[:size]    ||  "LETTER" 
+
+        @layout   = options[:layout]  || :portrait 
+
+        @margins  = options[:margins] || { :left    => 36,
+                                           :right   => 36,
+                                           :top     => 36,
+                                           :bottom  => 36  }
+
+        @content    = document.ref(:Length      => 0)
+        @dictionary = document.ref(:Type        => :Page,
+                                   :Parent      => document.store.pages,
+                                   :MediaBox    => dimensions,
+                                   :Contents    => content)
+
+        resources[:ProcSet] = [:PDF, :Text, :ImageB, :ImageC, :ImageI]
+
+        @stamp_stream      = nil
+        @stamp_dictionary  = nil
+      end
+
+      attr_accessor :size, :layout, :margins, :document, :content, :dictionary
+
+      def in_stamp_stream?
+        !!@stamp_stream
+      end
+
+      def stamp_stream(dictionary)
+        @stamp_stream     = ""
+        @stamp_dictionary = dictionary
+
+        document.send(:update_colors)
+        yield if block_given?
+        document.send(:update_colors)
+
+        @stamp_dictionary.data[:Length] = @stamp_stream.length + 1
+        @stamp_dictionary << @stamp_stream
+
+        @stamp_stream      = nil
+        @stamp_dictionary  = nil
+      end
+
+      def dimensions
+        coords = Prawn::Document::PageGeometry::SIZES[size] || size
+        [0,0] + case(layout)
+        when :portrait
+          coords
+        when :landscape
+          coords.reverse
+        else
+          raise Prawn::Errors::InvalidPageLayout,
+            "Layout must be either :portrait or :landscape"
+        end
+      end
+
+      def content
+        @stamp_stream || document.store[@content]
+      end
+
+      def dictionary
+        @stamp_dictionary || document.store[@dictionary]
+      end
+
+      def resources
+        dictionary.data[:Resources] ||= {}
+      end
+
+      def fonts
+        resources[:Font] ||= {}
+      end
+
+      def xobjects
+        resources[:XObject] ||= {}
+      end
+
+      def ext_gstates
+        resources[:ExtGState] ||= {}
+      end
+
+    end
+  end
+end
+

data/lib/prawn/core/text.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+
+# prawn/core/text.rb : Implements low level text helpers for Prawn
+#
+# Copyright January 2010, Daniel Nelson.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+ruby_18 { $KCODE="U" }
+
+module Prawn
+  module Core
+    module Text #:nodoc:
+
+      # These should be used as a base. Extensions may build on this list
+      #
+      VALID_OPTIONS = [:kerning, :size, :style]
+
+      attr_reader :text_options
+      attr_reader :skip_encoding
+
+      # Low level text placement method. All font and size alterations
+      # should already be set
+      #
+      def draw_text!(text, options)
+        x,y = map_to_absolute(options[:at])
+        add_text_content(text,x,y,options)
+      end
+
+      # Low level call to set the current font style and extract text options from
+      # an options hash. Should be called from within a save_font block
+      #
+      def process_text_options(options)
+        if options[:style]
+          raise "Bad font family" unless font.family
+          font(font.family, :style => options[:style])
+        end
+
+        # must compare against false to keep kerning on as default
+        unless options[:kerning] == false
+          options[:kerning] = font.has_kerning_data?
+        end
+
+        options[:size] ||= font_size
+      end
+
+      private
+
+      def add_text_content(text, x, y, options)
+        chunks = font.encode_text(text,options)
+
+        add_content "\nBT"
+
+        if options[:rotate]
+          rad = options[:rotate].to_i * Math::PI / 180
+          arr = [ Math.cos(rad), Math.sin(rad), -Math.sin(rad), Math.cos(rad), x, y ]
+          add_content "%.3f %.3f %.3f %.3f %.3f %.3f Tm" % arr
+        else
+          add_content "#{x} #{y} Td"
+        end
+
+        chunks.each do |(subset, string)|
+          font.add_to_current_page(subset)
+          add_content "/#{font.identifier_for(subset)} #{font_size} Tf"
+
+          operation = options[:kerning] && string.is_a?(Array) ? "TJ" : "Tj"
+          add_content Prawn::PdfObject(string, true) << " " << operation
+        end
+
+        add_content "ET\n"
+      end
+    end
+
+  end
+end

data/lib/prawn/document.rb

@@ -15,6 +15,7 @@ require "prawn/document/span"
 require "prawn/document/annotations"
 require "prawn/document/destinations"
 require "prawn/document/snapshot"
+require "prawn/document/graphics_state"
 
 module Prawn
   
@@ -53,20 +54,21 @@ module Prawn
   #
   class Document
 
-    include Text
-    include PageGeometry
     include Internals
     include Annotations
     include Destinations
     include Snapshot
+    include GraphicsState
     include Prawn::Text
     include Prawn::Graphics
     include Prawn::Images
     include Prawn::Stamp
+    
 
-    attr_accessor :margin_box
-    attr_reader   :margins, :page_size, :page_layout, :y
+    attr_accessor :margin_box, :page
+    attr_reader   :margins, :y, :store, :pages
     attr_writer   :font_size
+    attr_accessor :default_line_wrap
 
 
     # Any module added to this array will be included into instances of
@@ -109,7 +111,7 @@ module Prawn
     #     # self here is set to the newly instantiated Prawn::Document
     #     # and so any variables in the outside scope are unavailable
     #     font "Times-Roman"
-    #     text "Hello World", :at => [200,720], :size => 32
+    #     draw_text "Hello World", :at => [200,720], :size => 32
     #   end
     #
     # If you need to access your local and instance variables, use the explicit
@@ -121,7 +123,7 @@ module Prawn
     #   Prawn::Document.generate "example.pdf" do |pdf|
     #     # self here is left alone
     #     pdf.font "Times-Roman"
-    #     pdf.text content, :at => [200,720], :size => 32
+    #     pdf.draw_text content, :at => [200,720], :size => 32
     #   end
     #
     def self.generate(filename,options={},&block)
@@ -181,6 +183,10 @@ module Prawn
          :compress, :skip_encoding, :text_options, :background, :info,
          :optimize_objects], options
 
+
+       # need to fix, as the refactoring breaks this
+       # raise NotImplementedError if options[:skip_page_creation]
+
        self.class.extensions.reverse_each { |e| extend e }
       
        options[:info] ||= {}
@@ -194,39 +200,40 @@ module Prawn
        end
           
        @version = 1.3
-       @store = ObjectStore.new(options[:info])
+       @store = Prawn::Core::ObjectStore.new(options[:info])
        @trailer = {}
+
        @before_render_callbacks = []
        @on_page_create_callback = nil
 
-       @page_size     = options[:page_size]   || "LETTER"
-       @page_layout   = options[:page_layout] || :portrait
-       @compress      = options[:compress] || false
+       @compress         = options[:compress] || false
        @optimize_objects = options.fetch(:optimize_objects, false)
-       @skip_encoding = options[:skip_encoding]
-       @background    = options[:background]
-       @font_size     = 12
-       @page_content  = nil
+       @skip_encoding    = options[:skip_encoding]
+       @background       = options[:background]
+       @font_size        = 12
+
+       @pages            = []
+       @page             = nil
+
        @bounding_box  = nil
        @margin_box    = nil
 
        @text_options = options[:text_options] || {}
-       
-       apply_margin_option(options) if options[:margin]
-
-       default_margin = 36  # 0.5 inch
-       @margins = { :left   => options[:left_margin]   || default_margin,
-                    :right  => options[:right_margin]  || default_margin,
-                    :top    => options[:top_margin]    || default_margin,
-                    :bottom => options[:bottom_margin] || default_margin  }
-
-       generate_margin_box
+       @default_line_wrap = Prawn::Text::LineWrap.new
 
-       @bounding_box = @margin_box
        @page_number = 0
 
-       start_new_page unless options[:skip_page_creation]
+       options[:size] = options.delete(:page_size)
+       options[:layout] = options.delete(:page_layout)
 
+       if options[:skip_page_creation]
+         start_new_page(options.merge(:orphan => true))
+       else
+         start_new_page(options)
+       end
+       
+       @bounding_box = @margin_box
+       
        if block
          block.arity < 1 ? instance_eval(&block) : block[self]
        end
@@ -243,32 +250,45 @@ module Prawn
      #   pdf.start_new_page(:margin => 100)
      #
      def start_new_page(options = {})
-       
-       @page_size   = options[:size] if options[:size]
-       @page_layout = options[:layout] if options[:layout]
+       if last_page = page
+         last_page_size    = last_page.size
+         last_page_layout  = last_page.layout
+         last_page_margins = last_page.margins
+       end
+
+       self.page = Prawn::Core::Page.new(self, 
+         :size    => options[:size]   || last_page_size, 
+         :layout  => options[:layout] || last_page_layout,
+         :margins => last_page_margins )
+  
        
        apply_margin_option(options) if options[:margin]
 
        [:left,:right,:top,:bottom].each do |side|
          if margin = options[:"#{side}_margin"]
-           @margins[side] = margin
+           page.margins[side] = margin
          end
        end
 
-       build_new_page_content
-       
-       @store.pages.data[:Kids].insert(@page_number, current_page)
-       @store.pages.data[:Count] += 1
-       @page_number += 1
+       generate_margin_box
+
+       update_colors
+       undash if dashed?
+      
+       unless options[:orphan]
+         pages.insert(@page_number, page)
+         @store.pages.data[:Kids].insert(@page_number, page.dictionary)
+         @store.pages.data[:Count] += 1
+         @page_number += 1
+
+         save_graphics_state
         
-       add_content "q"
-       
-       @y = @bounding_box.absolute_top
+         canvas { image(@background, :at => bounds.top_left) } if @background 
+         @y = @bounding_box.absolute_top
 
-       image(@background, :at => [0,@y]) if @background
-       
-       float do
-         @on_page_create_callback.call(self) if @on_page_create_callback 
+         float do
+           @on_page_create_callback.call(self) if @on_page_create_callback 
+         end
        end
     end
 
@@ -280,7 +300,7 @@ module Prawn
     #   pdf.page_count #=> 4
     #
     def page_count
-      @store.pages.data[:Count]
+      pages.length
     end
 
     # Returns the 1-based page number of the current page. Returns 0 if the
@@ -289,7 +309,7 @@ module Prawn
     def page_number
       @page_number
     end
-
+    
     # Re-opens the page with the given (1-based) page number so that you can
     # draw on it. Does not restore page state such as margins, page orientation,
     # or paper size, so you'll have to handle that yourself.
@@ -298,9 +318,7 @@ module Prawn
     #
     def go_to_page(k)
       @page_number = k
-      jump_to = @store.pages.data[:Kids][k-1]
-      @current_page = jump_to.identifier
-      @page_content = jump_to.data[:Contents].identifier
+      self.page = pages[k-1]
     end
 
     def y=(new_y)
@@ -481,11 +499,6 @@ module Prawn
       fields.each { |f| send("#{f}=", stored[f]) }
     end
 
-    # Raised if group() is called with a block that is too big to be
-    # rendered in the current context.
-    #
-    CannotGroup = Class.new(StandardError) #FIXME: should be in prawn/errors.rb
-
     # Attempts to group the given block vertically within the current context.
     # First attempts to render it in the current position on the current page.
     # If that attempt overflows, it is tried anew after starting a new context
@@ -505,7 +518,7 @@ module Prawn
       success = transaction { yield }
 
       unless success
-        raise CannotGroup if second_attempt
+        raise Prawn::Errors::CannotGroup if second_attempt
         old_bounding_box.move_past_bottom
         group(second_attempt=true) { yield }
       end 
@@ -533,7 +546,7 @@ module Prawn
       page_count.times do |i|
         go_to_page(i+1)
         str = string.gsub("<page>","#{i+1}").gsub("<total>","#{page_count}")
-        text str, :at => position
+        draw_text str, :at => position
       end
     end
 
@@ -543,35 +556,16 @@ module Prawn
     def compression_enabled?
       !!@compress
     end
-
+    
     private
 
-    # See Prawn::Document::Internals for low-level PDF functions
-    #
-    def build_new_page_content
-      generate_margin_box
-      @page_content = ref(:Length => 0)
-
-      @current_page = ref(:Type      => :Page,
-                          :Parent    => @store.pages,
-                          :MediaBox  => page_dimensions,
-                          :Contents  => page_content)
-
-      # include all proc sets, all the time (recommended by PDF 1.4 Reference 
-      # section 9.1)
-      page_resources[:ProcSet] = [:PDF, :Text, :ImageB, :ImageC, :ImageI]
-
-      update_colors
-      undash if dashed?
-    end
-
     def generate_margin_box
       old_margin_box = @margin_box
       @margin_box = BoundingBox.new(
         self,
-        [ @margins[:left], page_dimensions[-1] - @margins[:top] ] ,
-        :width => page_dimensions[-2] - (@margins[:left] + @margins[:right]),
-        :height => page_dimensions[-1] - (@margins[:top] + @margins[:bottom])
+        [ page.margins[:left], page.dimensions[-1] - page.margins[:top] ] ,
+        :width => page.dimensions[-2] - (page.margins[:left] + page.margins[:right]),
+        :height => page.dimensions[-1] - (page.margins[:top] + page.margins[:bottom])
       )
 
       # we must update bounding box if not flowing from the previous page
@@ -591,6 +585,5 @@ module Prawn
         options[:"#{p}_margin"] ||= margin[i]
       end
     end
-
   end
 end