prawn 0.11.1 → 0.15.0

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec
+
+if ENV["CI"] 
+  platforms :rbx do
+    gem "rubysl-singleton", "~> 2.0"
+    gem "rubysl-digest", "~> 2.0"
+    gem "rubysl-enumerator", "~> 2.0"
+  end
+end

data/LICENSE

@@ -1,7 +1,7 @@
 Prawn is copyrighted free software produced by Gregory Brown along with 
 community contributions.  See git log for authorship information.
 
-Licensing terms follow (License of Ruby):
+Licensing terms follow:
 
 You can redistribute Prawn and/or modify it under either the terms of the GPLv2
 or GPLv3 (see GPLv2 and GPLv3 files), or the conditions below:

data/Rakefile

@@ -1,51 +1,31 @@
-require "rubygems"
 require "bundler"
 Bundler.setup
 
 require 'rake'
-require 'rake/testtask'
-require "rake/rdoctask"
-require "rake/gempackagetask"  
-
-task :default => [:test]
-       
-desc "Run all tests, test-spec, mocha, and pdf-reader required"
-Rake::TestTask.new do |test|
-  # test.ruby_opts  << "-w"  # .should == true triggers a lot of warnings
-  test.libs       << "spec"
-  test.test_files =  Dir[ "spec/*_spec.rb" ]
-  test.verbose    =  true
+require 'rspec/core/rake_task'
+require 'yard'
+require 'rubygems/package_task'
+
+task :default => [:spec]
+
+desc "Run all rspec files"
+RSpec::Core::RakeTask.new("spec") do |c|
+  c.rspec_opts = "-t ~unresolved"
 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'
+  CodeStatistics::TEST_TYPES << "Specs"
+  CodeStatistics.new( ["Prawn", "lib"],
+                      ["Specs", "spec"] ).to_s
 end
 
-desc "genrates documentation"
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_files.include( "README",
-                           "COPYING",
-                           "LICENSE", 
-                           "HACKING", "lib/" )
-  rdoc.main     = "README"
-  rdoc.rdoc_dir = "doc/html"
-  rdoc.title    = "Prawn Documentation"
-end     
-
-desc "run all examples"
-task :examples do
-  mkdir_p "output"
-  examples = Dir["examples/**/*.rb"]
-  t = Time.now
-  puts "Running Examples"
-  examples.each { |file| `ruby -Ilib #{file}` }
-  puts "Ran in #{Time.now - t} s"
-  `mv *.pdf output`
+YARD::Rake::YardocTask.new do |t|
+  t.options = ['--output-dir', 'doc/html']
 end
+task :docs => :yard
+
 
 desc "Generate the 'Prawn by Example' manual"
 task :manual do
@@ -56,8 +36,19 @@ task :manual do
 end
 
 spec = Gem::Specification.load "prawn.gemspec"
-Rake::GemPackageTask.new(spec) do |pkg|
+Gem::PackageTask.new(spec) do |pkg|
   pkg.need_zip = true
   pkg.need_tar = true
 end
 
+desc "Run a console with Prawn loaded"
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require_relative 'lib/prawn'
+  Prawn.debug = true
+
+  ARGV.clear
+  IRB.start
+end
+

data/data/pdfs/nested_pages.pdf

@@ -49,7 +49,7 @@ endobj
 >>
 /ProcSet [/PDF /Text /ImageB /ImageC /ImageI]
 >>
-/Parent 4 0 R
+/Parent 3 0 R
 >>
 endobj
 7 0 obj
@@ -85,7 +85,7 @@ endobj
 >>
 /ProcSet [/PDF /Text /ImageB /ImageC /ImageI]
 >>
-/Parent 4 0 R
+/Parent 3 0 R
 >>
 endobj
 10 0 obj
@@ -97,17 +97,17 @@ endobj
 endobj
 xref
 0 11
-0000000000 65535 f 
-0000000015 00000 n 
-0000000071 00000 n 
-0000000120 00000 n 
-0000000183 00000 n 
-0000000240 00000 n 
-0000000494 00000 n 
-0000000672 00000 n 
-0000000769 00000 n 
-0000000994 00000 n 
-0000001173 00000 n 
+0000000000 65535 f
+0000000015 00000 n
+0000000071 00000 n
+0000000120 00000 n
+0000000183 00000 n
+0000000240 00000 n
+0000000494 00000 n
+0000000672 00000 n
+0000000769 00000 n
+0000000994 00000 n
+0000001173 00000 n
 trailer
 << /Root 2 0 R
 /Size 11

data/lib/prawn/document/bounding_box.rb

@@ -8,6 +8,7 @@
 
 module Prawn
   class Document
+    # @group Stable API
 
     # :call-seq:
     #   bounding_box(point, options={}, &block)
@@ -154,10 +155,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
 
@@ -181,13 +182,31 @@ module Prawn
     private
 
     def init_bounding_box(user_block, options={}, &init_block)
+      unless user_block
+        raise ArgumentError,
+          "bounding boxes require a block to be drawn within the box"
+      end
+
       parent_box = @bounding_box
 
+      original_ypos = y
+
       init_block.call(parent_box)
 
       self.y = @bounding_box.absolute_top
       user_block.call
-      self.y = @bounding_box.absolute_bottom unless options[:hold_position]
+
+      # If the user actions did not modify the y position
+      # restore the original y position before the bounding
+      # box was created.
+      
+      if y == @bounding_box.absolute_top
+        self.y = original_ypos
+      end
+
+      unless options[:hold_position] || @bounding_box.stretchy?
+        self.y = @bounding_box.absolute_bottom
+      end
 
       created_box, @bounding_box = @bounding_box, parent_box
 
@@ -201,7 +220,7 @@ module Prawn
     #
     class BoundingBox
 
-      def initialize(document, parent, point, options={}) #:nodoc:
+      def initialize(document, parent, point, options={}) # @private
         unless options[:width]
           raise ArgumentError, "BoundingBox needs the :width option to be set"
         end
@@ -215,15 +234,22 @@ module Prawn
         @stretched_height = nil
       end
 
+      # @private
+
       attr_reader :document, :parent
+
+      # @private
       # The current indentation of the left side of the bounding box.
       attr_reader :total_left_padding
+
+      # @private
       # The current indentation of the right side of the bounding box.
       attr_reader :total_right_padding
 
       # The translated origin (x,y-height) which describes the location
       # of the bottom left corner of the bounding box
       #
+      # @private
       def anchor
         [@x, @y - height]
       end
@@ -254,6 +280,7 @@ module Prawn
       #    text "indented on both sides"
       #  end
       #
+      # @private
       def indent(left_padding, right_padding = 0, &block)
         add_left_padding(left_padding)
         add_right_padding(right_padding)
@@ -264,6 +291,7 @@ module Prawn
       end
 
       # Increase the left padding of the bounding box.
+      # @private
       def add_left_padding(left_padding)
         @total_left_padding += left_padding
         @x += left_padding
@@ -271,6 +299,7 @@ module Prawn
       end
 
       # Decrease the left padding of the bounding box.
+      # @private
       def subtract_left_padding(left_padding)
         @total_left_padding -= left_padding
         @x -= left_padding
@@ -278,12 +307,14 @@ module Prawn
       end
 
       # Increase the right padding of the bounding box.
+      # @private
       def add_right_padding(right_padding)
         @total_right_padding += right_padding
         @width -= right_padding
       end
 
       # Decrease the right padding of the bounding box.
+      # @private
       def subtract_right_padding(right_padding)
         @total_right_padding -= right_padding
         @width += right_padding
@@ -434,23 +465,30 @@ module Prawn
       end
 
       # an alias for absolute_left
+      # @private
       def left_side
-         absolute_left
+        absolute_left
       end
 
       # an alias for absolute_right
+      # @private
       def right_side
-         absolute_right
+        absolute_right
       end
 
-      # starts a new page
+      # @group Extension API
+
+      # Moves to the top of the next page of the document, starting a new page
+      # if necessary.
+      #
       def move_past_bottom
-        @document.start_new_page
+        if @document.page_number == @document.page_count
+          @document.start_new_page
+        else
+          @document.go_to_page(@document.page_number + 1)
+        end
       end
 
-
-      alias_method :update_height, :height
-
       # Returns +false+ when the box has a defined height, +true+ when the height
       # is being calculated on the fly based on the current vertical position.
       #
@@ -458,6 +496,43 @@ module Prawn
         !@height
       end
 
+      # Returns the innermost non-stretchy bounding box.
+      #
+      def reference_bounds
+        if stretchy?
+          raise "Can't find reference bounds: my parent is unset" unless @parent
+          @parent.reference_bounds
+        else
+          self
+        end
+      end
+
+      alias_method :update_height, :height
+
+      # Returns a deep copy of these bounds (including all parent bounds but
+      # not copying the reference to the Document).
+      #
+      # @private
+      def deep_copy
+        copy = dup
+        # Deep-copy the parent bounds
+        copy.instance_variable_set("@parent", if BoundingBox === @parent
+                                                @parent.deep_copy
+                                              end)
+        copy.instance_variable_set("@document", nil)
+        copy
+      end
+
+      # Restores a copy of the bounds taken by BoundingBox.deep_copy in the
+      # context of the given +document+. Does *not* set the bounds of the
+      # document to the resulting BoundingBox, only returns it.
+      #
+      # @private
+      def self.restore_deep_copy(bounds, document)
+        bounds.instance_variable_set("@document", document)
+        bounds
+      end
+
     end
 
   end

data/lib/prawn/document/column_box.rb

@@ -4,22 +4,28 @@
 #
 # Author Paul Ostazeski.
 
-require "prawn/document/bounding_box"
+require_relative "bounding_box"
+
 module Prawn
   class Document
 
+    # @group Experimental API
+
     # 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.
+    # number of :columns and a :spacer (in points) between columns. If resetting
+    # the top margin is desired on a new page (e.g. to allow for initial page 
+    # wide column titles) the option :reflow_margins => true can be set.
     #
-    # Defaults are :columns = 3 and :spacer = font_size
+    # Defaults are :columns = 3, :spacer = font_size, and 
+    # :reflow_margins => false
     # 
     # 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,25 +46,6 @@ module Prawn
 
       @bounding_box = parent_box
     end
-    
-    # Template methods to support ColumnBox extensions
-    class BoundingBox
-      
-      # an alias for absolute_left
-      def left_side
-         absolute_left
-      end
-
-      # an alias for absolute_right
-      def right_side
-         absolute_right
-      end
-
-      # starts a new page
-      def move_past_bottom
-         @document.start_new_page
-      end
-    end
 
     # Implements the necessary functionality to allow Document#column_box to
     # work.
@@ -70,19 +57,26 @@ module Prawn
         @columns = options[:columns] || 3
         @spacer  = options[:spacer]  || @document.font_size
         @current_column = 0
+        @reflow_margins = options[:reflow_margins]
+      end
+
+      # 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, not the width of the whole box.  Used to calculate
-      # how long a line of text can be.
+      # 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
@@ -91,6 +85,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
@@ -98,16 +98,45 @@ 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
+          if @reflow_margins
+            @y = @parent.absolute_top
+          end
           @document.start_new_page
         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,71 +8,8 @@
 #
 
 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
+    module GraphicsState # @private
 
       # 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
@@ -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