prawn 2.2.2 → 2.3.0

data/lib/prawn/security/arcfour.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Implementation of the "ARCFOUR" algorithm ("alleged RC4 (tm)"). Implemented
 # as described at:
 # http://www.mozilla.org/projects/security/pki/nss/draft-kaukonen-cipher-arcfour-03.txt

data/lib/prawn/soft_mask.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # soft_mask.rb : Implements soft-masking
 #
 # Copyright September 2012, Alexander Mankuta. All Rights Reserved.
@@ -73,7 +75,7 @@ module Prawn
         renderer.add_content "/#{soft_mask_registry[registry_key]} gs"
       else
         masks = page.resources[:ExtGState] ||= {}
-        id = masks.empty? ? 'GS1' : masks.keys.sort.last.succ
+        id = masks.empty? ? 'GS1' : masks.keys.max.succ
         masks[id] = g_state
 
         soft_mask_registry[registry_key] = id

data/lib/prawn/stamp.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # stamp.rb : Implements a repeatable stamp
 #
 # Copyright October 2009, Daniel Nelson. All Rights Reserved.
@@ -105,6 +107,7 @@ module Prawn
     def create_stamp_dictionary(name)
       raise Prawn::Errors::InvalidName if name.empty?
       raise Prawn::Errors::NameTaken unless stamp_dictionary_registry[name].nil?
+
       # BBox origin is the lower left margin of the page, so we need
       # it to be the full dimension of the page, or else things that
       # should appear near the top or right margin are invisible
@@ -131,7 +134,7 @@ module Prawn
     # to the /Annot dictionary of the object that contains the
     # call to the stamp object.
     def update_annotation_references(annots)
-      if annots && annots.any?
+      if annots&.any?
         state.page.dictionary.data[:Annots] ||= []
         state.page.dictionary.data[:Annots] |= annots
       end

data/lib/prawn/text.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # text.rb : Implements PDF text primitives
 #
 # Copyright May 2008, Gregory Brown. All Rights Reserved.
@@ -6,8 +8,6 @@
 
 require 'zlib'
 
-require 'pdf/core/text'
-
 require_relative 'text/formatted'
 require_relative 'text/box'
 
@@ -17,11 +17,11 @@ module Prawn
     include Prawn::Text::Formatted
 
     # No-Break Space
-    NBSP = "\u00A0".freeze
+    NBSP = "\u00A0"
     # Zero Width Space (indicate word boundaries without a space)
-    ZWSP = "\u200B".freeze
+    ZWSP = "\u200B"
     # Soft Hyphen (invisible, except when causing a line break)
-    SHY = "\u00AD".freeze
+    SHY = "\u00AD"
 
     # @group Stable API
 
@@ -151,6 +151,7 @@ module Prawn
     #
     def text(string, options = {})
       return false if string.nil?
+
       # we modify the options. don't change the user's hash
       options = options.dup
 
@@ -281,7 +282,7 @@ module Prawn
       text = text.to_s.dup
       save_font do
         process_text_options(options)
-        font.normalize_encoding!(text)
+        text = font.normalize_encoding(text)
         font_size(options[:size]) { draw_text!(text, options) }
       end
     end
@@ -293,9 +294,9 @@ module Prawn
       unless font.unicode? || font.class.hide_m17n_warning || text.ascii_only?
         warn "PDF's built-in fonts have very limited support for " \
              "internationalized text.\nIf you need full UTF-8 support, " \
-             "consider using a TTF font instead.\n\nTo disable this " \
+             "consider using an external font instead.\n\nTo disable this " \
              "warning, add the following line to your code:\n" \
-             "Prawn::Font::AFM.hide_m17n_warning = true\n"
+             "Prawn::Fonts::AFM.hide_m17n_warning = true\n"
 
         font.class.hide_m17n_warning = true
       end
@@ -409,10 +410,11 @@ module Prawn
       elsif options[:align]
         raise ArgumentError, 'The :align option does not work with draw_text'
       end
+
       if options[:kerning].nil?
         options[:kerning] = default_kerning?
       end
-      valid_options = PDF::Core::Text::VALID_OPTIONS + [:at, :rotate]
+      valid_options = PDF::Core::Text::VALID_OPTIONS + %i[at rotate]
       Prawn.verify_options(valid_options, options)
       options
     end
@@ -438,7 +440,7 @@ module Prawn
       options.delete(:indent_paragraphs)
     end
 
-    def move_text_position(dy)
+    def move_text_position(amount)
       bottom =
         if @bounding_box.stretchy?
           @margin_box.absolute_bottom
@@ -446,9 +448,9 @@ module Prawn
           @bounding_box.absolute_bottom
         end
 
-      @bounding_box.move_past_bottom if (y - dy) < bottom
+      @bounding_box.move_past_bottom if (y - amount) < bottom
 
-      self.y -= dy
+      self.y -= amount
     end
   end
 end

data/lib/prawn/text/box.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # text/rectangle.rb : Implements text boxes
 #
 # Copyright November 2009, Daniel Nelson. All Rights Reserved.
@@ -59,7 +61,7 @@ module Prawn
     #     or right-to-left) [value of document.text_direction]
     # <tt>:fallback_fonts</tt>::
     #     An array of font names. Each name must be the name of an AFM font or
-    #     the name that was used to register a family of TTF fonts (see
+    #     the name that was used to register a family of external fonts (see
     #     Prawn::Document#font_families). If present, then each glyph will be
     #     rendered using the first font that includes the glyph, starting with
     #     the current font and then moving through :fallback_fonts from

data/lib/prawn/text/formatted.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'formatted/wrap'
 
 require_relative 'formatted/box'

data/lib/prawn/text/formatted/arranger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # core/text/formatted/arranger.rb : Implements a data structure for 2-stage
 #                                   processing of lines of formatted text
 #
@@ -5,8 +7,6 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-# rubocop: disable Style/AccessorMethodName
-
 module Prawn
   module Text
     module Formatted #:nodoc:
@@ -57,12 +57,10 @@ module Prawn
           end
 
           @fragments.collect do |fragment|
-            begin
-              fragment.text.dup.encode(::Encoding::UTF_8)
-            rescue ::Encoding::InvalidByteSequenceError,
-                   ::Encoding::UndefinedConversionError
-              fragment.text.dup.force_encoding(::Encoding::UTF_8)
-            end
+            fragment.text.dup.encode(::Encoding::UTF_8)
+          rescue ::Encoding::InvalidByteSequenceError,
+                 ::Encoding::UndefinedConversionError
+            fragment.text.dup.force_encoding(::Encoding::UTF_8)
           end.join
         end
 
@@ -81,8 +79,8 @@ module Prawn
               @document
             )
             @fragments << fragment
-            set_fragment_measurements(fragment)
-            set_line_measurement_maximums(fragment)
+            self.fragment_measurements = fragment
+            self.line_measurement_maximums = fragment
           end
         end
 
@@ -166,6 +164,7 @@ module Prawn
           @document.character_spacing(character_spacing) do
             if font || font_style != :normal
               raise 'Bad font family' unless @document.font.family
+
               @document.font(
                 font || @document.font.family, style: font_style
               ) do
@@ -179,6 +178,7 @@ module Prawn
 
         def update_last_string(printed, unprinted, normalized_soft_hyphen = nil)
           return if printed.nil?
+
           if printed.empty?
             @consumed.pop
           else
@@ -284,7 +284,7 @@ module Prawn
           end
         end
 
-        def set_fragment_measurements(fragment)
+        def fragment_measurements=(fragment)
           apply_font_settings(fragment) do
             fragment.width = @document.width_of(
               fragment.text,
@@ -296,7 +296,7 @@ module Prawn
           end
         end
 
-        def set_line_measurement_maximums(fragment)
+        def line_measurement_maximums=(fragment)
           @max_line_height = [
             defined?(@max_line_height) && @max_line_height,
             fragment.line_height

data/lib/prawn/text/formatted/box.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # text/formatted/rectangle.rb : Implements text boxes with formatted text
 #
 # Copyright February 2010, Daniel Nelson. All Rights Reserved.
@@ -246,6 +248,7 @@ module Prawn
         #
         def height
           return 0 if @baseline_y.nil? || @descender.nil?
+
           (@baseline_y - @descender).abs
         end
 
@@ -267,6 +270,9 @@ module Prawn
                 else
                   @at[0] + @width - line_width
                 end
+          else
+            raise ArgumentError,
+              'align must be one of :left, :right, :center or :justify symbols'
           end
 
           x += accumulated_width
@@ -338,19 +344,19 @@ module Prawn
         end
 
         def valid_options
-          PDF::Core::Text::VALID_OPTIONS + [
-            :at,
-            :height, :width,
-            :align, :valign,
-            :rotate, :rotate_around,
-            :overflow, :min_font_size,
-            :disable_wrap_by_char,
-            :leading, :character_spacing,
-            :mode, :single_line,
-            :document,
-            :direction,
-            :fallback_fonts,
-            :draw_text_callback
+          PDF::Core::Text::VALID_OPTIONS + %i[
+            at
+            height width
+            align valign
+            rotate rotate_around
+            overflow min_font_size
+            disable_wrap_by_char
+            leading character_spacing
+            mode single_line
+            document
+            direction
+            fallback_fonts
+            draw_text_callback
           ]
         end
 
@@ -496,6 +502,7 @@ module Prawn
               @vertical_alignment_processed
             return
           end
+
           @vertical_alignment_processed = true
 
           return if @vertical_align == :top
@@ -587,6 +594,7 @@ module Prawn
 
         def draw_fragment_overlay_link(fragment)
           return unless fragment.link
+
           box = fragment.absolute_bounding_box
           @document.link_annotation(
             box,
@@ -601,6 +609,7 @@ module Prawn
 
         def draw_fragment_overlay_anchor(fragment)
           return unless fragment.anchor
+
           box = fragment.absolute_bounding_box
           @document.link_annotation(
             box,
@@ -611,6 +620,7 @@ module Prawn
 
         def draw_fragment_overlay_local(fragment)
           return unless fragment.local
+
           box = fragment.absolute_bounding_box
           @document.link_annotation(
             box,

data/lib/prawn/text/formatted/fragment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # text/formatted/fragment.rb : Implements information about a formatted fragment
 #
 # Copyright March 2010, Daniel Nelson. All Rights Reserved.

data/lib/prawn/text/formatted/line_wrap.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # core/text/formatted/line_wrap.rb : Implements individual line wrapping of
 #                                    formatted text
 #
@@ -39,7 +41,7 @@ module Prawn
           # rubocop: disable Lint/AssignmentInCondition
           while fragment = @arranger.next_string
             # rubocop: enable Lint/AssignmentInCondition
-            @fragment_output = ''
+            @fragment_output = +''
 
             fragment.lstrip! if first_fragment_on_this_line?(fragment)
             next if empty_line?(fragment)
@@ -91,11 +93,11 @@ module Prawn
             false
           else
             tokenize(fragment).each do |segment|
-              if segment == zero_width_space(segment.encoding)
-                segment_width = 0
-              else
-                segment_width = @document.width_of(segment, kerning: @kerning)
-              end
+              segment_width = if segment == zero_width_space(segment.encoding)
+                                0
+                              else
+                                @document.width_of(segment, kerning: @kerning)
+                              end
 
               if @accumulated_width + segment_width <= @width
                 @accumulated_width += segment_width
@@ -242,6 +244,7 @@ module Prawn
               !fragment.strip.empty?
             raise Prawn::Errors::CannotFit
           end
+
           @arranger.update_last_string(
             @fragment_output,
             remaining_text,
@@ -284,8 +287,7 @@ module Prawn
         end
 
         def update_line_status_based_on_last_output
-          if @fragment_output =~
-              word_division_scan_pattern(@fragment_output.encoding)
+          if @fragment_output&.match?(word_division_scan_pattern(@fragment_output.encoding))
             @line_contains_more_than_one_word = true
           end
         end

data/lib/prawn/text/formatted/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # text/formatted/parser.rb : Implements a bi-directional parser between a subset
 #                            of html and formatted text arrays
 #
@@ -55,21 +57,17 @@ module Prawn
           array.collect do |hash|
             prefix = ''
             suffix = ''
-            if hash[:styles]
-              hash[:styles].each do |style|
-                prefix += prefixes[style]
-                suffix = suffixes[style] + suffix
-              end
+            hash[:styles]&.each do |style|
+              prefix += prefixes[style]
+              suffix = suffixes[style] + suffix
             end
 
             font = hash[:font] ? " name='#{hash[:font]}'" : nil
             size = hash[:size] ? " size='#{hash[:size]}'" : nil
-            if hash[:character_spacing]
-              character_spacing =
+            character_spacing =
+              if hash[:character_spacing]
                 " character_spacing='#{hash[:character_spacing]}'"
-            else
-              character_spacing = nil
-            end
+              end
             if font || size || character_spacing
               prefix += "<font#{font}#{size}#{character_spacing}>"
               suffix = '</font>'

data/lib/prawn/text/formatted/wrap.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # wrap.rb: Handles text wrapping for for formatted text
 #
 # Contributed by Daniel Nelson
@@ -103,12 +105,12 @@ module Prawn
           end
 
           @printed_lines << printed_fragments.map do |s|
-            s.force_encoding(::Encoding::UTF_8)
+            s.dup.force_encoding(::Encoding::UTF_8)
           end.join
         end
 
         def word_spacing_for_this_line
-          if @align == :justify && @line_wrap.space_count > 0 &&
+          if @align == :justify && @line_wrap.space_count.positive? &&
               !@line_wrap.paragraph_finished?
             (available_width - @line_wrap.width) / @line_wrap.space_count
           else

data/lib/prawn/transformation_stack.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # transformation_stack.rb : Stores the transformations that have been applied to
 # the document
 #
@@ -7,7 +9,7 @@
 
 require 'matrix'
 
-# rubocop: disable Metrics/ParameterLists
+# rubocop: disable Metrics/ParameterLists, Naming/MethodParameterName
 module Prawn
   module TransformationStack
     def add_to_transformation_stack(a, b, c, d, e, f)
@@ -21,7 +23,7 @@ module Prawn
     end
 
     def restore_transformation_stack
-      @transformation_stack.pop if @transformation_stack
+      @transformation_stack&.pop
     end
 
     def current_transformation_matrix_with_translation(x = 0, y = 0)
@@ -39,3 +41,4 @@ module Prawn
     end
   end
 end
+# rubocop: enable Metrics/ParameterLists, Naming/MethodParameterName