prawn 2.2.2 → 2.3.0

data/lib/prawn/graphics/transformation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # transformation.rb: Implements rotate, translate, skew, scale and a generic
 #                     transformation_matrix
 #
@@ -47,6 +49,7 @@ module Prawn
           transformation_matrix(cos, sin, -sin, cos, 0, 0, &block)
         else
           raise Prawn::Errors::BlockRequired unless block_given?
+
           x = options[:origin][0] + bounds.absolute_left
           y = options[:origin][1] + bounds.absolute_bottom
           x_prime = x * cos - y * sin
@@ -116,6 +119,7 @@ module Prawn
           transformation_matrix(factor, 0, 0, factor, 0, 0, &block)
         else
           raise Prawn::Errors::BlockRequired unless block_given?
+
           x = options[:origin][0] + bounds.absolute_left
           y = options[:origin][1] + bounds.absolute_bottom
           x_prime = factor * x
@@ -145,7 +149,7 @@ module Prawn
           raise ArgumentError,
             'Transformation matrix must have exacty 6 elements'
         end
-        values = matrix.map { |x| format '%.5f', x }.join(' ')
+        values = matrix.map { |x| x.to_f.round(5) }.join(' ')
         save_graphics_state if block_given?
 
         add_to_transformation_stack(*matrix)

data/lib/prawn/graphics/transparency.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # transparency.rb : Implements transparency
 #
 # Copyright October 2009, Daniel Nelson. All Rights Reserved.

data/lib/prawn/grid.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # grid.rb: Provides a basic grid layout system for Prawn
 #
 # Contributed by Andrew O'Brien in March 2009
@@ -31,22 +33,21 @@ module Prawn
     #
     def grid(*args)
       @boxes ||= {}
-      return @boxes[args] if @boxes[args]
-
-      if args.empty?
-        @boxes[args] = @grid
-      else
-        g1, g2 = args
-
-        if g1.is_a?(Array) && g2.is_a?(Array) && g1.length == 2 &&
-            g2.length == 2
-          @boxes[args] = multi_box(single_box(*g1), single_box(*g2))
-        else
-          @boxes[args] = single_box(g1, g2)
+      @boxes[args] ||=
+        begin
+          if args.empty?
+            @grid
+          else
+            g1, g2 = args
+
+            if g1.is_a?(Array) && g2.is_a?(Array) &&
+                g1.length == 2 && g2.length == 2
+              multi_box(single_box(*g1), single_box(*g2))
+            else
+              single_box(g1, g2)
+            end
+          end
         end
-      end
-
-      @boxes[args]
     end
 
     # A Grid represents the entire grid system of a Page and calculates
@@ -56,7 +57,7 @@ module Prawn
     class Grid
       attr_reader :pdf, :columns, :rows, :gutter, :row_gutter, :column_gutter
       def initialize(pdf, options = {}) # :nodoc:
-        valid_options = [:columns, :rows, :gutter, :row_gutter, :column_gutter]
+        valid_options = %i[columns rows gutter row_gutter column_gutter]
         Prawn.verify_options valid_options, options
 
         @pdf = pdf
@@ -77,9 +78,9 @@ module Prawn
 
       # Diagnostic tool to show all of the grids.  Defaults to gray.
       def show_all(color = 'CCCCCC')
-        rows.times do |i|
-          columns.times do |j|
-            pdf.grid(i, j).show(color)
+        rows.times do |row|
+          columns.times do |column|
+            pdf.grid(row, column).show(color)
           end
         end
       end
@@ -111,17 +112,17 @@ module Prawn
     class GridBox
       attr_reader :pdf
 
-      def initialize(pdf, i, j)
+      def initialize(pdf, rows, columns)
         @pdf = pdf
-        @i = i
-        @j = j
+        @rows = rows
+        @columns = columns
       end
 
       # Mostly diagnostic method that outputs the name of a box as
       # col_num, row_num
       #
       def name
-        "#{@i},#{@j}"
+        "#{@rows},#{@columns}"
       end
 
       # :nodoc
@@ -146,7 +147,7 @@ module Prawn
 
       # x-coordinate of left side
       def left
-        @left ||= (width + grid.column_gutter) * @j.to_f
+        @left ||= (width + grid.column_gutter) * @columns.to_f
       end
 
       # x-coordinate of right side
@@ -156,7 +157,7 @@ module Prawn
 
       # y-coordinate of the top
       def top
-        @top ||= total_height - ((height + grid.row_gutter) * @i.to_f)
+        @top ||= total_height - ((height + grid.row_gutter) * @rows.to_f)
       end
 
       # y-coordinate of the bottom
@@ -213,17 +214,17 @@ module Prawn
     #
     # @group Experimental API
     class MultiBox < GridBox
-      def initialize(pdf, b1, b2)
+      def initialize(pdf, box1, box2)
         @pdf = pdf
-        @bs = [b1, b2]
+        @boxes = [box1, box2]
       end
 
       def name
-        @bs.map(&:name).join(':')
+        @boxes.map(&:name).join(':')
       end
 
       def total_height
-        @bs[0].total_height
+        @boxes[0].total_height
       end
 
       def width
@@ -235,7 +236,7 @@ module Prawn
       end
 
       def gutter
-        @bs[0].gutter
+        @boxes[0].gutter
       end
 
       def left
@@ -257,30 +258,30 @@ module Prawn
       private
 
       def left_box
-        @left_box ||= @bs.min_by(&:left)
+        @left_box ||= @boxes.min_by(&:left)
       end
 
       def right_box
-        @right_box ||= @bs.max_by(&:right)
+        @right_box ||= @boxes.max_by(&:right)
       end
 
       def top_box
-        @top_box ||= @bs.max_by(&:top)
+        @top_box ||= @boxes.max_by(&:top)
       end
 
       def bottom_box
-        @bottom_box ||= @bs.min_by(&:bottom)
+        @bottom_box ||= @boxes.min_by(&:bottom)
       end
     end
 
     private
 
-    def single_box(i, j)
-      GridBox.new(self, i, j)
+    def single_box(rows, columns)
+      GridBox.new(self, rows, columns)
     end
 
-    def multi_box(b1, b2)
-      MultiBox.new(self, b1, b2)
+    def multi_box(box1, box2)
+      MultiBox.new(self, box1, box2)
     end
   end
 end

data/lib/prawn/image_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # ImageHandler provides a way to register image processors with Prawn
 #
 # Contributed by Evan Sharp in November 2013.

data/lib/prawn/images.rb

@@ -1,4 +1,7 @@
 # encoding: ASCII-8BIT
+
+# frozen_string_literal: true
+
 # images.rb : Implements PDF image embedding
 #
 # Copyright April 2008, James Healy, Gregory Brown.  All Rights Reserved.
@@ -63,9 +66,9 @@ module Prawn
     # (See also: Prawn::Images::PNG , Prawn::Images::JPG)
     #
     def image(file, options = {})
-      Prawn.verify_options [
-        :at, :position, :vposition, :height,
-        :width, :scale, :fit
+      Prawn.verify_options %i[
+        at position vposition height
+        width scale fit
       ], options
 
       pdf_obj, info = build_image_object(file)
@@ -79,8 +82,7 @@ module Prawn
     #
     # @private
     def build_image_object(file)
-      io = verify_and_open_image(file)
-      image_content = io.read
+      image_content = verify_and_read_image(file)
       image_sha1 = Digest::SHA1.hexdigest(image_content)
 
       # if this image has already been embedded, just reuse it
@@ -132,7 +134,7 @@ module Prawn
 
     private
 
-    def verify_and_open_image(io_or_path)
+    def verify_and_read_image(io_or_path)
       # File or IO
       if io_or_path.respond_to?(:rewind)
         io = io_or_path
@@ -142,38 +144,38 @@ module Prawn
         # read the file as binary so the size is calculated correctly
         # guard binmode because some objects acting io-like don't implement it
         io.binmode if io.respond_to?(:binmode)
-        return io
+        return io.read
       end
       # String or Pathname
       io_or_path = Pathname.new(io_or_path)
       raise ArgumentError, "#{io_or_path} not found" unless io_or_path.file?
-      io = io_or_path.open('rb')
-      io
+
+      io_or_path.binread
     end
 
-    def image_position(w, h, options)
+    def image_position(width, height, options)
       options[:position] ||= :left
 
       y = case options[:vposition]
           when :top
             bounds.absolute_top
           when :center
-            bounds.absolute_top - (bounds.height - h) / 2.0
+            bounds.absolute_top - (bounds.height - height) / 2.0
           when :bottom
-            bounds.absolute_bottom + h
+            bounds.absolute_bottom + height
           when Numeric
             bounds.absolute_top - options[:vposition]
           else
-            determine_y_with_page_flow(h)
+            determine_y_with_page_flow(height)
           end
 
       x = case options[:position]
           when :left
             bounds.left_side
           when :center
-            bounds.left_side + (bounds.width - w) / 2.0
+            bounds.left_side + (bounds.width - width) / 2.0
           when :right
-            bounds.right_side - w
+            bounds.right_side - width
           when Numeric
             options[:position] + bounds.left_side
           end
@@ -181,15 +183,15 @@ module Prawn
       [x, y]
     end
 
-    def determine_y_with_page_flow(h)
-      if overruns_page?(h)
+    def determine_y_with_page_flow(height)
+      if overruns_page?(height)
         bounds.move_past_bottom
       end
       y
     end
 
-    def overruns_page?(h)
-      (y - h) < reference_bounds.absolute_bottom
+    def overruns_page?(height)
+      (y - height) < reference_bounds.absolute_bottom
     end
 
     def image_registry

data/lib/prawn/images/image.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # image.rb : Base class for image info objects
 #
 # Copyright September 2011, Brad Ediger. All rights reserved.

data/lib/prawn/images/jpg.rb

@@ -1,5 +1,7 @@
 # encoding: ASCII-8BIT
 
+# frozen_string_literal: true
+
 # jpg.rb : Extracts the data from a JPG that is needed for embedding
 #
 # Copyright April 2008, James Healy.  All Rights Reserved.

data/lib/prawn/images/png.rb

@@ -1,5 +1,7 @@
 # encoding: ASCII-8BIT
 
+# frozen_string_literal: true
+
 # png.rb : Extracts the data from a PNG that is needed for embedding
 #
 # Based on some similar code in PDF::Writer by Austin Ziegler
@@ -9,8 +11,6 @@
 # This is free software. Please see the LICENSE and COPYING files for details.
 
 require 'stringio'
-require 'enumerator'
-
 module Prawn
   module Images
     # A convenience class that wraps the logic for extracting the parts
@@ -38,12 +38,12 @@ module Prawn
 
         data.read(8) # Skip the default header
 
-        @palette = ''
-        @img_data = ''
+        @palette = +''
+        @img_data = +''
         @transparency = {}
 
         loop do
-          chunk_size = data.read(4).unpack('N')[0]
+          chunk_size = data.read(4).unpack1('N')
           section = data.read(4)
           case section
           when 'IHDR'
@@ -72,7 +72,7 @@ module Prawn
             when 0
               # Greyscale. Corresponding to entries in the PLTE chunk.
               # Grey is two bytes, range 0 .. (2 ^ bit-depth) - 1
-              grayval = data.read(chunk_size).unpack('n').first
+              grayval = data.read(chunk_size).unpack1('n')
               @transparency[:grayscale] = grayval
             when 2
               # True colour with proper alpha channel.
@@ -97,9 +97,9 @@ module Prawn
       def colors
         case color_type
         when 0, 3, 4
-          return 1
+          1
         when 2, 6
-          return 3
+          3
         end
       end
 
@@ -321,7 +321,7 @@ module Prawn
           alpha.putc filter
 
           width.times do
-            color = data.read(1).unpack('C').first
+            color = data.read(1).unpack1('C')
             alpha.putc alpha_palette[color]
           end
         end

data/lib/prawn/measurement_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # measurement_extensions.rb: Core extensions for Prawn::Measurements
 #
 # Copyright December 2008, Florian Witteler.  All Rights Reserved.

data/lib/prawn/measurements.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 # measurements.rb: Conversions from other measurements to PDF points
 #
 # Copyright December 2008, Florian Witteler.  All Rights Reserved.
 #
+
+# rubocop: disable Naming/MethodParameterName
 module Prawn
   # @group Stable API
 
@@ -67,3 +71,4 @@ module Prawn
     end
   end
 end
+# rubocop: enable Naming/MethodParameterName

data/lib/prawn/outline.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Prawn
   class Document
     # @group Stable API

data/lib/prawn/repeater.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # repeater.rb : Implements repeated page elements.
 # Heavy inspired by repeating_element() in PDF::Wrapper
 #   http://pdf-wrapper.rubyforge.org/

data/lib/prawn/security.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # encryption.rb : Implements encrypted PDF and access permissions.
 #
 # Copyright August 2008, Brad Ediger. All Rights Reserved.
@@ -6,8 +8,6 @@
 
 require 'digest/md5'
 
-require 'pdf/core/byte_string'
-
 require_relative 'security/arcfour'
 
 module Prawn
@@ -86,7 +86,7 @@ module Prawn
       #   PDF format.
       #
       def encrypt_document(options = {})
-        Prawn.verify_options [:user_password, :owner_password, :permissions],
+        Prawn.verify_options %i[user_password owner_password permissions],
           options
         @user_password = options.delete(:user_password) || ''
 
@@ -133,28 +133,30 @@ module Prawn
       end
 
       # Flags in the permissions word, numbered as LSB = 1
-      PermissionsBits = {
+      PERMISSIONS_BITS = {
         print_document: 3,
         modify_contents: 4,
         copy_contents: 5,
         modify_annotations: 6
       }.freeze
+      private_constant :PERMISSIONS_BITS
 
       FULL_PERMISSIONS = 0b1111_1111_1111_1111_1111_1111_1111_1111
+      private_constant :FULL_PERMISSIONS
 
       def permissions=(perms = {})
         @permissions ||= FULL_PERMISSIONS
         perms.each do |key, value|
-          unless PermissionsBits[key]
+          unless PERMISSIONS_BITS[key]
             raise(
               ArgumentError,
               "Unknown permission :#{key}. Valid options: " +
-                PermissionsBits.keys.map(&:inspect).join(', ')
+                PERMISSIONS_BITS.keys.map(&:inspect).join(', ')
             )
           end
 
           # 0-based bit number, from LSB
-          bit_position = PermissionsBits[key] - 1
+          bit_position = PERMISSIONS_BITS[key] - 1
 
           if value # set bit
             @permissions |= (1 << bit_position)
@@ -168,14 +170,14 @@ module Prawn
         @permissions || FULL_PERMISSIONS
       end
 
-      PasswordPadding =
+      PASSWORD_PADDING =
         '28BF4E5E4E758A4164004E56FFFA01082E2E00B6D0683E802F0CA9FE6453697A'
           .scan(/../).map { |x| x.to_i(16) }.pack('c*')
 
       # Pads or truncates a password to 32 bytes as per Alg 3.2.
       def pad_password(password)
         password = password[0, 32]
-        password + PasswordPadding[0, 32 - password.length]
+        password + PASSWORD_PADDING[0, 32 - password.length]
       end
 
       def user_encryption_key
@@ -198,7 +200,7 @@ module Prawn
 
       # The U (user) value in the encryption dictionary. Algorithm 3.4.
       def user_password_hash
-        Arcfour.new(user_encryption_key).encrypt(PasswordPadding)
+        Arcfour.new(user_encryption_key).encrypt(PASSWORD_PADDING)
       end
     end
   end
@@ -217,9 +219,9 @@ module PDF
     def encrypted_pdf_object(obj, key, id, gen, in_content_stream = false)
       case obj
       when Array
-        '[' << obj.map do |e|
+        '[' + obj.map do |e|
           encrypted_pdf_object(e, key, id, gen, in_content_stream)
-        end.join(' ') << ']'
+        end.join(' ') + ']'
       when LiteralString
         obj = ByteString.new(
           Prawn::Document::Security.encrypt_string(obj, key, id, gen)
@@ -239,16 +241,16 @@ module PDF
           in_content_stream
         )
       when ::Hash
-        output = '<< '
-        obj.each do |k, v|
-          unless k.is_a?(String) || k.is_a?(Symbol)
-            raise PDF::Core::Errors::FailedObjectConversion,
-              'A PDF Dictionary must be keyed by names'
-          end
-          output << pdf_object(k.to_sym, in_content_stream) << ' ' <<
-            encrypted_pdf_object(v, key, id, gen, in_content_stream) << "\n"
-        end
-        output << '>>'
+        '<< ' +
+          obj.map do |k, v|
+            unless k.is_a?(String) || k.is_a?(Symbol)
+              raise PDF::Core::Errors::FailedObjectConversion,
+                'A PDF Dictionary must be keyed by names'
+            end
+            pdf_object(k.to_sym, in_content_stream) + ' ' +
+              encrypted_pdf_object(v, key, id, gen, in_content_stream) + "\n"
+          end.join('') +
+          '>>'
       when NameTree::Value
         pdf_object(obj.name) + ' ' +
           encrypted_pdf_object(obj.value, key, id, gen, in_content_stream)
@@ -278,9 +280,9 @@ module PDF
       # Returns the object definition for the object this references, keyed from
       # +key+.
       def encrypted_object(key)
-        @on_encode.call(self) if @on_encode
+        @on_encode&.call(self)
 
-        output = "#{@identifier} #{gen} obj\n"
+        output = +"#{@identifier} #{gen} obj\n"
         if @stream.empty?
           output <<
             PDF::Core.encrypted_pdf_object(data, key, @identifier, gen) << "\n"