prawn 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dd091ffaaed7c69fe8a0353317736d1f145e91f3f133a6d04ed0cffd7b5eb37
-  data.tar.gz: 98d1b0c973c9bf1947681ea971240fe9c351a9bcc1a74c91e7f8f677510eb11c
+  metadata.gz: d64c2da1e4be48e40f4fa6fa4de35e04c75debf0119e8c59b3fba9d944c112db
+  data.tar.gz: 393bbdd1a5df657d5c6190d4bd10ecd7353522e714b2f60c8d9c5f70e5bc1ce9
 SHA512:
-  metadata.gz: 9b75677d2586bf8a812549075cc9532bc02f78dc18b0e0db99711ad1087586f4fef6ae2f244e96a73366172410357d19e9371ac7b7eacf4a3bcbf85292ffb028
-  data.tar.gz: 138ac861e5016c49836a882c8beda2d2ed250e63959307ffe720624d322fd92b21ca71945e9cf58d0439851f8ebec515d13fb5f1d1660a3c9f4c996c5d04e701
+  metadata.gz: c4980639ca24796d577be790ed0f6fa85c985f1a6eb147e4c5db1df261c5d50afe8a466f06b65588b71a897e22e8d2b7b01daceed1714f6164124057154d2d28
+  data.tar.gz: e0fd560d4a80f2827736d599266bcb2e2fe19abedcde639520fba8bd19a2f12fe2cf0e8a60a91b87dbac4336d25c680f94b2341e5f9ce3d6d24f2e65f24e24a3

data/Rakefile

@@ -1,23 +1,10 @@
 # frozen_string_literal: true
 
-require 'rake'
-require 'rspec/core/rake_task'
-require 'yard'
-require 'rubygems/package_task'
-require 'rubocop/rake_task'
+GEMSPEC = File.expand_path('prawn.gemspec', __dir__)
+require 'prawn/dev/tasks'
 
 task default: %i[spec rubocop]
 
-desc 'Run all rspec files'
-RSpec::Core::RakeTask.new('spec') do |c|
-  c.rspec_opts = '-t ~unresolved'
-end
-
-YARD::Rake::YardocTask.new do |t|
-  t.options = ['--output-dir', 'doc/html']
-end
-task docs: :yard
-
 desc "Generate the 'Prawn by Example' manual"
 task :manual do
   puts 'Building manual...'
@@ -26,12 +13,6 @@ task :manual do
   puts 'The Prawn manual is available at manual.pdf. Happy Prawning!'
 end
 
-spec = Gem::Specification.load 'prawn.gemspec'
-Gem::PackageTask.new(spec) do |pkg|
-  pkg.need_zip = true
-  pkg.need_tar = true
-end
-
 desc 'Run a console with Prawn loaded'
 task :console do
   require 'irb'
@@ -42,13 +23,3 @@ task :console do
   ARGV.clear
   IRB.start
 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

@@ -32,6 +32,7 @@ module Prawn
   #
   # @private
   attr_accessor :debug
+
   module_function :debug, :debug=
 
   module_function

data/lib/prawn/document.rb

@@ -98,6 +98,7 @@ module Prawn
 
     # @private
     def self.inherited(base)
+      super
       extensions.each { |e| base.extensions << e }
     end
 
@@ -570,11 +571,12 @@ module Prawn
       opts = options.dup
       start_count_at = opts.delete(:start_count_at).to_i
 
-      page_filter = if opts.key?(:page_filter)
-                      opts.delete(:page_filter)
-                    else
-                      :all
-                    end
+      page_filter =
+        if opts.key?(:page_filter)
+          opts.delete(:page_filter)
+        else
+          :all
+        end
 
       total_pages = opts.delete(:total_pages)
       txtcolor = opts.delete(:color)
@@ -585,12 +587,13 @@ module Prawn
       pseudopage = 0
       (1..page_count).each do |p|
         unless start_count
-          pseudopage = case start_count_at
-                       when 0
-                         1
-                       else
-                         start_count_at.to_i
-                       end
+          pseudopage =
+            case start_count_at
+            when 0
+              1
+            else
+              start_count_at.to_i
+            end
         end
         if page_match?(page_filter, p)
           go_to_page(p)
@@ -668,9 +671,9 @@ module Prawn
       # and then restores the original values after the block has executed.
       # -- I will remove the nodoc if/when this feature is a little less hacky
       stored = {}
-      fields.each { |f| stored[f] = send(f) }
+      fields.each { |f| stored[f] = public_send(f) }
       yield
-      fields.each { |f| send("#{f}=", stored[f]) }
+      fields.each { |f| public_send("#{f}=", stored[f]) }
     end
 
     # @group Extension API
@@ -737,8 +740,10 @@ module Prawn
 
       # Treat :margin as CSS shorthand with 1-4 values.
       positions = {
-        4 => [0, 1, 2, 3], 3 => [0, 1, 2, 1],
-        2 => [0, 1, 0, 1], 1 => [0, 0, 0, 0],
+        4 => [0, 1, 2, 3],
+        3 => [0, 1, 2, 1],
+        2 => [0, 1, 0, 1],
+        1 => [0, 0, 0, 0],
         0 => []
       }[margin.length]
 

data/lib/prawn/document/bounding_box.rb

@@ -173,7 +173,9 @@ module Prawn
       init_bounding_box(block, hold_position: true) do |_|
         # Canvas bbox acts like margin_box in that its parent bounds are unset.
         @bounding_box = BoundingBox.new(
-          self, nil, [0, page.dimensions[3]],
+          self,
+          nil,
+          [0, page.dimensions[3]],
           width: page.dimensions[2],
           height: page.dimensions[3]
         )
@@ -221,6 +223,12 @@ module Prawn
     # is used for.
     #
     class BoundingBox
+      class NoReferenceBounds < StandardError
+        def initialize(message = "Can't find reference bounds: my parent is unset")
+          super
+        end
+      end
+
       # @private
       def initialize(document, parent, point, options = {})
         unless options[:width]
@@ -504,7 +512,7 @@ module Prawn
       #
       def reference_bounds
         if stretchy?
-          raise "Can't find reference bounds: my parent is unset" unless @parent
+          raise NoReferenceBounds unless @parent
 
           @parent.reference_bounds
         else

data/lib/prawn/document/span.rb

@@ -51,7 +51,8 @@ module Prawn
           [
             left_boundary,
             margin_box.absolute_top
-          ], width: width
+          ],
+          width: width
         ) do
           self.y = original_position
           yield

data/lib/prawn/font.rb

@@ -318,10 +318,10 @@ module Prawn
       return options.fetch(:format, 'ttf') if src.respond_to? :read
 
       case src.to_s
-      when /\.ttf$/i   then 'ttf'
-      when /\.otf$/i   then 'otf'
+      when /\.ttf$/i then 'ttf'
+      when /\.otf$/i then 'otf'
       when /\.dfont$/i then 'dfont'
-      when /\.ttc$/i   then 'ttc'
+      when /\.ttc$/i then 'ttc'
       else 'afm'
       end
     end
@@ -420,7 +420,7 @@ module Prawn
     #
     def eql?(other) #:nodoc:
       self.class == other.class && name == other.name &&
-        family == other.family && size == other.send(:size)
+        family == other.family && size == other.size
     end
 
     private
@@ -445,6 +445,8 @@ module Prawn
       end
     end
 
+    protected
+
     def size
       @document.font_size
     end

data/lib/prawn/font_metric_cache.rb

@@ -22,12 +22,13 @@ module Prawn
     end
 
     def width_of(string, options)
-      f = if options[:style]
-            # override style with :style => :bold
-            @document.find_font(@document.font.family, style: options[:style])
-          else
-            @document.font
-          end
+      f =
+        if options[:style]
+          # override style with :style => :bold
+          @document.find_font(@document.font.family, style: options[:style])
+        else
+          @document.font
+        end
 
       encoded_string = f.normalize_encoding(string)
 

data/lib/prawn/fonts/afm.rb

@@ -31,16 +31,17 @@ module Prawn
       end
 
       def self.metrics_path
-        @metrics_path ||= if ENV['METRICS']
-                            ENV['METRICS'].split(':')
-                          else
-                            [
-                              '.', '/usr/lib/afm',
-                              '/usr/local/lib/afm',
-                              '/usr/openwin/lib/fonts/afm',
-                              Prawn::DATADIR + '/fonts'
-                            ]
-                          end
+        @metrics_path ||=
+          if ENV['METRICS']
+            ENV['METRICS'].split(':')
+          else
+            [
+              '.', '/usr/lib/afm',
+              '/usr/local/lib/afm',
+              '/usr/openwin/lib/fonts/afm',
+              "#{Prawn::DATADIR}/fonts"
+            ]
+          end
       end
 
       attr_reader :attributes #:nodoc:
@@ -88,7 +89,7 @@ module Prawn
 
         if options[:kerning]
           strings, numbers = kern(string).partition { |e| e.is_a?(String) }
-          total_kerning_offset = numbers.inject(0.0) { |a, e| a + e }
+          total_kerning_offset = numbers.sum
           (unscaled_width_of(strings.join) - total_kerning_offset) * scale
         else
           unscaled_width_of(string) * scale
@@ -176,7 +177,7 @@ module Prawn
       rescue NoMethodError
         raise Prawn::Errors::UnknownFont,
           "Couldn't find the font: #{file} in any of:\n" +
-          self.class.metrics_path.join("\n")
+            self.class.metrics_path.join("\n")
       end
 
       def parse_afm(file_name)
@@ -220,9 +221,10 @@ module Prawn
 
         # process data parsed from AFM file to build tables which
         #   will be used when measuring and kerning text
-        data[:glyph_table] = (0..255).map do |i|
-          data[:glyph_widths][Encoding::WinAnsi::CHARACTERS[i]].to_i
-        end
+        data[:glyph_table] =
+          (0..255).map do |i|
+            data[:glyph_widths][Encoding::WinAnsi::CHARACTERS[i]].to_i
+          end
 
         character_hash = Hash[
           Encoding::WinAnsi::CHARACTERS.zip(
@@ -281,7 +283,7 @@ module Prawn
       end
 
       def unscaled_width_of(string)
-        string.bytes.inject(0) do |s, r|
+        string.bytes.reduce(0) do |s, r|
           s + @glyph_table[r]
         end
       end

data/lib/prawn/fonts/ttf.rb

@@ -14,6 +14,29 @@ module Prawn
   module Fonts
     # @private
     class TTF < Font
+      class Error < StandardError
+        DEFAULT_MESSAGE = 'TTF font error'
+        MESSAGE_WITH_FONT = 'TTF font error in font %<font>s'
+
+        def initialize(message = DEFAULT_MESSAGE, font: nil)
+          if font && message == DEFAULT_MESSAGE
+            super format(MESSAGE_WITH_FONT, font: font)
+          else
+            super message
+          end
+        end
+      end
+
+      class NoUnicodeCMap < Error
+        DEFAULT_MESSAGE = 'No unicode cmap found in font'
+        MESSAGE_WITH_FONT = 'No unicode cmap found in font %<font>s'
+      end
+
+      class NoPostscriptName < Error
+        DEFAULT_MESSAGE = 'Can not detect a postscript name'
+        MESSAGE_WITH_FONT = 'Can not detect a postscript name in font %<font>s'
+      end
+
       attr_reader :ttf, :subsets
 
       def unicode?
@@ -41,15 +64,15 @@ module Prawn
       def compute_width_of(string, options = {}) #:nodoc:
         scale = (options[:size] || size) / 1000.0
         if options[:kerning]
-          kern(string).inject(0) do |s, r|
+          kern(string).reduce(0) do |s, r|
             if r.is_a?(Numeric)
               s - r
             else
-              r.inject(s) { |a, e| a + character_width_by_code(e) }
+              r.reduce(s) { |a, e| a + character_width_by_code(e) }
             end
           end * scale
         else
-          string.codepoints.inject(0) do |s, r|
+          string.codepoints.reduce(0) do |s, r|
             s + character_width_by_code(r)
           end * scale
         end
@@ -82,7 +105,7 @@ module Prawn
 
         if options[:kerning]
           last_subset = nil
-          kern(text).inject([]) do |result, element|
+          kern(text).reduce([]) do |result, element|
             if element.is_a?(Numeric)
               unless result.last[1].is_a?(Array)
                 result.last[1] = [result.last[1]]
@@ -136,10 +159,11 @@ module Prawn
       end
 
       def cap_height
-        @cap_height ||= begin
-          height = @ttf.os2.exists? && @ttf.os2.cap_height || 0
-          height.zero? ? @ascender : height
-        end
+        @cap_height ||=
+          begin
+            height = @ttf.os2.exists? && @ttf.os2.cap_height || 0
+            height.zero? ? @ascender : height
+          end
       end
 
       def x_height
@@ -161,23 +185,24 @@ module Prawn
       end
 
       def pdf_flags
-        @pdf_flags ||= begin
-          flags = 0
-          flags |= 0x0001 if @ttf.postscript.fixed_pitch?
-          flags |= 0x0002 if serif?
-          flags |= 0x0008 if script?
-          flags |= 0x0040 if italic_angle != 0
-          # Assume the font contains at least some non-latin characters
-          flags | 0x0004
-        end
+        @pdf_flags ||=
+          begin
+            flags = 0
+            flags |= 0x0001 if @ttf.postscript.fixed_pitch?
+            flags |= 0x0002 if serif?
+            flags |= 0x0008 if script?
+            flags |= 0x0040 if italic_angle != 0
+            # Assume the font contains at least some non-latin characters
+            flags | 0x0004
+          end
       end
 
       def normalize_encoding(text)
         text.encode(::Encoding::UTF_8)
       rescue StandardError => e
         puts e
-        raise Prawn::Errors::IncompatibleStringEncoding, 'Encoding ' \
-          "#{text.encoding} can not be transparently converted to UTF-8. " \
+        raise Prawn::Errors::IncompatibleStringEncoding,
+          "Encoding #{text.encoding} can not be transparently converted to UTF-8. " \
           'Please ensure the encoding of the string you are attempting ' \
           'to use is set correctly'
       end
@@ -200,7 +225,7 @@ module Prawn
       private
 
       def cmap
-        (@cmap ||= @ttf.cmap.unicode.first) || raise('no unicode cmap for font')
+        (@cmap ||= @ttf.cmap.unicode.first) || raise(NoUnicodeCMap.new(font: name))
       end
 
       # +string+ must be UTF8-encoded.
@@ -275,7 +300,7 @@ module Prawn
         # if their font name is more than 33 bytes long. Strange. But true.
         basename = font.name.postscript_name[0, 33].delete("\0")
 
-        raise "Can't detect a postscript name for #{file}" if basename.nil?
+        raise NoPostscriptName.new(font: font) if basename.nil?
 
         fontfile = @document.ref!(Length1: font_content.size)
         fontfile.stream << font_content
@@ -313,7 +338,7 @@ module Prawn
         map = @subsets[subset].to_unicode_map
 
         ranges = [[]]
-        map.keys.sort.inject('') do |_s, code|
+        map.keys.sort.reduce('') do |_s, code|
           ranges << [] if ranges.last.length >= 100
           unicode = map[code]
           ranges.last << format(
@@ -323,13 +348,14 @@ module Prawn
           )
         end
 
-        range_blocks = ranges.inject(+'') do |s, list|
-          s << format(
-            "%<lenght>d beginbfchar\n%<list>s\nendbfchar\n",
-            lenght: list.length,
-            list: list.join("\n")
-          )
-        end
+        range_blocks =
+          ranges.reduce(+'') do |s, list|
+            s << format(
+              "%<lenght>d beginbfchar\n%<list>s\nendbfchar\n",
+              lenght: list.length,
+              list: list.join("\n")
+            )
+          end
 
         to_unicode_cmap = UNICODE_CMAP_TEMPLATE % range_blocks.strip