prawn 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 56fa98e400aa9b739c52009b0967373f0fc657e9
-  data.tar.gz: 33ec56d682263af565d208b38a4a11e99db61b16
+SHA256:
+  metadata.gz: 1dd091ffaaed7c69fe8a0353317736d1f145e91f3f133a6d04ed0cffd7b5eb37
+  data.tar.gz: 98d1b0c973c9bf1947681ea971240fe9c351a9bcc1a74c91e7f8f677510eb11c
 SHA512:
-  metadata.gz: 04a3e22e55410e60240d203d74fbb43d20daa129c3e3e5d6334abab38d619e3e69c57e37c9522a2360176de3126723e3fb96e92ba3b2225bfac593e4ef4403a9
-  data.tar.gz: 0a498d73aca1141f7b5b0e3fed25d5b94ddd27ffee63bafd16ad0634860024fd49280697aed0df1253e53f15207dd6f13006eb9e87b7f9ddcac10077872cdf04
+  metadata.gz: 9b75677d2586bf8a812549075cc9532bc02f78dc18b0e0db99711ad1087586f4fef6ae2f244e96a73366172410357d19e9371ac7b7eacf4a3bcbf85292ffb028
+  data.tar.gz: 138ac861e5016c49836a882c8beda2d2ed250e63959307ffe720624d322fd92b21ca71945e9cf58d0439851f8ebec515d13fb5f1d1660a3c9f4c996c5d04e701

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,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Rakefile

@@ -1,5 +1,4 @@
-require 'bundler'
-Bundler.setup
+# frozen_string_literal: true
 
 require 'rake'
 require 'rspec/core/rake_task'
@@ -7,7 +6,7 @@ require 'yard'
 require 'rubygems/package_task'
 require 'rubocop/rake_task'
 
-task default: [:spec, :rubocop]
+task default: %i[spec rubocop]
 
 desc 'Run all rspec files'
 RSpec::Core::RakeTask.new('spec') do |c|
@@ -45,3 +44,11 @@ task :console do
 end
 
 RuboCop::RakeTask.new
+
+task :checksum do
+  require 'digest/sha2'
+  built_gem_path = "prawn-#{Prawn::VERSION}.gem"
+  checksum = Digest::SHA512.new.hexdigest(File.read(built_gem_path))
+  checksum_path = "checksums/#{built_gem_path}.sha512"
+  File.write(checksum_path, checksum)
+end

data/lib/prawn.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Welcome to Prawn, the best PDF Generation library ever.
 # This documentation covers user level functionality.
 #
@@ -28,11 +30,16 @@ 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])
       raise Prawn::Errors::UnknownOption,
         "\nDetected unknown option(s): #{(act - acc).to_a.inspect}\n" \
@@ -40,7 +47,6 @@ module Prawn
     end
     yield if block_given?
   end
-  module_function :verify_options
 end
 
 require_relative 'prawn/version'

data/lib/prawn/document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # document.rb : Implements PDF document generation for Prawn
 #
 # Copyright April 2008, Gregory Brown.  All Rights Reserved.
@@ -62,11 +64,11 @@ 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
@@ -269,7 +271,7 @@ module Prawn
 
         # 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
+        new_graphic_state&.color_space = {}
 
         page_options[:graphic_state] = new_graphic_state
       end
@@ -304,6 +306,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
@@ -320,9 +342,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
@@ -369,13 +391,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.
@@ -437,15 +459,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.
     #
-    def move_down(n)
-      self.y -= n
+    def move_down(amount)
+      self.y -= amount
     end
 
     # Moves down the document and then executes a block.
@@ -597,7 +619,7 @@ module Prawn
     # the current page or column.
     #
     # @private
-    def group(*_a)
+    def group(*_arguments)
       raise NotImplementedError,
         'Document#group has been disabled because its implementation ' \
         'lead to corrupted documents whenever a page boundary was ' \
@@ -706,11 +728,11 @@ 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)
-      sides = [:top, :right, :bottom, :left]
+      sides = %i[top right bottom left]
       margin = Array(options[:margin])
 
       # Treat :margin as CSS shorthand with 1-4 values.

data/lib/prawn/document/bounding_box.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # bounding_box.rb : Implements a mechanism for shifting the coordinate space
 #
 # Copyright May 2008, Gregory Brown. All Rights Reserved.
@@ -153,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
 
@@ -219,7 +221,8 @@ module Prawn
     # is used for.
     #
     class BoundingBox
-      def initialize(document, parent, point, options = {}) # @private
+      # @private
+      def initialize(document, parent, point, options = {})
         unless options[:width]
           raise ArgumentError, 'BoundingBox needs the :width option to be set'
         end
@@ -457,6 +460,7 @@ module Prawn
       #
       def height
         return @height if @height
+
         @stretched_height = [
           (absolute_top - @document.y),
           @stretched_height.to_f
@@ -501,6 +505,7 @@ module Prawn
       def reference_bounds
         if stretchy?
           raise "Can't find reference bounds: my parent is unset" unless @parent
+
           @parent.reference_bounds
         else
           self

data/lib/prawn/document/column_box.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # column_box.rb: Extends BoundingBox to allow for columns of text
 #
 # Author Paul Ostazeski.

data/lib/prawn/document/internals.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # internals.rb : Implements document internals for Prawn
 #
 # Copyright August 2008, Gregory Brown. All Rights Reserved.
@@ -21,9 +23,9 @@ 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,
-        :on_page_create
+      delegate %i[
+        graphic_state
+        on_page_create
       ] => :renderer
 
       def save_graphics_state(state = nil, &block)
@@ -45,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,3 +1,5 @@
+# frozen_string_literal: true
+
 # span.rb : Implements text columns
 #
 # Copyright September 2008, Gregory Brown. All Rights Reserved.

data/lib/prawn/encoding.rb

@@ -1,9 +1,12 @@
+# 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:

data/lib/prawn/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # errors.rb : Implements custom error classes for Prawn
 #
 # Copyright April 2008, Gregory Brown.  All Rights Reserved.

data/lib/prawn/font.rb

@@ -1,13 +1,11 @@
+# frozen_string_literal: true
+
 # font.rb : The Prawn font class
 #
 # Copyright May 2008, Gregory Brown / James Healy. All Rights Reserved.
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 #
-require_relative 'font/afm'
-require_relative 'font/ttf'
-require_relative 'font/dfont'
-require_relative 'font/ttc'
 require_relative 'font_metric_cache'
 
 module Prawn
@@ -35,7 +33,7 @@ module Prawn
     #
     # The :name parameter must be a string. It can be one of the 14 built-in
     # fonts supported by PDF, or the location of a TTF file. The
-    # Font::AFM::BUILT_INS array specifies the valid built in font values.
+    # Fonts::AFM::BUILT_INS array specifies the valid built in font values.
     #
     # If a ttf font is specified, the glyphs necessary to render your document
     # will be embedded in the rendered PDF. This should be your preferred option
@@ -96,6 +94,7 @@ module Prawn
     #
     def font_size(points = nil)
       return @font_size unless points
+
       size_before_yield = @font_size
       @font_size = points
       block_given? ? yield : return
@@ -280,6 +279,18 @@ module Prawn
   # Provides font information and helper functions.
   #
   class Font
+    require_relative 'fonts/afm'
+    require_relative 'fonts/ttf'
+    require_relative 'fonts/dfont'
+    require_relative 'fonts/otf'
+    require_relative 'fonts/ttc'
+
+    # @deprecated
+    AFM = Fonts::AFM
+    TTF = Fonts::TTF
+    DFont = Fonts::DFont
+    TTC = Fonts::TTC
+
     # The current font name
     attr_reader :name
 
@@ -290,14 +301,15 @@ module Prawn
     attr_reader :options
 
     # Shortcut interface for constructing a font object.  Filenames of the form
-    # *.ttf will call Font::TTF.new, *.dfont Font::DFont.new, *.ttc goes to
-    # Font::TTC.new, and anything else will be passed through to
-    # Font::AFM.new()
+    # *.ttf will call Fonts::TTF.new, *.dfont Fonts::DFont.new, *.ttc goes to
+    # Fonts::TTC.new, and anything else will be passed through to
+    # Fonts::AFM.new()
     def self.load(document, src, options = {})
       case font_format(src, options)
-      when 'ttf'   then TTF.new(document, src, options)
+      when 'ttf' then TTF.new(document, src, options)
+      when 'otf' then Fonts::OTF.new(document, src, options)
       when 'dfont' then DFont.new(document, src, options)
-      when 'ttc'   then TTC.new(document, src, options)
+      when 'ttc' then TTC.new(document, src, options)
       else AFM.new(document, src, options)
       end
     end
@@ -306,10 +318,11 @@ module Prawn
       return options.fetch(:format, 'ttf') if src.respond_to? :read
 
       case src.to_s
-      when /\.ttf$/i   then return 'ttf'
-      when /\.dfont$/i then return 'dfont'
-      when /\.ttc$/i   then return 'ttc'
-      else return 'afm'
+      when /\.ttf$/i   then 'ttf'
+      when /\.otf$/i   then 'otf'
+      when /\.dfont$/i then 'dfont'
+      when /\.ttc$/i   then 'ttc'
+      else 'afm'
       end
     end
 
@@ -355,8 +368,11 @@ module Prawn
     # Destructive version of normalize_encoding; normalizes the encoding of a
     # string in place.
     #
+    # @deprecated
     def normalize_encoding!(str)
-      str.replace(normalize_encoding(str))
+      warn 'Font#normalize_encoding! is deprecated. ' \
+        'Please use non-mutating version Font#normalize_encoding instead.'
+      str.dup.replace(normalize_encoding(str))
     end
 
     # Gets height of current font in PDF points at the given font size
@@ -384,7 +400,7 @@ module Prawn
     end
 
     def identifier_for(subset) #:nodoc:
-      "#{@identifier}.#{subset}"
+      "#{@identifier}.#{subset}".to_sym
     end
 
     def inspect #:nodoc:
@@ -417,13 +433,14 @@ module Prawn
       loop do
         key = :"F#{font_count}"
         break if key_is_unique?(key)
+
         font_count += 1
       end
       key
     end
 
     def key_is_unique?(test_key)
-      !@document.state.page.fonts.keys.any? do |key|
+      @document.state.page.fonts.keys.none? do |key|
         key.to_s.start_with?("#{test_key}.")
       end
     end