prawn 2.1.0 → 2.4.0

data/lib/prawn/security/arcfour.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # Implementation of the "ARCFOUR" algorithm ("alleged RC4 (tm)"). Implemented
 # as described at:
@@ -39,7 +39,7 @@ class Arcfour
   end
 
   def encrypt(string)
-    string.unpack('c*').map{ |byte| byte ^ key_byte }.pack('c*')
+    string.unpack('c*').map { |byte| byte ^ key_byte }.pack('c*')
   end
 
   private

data/lib/prawn/soft_mask.rb

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # soft_mask.rb : Implements soft-masking
 #
 # Copyright September 2012, Alexander Mankuta. All Rights Reserved.
@@ -31,51 +31,51 @@ module Prawn
       renderer.min_version(1.4)
 
       group_attrs = ref!(
-        :Type => :Group,
-        :S => :Transparency,
-        :CS => :DeviceRGB,
-        :I => false,
-        :K => false
+        Type: :Group,
+        S: :Transparency,
+        CS: :DeviceRGB,
+        I: false,
+        K: false
       )
 
       group = ref!(
-        :Type => :XObject,
-        :Subtype => :Form,
-        :BBox => state.page.dimensions,
-        :Group => group_attrs
+        Type: :XObject,
+        Subtype: :Form,
+        BBox: state.page.dimensions,
+        Group: group_attrs
       )
 
       state.page.stamp_stream(group, &block)
 
       mask = ref!(
-        :Type => :Mask,
-        :S => :Luminosity,
-        :G => group
+        Type: :Mask,
+        S: :Luminosity,
+        G: group
       )
 
       g_state = ref!(
-        :Type => :ExtGState,
-        :SMask => mask,
+        Type: :ExtGState,
+        SMask: mask,
 
-        :AIS => false,
-        :BM => :Normal,
-        :OP => false,
-        :op => false,
-        :OPM => 1,
-        :SA => true
+        AIS: false,
+        BM: :Normal,
+        OP: false,
+        op: false,
+        OPM: 1,
+        SA: true
       )
 
       registry_key = {
-        :bbox => state.page.dimensions,
-        :mask => [group.stream.filters.normalized, group.stream.filtered_stream],
-        :page => state.page_count
+        bbox: state.page.dimensions,
+        mask: [group.stream.filters.normalized, group.stream.filtered_stream],
+        page: state.page_count
       }.hash
 
       if soft_mask_registry[registry_key]
         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,5 +1,5 @@
-# encoding: utf-8
-#
+# frozen_string_literal: true
+
 # stamp.rb : Implements a repeatable stamp
 #
 # Copyright October 2009, Daniel Nelson. All Rights Reserved.
@@ -92,9 +92,9 @@ module Prawn
     end
 
     def stamp_dictionary(name)
-      fail Prawn::Errors::InvalidName if name.empty?
+      raise Prawn::Errors::InvalidName if name.empty?
       if stamp_dictionary_registry[name].nil?
-        fail Prawn::Errors::UndefinedObjectName
+        raise Prawn::Errors::UndefinedObjectName
       end
 
       dict = stamp_dictionary_registry[name]
@@ -105,20 +105,27 @@ module Prawn
     end
 
     def create_stamp_dictionary(name)
-      fail Prawn::Errors::InvalidName if name.empty?
-      fail Prawn::Errors::NameTaken unless stamp_dictionary_registry[name].nil?
+      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
-      dictionary = ref!(:Type    => :XObject,
-                        :Subtype => :Form,
-                        :BBox    => [0, 0,
-                                     state.page.dimensions[2], state.page.dimensions[3]])
+      dictionary = ref!(
+        Type: :XObject,
+        Subtype: :Form,
+        BBox: [
+          0, 0,
+          state.page.dimensions[2], state.page.dimensions[3]
+        ]
+      )
 
       dictionary_name = "Stamp#{next_stamp_dictionary_id}"
 
-      stamp_dictionary_registry[name] = { :stamp_dictionary_name => dictionary_name,
-                                          :stamp_dictionary      => dictionary }
+      stamp_dictionary_registry[name] = {
+        stamp_dictionary_name: dictionary_name,
+        stamp_dictionary: dictionary
+      }
       dictionary
     end
 
@@ -127,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,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # text.rb : Implements PDF text primitives
 #
@@ -6,12 +6,10 @@
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require "zlib"
+require 'zlib'
 
-require "pdf/core/text"
-
-require_relative "text/formatted"
-require_relative "text/box"
+require_relative 'text/formatted'
+require_relative 'text/box'
 
 module Prawn
   module Text
@@ -19,11 +17,11 @@ module Prawn
     include Prawn::Text::Formatted
 
     # No-Break Space
-    Prawn::Text::NBSP = " "
+    NBSP = "\u00A0"
     # Zero Width Space (indicate word boundaries without a space)
-    Prawn::Text::ZWSP = [8203].pack("U")
+    ZWSP = "\u200B"
     # Soft Hyphen (invisible, except when causing a line break)
-    Prawn::Text::SHY = "­"
+    SHY = "\u00AD"
 
     # @group Stable API
 
@@ -139,9 +137,9 @@ module Prawn
     #                       each line is included below the last line;
     #                       otherwise, document.y is placed just below the
     #                       descender of the last line printed [true]
-    # <tt>:mode</tt>:: The text rendering mode to use. Use this to specify if the
-    #                  text should render with the fill color, stroke color or
-    #                  both. See the comments to text_rendering_mode() to see
+    # <tt>:mode</tt>:: The text rendering mode to use. Use this to specify if
+    #                  the text should render with the fill color, stroke color
+    #                  or both. See the comments to text_rendering_mode() to see
     #                  a list of valid options. [0]
     #
     # == Exceptions
@@ -153,15 +151,17 @@ 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
 
-      if p = options[:inline_format]
+      p = options[:inline_format]
+      if p
         p = [] unless p.is_a?(Array)
         options.delete(:inline_format)
-        array = self.text_formatter.format(string, *p)
+        array = text_formatter.format(string, *p)
       else
-        array = [{ :text => string }]
+        array = [{ text: string }]
       end
 
       formatted_text(array, options)
@@ -190,26 +190,27 @@ module Prawn
     def formatted_text(array, options = {})
       options = inspect_options_for_text(options.dup)
 
-      if color = options.delete(:color)
-        array = array.map do |fragment|
-          fragment[:color] ? fragment : fragment.merge(:color => color)
-        end
+      color = options.delete(:color)
+      if color
+        array =
+          array.map do |fragment|
+            fragment[:color] ? fragment : fragment.merge(color: color)
+          end
       end
 
       if @indent_paragraphs
-        self.text_formatter.array_paragraphs(array).each do |paragraph|
+        text_formatter.array_paragraphs(array).each do |paragraph|
           remaining_text = draw_indented_formatted_line(paragraph, options)
 
-          if @no_text_printed
-            # unless this paragraph was an empty line
-            unless @all_text_printed
-              @bounding_box.move_past_bottom
-              remaining_text = draw_indented_formatted_line(paragraph, options)
-            end
+          if @no_text_printed && !@all_text_printed
+            @bounding_box.move_past_bottom
+            remaining_text = draw_indented_formatted_line(paragraph, options)
           end
 
-          remaining_text = fill_formatted_text_box(remaining_text, options)
-          draw_remaining_formatted_text_on_new_pages(remaining_text, options)
+          unless @all_text_printed
+            remaining_text = fill_formatted_text_box(remaining_text, options)
+            draw_remaining_formatted_text_on_new_pages(remaining_text, options)
+          end
         end
       else
         remaining_text = fill_formatted_text_box(array, options)
@@ -236,7 +237,8 @@ module Prawn
     # == Rotation
     #
     # Text can be rotated before it is placed on the canvas by specifying the
-    # <tt>:rotate</tt> option with a given angle. Rotation occurs counter-clockwise.
+    # <tt>:rotate</tt> option with a given angle. Rotation occurs
+    # counter-clockwise.
     #
     # == Encoding
     #
@@ -253,7 +255,8 @@ module Prawn
     #
     # == Options (default values marked in [])
     #
-    # <tt>:at</tt>:: <tt>[x, y]</tt>(required). The position at which to start the text
+    # <tt>:at</tt>:: <tt>[x, y]</tt>(required). The position at which to start
+    #                the text
     # <tt>:kerning</tt>:: <tt>boolean</tt>. Whether or not to use kerning (if it
     #                     is available with the current font)
     #                     [value of default_kerning?]
@@ -277,7 +280,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
@@ -289,9 +292,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
@@ -317,7 +320,7 @@ module Prawn
     # any text
     #
     def height_of(string, options = {})
-      height_of_formatted([{ :text => string }], options)
+      height_of_formatted([{ text: string }], options)
     end
 
     # Gets height of formatted text in PDF points.
@@ -332,15 +335,15 @@ module Prawn
     #
     def height_of_formatted(array, options = {})
       if options[:indent_paragraphs]
-        fail NotImplementedError, ":indent_paragraphs option not available" \
-          "with height_of"
+        raise NotImplementedError,
+          ':indent_paragraphs option not available with height_of'
       end
       process_final_gap_option(options)
       box = Text::Formatted::Box.new(
         array,
-        options.merge(:height => 100000000, :document => self)
+        options.merge(height: 100_000_000, document: self)
       )
-      box.render(:dry_run => true)
+      box.render(dry_run: true)
 
       height = box.height
       height += box.line_gap + box.leading if @final_gap
@@ -350,7 +353,7 @@ module Prawn
     private
 
     def draw_remaining_formatted_text_on_new_pages(remaining_text, options)
-      while remaining_text.length > 0
+      until remaining_text.empty?
         @bounding_box.move_past_bottom
         previous_remaining_text = remaining_text
         remaining_text = fill_formatted_text_box(remaining_text, options)
@@ -359,14 +362,15 @@ module Prawn
     end
 
     def draw_indented_formatted_line(string, options)
-      if options.fetch(:direction, text_direction) == :ltr
-        gap = [@indent_paragraphs, 0]
-      else
-        gap = [0, @indent_paragraphs]
-      end
+      gap =
+        if options.fetch(:direction, text_direction) == :ltr
+          [@indent_paragraphs, 0]
+        else
+          [0, @indent_paragraphs]
+        end
 
       indent(*gap) do
-        fill_formatted_text_box(string, options.dup.merge(:single_line => true))
+        fill_formatted_text_box(string, options.dup.merge(single_line: true))
       end
     end
 
@@ -384,33 +388,41 @@ module Prawn
     end
 
     def merge_text_box_positioning_options(options)
-      bottom = @bounding_box.stretchy? ? @margin_box.absolute_bottom :
-                                         @bounding_box.absolute_bottom
+      bottom =
+        if @bounding_box.stretchy?
+          @margin_box.absolute_bottom
+        else
+          @bounding_box.absolute_bottom
+        end
 
       options[:height] = y - bottom
       options[:width] = bounds.width
-      options[:at] = [@bounding_box.left_side - @bounding_box.absolute_left,
-                      y - @bounding_box.absolute_bottom]
+      options[:at] = [
+        @bounding_box.left_side - @bounding_box.absolute_left,
+        y - @bounding_box.absolute_bottom
+      ]
     end
 
     def inspect_options_for_draw_text(options)
       if options[:at].nil?
-        fail ArgumentError, "The :at option is required for draw_text"
+        raise ArgumentError, 'The :at option is required for draw_text'
       elsif options[:align]
-        fail ArgumentError, "The :align option does not work with draw_text"
+        raise ArgumentError, 'The :align option does not work with draw_text'
       end
-      if options[:kerning].nil? then
+
+      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
 
     def inspect_options_for_text(options)
       if options[:at]
-        fail ArgumentError, ":at is no longer a valid option with text." \
-                             "use draw_text or text_box instead"
+        raise ArgumentError,
+          ':at is no longer a valid option with text.' \
+          'use draw_text or text_box instead'
       end
       process_final_gap_option(options)
       process_indent_paragraphs_option(options)
@@ -428,13 +440,17 @@ module Prawn
       options.delete(:indent_paragraphs)
     end
 
-    def move_text_position(dy)
-      bottom = @bounding_box.stretchy? ? @margin_box.absolute_bottom :
-                                         @bounding_box.absolute_bottom
+    def move_text_position(amount)
+      bottom =
+        if @bounding_box.stretchy?
+          @margin_box.absolute_bottom
+        else
+          @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,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # text/rectangle.rb : Implements text boxes
 #
@@ -7,7 +7,7 @@
 # This is free software. Please see the LICENSE and COPYING files for details.
 #
 
-require_relative "formatted/box"
+require_relative 'formatted/box'
 
 module Prawn
   module Text
@@ -52,7 +52,8 @@ module Prawn
     #     <tt>[x, y]</tt>. The upper left corner of the box
     #     [@document.bounds.left, @document.bounds.top]
     # <tt>:width</tt>::
-    #     <tt>number</tt>. The width of the box [@document.bounds.right - @at[0]]
+    #     <tt>number</tt>. The width of the box
+    #     [@document.bounds.right - @at[0]]
     # <tt>:height</tt>::
     #     <tt>number</tt>. The height of the box [default_height()]
     # <tt>:direction</tt>::
@@ -60,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
@@ -82,7 +83,8 @@ module Prawn
     #     <tt>number</tt>. Additional space between lines [value of
     #     document.default_leading]
     # <tt>:single_line</tt>::
-    #     <tt>boolean</tt>. If true, then only the first line will be drawn [false]
+    #     <tt>boolean</tt>. If true, then only the first line will be drawn
+    #     [false]
     # <tt>:overflow</tt>::
     #     <tt>:truncate</tt>, <tt>:shrink_to_fit</tt>, or <tt>:expand</tt>
     #     This controls the behavior when the amount of text
@@ -105,13 +107,15 @@ module Prawn
       options = options.dup
       options[:document] = self
 
-      box = if p = options.delete(:inline_format)
-              p = [] unless p.is_a?(Array)
-              array = self.text_formatter.format(string, *p)
-              Text::Formatted::Box.new(array, options)
-            else
-              Text::Box.new(string, options)
-            end
+      box =
+        if options[:inline_format]
+          p = options.delete(:inline_format)
+          p = [] unless p.is_a?(Array)
+          array = text_formatter.format(string, *p)
+          Text::Formatted::Box.new(array, options)
+        else
+          Text::Box.new(string, options)
+        end
 
       box.render
     end
@@ -126,12 +130,12 @@ module Prawn
     #
     class Box < Prawn::Text::Formatted::Box
       def initialize(string, options = {})
-        super([{ :text => string }], options)
+        super([{ text: string }], options)
       end
 
       def render(flags = {})
         leftover = super(flags)
-        leftover.collect { |hash| hash[:text] }.join
+        leftover.map { |hash| hash[:text] }.join
       end
     end
   end