prawn 2.1.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e103cb901b7728d21af3dfe412f3072063a86835
-  data.tar.gz: 132ff9e3bf2aeeeb1e9b574e5b84115192e576dc
+SHA256:
+  metadata.gz: d64c2da1e4be48e40f4fa6fa4de35e04c75debf0119e8c59b3fba9d944c112db
+  data.tar.gz: 393bbdd1a5df657d5c6190d4bd10ecd7353522e714b2f60c8d9c5f70e5bc1ce9
 SHA512:
-  metadata.gz: 0cad684b3b096da6cdceb69e47b78c5629251687d28c8a3ab4f824fc64b842daa11e2f62122033d9b27f1cd4afe809bfad1c3cc2c150e909cae09f5480a442ec
-  data.tar.gz: 5ea7ffa1b819a00d71897150c87afd0a7b7cc08e1afc8c4b41a425fd262f5276c961e969ea0e6e0178dde6f74ded16842076674abe39afbc5ca9bfaf513d5aab
+  metadata.gz: c4980639ca24796d577be790ed0f6fa85c985f1a6eb147e4c5db1df261c5d50afe8a466f06b65588b71a897e22e8d2b7b01daceed1714f6164124057154d2d28
+  data.tar.gz: e0fd560d4a80f2827736d599266bcb2e2fe19abedcde639520fba8bd19a2f12fe2cf0e8a60a91b87dbac4336d25c680f94b2341e5f9ce3d6d24f2e65f24e24a3

data/GPLv2

@@ -1,12 +1,12 @@
-		    GNU GENERAL PUBLIC LICENSE
-		       Version 2, June 1991
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
 
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.
-     59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
-			    Preamble
+                            Preamble
 
   The licenses for most software are designed to take away your
 freedom to share and change it.  By contrast, the GNU General Public
@@ -15,7 +15,7 @@ software--to make sure the software is free for all its users.  This
 General Public License applies to most of the Free Software
 Foundation's software and to any other program whose authors commit to
 using it.  (Some other Free Software Foundation software is covered by
-the GNU Library General Public License instead.)  You can apply it to
+the GNU Lesser General Public License instead.)  You can apply it to
 your programs, too.
 
   When we speak of free software, we are referring to freedom, not
@@ -55,8 +55,8 @@ patent must be licensed for everyone's free use or not licensed at all.
 
   The precise terms and conditions for copying, distribution and
 modification follow.
-
-		    GNU GENERAL PUBLIC LICENSE
+
+                    GNU GENERAL PUBLIC LICENSE
    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
   0. This License applies to any program or other work which contains
@@ -110,7 +110,7 @@ above, provided that you also meet all of these conditions:
     License.  (Exception: if the Program itself is interactive but
     does not normally print such an announcement, your work based on
     the Program is not required to print an announcement.)
-
+
 These requirements apply to the modified work as a whole.  If
 identifiable sections of that work are not derived from the Program,
 and can be reasonably considered independent and separate works in
@@ -168,7 +168,7 @@ access to copy from a designated place, then offering equivalent
 access to copy the source code from the same place counts as
 distribution of the source code, even though third parties are not
 compelled to copy the source along with the object code.
-
+
   4. You may not copy, modify, sublicense, or distribute the Program
 except as expressly provided under this License.  Any attempt
 otherwise to copy, modify, sublicense or distribute the Program is
@@ -225,7 +225,7 @@ impose that choice.
 
 This section is intended to make thoroughly clear what is believed to
 be a consequence of the rest of this License.
-
+
   8. If the distribution and/or use of the Program is restricted in
 certain countries either by patents or by copyrighted interfaces, the
 original copyright holder who places the Program under this License
@@ -255,7 +255,7 @@ make exceptions for this.  Our decision will be guided by the two goals
 of preserving the free status of all derivatives of our free software and
 of promoting the sharing and reuse of software generally.
 
-			    NO WARRANTY
+                            NO WARRANTY
 
   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
@@ -277,9 +277,9 @@ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGES.
 
-		     END OF TERMS AND CONDITIONS
-
-	    How to Apply These Terms to Your New Programs
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
 
   If you develop a new program, and you want it to be of the greatest
 possible use to the public, the best way to achieve this is to make it
@@ -303,17 +303,16 @@ the "copyright" line and a pointer to where the full notice is found.
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 Also add information on how to contact you by electronic and paper mail.
 
 If the program is interactive, make it output a short notice like this
 when it starts in an interactive mode:
 
-    Gnomovision version 69, Copyright (C) year  name of author
+    Gnomovision version 69, Copyright (C) year name of author
     Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.
@@ -336,5 +335,5 @@ necessary.  Here is a sample; alter the names:
 This General Public License does not permit incorporating your program into
 proprietary programs.  If your program is a subroutine library, you may
 consider it more useful to permit linking proprietary applications with the
-library.  If this is what you want to do, use the GNU Library General
+library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.

data/Gemfile

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

data/Rakefile

@@ -1,49 +1,19 @@
-require "bundler"
-Bundler.setup
+# frozen_string_literal: true
 
-require 'rake'
-require 'rspec/core/rake_task'
-require 'yard'
-require 'rubygems/package_task'
-require 'rubocop/rake_task'
+GEMSPEC = File.expand_path('prawn.gemspec', __dir__)
+require 'prawn/dev/tasks'
 
-task :default => [:spec, :rubocop]
-
-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/code_statistics'
-  puts CodeStatistics::CodeStatistics.new(
-    [
-      ["Prawn", "lib"],
-      ["Specs", "spec"]
-    ]
-  ).to_s
-end
-
-YARD::Rake::YardocTask.new do |t|
-  t.options = ['--output-dir', 'doc/html']
-end
-task :docs => :yard
+task default: %i[spec rubocop]
 
 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]))
-  puts "The Prawn manual is available at manual.pdf. Happy Prawning!"
-end
-
-spec = Gem::Specification.load "prawn.gemspec"
-Gem::PackageTask.new(spec) do |pkg|
-  pkg.need_zip = true
-  pkg.need_tar = true
+  puts 'Building manual...'
+  require File.expand_path(File.join(__dir__, %w[manual contents]))
+  prawn_manual_document.render_file('manual.pdf')
+  puts 'The Prawn manual is available at manual.pdf. Happy Prawning!'
 end
 
-desc "Run a console with Prawn loaded"
+desc 'Run a console with Prawn loaded'
 task :console do
   require 'irb'
   require 'irb/completion'
@@ -53,5 +23,3 @@ task :console do
   ARGV.clear
   IRB.start
 end
-
-RuboCop::RakeTask.new

data/lib/prawn.rb

@@ -1,19 +1,17 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # Welcome to Prawn, the best PDF Generation library ever.
 # This documentation covers user level functionality.
 #
-require "set"
+require 'set'
 
 require 'ttfunk'
-require "pdf/core"
+require 'pdf/core'
 
 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
   #
@@ -32,59 +30,49 @@ module Prawn
   #   Detected unknown option(s): [:tomato]
   #   Accepted options are: [:page_size, :page_layout, :left_margin, ...]
   #
-  attr_accessor :debug # @private
+  # @private
+  attr_accessor :debug
+
+  module_function :debug, :debug=
 
-  def verify_options(accepted, actual) # @private
+  module_function
+
+  # @private
+  def verify_options(accepted, actual)
     return unless debug || $DEBUG
+
     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}"
+      raise Prawn::Errors::UnknownOption,
+        "\nDetected unknown option(s): #{(act - acc).to_a.inspect}\n" \
+        "Accepted options are: #{accepted.inspect}"
     end
     yield if block_given?
   end
-
-  module Configurable # @private
-    def configuration(*args)
-      @config ||= Marshal.load(Marshal.dump(default_configuration))
-      if Hash === args[0]
-        @config.update(args[0])
-      elsif args.length > 1
-        @config.values_at(*args)
-      elsif args.length == 1
-        @config[args[0]]
-      else
-        @config
-      end
-    end
-
-    alias_method :C, :configuration
-  end
 end
 
-require_relative "prawn/version"
+require_relative 'prawn/version'
 
-require_relative "prawn/errors"
+require_relative 'prawn/errors'
 
-require_relative "prawn/utilities"
-require_relative "prawn/text"
-require_relative "prawn/graphics"
-require_relative "prawn/images"
-require_relative "prawn/images/image"
-require_relative "prawn/images/jpg"
-require_relative "prawn/images/png"
-require_relative "prawn/stamp"
-require_relative "prawn/soft_mask"
-require_relative "prawn/security"
-require_relative "prawn/transformation_stack"
-require_relative "prawn/document"
-require_relative "prawn/font"
-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"
+require_relative 'prawn/utilities'
+require_relative 'prawn/text'
+require_relative 'prawn/graphics'
+require_relative 'prawn/images'
+require_relative 'prawn/images/image'
+require_relative 'prawn/images/jpg'
+require_relative 'prawn/images/png'
+require_relative 'prawn/stamp'
+require_relative 'prawn/soft_mask'
+require_relative 'prawn/security'
+require_relative 'prawn/transformation_stack'
+require_relative 'prawn/document'
+require_relative 'prawn/font'
+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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # document.rb : Implements PDF document generation for Prawn
 #
@@ -6,21 +6,21 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require "stringio"
+require 'stringio'
 
-require_relative "document/bounding_box"
-require_relative "document/column_box"
-require_relative "document/internals"
-require_relative "document/span"
+require_relative 'document/bounding_box'
+require_relative 'document/column_box'
+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
-  # are through assignment, implicit block or explicit block.  Below is an exmple
-  # of each type, each example does exactly the same thing, makes a PDF document
-  # with all the defaults and puts in the default font "Hello There" and then
-  # saves it to the current directory as "example.pdf"
+  # are through assignment, implicit block or explicit block.  Below is an
+  # example of each type, each example does exactly the same thing, makes a PDF
+  # document with all the defaults and puts in the default font "Hello There"
+  # and then saves it to the current directory as "example.pdf"
   #
   # For example, assignment can be like this:
   #
@@ -42,8 +42,8 @@ module Prawn
   #     pdf.text words
   #   end
   #
-  # Usually, the block forms are used when you are simply creating a PDF document
-  # that you want to immediately save or render out.
+  # Usually, the block forms are used when you are simply creating a PDF
+  # document that you want to immediately save or render out.
   #
   # See the new and generate methods for further details on the above.
   #
@@ -64,10 +64,12 @@ module Prawn
     # NOTE: We probably need to rethink the options validation system, but this
     # constant temporarily allows for extensions to modify the list.
 
-    VALID_OPTIONS = [:page_size, :page_layout, :margin, :left_margin,
-                     :right_margin, :top_margin, :bottom_margin, :skip_page_creation,
-                     :compress, :background, :info,
-                     :text_formatter, :print_scaling]
+    VALID_OPTIONS = %i[
+      page_size page_layout margin left_margin
+      right_margin top_margin bottom_margin skip_page_creation
+      compress background info
+      text_formatter print_scaling
+    ].freeze
 
     # Any module added to this array will be included into instances of
     # Prawn::Document at the per-object level.  These will also be inherited by
@@ -96,6 +98,7 @@ module Prawn
 
     # @private
     def self.inherited(base)
+      super
       extensions.each { |e| base.extensions << e }
     end
 
@@ -153,15 +156,22 @@ module Prawn
     # <tt>:right_margin</tt>:: Sets the right margin in points [0.5 inch]
     # <tt>:top_margin</tt>:: Sets the top margin in points [0.5 inch]
     # <tt>:bottom_margin</tt>:: Sets the bottom margin in points [0.5 inch]
-    # <tt>:skip_page_creation</tt>:: Creates a document without starting the first page [false]
-    # <tt>:compress</tt>:: Compresses content streams before rendering them [false]
-    # <tt>:background</tt>:: An image path to be used as background on all pages [nil]
+    # <tt>:skip_page_creation</tt>:: Creates a document without starting the
+    #                                first page [false]
+    # <tt>:compress</tt>:: Compresses content streams before rendering them
+    #                      [false]
+    # <tt>:background</tt>:: An image path to be used as background on all pages
+    #                        [nil]
     # <tt>:background_scale</tt>:: Backgound image scale [1] [nil]
-    # <tt>:info</tt>:: Generic hash allowing for custom metadata properties [nil]
-    # <tt>:text_formatter</tt>: The text formatter to use for <tt>:inline_format</tt>ted text [Prawn::Text::Formatted::Parser]
+    # <tt>:info</tt>:: Generic hash allowing for custom metadata properties
+    #                  [nil]
+    # <tt>:text_formatter</tt>: The text formatter to use for
+    #                           <tt>:inline_format</tt>ted text
+    #                           [Prawn::Text::Formatted::Parser]
     #
-    # Setting e.g. the :margin to 100 points and the :left_margin to 50 will result in margins
-    # of 100 points on every side except for the left, where it will be 50.
+    # Setting e.g. the :margin to 100 points and the :left_margin to 50 will
+    # result in margins of 100 points on every side except for the left, where
+    # it will be 50.
     #
     # The :margin can also be an array much like CSS shorthand:
     #
@@ -172,8 +182,8 @@ module Prawn
     #   # Top is 10, right is 20, bottom is 30, left is 40.
     #   :margin => [10, 20, 30, 40]
     #
-    # Additionally, :page_size can be specified as a simple two value array giving
-    # the width and height of the document you need in PDF Points.
+    # Additionally, :page_size can be specified as a simple two value array
+    # giving the width and height of the document you need in PDF Points.
     #
     # Usage:
     #
@@ -181,13 +191,15 @@ module Prawn
     #   pdf = Prawn::Document.new
     #
     #   # New document, A4 paper, landscaped
-    #   pdf = Prawn::Document.new(:page_size => "A4", :page_layout => :landscape)
+    #   pdf = Prawn::Document.new(page_size: "A4", page_layout: :landscape)
     #
     #   # New document, Custom size
-    #   pdf = Prawn::Document.new(:page_size => [200, 300])
+    #   pdf = Prawn::Document.new(page_size: [200, 300])
     #
     #   # New document, with background
-    #   pdf = Prawn::Document.new(:background => "#{Prawn::DATADIR}/images/pigs.jpg")
+    #   pdf = Prawn::Document.new(
+    #     background: "#{Prawn::DATADIR}/images/pigs.jpg"
+    #   )
     #
     def initialize(options = {}, &block)
       options = options.dup
@@ -199,21 +211,22 @@ module Prawn
 
       self.class.extensions.reverse_each { |e| extend e }
       self.state = PDF::Core::DocumentState.new(options)
-      self.state.populate_pages_from_store(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
 
       @background = options[:background]
       @background_scale = options[:background_scale] || 1
-      @font_size  = 12
+      @font_size = 12
 
-      @bounding_box  = nil
-      @margin_box    = nil
+      @bounding_box = nil
+      @margin_box = nil
 
       @page_number = 0
 
-      @text_formatter = options.delete(:text_formatter) || Text::Formatted::Parser
+      @text_formatter = options.delete(:text_formatter) ||
+        Text::Formatted::Parser
 
       options[:size] = options.delete(:page_size)
       options[:layout] = options.delete(:page_layout)
@@ -240,24 +253,28 @@ module Prawn
     #   pdf.start_new_page(:margin => 100)
     #
     def start_new_page(options = {})
-      if last_page = state.page
-        last_page_size    = last_page.size
-        last_page_layout  = last_page.layout
+      last_page = state.page
+      if last_page
+        last_page_size = last_page.size
+        last_page_layout = last_page.layout
         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
+        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
+        if last_page.graphic_state
+          new_graphic_state = last_page.graphic_state.dup
+        end
 
-        # 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
+        # erase the color space so that it gets reset on new page for fussy
+        # pdf-readers
+        new_graphic_state&.color_space = {}
 
-        page_options.merge!(:graphic_state => new_graphic_state)
+        page_options[:graphic_state] = new_graphic_state
       end
 
       state.page = PDF::Core::Page.new(self, page_options)
@@ -277,7 +294,11 @@ module Prawn
         state.insert_page(state.page, @page_number)
         @page_number += 1
 
-        canvas { image(@background, :scale => @background_scale, :at => bounds.top_left) } if @background
+        if @background
+          canvas do
+            image(@background, scale: @background_scale, at: bounds.top_left)
+          end
+        end
         @y = @bounding_box.absolute_top
 
         float do
@@ -286,6 +307,26 @@ module Prawn
       end
     end
 
+    # Remove page of the document by index
+    #
+    #   pdf = Prawn::Document.new
+    #   pdf.page_count #=> 1
+    #   3.times { pdf.start_new_page }
+    #   pdf.page_count #=> 4
+    #   pdf.delete_page(-1)
+    #   pdf.page_count #=> 3
+    #
+    def delete_page(index)
+      return false if index.abs > (state.pages.count - 1)
+
+      state.pages.delete_at(index)
+
+      state.store.pages.data[:Kids].delete_at(index)
+      state.store.pages.data[:Count] -= 1
+      @page_number -= 1
+      true
+    end
+
     # Returns the number of pages in the document
     #
     #   pdf = Prawn::Document.new
@@ -302,9 +343,9 @@ module Prawn
     #
     # See Prawn::Document#number_pages for a sample usage of this capability.
     #
-    def go_to_page(k)
-      @page_number = k
-      state.page = state.pages[k - 1]
+    def go_to_page(page_number)
+      @page_number = page_number
+      state.page = state.pages[page_number - 1]
       generate_margin_box
       @y = @bounding_box.absolute_top
     end
@@ -351,13 +392,13 @@ module Prawn
     # Renders the PDF document to string.
     # Pass an open file descriptor to render to file.
     #
-    def render(*a, &b)
+    def render(*arguments, &block)
       (1..page_count).each do |i|
         go_to_page i
         repeaters.each { |r| r.run(i) }
       end
 
-      renderer.render(*a, &b)
+      renderer.render(*arguments, &block)
     end
 
     # Renders the PDF document to file.
@@ -365,7 +406,7 @@ module Prawn
     #   pdf.render_file "foo.pdf"
     #
     def render_file(filename)
-      File.open(filename, "wb") { |f| render(f) }
+      File.open(filename, 'wb') { |f| render(f) }
     end
 
     # The bounds method returns the current bounding box you are currently in,
@@ -374,14 +415,15 @@ module Prawn
     # block, the box defined by that call will be returned instead of the
     # document margin box.
     #
-    # Another important point about bounding boxes is that all x and y measurements
-    # within a bounding box code block are relative to the bottom left corner of the
-    # bounding box.
+    # Another important point about bounding boxes is that all x and
+    # y measurements within a bounding box code block are relative to the bottom
+    # left corner of the bounding box.
     #
     # For example:
     #
     #  Prawn::Document.new do
-    #    # In the default "margin box" of a Prawn document of 0.5in along each edge
+    #    # In the default "margin box" of a Prawn document of 0.5in along each
+    #    # edge
     #
     #    # Draw a border around the page (the manual way)
     #    stroke do
@@ -408,8 +450,8 @@ module Prawn
 
     # Sets Document#bounds to the BoundingBox provided.  See above for a brief
     # description of what a bounding box is.  This function is useful if you
-    # really need to change the bounding box manually, but usually, just entering
-    # and exiting bounding box code blocks is good enough.
+    # really need to change the bounding box manually, but usually, just
+    # entering and exiting bounding box code blocks is good enough.
     #
     def bounds=(bounding_box)
       @bounding_box = bounding_box
@@ -418,15 +460,15 @@ module Prawn
     # Moves up the document by n points relative to the current position inside
     # the current bounding box.
     #
-    def move_up(n)
-      self.y += n
+    def move_up(amount)
+      self.y += amount
     end
 
-    # Moves down the document by n points relative to the current position inside
-    # the current bounding box.
+    # Moves down the document by n points relative to the current position
+    # inside the current bounding box.
     #
-    def move_down(n)
-      self.y -= n
+    def move_down(amount)
+      self.y -= amount
     end
 
     # Moves down the document and then executes a block.
@@ -486,50 +528,55 @@ module Prawn
       bounds.indent(left, right, &block)
     end
 
-    # Places a text box on specified pages for page numbering.  This should be called
-    # towards the end of document creation, after all your content is already in
-    # place.  In your template string, <page> refers to the current page, and
-    # <total> refers to the total amount of pages in the document.  Page numbering should
-    # occur at the end of your Prawn::Document.generate block because the method iterates
-    # through existing pages after they are created.
+    # Places a text box on specified pages for page numbering.  This should be
+    # called towards the end of document creation, after all your content is
+    # already in place.  In your template string, <page> refers to the current
+    # page, and <total> refers to the total amount of pages in the document.
+    # Page numbering should occur at the end of your Prawn::Document.generate
+    # block because the method iterates through existing pages after they are
+    # created.
     #
     # Parameters are:
     #
     # <tt>string</tt>:: Template string for page number wording.
     #                   Should include '<page>' and, optionally, '<total>'.
     # <tt>options</tt>:: A hash for page numbering and text box options.
-    #     <tt>:page_filter</tt>:: A filter to specify which pages to place page numbers on.
-    #                             Refer to the method 'page_match?'
+    #     <tt>:page_filter</tt>:: A filter to specify which pages to place page
+    #                             numbers on. Refer to the method 'page_match?'
     #     <tt>:start_count_at</tt>:: The starting count to increment pages from.
-    #     <tt>:total_pages</tt>:: If provided, will replace <total> with the value given.
-    #                             Useful to override the total number of pages when using
-    #                             the start_count_at option.
+    #     <tt>:total_pages</tt>:: If provided, will replace <total> with the
+    #                             value given. Useful to override the total
+    #                             number of pages when using the start_count_at
+    #                             option.
     #     <tt>:color</tt>:: Text fill color.
     #
-    #     Please refer to Prawn::Text::text_box for additional options concerning text
-    #     formatting and placement.
-    #
-    # Example: Print page numbers on every page except for the first.  Start counting from
-    #          five.
+    #     Please refer to Prawn::Text::text_box for additional options
+    #     concerning text formatting and placement.
     #
-    #   Prawn::Document.generate("page_with_numbering.pdf") do
-    #     number_pages "<page> in a total of <total>",
-    #                                          {:start_count_at => 5,
-    #                                           :page_filter => lambda{ |pg| pg != 1 },
-    #                                           :at => [bounds.right - 50, 0],
-    #                                           :align => :right,
-    #                                           :size => 14}
-    #   end
+    # Example:
+    #   Print page numbers on every page except for the first. Start counting
+    #   from five.
+    #
+    #     Prawn::Document.generate("page_with_numbering.pdf") do
+    #       number_pages "<page> in a total of <total>", {
+    #         start_count_at: 5,
+    #         page_filter: lambda { |pg| pg != 1 },
+    #         at: [bounds.right - 50, 0],
+    #         align: :right,
+    #         size: 14
+    #       }
+    #     end
     #
     def number_pages(string, options = {})
       opts = options.dup
       start_count_at = opts.delete(:start_count_at).to_i
 
-      if opts.key?(:page_filter)
-        page_filter = opts.delete(:page_filter)
-      else
-        page_filter = :all
-      end
+      page_filter =
+        if opts.key?(:page_filter)
+          opts.delete(:page_filter)
+        else
+          :all
+        end
 
       total_pages = opts.delete(:total_pages)
       txtcolor = opts.delete(:color)
@@ -540,21 +587,24 @@ module Prawn
       pseudopage = 0
       (1..page_count).each do |p|
         unless start_count
-          pseudopage = case start_count_at
-                       when 0
-                         1
-                       else
-                         start_count_at.to_i
-                       end
+          pseudopage =
+            case start_count_at
+            when 0
+              1
+            else
+              start_count_at.to_i
+            end
         end
         if page_match?(page_filter, p)
           go_to_page(p)
-          # have to use fill_color here otherwise text reverts back to default fill color
+          # 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.to_s)
+            .gsub('<total>', total_pages.to_s)
           text_box str, opts
-          start_count = true  # increment page count as soon as first match found
+          start_count = true # increment page count as soon as first match found
         end
         pseudopage += 1 if start_count
       end
@@ -572,21 +622,21 @@ module Prawn
     # the current page or column.
     #
     # @private
-    def group(*a, &b)
-      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"
+    def group(*_arguments)
+      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'
     end
 
     # @private
     def transaction
-      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"
+      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'
     end
 
     # Provides a way to execute a block of code repeatedly based on a
@@ -617,20 +667,20 @@ 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.
+      # 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) }
+      fields.each { |f| stored[f] = public_send(f) }
       yield
-      fields.each { |f| send("#{f}=", stored[f]) }
+      fields.each { |f| public_send("#{f}=", stored[f]) }
     end
 
     # @group Extension API
 
     def initialize_first_page(options)
       if options[:skip_page_creation]
-        start_new_page(options.merge(:orphan => true))
+        start_new_page(options.merge(orphan: true))
       else
         start_new_page(options)
       end
@@ -648,11 +698,11 @@ module Prawn
 
     private
 
-    # setting override_settings to true ensures that a new graphic state does not end up using
-    # previous settings.
+    # 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)
-      set_fill_color if current_fill_color != "000000" || override_settings
-      set_stroke_color if current_stroke_color != "000000" || override_settings
+      set_fill_color if current_fill_color != '000000' || override_settings
+      set_stroke_color if current_stroke_color != '000000' || override_settings
       write_line_width if line_width != 1 || override_settings
       write_stroke_cap_style if cap_style != :butt || override_settings
       write_stroke_join_style if join_style != :miter || override_settings
@@ -661,14 +711,16 @@ module Prawn
 
     def generate_margin_box
       old_margin_box = @margin_box
-      page           = state.page
+      page = state.page
 
       @margin_box = BoundingBox.new(
         self,
-        nil,  # margin box has no parent
-        [ 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])
+        nil, # margin box has no parent
+        [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])
       )
 
       # This check maintains indentation settings across page breaks
@@ -679,25 +731,25 @@ module Prawn
 
       # we must update bounding box if not flowing from the previous page
       #
-      @bounding_box = @margin_box unless @bounding_box && @bounding_box.parent
+      @bounding_box = @margin_box unless @bounding_box&.parent
     end
 
     def apply_margin_options(options)
-      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]
-
-        [: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
+      sides = %i[top right bottom left]
+      margin = Array(options[:margin])
+
+      # Treat :margin as CSS shorthand with 1-4 values.
+      positions = {
+        4 => [0, 1, 2, 3],
+        3 => [0, 1, 2, 1],
+        2 => [0, 1, 0, 1],
+        1 => [0, 0, 0, 0],
+        0 => []
+      }[margin.length]
+
+      sides.zip(positions).each do |side, pos|
+        new_margin = options[:"#{side}_margin"] || (margin[pos] if pos)
+        state.page.margins[side] = new_margin if new_margin
       end
     end