prawn 2.0.2 → 2.3.0

data/lib/prawn/document/bounding_box.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # bounding_box.rb : Implements a mechanism for shifting the coordinate space
 #
@@ -155,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(pt, *args, &block)
+    def bounding_box(point, *args, &block)
       init_bounding_box(block) do |parent_box|
-        pt = map_to_absolute(pt)
-        @bounding_box = BoundingBox.new(self, parent_box, pt, *args)
+        point = map_to_absolute(point)
+        @bounding_box = BoundingBox.new(self, parent_box, point, *args)
       end
     end
 
@@ -170,29 +170,29 @@ module Prawn
     #   end
     #
     def canvas(&block)
-      init_bounding_box(block, :hold_position => true) do |_|
+      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]],
-          :width => page.dimensions[2],
-          :height => page.dimensions[3]
+          width: page.dimensions[2],
+          height: page.dimensions[3]
         )
       end
     end
 
     private
 
-    def init_bounding_box(user_block, options = {}, &init_block)
+    def init_bounding_box(user_block, options = {})
       unless user_block
-        fail ArgumentError,
-             "bounding boxes require a block to be drawn within the box"
+        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)
+      yield(parent_box)
 
       self.y = @bounding_box.absolute_top
       user_block.call
@@ -209,9 +209,10 @@ module Prawn
         self.y = @bounding_box.absolute_bottom
       end
 
-      created_box, @bounding_box = @bounding_box, parent_box
+      created_box = @bounding_box
+      @bounding_box = parent_box
 
-      return created_box
+      created_box
     end
 
     # Low level layout helper that simplifies coordinate math.
@@ -220,15 +221,17 @@ module Prawn
     # is used for.
     #
     class BoundingBox
-      def initialize(document, parent, point, options = {}) # @private
+      # @private
+      def initialize(document, parent, point, options = {})
         unless options[:width]
-          fail ArgumentError, "BoundingBox needs the :width option to be set"
+          raise ArgumentError, 'BoundingBox needs the :width option to be set'
         end
 
         @document = document
         @parent = parent
         @x, @y = point
-        @width, @height = options[:width], options[:height]
+        @width = options[:width]
+        @height = options[:height]
         @total_left_padding = 0
         @total_right_padding = 0
         @stretched_height = nil
@@ -280,7 +283,7 @@ module Prawn
       #  end
       #
       # @private
-      def indent(left_padding, right_padding = 0, &block)
+      def indent(left_padding, right_padding = 0)
         add_left_padding(left_padding)
         add_right_padding(right_padding)
         yield
@@ -319,7 +322,8 @@ module Prawn
         @width += right_padding
       end
 
-      # Relative right x-coordinate of the bounding box. (Equal to the box width)
+      # Relative right x-coordinate of the bounding box. (Equal to the box
+      # width)
       #
       # Example, position some text 3 pts from the right of the containing box:
       #
@@ -456,8 +460,11 @@ module Prawn
       #
       def height
         return @height if @height
-        @stretched_height = [(absolute_top - @document.y),
-                             @stretched_height.to_f].max
+
+        @stretched_height = [
+          (absolute_top - @document.y),
+          @stretched_height.to_f
+        ].max
       end
 
       # an alias for absolute_left
@@ -485,8 +492,9 @@ module Prawn
         end
       end
 
-      # 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.
+      # 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.
       #
       def stretchy?
         !@height
@@ -496,14 +504,15 @@ module Prawn
       #
       def reference_bounds
         if stretchy?
-          fail "Can't find reference bounds: my parent is unset" unless @parent
+          raise "Can't find reference bounds: my parent is unset" unless @parent
+
           @parent.reference_bounds
         else
           self
         end
       end
 
-      alias_method :update_height, :height
+      alias update_height height
 
       # Returns a deep copy of these bounds (including all parent bounds but
       # not copying the reference to the Document).
@@ -512,10 +521,13 @@ module Prawn
       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.instance_variable_set(
+          '@parent',
+          if @parent.is_a?(BoundingBox)
+            @parent.deep_copy
+          end
+        )
+        copy.instance_variable_set('@document', nil)
         copy
       end
 
@@ -525,7 +537,7 @@ module Prawn
       #
       # @private
       def self.restore_deep_copy(bounds, document)
-        bounds.instance_variable_set("@document", document)
+        bounds.instance_variable_set('@document', document)
         bounds
       end
     end

data/lib/prawn/document/column_box.rb

@@ -1,12 +1,12 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # column_box.rb: Extends BoundingBox to allow for columns of text
 #
 # Author Paul Ostazeski.
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require_relative "bounding_box"
+require_relative 'bounding_box'
 
 module Prawn
   class Document
@@ -36,10 +36,10 @@ module Prawn
 
     private
 
-    def init_column_box(user_block, options = {}, &init_block)
+    def init_column_box(user_block, options = {})
       parent_box = @bounding_box
 
-      init_block.call(parent_box)
+      yield(parent_box)
 
       self.y = @bounding_box.absolute_top
       user_block.call
@@ -55,7 +55,7 @@ module Prawn
       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
@@ -109,7 +109,7 @@ module Prawn
       def move_past_bottom
         @current_column = (@current_column + 1) % @columns
         @document.y = @y
-        if 0 == @current_column
+        if @current_column.zero?
           if @reflow_margins
             @y = @parent.absolute_top
           end

data/lib/prawn/document/internals.rb

@@ -1,12 +1,12 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # internals.rb : Implements document internals for Prawn
 #
 # Copyright August 2008, Gregory Brown. All Rights Reserved.
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require "forwardable"
+require 'forwardable'
 
 module Prawn
   class Document
@@ -23,10 +23,20 @@ module Prawn
       # 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,
-                 :on_page_create ] => :renderer
+      delegate %i[
+        graphic_state
+        on_page_create
+      ] => :renderer
+
+      def save_graphics_state(state = nil, &block)
+        save_transformation_stack
+        renderer.save_graphics_state(state, &block)
+      end
+
+      def restore_graphics_state
+        restore_transformation_stack
+        renderer.restore_graphics_state
+      end
 
       # FIXME: This is a circular reference, because in theory Prawn should
       # be passing instances of renderer to PDF::Core::Page, but it's
@@ -37,7 +47,7 @@ module Prawn
       delegate [:compression_enabled?] => :renderer
 
       # FIXME: More circular references in PDF::Core::Page.
-      delegate [ :ref, :ref!, :deref ] => :renderer
+      delegate %i[ref ref! deref] => :renderer
 
       # FIXME: Another circular reference, because we mix in a module from
       # PDF::Core to provide destinations, which in theory should not

data/lib/prawn/document/span.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # span.rb : Implements text columns
 #
@@ -28,26 +28,31 @@ module Prawn
     #
     def span(width, options = {})
       Prawn.verify_options [:position], options
-      original_position = self.y
+      original_position = 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
-                        fail ArgumentError, "Invalid option for :position"
-                      end
+      left_boundary =
+        case options.fetch(: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
 
       # we need to bust out of whatever nested bounding boxes we're in.
       canvas do
-        bounding_box([left_boundary,
-                      margin_box.absolute_top], :width => width) do
+        bounding_box(
+          [
+            left_boundary,
+            margin_box.absolute_top
+          ], width: width
+        ) do
           self.y = original_position
           yield
         end

data/lib/prawn/encoding.rb

@@ -1,87 +1,88 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # Copyright September 2008, Gregory Brown, James Healy  All Rights Reserved.
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 #
 module Prawn
-  module Encoding # @private
+  # @private
+  module Encoding
     # Map between unicode and WinAnsiEnoding
     #
     class WinAnsi #:nodoc:
       CHARACTERS = %w[
-        .notdef       .notdef        .notdef        .notdef
-        .notdef       .notdef        .notdef        .notdef
-        .notdef       .notdef        .notdef        .notdef
-        .notdef       .notdef        .notdef        .notdef
-        .notdef       .notdef        .notdef        .notdef
-        .notdef       .notdef        .notdef        .notdef
-        .notdef       .notdef        .notdef        .notdef
-        .notdef       .notdef        .notdef        .notdef
+        .notdef .notdef .notdef .notdef
+        .notdef .notdef .notdef .notdef
+        .notdef .notdef .notdef .notdef
+        .notdef .notdef .notdef .notdef
+        .notdef .notdef .notdef .notdef
+        .notdef .notdef .notdef .notdef
+        .notdef .notdef .notdef .notdef
+        .notdef .notdef .notdef .notdef
 
-        space         exclam         quotedbl       numbersign
-        dollar        percent        ampersand      quotesingle
-        parenleft     parenright     asterisk       plus
-        comma         hyphen         period         slash
-        zero          one            two            three
-        four          five           six            seven
-        eight         nine           colon          semicolon
-        less          equal          greater        question
+        space exclam quotedbl numbersign
+        dollar percent ampersand quotesingle
+        parenleft parenright asterisk plus
+        comma hyphen period slash
+        zero one two three
+        four five six seven
+        eight nine colon semicolon
+        less equal greater question
 
-        at            A              B              C
-        D             E              F              G
-        H             I              J              K
-        L             M              N              O
-        P             Q              R              S
-        T             U              V              W
-        X             Y              Z              bracketleft
-        backslash     bracketright   asciicircum    underscore
+        at A B C
+        D E F G
+        H I J K
+        L M N O
+        P Q R S
+        T U V W
+        X Y Z bracketleft
+        backslash bracketright asciicircum underscore
 
-        grave         a              b              c
-        d             e              f              g
-        h             i              j              k
-        l             m              n              o
-        p             q              r              s
-        t             u              v              w
-        x             y              z              braceleft
-        bar           braceright     asciitilde     .notdef
+        grave a b c
+        d e f g
+        h i j k
+        l m n o
+        p q r s
+        t u v w
+        x y z braceleft
+        bar braceright asciitilde .notdef
 
-        Euro          .notdef        quotesinglbase florin
-        quotedblbase  ellipsis       dagger         daggerdbl
-        circumflex    perthousand    Scaron         guilsinglleft
-        OE            .notdef        Zcaron         .notdef
-        .notdef       quoteleft      quoteright     quotedblleft
-        quotedblright bullet         endash         emdash
-        tilde         trademark      scaron         guilsinglright
-        oe            .notdef        zcaron         ydieresis
+        Euro .notdef quotesinglbase florin
+        quotedblbase ellipsis dagger daggerdbl
+        circumflex perthousand Scaron guilsinglleft
+        OE .notdef Zcaron .notdef
+        .notdef quoteleft quoteright quotedblleft
+        quotedblright bullet endash emdash
+        tilde trademark scaron guilsinglright
+        oe .notdef zcaron ydieresis
 
-        space         exclamdown     cent           sterling
-        currency      yen            brokenbar      section
-        dieresis      copyright      ordfeminine    guillemotleft
-        logicalnot    hyphen         registered     macron
-        degree        plusminus      twosuperior    threesuperior
-        acute         mu             paragraph      periodcentered
-        cedilla       onesuperior    ordmasculine   guillemotright
-        onequarter    onehalf        threequarters  questiondown
+        space exclamdown cent sterling
+        currency yen brokenbar section
+        dieresis copyright ordfeminine guillemotleft
+        logicalnot hyphen registered macron
+        degree plusminus twosuperior threesuperior
+        acute mu paragraph periodcentered
+        cedilla onesuperior ordmasculine guillemotright
+        onequarter onehalf threequarters questiondown
 
-        Agrave        Aacute         Acircumflex    Atilde
-        Adieresis     Aring          AE             Ccedilla
-        Egrave        Eacute         Ecircumflex    Edieresis
-        Igrave        Iacute         Icircumflex    Idieresis
-        Eth           Ntilde         Ograve         Oacute
-        Ocircumflex   Otilde         Odieresis      multiply
-        Oslash        Ugrave         Uacute         Ucircumflex
-        Udieresis     Yacute         Thorn          germandbls
+        Agrave Aacute Acircumflex Atilde
+        Adieresis Aring AE Ccedilla
+        Egrave Eacute Ecircumflex Edieresis
+        Igrave Iacute Icircumflex Idieresis
+        Eth Ntilde Ograve Oacute
+        Ocircumflex Otilde Odieresis multiply
+        Oslash Ugrave Uacute Ucircumflex
+        Udieresis Yacute Thorn germandbls
 
-        agrave        aacute         acircumflex    atilde
-        adieresis     aring          ae             ccedilla
-        egrave        eacute         ecircumflex    edieresis
-        igrave        iacute         icircumflex    idieresis
-        eth           ntilde         ograve         oacute
-        ocircumflex   otilde         odieresis      divide
-        oslash        ugrave         uacute         ucircumflex
-        udieresis     yacute         thorn          ydieresis
-      ]
+        agrave aacute acircumflex atilde
+        adieresis aring ae ccedilla
+        egrave eacute ecircumflex edieresis
+        igrave iacute icircumflex idieresis
+        eth ntilde ograve oacute
+        ocircumflex otilde odieresis divide
+        oslash ugrave uacute ucircumflex
+        udieresis yacute thorn ydieresis
+      ].freeze
     end
   end
 end