prawn 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b75f193e883ce03850e0850a8085380b11418d4f
-  data.tar.gz: 7ebda9fc8a346132f6cb3a56c5b55bd1894af9c8
+  metadata.gz: b05cc94288d323f650bc4a44529992282d42b69f
+  data.tar.gz: 71cb2515eb6667207083899502a96487807f8667
 SHA512:
-  metadata.gz: 9ad5b0b7ec71ec616f1bd77ac06b8a74188b1a1bddd8849255235e31be7bfd447720a1b48da2fef71a727771d6820c028a32f1f1b3b9f58c4e8ac58ff4772e52
-  data.tar.gz: f0a2d18ef07e0103c55274004b0f11c2f2029af8280ba77f5eb07bdbee2627aa053d6b5bf20a6958e79c86b780299b4da485be4b795571813823b7dc99d0b900
+  metadata.gz: 4081995850066454b2ec29d3532ea5470812d8af92606a7e2d65d9514105242d3e4061927559e8280c180732c8223d11f37debc7423382ffeada0820dbfc8c8c
+  data.tar.gz: f1ef9c7346cddd535db2acde3a3522bdc4a128dcd8da2eb45439278203ca982e22543de1667a0d7f6435824884f73eb8ed046f6dbf128fa9ad3d721792bc4add

data/Rakefile

@@ -17,8 +17,12 @@ end
 desc "Show library's code statistics"
 task :stats do
   require 'code_statistics/code_statistics'
-  puts CodeStatistics::CodeStatistics.new( [["Prawn", "lib"],
-                      ["Specs", "spec"]] ).to_s
+  puts CodeStatistics::CodeStatistics.new(
+    [
+      ["Prawn", "lib"],
+      ["Specs", "spec"]
+    ]
+  ).to_s
 end
 
 YARD::Rake::YardocTask.new do |t|
@@ -26,12 +30,10 @@ YARD::Rake::YardocTask.new do |t|
 end
 task :docs => :yard
 
-
 desc "Generate the 'Prawn by Example' manual"
 task :manual do
   puts "Building manual..."
-  require File.expand_path(File.join(File.dirname(__FILE__),
-    %w[manual contents]))
+  require File.expand_path(File.join(File.dirname(__FILE__), %w[manual contents]))
   puts "The Prawn manual is available at manual.pdf. Happy Prawning!"
 end
 

data/lib/prawn.rb

@@ -36,10 +36,10 @@ module Prawn
 
   def verify_options(accepted, actual) # @private
     return unless debug || $DEBUG
-    unless (act=Set[*actual.keys]).subset?(acc=Set[*accepted])
-      raise Prawn::Errors::UnknownOption,
-        "\nDetected unknown option(s): #{(act - acc).to_a.inspect}\n" <<
-        "Accepted options are: #{accepted.inspect}"
+    unless (act = Set[*actual.keys]).subset?(acc = Set[*accepted])
+      fail Prawn::Errors::UnknownOption,
+           "\nDetected unknown option(s): #{(act - acc).to_a.inspect}\n" \
+           "Accepted options are: #{accepted.inspect}"
     end
     yield if block_given?
   end

data/lib/prawn/document.rb

@@ -14,7 +14,6 @@ require_relative "document/internals"
 require_relative "document/span"
 
 module Prawn
-
   # The Prawn::Document class is how you start creating a PDF document.
   #
   # There are three basic ways you can instantiate PDF Documents in Prawn, they
@@ -102,7 +101,7 @@ module Prawn
     # @group Stable Attributes
 
     attr_accessor :margin_box
-    attr_reader   :margins, :y
+    attr_reader :margins, :y
     attr_accessor :page_number
 
     # @group Extension Attributes
@@ -138,8 +137,8 @@ module Prawn
     #     pdf.draw_text content, :at => [200,720], :size => 32
     #   end
     #
-    def self.generate(filename,options={},&block)
-      pdf = new(options,&block)
+    def self.generate(filename, options = {}, &block)
+      pdf = new(options, &block)
       pdf.render_file(filename)
     end
 
@@ -189,7 +188,7 @@ module Prawn
     #   # New document, with background
     #   pdf = Prawn::Document.new(:background => "#{Prawn::DATADIR}/images/pigs.jpg")
     #
-    def initialize(options={},&block)
+    def initialize(options = {}, &block)
       options = options.dup
 
       Prawn.verify_options VALID_OPTIONS, options
@@ -198,8 +197,8 @@ module Prawn
       # raise NotImplementedError if options[:skip_page_creation]
 
       self.class.extensions.reverse_each { |e| extend e }
-      @internal_state = PDF::Core::DocumentState.new(options)
-      @internal_state.populate_pages_from_store(self)
+      self.state = PDF::Core::DocumentState.new(options)
+      self.state.populate_pages_from_store(self)
       renderer.min_version(state.store.min_version) if state.store.min_version
 
       renderer.min_version(1.6) if options[:print_scaling] == :none
@@ -246,13 +245,17 @@ module Prawn
         last_page_margins = last_page.margins.dup
       end
 
-      page_options = {:size => options[:size] || last_page_size,
-                      :layout  => options[:layout] || last_page_layout,
-                      :margins => last_page_margins}
+      page_options = {
+        :size    => options[:size] || last_page_size,
+        :layout  => options[:layout] || last_page_layout,
+        :margins => last_page_margins
+      }
       if last_page
         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
+
+        # erase the color space so that it gets reset on new page for fussy pdf-readers
         new_graphic_state.color_space = {} if new_graphic_state
+
         page_options.merge!(:graphic_state => new_graphic_state)
       end
 
@@ -300,7 +303,7 @@ module Prawn
     #
     def go_to_page(k)
       @page_number = k
-      state.page = state.pages[k-1]
+      state.page = state.pages[k - 1]
       generate_margin_box
       @y = @bounding_box.absolute_top
     end
@@ -466,7 +469,6 @@ module Prawn
       move_down(y)
     end
 
-
     # Indents the specified number of PDF points for the duration of the block
     #
     #  pdf.text "some text"
@@ -518,18 +520,20 @@ module Prawn
     #                                           :size => 14}
     #   end
     #
-    def number_pages(string, options={})
+    def number_pages(string, options = {})
       opts = options.dup
       start_count_at = opts.delete(:start_count_at).to_i
-      page_filter = if opts.has_key?(:page_filter)
-        opts.delete(:page_filter)
+
+      if opts.key?(:page_filter)
+        page_filter = opts.delete(:page_filter)
       else
-        :all
+        page_filter = :all
       end
+
       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 unless opts.has_key?(:height)
+      opts[:height] = 50 unless opts.key?(:height)
 
       start_count = false
       pseudopage = 0
@@ -547,7 +551,7 @@ module Prawn
           # have to use fill_color here otherwise text reverts back to default fill color
           fill_color txtcolor unless txtcolor.nil?
           total_pages = total_pages.nil? ? page_count : total_pages
-          str = string.gsub("<page>","#{pseudopage}").gsub("<total>","#{total_pages}")
+          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
@@ -568,20 +572,20 @@ module Prawn
     #
     # @private
     def group(*a, &b)
-      raise NotImplementedError,
-        "Document#group has been disabled because its implementation "+
-        "lead to corrupted documents whenever a page boundary was "+
-        "crossed. We will try to work on reimplementing it in a "+
-        "future release"
+      fail NotImplementedError,
+           "Document#group has been disabled because its implementation " \
+           "lead to corrupted documents whenever a page boundary was " \
+           "crossed. We will try to work on reimplementing it in a " \
+           "future release"
     end
 
     # @private
     def transaction
-      raise NotImplementedError,
-        "Document#transaction has been disabled because its implementation "+
-        "lead to corrupted documents whenever a page boundary was "+
-        "crossed. We will try to work on reimplementing it in a "+
-        "future release"
+      fail NotImplementedError,
+           "Document#transaction has been disabled because its implementation " \
+           "lead to corrupted documents whenever a page boundary was " \
+           "crossed. We will try to work on reimplementing it in a " \
+           "future release"
     end
 
     # Provides a way to execute a block of code repeatedly based on a
@@ -599,9 +603,9 @@ module Prawn
       when :all
         true
       when :odd
-        page_number % 2 == 1
+        page_number.odd?
       when :even
-        page_number % 2 == 0
+        page_number.even?
       when Range, Array
         page_filter.include?(page_number)
       when Proc
@@ -612,9 +616,9 @@ module Prawn
     # @private
 
     def mask(*fields)
-     # Stores the current state of the named attributes, executes the block, and
-     # then restores the original values after the block has executed.
-     # -- I will remove the nodoc if/when this feature is a little less hacky
+      # Stores the current state of the named attributes, executes the block, and
+      # then restores the original values after the block has executed.
+      # -- I will remove the nodoc if/when this feature is a little less hacky
       stored = {}
       fields.each { |f| stored[f] = send(f) }
       yield
@@ -634,9 +638,7 @@ module Prawn
     ## Internals. Don't depend on them!
 
     # @private
-    def state
-      @internal_state
-    end
+    attr_accessor :state
 
     # @private
     def page
@@ -645,7 +647,6 @@ module Prawn
 
     private
 
-
     # setting override_settings to true ensures that a new graphic state does not end up using
     # previous settings.
     def use_graphic_settings(override_settings = false)
@@ -684,23 +685,23 @@ module Prawn
       if options[:margin]
         # Treat :margin as CSS shorthand with 1-4 values.
         margin = Array(options[:margin])
-        positions = { 4 => [0,1,2,3], 3 => [0,1,2,1],
-                      2 => [0,1,0,1], 1 => [0,0,0,0] }[margin.length]
+        positions = { 4 => [0, 1, 2, 3], 3 => [0, 1, 2, 1],
+                      2 => [0, 1, 0, 1], 1 => [0, 0, 0, 0] }[margin.length]
 
-        [:top, :right, :bottom, :left].zip(positions).each do |p,i|
+        [:top, :right, :bottom, :left].zip(positions).each do |p, i|
           options[:"#{p}_margin"] ||= margin[i]
         end
       end
 
-      [:left,:right,:top,:bottom].each do |side|
-         if margin = options[:"#{side}_margin"]
-           state.page.margins[side] = margin
-         end
+      [:left, :right, :top, :bottom].each do |side|
+        if margin = options[:"#{side}_margin"]
+          state.page.margins[side] = margin
+        end
       end
     end
 
     def font_metric_cache #:nodoc:
-      @font_metric_cache ||= FontMetricCache.new( self )
+      @font_metric_cache ||= FontMetricCache.new(self)
     end
   end
 end

data/lib/prawn/document/bounding_box.rb

@@ -172,7 +172,8 @@ module Prawn
     def canvas(&block)
       init_bounding_box(block, :hold_position => true) do |_|
         # Canvas bbox acts like margin_box in that its parent bounds are unset.
-        @bounding_box = BoundingBox.new(self, nil, [0,page.dimensions[3]],
+        @bounding_box = BoundingBox.new(
+          self, nil, [0, page.dimensions[3]],
           :width => page.dimensions[2],
           :height => page.dimensions[3]
         )
@@ -181,10 +182,10 @@ module Prawn
 
     private
 
-    def init_bounding_box(user_block, options={}, &init_block)
+    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"
+        fail ArgumentError,
+             "bounding boxes require a block to be drawn within the box"
       end
 
       parent_box = @bounding_box
@@ -219,10 +220,9 @@ module Prawn
     # is used for.
     #
     class BoundingBox
-
-      def initialize(document, parent, point, options={}) # @private
+      def initialize(document, parent, point, options = {}) # @private
         unless options[:width]
-          raise ArgumentError, "BoundingBox needs the :width option to be set"
+          fail ArgumentError, "BoundingBox needs the :width option to be set"
         end
 
         @document = document
@@ -264,7 +264,6 @@ module Prawn
         0
       end
 
-
       # Temporarily adjust the @x coordinate to allow for left_padding
       #
       # Example:
@@ -360,7 +359,7 @@ module Prawn
       #  end
       #
       def top_left
-        [left,top]
+        [left, top]
       end
 
       # Relative top-right point of the bounding box
@@ -373,7 +372,7 @@ module Prawn
       #  end
       #
       def top_right
-        [right,top]
+        [right, top]
       end
 
       # Relative bottom-right point of the bounding box
@@ -385,7 +384,7 @@ module Prawn
       #  end
       #
       def bottom_right
-        [right,bottom]
+        [right, bottom]
       end
 
       # Relative bottom-left point of the bounding box
@@ -397,7 +396,7 @@ module Prawn
       #  end
       #
       def bottom_left
-        [left,bottom]
+        [left, bottom]
       end
 
       # Absolute left x-coordinate of the bounding box
@@ -449,10 +448,7 @@ module Prawn
       end
 
       # Width of the bounding box
-      #
-      def width
-        @width
-      end
+      attr_reader :width
 
       # Height of the bounding box.  If the box is 'stretchy' (unspecified
       # height attribute), height is calculated as the distance from the top of
@@ -500,7 +496,7 @@ module Prawn
       #
       def reference_bounds
         if stretchy?
-          raise "Can't find reference bounds: my parent is unset" unless @parent
+          fail "Can't find reference bounds: my parent is unset" unless @parent
           @parent.reference_bounds
         else
           self
@@ -532,8 +528,6 @@ module Prawn
         bounds.instance_variable_set("@document", document)
         bounds
       end
-
     end
-
   end
 end

data/lib/prawn/document/column_box.rb

@@ -10,7 +10,6 @@ require_relative "bounding_box"
 
 module Prawn
   class Document
-
     # @group Experimental API
 
     # A column box is a bounding box with the additional property that when
@@ -37,7 +36,7 @@ module Prawn
 
     private
 
-    def init_column_box(user_block, options={}, &init_block)
+    def init_column_box(user_block, options = {}, &init_block)
       parent_box = @bounding_box
 
       init_block.call(parent_box)
@@ -53,11 +52,10 @@ module Prawn
     # work.
     #
     class ColumnBox < BoundingBox
-
-      def initialize(document, parent, point, options={}) #:nodoc:
+      def initialize(document, parent, point, options = {}) #:nodoc:
         super
         @columns = options[:columns] || 3
-        @spacer  = options[:spacer]  || @document.font_size
+        @spacer  = options[:spacer] || @document.font_size
         @current_column = 0
         @reflow_margins = options[:reflow_margins]
       end

data/lib/prawn/document/internals.rb

@@ -10,7 +10,6 @@ require "forwardable"
 
 module Prawn
   class Document
-
     # This module exposes a few low-level PDF features for those who want
     # to extend Prawn's core functionality.  If you are not comfortable with
     # low level PDF functionality as defined by Adobe's specification, chances

data/lib/prawn/document/span.rb

@@ -26,23 +26,23 @@ module Prawn
     #    text "Here's some centered text in a 350 point column. " * 100
     #  end
     #
-    def span(width, options={})
+    def span(width, options = {})
       Prawn.verify_options [:position], options
       original_position = self.y
 
       # FIXME: Any way to move this upstream?
       left_boundary = case(options[:position] || :left)
-      when :left
-        margin_box.absolute_left
-      when :center
-        margin_box.absolute_left + margin_box.width / 2.0 - width / 2.0
-      when :right
-        margin_box.absolute_right - width
-      when Numeric
-        margin_box.absolute_left + options[:position]
-      else
-        raise ArgumentError, "Invalid option for :position"
-      end
+                      when :left
+                        margin_box.absolute_left
+                      when :center
+                        margin_box.absolute_left + margin_box.width / 2.0 - width / 2.0
+                      when :right
+                        margin_box.absolute_right - width
+                      when Numeric
+                        margin_box.absolute_left + options[:position]
+                      else
+                        fail ArgumentError, "Invalid option for :position"
+                      end
 
       # we need to bust out of whatever nested bounding boxes we're in.
       canvas do