prawn 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4853225e17270cdd3f00813349b44209903ab6b2
-  data.tar.gz: 9ef5c9cf24f812537776b41b3503a87aa9fe52b6
+  metadata.gz: 287dd21a281ca025939e562e2d9d0dae14373d21
+  data.tar.gz: 0c08643d45840aad66a59661f7593bc3abb89302
 SHA512:
-  metadata.gz: cef52ab9b8e81515a1314f63bbb6ee27d8ed2fd8d0832def46e4a49b40296eedc633c5f05b3689ea5fae33905e42747ac2ac5a6e00d434528caa9e7f171a113f
-  data.tar.gz: 6dca2892f00d9c7b11d2124e09b17d11d82f5f50e0f0fbe76befba7cc263a02fc33946736f70c90c3ba456bba1151aa48c2df5fc42c1f066550323dda600fb14
+  metadata.gz: 013f40d6fa76d1cf34ed85578e8ce5700c3ba47bbf6b373b9856ae2a34fe42421d83da002604f1acb5bdfd7fdcf0acc85a1f58d9397c89d46254c2e01da5764a
+  data.tar.gz: b478644390db0dcd837063a79c126cf0d8d70a53746755dae3797bda11553b8520dd33d3ca983301a7627a76b74d824337d3497abba5966683eedd81efb5a2d5

data/Rakefile

@@ -16,10 +16,9 @@ end
 
 desc "Show library's code statistics"
 task :stats do
-  require 'code_statistics'
-  CodeStatistics::TEST_TYPES << "Specs"
-  CodeStatistics.new( ["Prawn", "lib"],
-                      ["Specs", "spec"] ).to_s
+  require 'code_statistics/code_statistics'
+  puts CodeStatistics::CodeStatistics.new( [["Prawn", "lib"],
+                      ["Specs", "spec"]] ).to_s
 end
 
 YARD::Rake::YardocTask.new do |t|

data/lib/prawn.rb

@@ -21,8 +21,6 @@ module Prawn
   BASEDIR = File.expand_path(File.join(dir, '..'))
   DATADIR = File.expand_path(File.join(dir, '..', 'data'))
 
-  VERSION = File.read("#{BASEDIR}/VERSION").strip
-
   FLOAT_PRECISION = 1.0e-9
 
   # Whe set to true, Prawn will verify hash options to ensure only valid keys
@@ -64,8 +62,9 @@ module Prawn
   end
 end
 
-require_relative "prawn/errors"
+require_relative "prawn/version"
 
+require_relative "prawn/errors"
 
 require_relative "prawn/utilities"
 require_relative "prawn/text"
@@ -84,10 +83,8 @@ require_relative "prawn/measurements"
 require_relative "prawn/repeater"
 require_relative "prawn/outline"
 require_relative "prawn/grid"
-
+require_relative "prawn/view"
 require_relative "prawn/image_handler"
 
-
-
 Prawn.image_handler.register(Prawn::Images::PNG)
 Prawn.image_handler.register(Prawn::Images::JPG)

data/lib/prawn/document.rb

@@ -12,7 +12,6 @@ require_relative "document/bounding_box"
 require_relative "document/column_box"
 require_relative "document/internals"
 require_relative "document/span"
-require_relative "document/graphics_state"
 
 module Prawn
 
@@ -53,7 +52,6 @@ module Prawn
     include Prawn::Document::Internals
     include PDF::Core::Annotations
     include PDF::Core::Destinations
-    include Prawn::Document::GraphicsState
     include Prawn::Document::Security
     include Prawn::Text
     include Prawn::Graphics
@@ -202,9 +200,9 @@ module Prawn
       self.class.extensions.reverse_each { |e| extend e }
       @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
+      renderer.min_version(state.store.min_version) if state.store.min_version
 
-      min_version(1.6) if options[:print_scaling] == :none
+      renderer.min_version(1.6) if options[:print_scaling] == :none
 
       @background = options[:background]
       @background_scale = options[:background_scale] || 1
@@ -349,23 +347,13 @@ module Prawn
     # Renders the PDF document to string.
     # Pass an open file descriptor to render to file.
     #
-    def render(output = StringIO.new)
-      if output.instance_of?(StringIO)
-        output.set_encoding(::Encoding::ASCII_8BIT)
-      end
-      finalize_all_page_contents
-
-      render_header(output)
-      render_body(output)
-      render_xref(output)
-      render_trailer(output)
-      if output.instance_of?(StringIO)
-        str = output.string
-        str.force_encoding(::Encoding::ASCII_8BIT)
-        return str
-      else
-        return nil
+    def render(*a, &b)
+      (1..page_count).each do |i|
+        go_to_page i
+        repeaters.each { |r| r.run(i) }
       end
+
+      renderer.render(*a, &b)
     end
 
     # Renders the PDF document to file.
@@ -567,13 +555,6 @@ module Prawn
       end
     end
 
-    # Returns true if content streams will be compressed before rendering,
-    # false otherwise
-    #
-    def compression_enabled?
-      !!state.compress
-    end
-
     # @group Experimental API
 
     # Attempts to group the given block vertically within the current context.

data/lib/prawn/document/internals.rb

@@ -6,6 +6,8 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
+require "forwardable"
+
 module Prawn
   class Document
 
@@ -16,159 +18,40 @@ module Prawn
     #
     # @private
     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.
-      #
-      # Returns the identifier which points to the reference in the ObjectStore
-      #
-      def ref(data)
-        ref!(data).identifier
-      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
-      # if needed.  If you take this approach, Prawn::Document::Snapshot
-      # will probably work with your extension
-      #
-      def ref!(data)
-        state.store.ref(data)
-      end
-
-      # At any stage in the object tree an object can be replaced with an
-      # indirect reference. To get access to the object safely, regardless
-      # of if it's hidden behind a Prawn::Reference, wrap it in deref().
-      #
-      def deref(obj)
-        obj.is_a?(PDF::Core::Reference) ? obj.data : obj
-      end
-
-      # Appends a raw string to the current page content.
-      #
-      #  # 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 l" % [ x2, y2 ])  # draw path
-      #  pdf.add_content("S") # stroke
-      #
-      def add_content(str)
-        save_graphics_state if graphic_state.nil?
-        state.page.content << str << "\n"
-      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
-      # dictionary do not incur the additional overhead.
-      #
-      def names
-        state.store.root.data[:Names] ||= ref!(:Type => :Names)
-      end
-
-      # Returns true if the Names dictionary is in use for this document.
-      #
-      def names?
-        state.store.root.data[:Names]
-      end
-
-      # Defines a block to be called just before the document is rendered.
-      #
-      def before_render(&block)
-        state.before_render_callbacks << block
-      end
-
-      # Defines a block to be called just before a new page is started.
-      #
-      def on_page_create(&block)
-         if block_given?
-            state.on_page_create_callback = block
-         else
-            state.on_page_create_callback = nil
-         end
-      end
-
-      private
-
-      # adds a new, empty content stream to each page. Used in templating so
-      # that imported content streams can be left pristine
-      #
-      def fresh_content_streams(options={})
-        (1..page_count).each do |i|
-          go_to_page i
-          state.page.new_content_stream
-          apply_margin_options(options)
-          generate_margin_box
-          use_graphic_settings(options[:template])
-          forget_text_rendering_mode!
-        end
-      end
-
-      def finalize_all_page_contents
-        (1..page_count).each do |i|
-          go_to_page i
-          repeaters.each { |r| r.run(i) }
-          while graphic_stack.present?
-            restore_graphics_state
-          end
-          state.page.finalize
-        end
-      end
+      extend Forwardable
 
-      # 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)
-        state.version = min if min > state.version
-      end
+      # These methods are not officially part of Prawn's public API,
+      # but they are used in documentation and possibly in extensions.
+      # Perhaps they will become part of the extension API?
+      # Anyway, for now it's not clear what we should do w. them.
+      delegate [ :graphic_state,
+                 :save_graphics_state,
+                 :restore_graphics_state ] => :renderer
 
-      # Write out the PDF Header, as per spec 3.4.1
+      # FIXME: This is a circular reference, because in theory Prawn should
+      # be passing instances of renderer to PDF::Core::Page, but it's
+      # passing Prawn::Document objects instead.
       #
-      def render_header(output)
-        state.before_render_actions(self)
+      # A proper design would probably not require Prawn to directly instantiate
+      # PDF::Core::Page objects at all!
+      delegate [:compression_enabled?] => :renderer
 
-        # pdf version
-        output << "%PDF-#{state.version}\n"
+      # FIXME: More circular references in PDF::Core::Page.
+      delegate [ :ref, :ref!, :deref ] => :renderer
 
-        # 4 binary chars, as recommended by the spec
-        output << "%\xFF\xFF\xFF\xFF\n"
-      end
+      # FIXME: Another circular reference, because we mix in a module from
+      # PDF::Core to provide destinations, which in theory should not
+      # rely on a Prawn::Document object but is currently wired up that way.
+      delegate [:names] => :renderer
 
-      # Write out the PDF Body, as per spec 3.4.2
-      #
-      def render_body(output)
-        state.render_body(output)
-      end
+      # FIXME: Circular reference because we mix PDF::Core::Text into
+      # Prawn::Document. PDF::Core::Text should either be split up or
+      # moved in its entirety back up into Prawn.
+      delegate [:add_content] => :renderer
 
-      # Write out the PDF Cross Reference Table, as per spec 3.4.3
-      #
-      def render_xref(output)
-        @xref_offset = output.size
-        output << "xref\n"
-        output << "0 #{state.store.size + 1}\n"
-        output << "0000000000 65535 f \n"
-        state.store.each do |ref|
-          output.printf("%010d", ref.offset)
-          output << " 00000 n \n"
-        end
+      def renderer
+        @renderer ||= PDF::Core::Renderer.new(state)
       end
-
-      # Write out the PDF Trailer, as per spec 3.4.4
-      #
-      def render_trailer(output)
-        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 << PDF::Core::PdfObject(trailer_hash) << "\n"
-        output << "startxref\n"
-        output << @xref_offset << "\n"
-        output << "%%EOF" << "\n"
-      end
-
     end
   end
 end

data/lib/prawn/font.rb

@@ -398,31 +398,10 @@ module Prawn
 
     private
 
-    # generate a font identifier that hasn't been used on the curretn page yet
+    # generate a font identifier that hasn't been used on the current page yet
     #
     def generate_unique_id
-      offset, id = 0, nil
-
-      while id.nil? || page_contains_font_id?(id)
-        offset += 1
-        id = :"F#{@document.font_registry.size + offset}"
-      end
-
-      id
-    end
-
-    # Returns true if the provided font identifier already exists in the document.
-    # This is used when adding new fonts to a document to ensure we don't step
-    # on fonts imported from a template.
-    #
-    #   page_contains_font_id?("F1")
-    #   => true
-    #
-    def page_contains_font_id?(id)
-      id = id.to_s
-      @document.state.page.fonts.keys.any? { |exist_id|
-        exist_id.to_s[0,id.size] == id
-      }
+      :"F#{@document.font_registry.size + 1}"
     end
 
     def size

data/lib/prawn/font/ttf.rb

@@ -245,7 +245,7 @@ module Prawn
 
         # Embed the font metrics in the document after everything has been
         # drawn, just before the document is emitted.
-        @document.before_render { |doc| embed(ref, subset) }
+        @document.renderer.before_render { |doc| embed(ref, subset) }
 
         ref
       end

data/lib/prawn/graphics.rb

@@ -47,7 +47,7 @@ module Prawn
     #
     def move_to(*point)
       x,y = map_to_absolute(point)
-      add_content("%.3f %.3f m" % [ x, y ])
+      renderer.add_content("%.3f %.3f m" % [ x, y ])
     end
 
     # Draws a line from the current drawing position to the specified point.
@@ -58,7 +58,7 @@ module Prawn
     #
     def line_to(*point)
       x,y = map_to_absolute(point)
-      add_content("%.3f %.3f l" % [ x, y ])
+      renderer.add_content("%.3f %.3f l" % [ x, y ])
     end
 
     # Draws a Bezier curve from the current drawing position to the
@@ -72,7 +72,7 @@ module Prawn
          "as :bounds => [[x1,y1],[x2,y2]]"
 
        curve_points = (options[:bounds] << dest).map { |e| map_to_absolute(e) }
-       add_content("%.3f %.3f %.3f %.3f %.3f %.3f c" %
+       renderer.add_content("%.3f %.3f %.3f %.3f %.3f %.3f c" %
                      curve_points.flatten )
     end
 
@@ -83,7 +83,7 @@ module Prawn
     #
     def rectangle(point,width,height)
       x,y = map_to_absolute(point)
-      add_content("%.3f %.3f %.3f %.3f re" % [ x, y - height, width, height ])
+      renderer.add_content("%.3f %.3f %.3f %.3f re" % [ x, y - height, width, height ])
     end
 
     # Draws a rounded rectangle given <tt>point</tt>, <tt>width</tt> and
@@ -239,7 +239,7 @@ module Prawn
         line_to(*point)
       end
       # close the path
-      add_content "h"
+      renderer.add_content "h"
     end
 
     # Draws a rounded polygon from specified points using the radius to define bezier curves
@@ -255,7 +255,7 @@ module Prawn
         rounded_vertex(radius, points[i], points[i + 1], points[i + 2])
       end
       # close the path
-      add_content "h"
+      renderer.add_content "h"
     end
 
 
@@ -276,7 +276,7 @@ module Prawn
     #
     def stroke
       yield if block_given?
-      add_content "S"
+      renderer.add_content "S"
     end
 
     # Closes and strokes the current path. If a block is provided, yields to
@@ -284,7 +284,7 @@ module Prawn
     #
     def close_and_stroke
       yield if block_given?
-      add_content "s"
+      renderer.add_content "s"
     end
 
     # Draws and strokes a rectangle represented by the current bounding box
@@ -364,7 +364,7 @@ module Prawn
     #
     def fill(options={})
       yield if block_given?
-      add_content(options[:fill_rule] == :even_odd ? "f*" : "f")
+      renderer.add_content(options[:fill_rule] == :even_odd ? "f*" : "f")
     end
 
     # Closes, fills, and strokes the current path. If a block is provided,
@@ -378,13 +378,13 @@ module Prawn
     #
     def fill_and_stroke(options={})
       yield if block_given?
-      add_content(options[:fill_rule] == :even_odd ? "b*" : "b")
+      renderer.add_content(options[:fill_rule] == :even_odd ? "b*" : "b")
     end
 
     # Closes the current path.
     #
     def close_path
-      add_content "h"
+      renderer.add_content "h"
     end
 
     ##
@@ -612,7 +612,7 @@ module Prawn
     end
 
     def write_line_width
-      add_content("#{current_line_width} w")
+      renderer.add_content("#{current_line_width} w")
     end
 
     def map_to_absolute(*point)