prawn 2.2.2 → 2.3.0

data/lib/prawn/font_metric_cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # font_metric_cache.rb : The Prawn font class
 #
 # Copyright Dec 2012, Kenneth Kalmer. All Rights Reserved.
@@ -35,9 +37,12 @@ module Prawn
 
       length = @cache[key]
 
-      length +
-        (@document.character_spacing *
-         @document.font.character_count(encoded_string))
+      character_count = @document.font.character_count(encoded_string)
+      if character_count.positive?
+        length += @document.character_spacing * (character_count - 1)
+      end
+
+      length
     end
   end
 end

data/lib/prawn/{font → fonts}/afm.rb

@@ -1,4 +1,6 @@
-# prawn/font/afm.rb : Implements AFM font support for Prawn
+# frozen_string_literal: true
+
+# Implements AFM font support for Prawn
 #
 # Copyright May 2008, Gregory Brown / James Healy.  All Rights Reserved.
 #
@@ -7,7 +9,7 @@
 require_relative '../encoding'
 
 module Prawn
-  class Font
+  module Fonts
     # @private
 
     class AFM < Font
@@ -49,14 +51,16 @@ module Prawn
       end
 
       def initialize(document, name, options = {}) #:nodoc:
+        name ||= options[:family]
         unless BUILT_INS.include?(name)
-          raise Prawn::Errors::UnknownFont, "#{name} is not a known font."
+          raise Prawn::Errors::UnknownFont,
+            "#{name} (#{options[:style] || 'normal'}) is not a known font."
         end
 
         super
 
         file_name = @name.dup
-        file_name << '.afm' unless file_name =~ /\.afm$/
+        file_name << '.afm' unless /\.afm$/.match?(file_name)
         file_name = file_name[0] == '/' ? file_name : find_font(file_name)
 
         font_data = self.class.font_data[file_name] ||= parse_afm(file_name)
@@ -93,9 +97,11 @@ module Prawn
 
       # Returns true if the font has kerning data, false otherwise
       #
+      # rubocop: disable Naming/PredicateName
       def has_kerning_data?
         @kern_pairs.any?
       end
+      # rubocop: enable Naming/PredicateName
 
       # built-in fonts only work with winansi encoding, so translate the
       # string. Changes the encoding in-place, so the argument itself
@@ -109,8 +115,8 @@ module Prawn
         raise Prawn::Errors::IncompatibleStringEncoding,
           "Your document includes text that's not compatible with the " \
           "Windows-1252 character set.\n" \
-          "If you need full UTF-8 support, use TTF fonts instead of PDF's " \
-          "built-in fonts.\n"
+          'If you need full UTF-8 support, use external fonts instead of ' \
+          "PDF's built-in fonts.\n"
       end
 
       def to_utf8(text)
@@ -194,13 +200,14 @@ module Prawn
 
           case section
           when %w[FontMetrics CharMetrics]
-            next unless line =~ /^CH?\s/
+            next unless /^CH?\s/.match?(line)
 
             name = line[/\bN\s+(\.?\w+)\s*;/, 1]
             data[:glyph_widths][name] = line[/\bWX\s+(\d+)\s*;/, 1].to_i
             data[:bounding_boxes][name] = line[/\bB\s+([^;]+);/, 1].to_s.rstrip
           when %w[FontMetrics KernData KernPairs]
             next unless line =~ /^KPX\s+(\.?\w+)\s+(\.?\w+)\s+(-?\d+)/
+
             data[:kern_pairs][[Regexp.last_match(1), Regexp.last_match(2)]] =
               Regexp.last_match(3).to_i
           when %w[FontMetrics KernData TrackKern],

data/lib/prawn/{font → fonts}/dfont.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require_relative 'ttf'
 
 module Prawn
-  class Font
+  module Fonts
     # @private
     class DFont < TTF
       # Returns a list of the names of all named fonts in the given dfont file.

data/lib/prawn/fonts/otf.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'ttf'
+
+module Prawn
+  module Fonts
+    # @private
+    class OTF < TTF
+    end
+  end
+end

data/lib/prawn/{font → fonts}/ttc.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require_relative 'ttf'
 
 module Prawn
-  class Font
+  module Fonts
     # @private
     class TTC < TTF
       # Returns a list of the names of all named fonts in the given ttc file.

data/lib/prawn/{font → fonts}/ttf.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # prawn/font/ttf.rb : Implements AFM font support for Prawn
 #
 # Copyright May 2008, Gregory Brown / James Healy / Jamis Buck
@@ -9,7 +11,7 @@ require 'ttfunk'
 require 'ttfunk/subset_collection'
 
 module Prawn
-  class Font
+  module Fonts
     # @private
     class TTF < Font
       attr_reader :ttf, :subsets
@@ -23,6 +25,7 @@ module Prawn
 
         @ttf = read_ttf_file
         @subsets = TTFunk::SubsetCollection.new(@ttf)
+        @italic_angle = nil
 
         @attributes = {}
         @bounding_boxes = {}
@@ -59,9 +62,12 @@ module Prawn
       end
 
       # Returns true if the font has kerning data, false otherwise
+      #
+      # rubocop: disable Naming/PredicateName
       def has_kerning_data?
         @has_kerning_data
       end
+      # rubocop: enable Naming/PredicateName
 
       # Perform any changes to the string that need to happen
       # before it is rendered to the canvas. Returns an array of
@@ -109,7 +115,7 @@ module Prawn
       end
 
       # not sure how to compute this for true-type fonts...
-      def stemV # rubocop: disable Style/MethodName
+      def stem_v
         0
       end
 
@@ -155,7 +161,7 @@ module Prawn
       end
 
       def pdf_flags
-        @flags ||= begin
+        @pdf_flags ||= begin
           flags = 0
           flags |= 0x0001 if @ttf.postscript.fixed_pitch?
           flags |= 0x0002 if serif?
@@ -168,7 +174,7 @@ module Prawn
 
       def normalize_encoding(text)
         text.encode(::Encoding::UTF_8)
-      rescue => e
+      rescue StandardError => e
         puts e
         raise Prawn::Errors::IncompatibleStringEncoding, 'Encoding ' \
           "#{text.encoding} can not be transparently converted to UTF-8. " \
@@ -182,7 +188,7 @@ module Prawn
 
       def glyph_present?(char)
         code = char.codepoints.first
-        cmap[code] > 0
+        cmap[code].positive?
       end
 
       # Returns the number of characters in +str+ (a UTF-8-encoded string).
@@ -220,7 +226,7 @@ module Prawn
       end
 
       def kern_pairs_table
-        @kerning_data ||=
+        @kern_pairs_table ||=
           if has_kerning_data?
             @ttf.kerning.tables.first.pairs
           else
@@ -243,7 +249,7 @@ module Prawn
       end
 
       def scale_factor
-        @scale ||= 1000.0 / @ttf.header.units_per_em
+        @scale_factor ||= 1000.0 / @ttf.header.units_per_em
       end
 
       def register(subset)
@@ -281,7 +287,7 @@ module Prawn
           FontFile2: fontfile,
           FontBBox: bbox,
           Flags: pdf_flags,
-          StemV: stemV,
+          StemV: stem_v,
           ItalicAngle: italic_angle,
           Ascent: @ascender,
           Descent: @descender,
@@ -310,13 +316,18 @@ module Prawn
         map.keys.sort.inject('') do |_s, code|
           ranges << [] if ranges.last.length >= 100
           unicode = map[code]
-          ranges.last << format('<%02x><%04x>', code, unicode)
+          ranges.last << format(
+            '<%<code>02x><%<unicode>04x>',
+            code: code,
+            unicode: unicode
+          )
         end
 
-        range_blocks = ranges.inject('') do |s, list|
+        range_blocks = ranges.inject(+'') do |s, list|
           s << format(
-            "%d beginbfchar\n%s\nendbfchar\n",
-            list.length, list.join("\n")
+            "%<lenght>d beginbfchar\n%<list>s\nendbfchar\n",
+            lenght: list.length,
+            list: list.join("\n")
           )
         end
 

data/lib/prawn/graphics.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # graphics.rb : Implements PDF drawing primitives
 #
 # Copyright April 2008, Gregory Brown.  All Rights Reserved.
@@ -148,11 +150,7 @@ module Prawn
     #  horizontal_line 25, 100, :at => 75
     #
     def horizontal_line(x1, x2, options = {})
-      y1 = if options[:at]
-             options[:at]
-           else
-             y - bounds.absolute_bottom
-           end
+      y1 = options[:at] || y - bounds.absolute_bottom
 
       line(x1, y1, x2, y1)
     end
@@ -198,36 +196,36 @@ module Prawn
       ellipse(center, radius, radius)
     end
 
-    # Draws an ellipse of +x+ radius <tt>r1</tt> and +y+ radius <tt>r2</tt>
-    # with the centre-point at <tt>point</tt> as a complete subpath. The
-    # drawing point will be moved to the centre-point upon completion of the
-    # drawing the ellipse.
+    # Draws an ellipse of +x+ radius <tt>radius1</tt> and +y+ radius
+    # <tt>radius2</tt> with the centre-point at <tt>point</tt> as a complete
+    # subpath. The drawing point will be moved to the centre-point upon
+    # completion of the drawing the ellipse.
     #
     #    # draws an ellipse with x-radius 25 and y-radius 50
     #    pdf.ellipse [100,100], 25, 50
     #
-    def ellipse(point, r1, r2 = r1)
+    def ellipse(point, radius1, radius2 = radius1)
       x, y = point
-      l1 = r1 * KAPPA
-      l2 = r2 * KAPPA
+      l1 = radius1 * KAPPA
+      l2 = radius2 * KAPPA
 
-      move_to(x + r1, y)
+      move_to(x + radius1, y)
 
       # Upper right hand corner
-      curve_to [x,  y + r2],
-        bounds: [[x + r1, y + l2], [x + l1, y + r2]]
+      curve_to [x,  y + radius2],
+        bounds: [[x + radius1, y + l2], [x + l1, y + radius2]]
 
       # Upper left hand corner
-      curve_to [x - r1, y],
-        bounds: [[x - l1, y + r2], [x - r1, y + l2]]
+      curve_to [x - radius1, y],
+        bounds: [[x - l1, y + radius2], [x - radius1, y + l2]]
 
       # Lower left hand corner
-      curve_to [x, y - r2],
-        bounds: [[x - r1, y - l2], [x - l1, y - r2]]
+      curve_to [x, y - radius2],
+        bounds: [[x - radius1, y - l2], [x - l1, y - radius2]]
 
       # Lower right hand corner
-      curve_to [x + r1, y],
-        bounds: [[x + l1, y - r2], [x + r1, y - l2]]
+      curve_to [x + radius1, y],
+        bounds: [[x + l1, y - radius2], [x + radius1, y - l2]]
 
       move_to(x, y)
     end
@@ -343,9 +341,9 @@ module Prawn
       }.merge(options)
 
       Prawn.verify_options(
-        [
-          :at, :width, :height, :step_length,
-          :negative_axes_length, :color
+        %i[
+          at width height step_length
+          negative_axes_length color
         ], options
       )
 
@@ -634,12 +632,12 @@ module Prawn
     ]
 
     ops.product(shapes).each do |operation, shape|
-      class_eval <<-END
+      class_eval <<-METHOD, __FILE__, __LINE__ + 1
         def #{operation}_#{shape}(*args)
           #{shape}(*args)
           #{operation}
         end
-      END
+      METHOD
     end
 
     private

data/lib/prawn/graphics/blend_mode.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # blend_mode.rb : Implements blend modes
 #
 # Contributed by John Ford. October, 2015

data/lib/prawn/graphics/cap_style.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # cap_style.rb : Implements stroke cap styling
 #
 # Contributed by Daniel Nelson. October, 2009

data/lib/prawn/graphics/color.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # color.rb : Implements color handling
 #
 # Copyright June 2008, Gregory Brown.  All Rights Reserved.
@@ -25,6 +27,7 @@ module Prawn
       #
       def fill_color(*color)
         return current_fill_color if color.empty?
+
         self.current_fill_color = process_color(*color)
         set_fill_color
       end
@@ -47,6 +50,7 @@ module Prawn
       #
       def stroke_color(*color)
         return current_stroke_color if color.empty?
+
         color = process_color(*color)
         self.current_stroke_color = color
         set_stroke_color(color)
@@ -63,7 +67,7 @@ module Prawn
       #   => "ff7808"
       #
       def rgb2hex(rgb)
-        rgb.map { |e| format '%02x', e }.join
+        rgb.map { |e| format '%<value>02x', value: e }.join
       end
 
       # Converts hex string into RGB value array:
@@ -94,7 +98,7 @@ module Prawn
       def color_type(color)
         case color
         when String
-          if color =~ /\A[0-F]{6}\z/i
+          if /\A\h{6}\z/.match?(color)
             :RGB
           else
             raise ArgumentError, "Unknown type of color: #{color.inspect}"
@@ -135,7 +139,7 @@ module Prawn
         end
       end
 
-      COLOR_SPACES = [:DeviceRGB, :DeviceCMYK, :Pattern].freeze
+      COLOR_SPACES = %i[DeviceRGB DeviceCMYK Pattern].freeze
 
       def set_color_space(type, color_space)
         # don't set the same color space again
@@ -143,6 +147,7 @@ module Prawn
             !state.page.in_stamp_stream?
           return
         end
+
         set_current_color_space(color_space, type)
 
         unless COLOR_SPACES.include?(color_space)

data/lib/prawn/graphics/dash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # dash.rb : Implements stroke dashing
 #
 # Contributed by Daniel Nelson. October, 2009
@@ -61,7 +63,7 @@ module Prawn
         if length.all?(&:zero?)
           raise ArgumentError,
             'Zero length dashes are invalid. Call #undash to disable dashes.'
-        elsif length.any? { |e| e < 0 }
+        elsif length.any?(&:negative?)
           raise ArgumentError,
             'Negative numbers are not allowed for dash lengths.'
         end

data/lib/prawn/graphics/join_style.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # join_style.rb : Implements stroke join styling
 #
 # Contributed by Daniel Nelson. October, 2009

data/lib/prawn/graphics/patterns.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'digest/sha1'
 
 # patterns.rb : Implements axial & radial gradients
@@ -106,7 +108,8 @@ module Prawn
         renderer.add_content "/SP#{registry_key} #{operator}"
       end
 
-      def parse_gradient_arguments( # rubocop: disable Metrics/ParameterLists
+      # rubocop: disable Metrics/ParameterLists
+      def parse_gradient_arguments(
         *arguments, from: nil, to: nil, r1: nil, r2: nil, stops: nil,
         apply_transformations: nil
       )
@@ -137,6 +140,7 @@ module Prawn
           unless (0..1).cover?(position)
             raise ArgumentError, 'position must be between 0 and 1'
           end
+
           GradientStop.new(position, normalize_color(color))
         end
 
@@ -159,6 +163,7 @@ module Prawn
           r1, r2
         )
       end
+      # rubocop: enable Metrics/ParameterLists
 
       def gradient_registry_key(gradient)
         _x1, _y1, x2, y2, transformation = gradient_coordinates(gradient)
@@ -171,7 +176,7 @@ module Prawn
           gradient.stops.length,
           gradient.stops.map { |s| [s.position, s.color] }
         ].flatten
-        Digest::SHA1.hexdigest(key.pack('HC*'))
+        Digest::SHA1.hexdigest(key.join(','))
       end
 
       def gradient_registry