prawn 2.1.0 → 2.2.0

data/lib/prawn/font/dfont.rb

@@ -1,11 +1,3 @@
-# encoding: utf-8
-#
-# font.rb : The Prawn font class
-#
-# Copyright November 2008, Jamis Buck. All Rights Reserved.
-#
-# This is free software. Please see the LICENSE and COPYING files for details.
-#
 require_relative 'ttf'
 
 module Prawn
@@ -20,7 +12,7 @@ module Prawn
       #
       def self.named_fonts(file)
         TTFunk::ResourceFile.open(file) do |f|
-          return f.resources_for("sfnt")
+          return f.resources_for('sfnt')
         end
       end
 
@@ -28,7 +20,7 @@ module Prawn
       #
       def self.font_count(file)
         TTFunk::ResourceFile.open(file) do |f|
-          return f.map["sfnt"][:list].length
+          return f.map['sfnt'][:list].length
         end
       end
 

data/lib/prawn/font/ttc.rb

@@ -0,0 +1,34 @@
+require_relative 'ttf'
+
+module Prawn
+  class Font
+    # @private
+    class TTC < TTF
+      # Returns a list of the names of all named fonts in the given ttc file.
+      # They are returned in order of their appearance in the file.
+      #
+      def self.font_names(file)
+        TTFunk::Collection.open(file) do |ttc|
+          ttc.map { |font| font.name.font_name.first }
+        end
+      end
+
+      private
+
+      def read_ttf_file
+        TTFunk::File.from_ttc(
+          @name,
+          font_option_to_index(@name, @options[:font])
+        )
+      end
+
+      def font_option_to_index(file, option)
+        if option.is_a?(Numeric)
+          option
+        else
+          self.class.font_names(file).index { |n| n == option } || 0
+        end
+      end
+    end
+  end
+end

data/lib/prawn/font/ttf.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # prawn/font/ttf.rb : Implements AFM font support for Prawn
 #
 # Copyright May 2008, Gregory Brown / James Healy / Jamis Buck
@@ -23,17 +21,17 @@ module Prawn
       def initialize(document, name, options = {})
         super
 
-        @ttf              = read_ttf_file
-        @subsets          = TTFunk::SubsetCollection.new(@ttf)
+        @ttf = read_ttf_file
+        @subsets = TTFunk::SubsetCollection.new(@ttf)
 
-        @attributes       = {}
-        @bounding_boxes   = {}
-        @char_widths      = {}
+        @attributes = {}
+        @bounding_boxes = {}
+        @char_widths = {}
         @has_kerning_data = @ttf.kerning.exists? && @ttf.kerning.tables.any?
 
-        @ascender         = Integer(@ttf.ascent * scale_factor)
-        @descender        = Integer(@ttf.descent * scale_factor)
-        @line_gap         = Integer(@ttf.line_gap * scale_factor)
+        @ascender = Integer(@ttf.ascent * scale_factor)
+        @descender = Integer(@ttf.descent * scale_factor)
+        @line_gap = Integer(@ttf.line_gap * scale_factor)
       end
 
       # NOTE: +string+ must be UTF8-encoded.
@@ -44,7 +42,7 @@ module Prawn
             if r.is_a?(Numeric)
               s - r
             else
-              r.inject(s) { |s2, u| s2 + character_width_by_code(u) }
+              r.inject(s) { |a, e| a + character_width_by_code(e) }
             end
           end * scale
         else
@@ -80,7 +78,9 @@ module Prawn
           last_subset = nil
           kern(text).inject([]) do |result, element|
             if element.is_a?(Numeric)
-              result.last[1] = [result.last[1]] unless result.last[1].is_a?(Array)
+              unless result.last[1].is_a?(Array)
+                result.last[1] = [result.last[1]]
+              end
               result.last[1] << element
               result
             else
@@ -100,7 +100,7 @@ module Prawn
             end
           end
         else
-          @subsets.encode(text.unpack("U*"))
+          @subsets.encode(text.unpack('U*'))
         end
       end
 
@@ -109,7 +109,7 @@ module Prawn
       end
 
       # not sure how to compute this for true-type fonts...
-      def stemV
+      def stemV # rubocop: disable Style/MethodName
         0
       end
 
@@ -118,7 +118,8 @@ module Prawn
 
         if @ttf.postscript.exists?
           raw = @ttf.postscript.italic_angle
-          hi, low = raw >> 16, raw & 0xFF
+          hi = raw >> 16
+          low = raw & 0xFF
           hi = -((hi ^ 0xFFFF) + 1) if hi & 0x8000 != 0
           @italic_angle = "#{hi}.#{low}".to_f
         else
@@ -131,7 +132,7 @@ module Prawn
       def cap_height
         @cap_height ||= begin
           height = @ttf.os2.exists? && @ttf.os2.cap_height || 0
-          height == 0 ? @ascender : height
+          height.zero? ? @ascender : height
         end
       end
 
@@ -160,24 +161,23 @@ module Prawn
           flags |= 0x0002 if serif?
           flags |= 0x0008 if script?
           flags |= 0x0040 if italic_angle != 0
-          flags |= 0x0004 # assume the font contains at least some non-latin characters
+          # Assume the font contains at least some non-latin characters
+          flags | 0x0004
         end
       end
 
       def normalize_encoding(text)
-        begin
-          text.encode(::Encoding::UTF_8)
-        rescue => e
-          puts e
-          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
+        text.encode(::Encoding::UTF_8)
+      rescue => e
+        puts e
+        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
 
       def to_utf8(text)
-        text.encode("UTF-8")
+        text.encode('UTF-8')
       end
 
       def glyph_present?(char)
@@ -194,7 +194,7 @@ module Prawn
       private
 
       def cmap
-        @cmap ||= @ttf.cmap.unicode.first or fail("no unicode cmap for font")
+        (@cmap ||= @ttf.cmap.unicode.first) || raise('no unicode cmap for font')
       end
 
       # +string+ must be UTF8-encoded.
@@ -220,12 +220,12 @@ module Prawn
       end
 
       def kern_pairs_table
-        @kerning_data ||= has_kerning_data? ? @ttf.kerning.tables.first.pairs : {}
-      end
-
-      def cid_to_gid_map
-        max = cmap.code_map.keys.max
-        (0..max).map { |cid| cmap[cid] }.pack("n*")
+        @kerning_data ||=
+          if has_kerning_data?
+            @ttf.kerning.tables.first.pairs
+          else
+            {}
+          end
       end
 
       def hmtx
@@ -247,12 +247,12 @@ module Prawn
       end
 
       def register(subset)
-        temp_name = @ttf.name.postscript_name.gsub("\0", "").to_sym
-        ref = @document.ref!(:Type => :Font, :BaseFont => temp_name)
+        temp_name = @ttf.name.postscript_name.delete("\0").to_sym
+        ref = @document.ref!(Type: :Font, BaseFont: temp_name)
 
         # Embed the font metrics in the document after everything has been
         # drawn, just before the document is emitted.
-        @document.renderer.before_render { |doc| embed(ref, subset) }
+        @document.renderer.before_render { |_doc| embed(ref, subset) }
 
         ref
       end
@@ -267,29 +267,32 @@ module Prawn
 
         # empirically, it looks like Adobe Reader will not display fonts
         # if their font name is more than 33 bytes long. Strange. But true.
-        basename = font.name.postscript_name[0, 33].gsub("\0", "")
+        basename = font.name.postscript_name[0, 33].delete("\0")
 
-        fail "Can't detect a postscript name for #{file}" if basename.nil?
+        raise "Can't detect a postscript name for #{file}" if basename.nil?
 
-        fontfile = @document.ref!(:Length1 => font_content.size)
+        fontfile = @document.ref!(Length1: font_content.size)
         fontfile.stream << font_content
         fontfile.stream.compress!
 
-        descriptor = @document.ref!(:Type        => :FontDescriptor,
-                                    :FontName    => basename.to_sym,
-                                    :FontFile2   => fontfile,
-                                    :FontBBox    => bbox,
-                                    :Flags       => pdf_flags,
-                                    :StemV       => stemV,
-                                    :ItalicAngle => italic_angle,
-                                    :Ascent      => @ascender,
-                                    :Descent     => @descender,
-                                    :CapHeight   => cap_height,
-                                    :XHeight     => x_height)
+        descriptor = @document.ref!(
+          Type: :FontDescriptor,
+          FontName: basename.to_sym,
+          FontFile2: fontfile,
+          FontBBox: bbox,
+          Flags: pdf_flags,
+          StemV: stemV,
+          ItalicAngle: italic_angle,
+          Ascent: @ascender,
+          Descent: @descender,
+          CapHeight: cap_height,
+          XHeight: x_height
+        )
 
         hmtx = font.horizontal_metrics
-        widths = font.cmap.tables.first.code_map.map { |gid|
-          Integer(hmtx.widths[gid] * scale_factor) }[32..-1]
+        widths = font.cmap.tables.first.code_map.map do |gid|
+          Integer(hmtx.widths[gid] * scale_factor)
+        end[32..-1]
 
         # It would be nice to have Encoding set for the macroman subsets,
         # and only do a ToUnicode cmap for non-encoded unicode subsets.
@@ -304,14 +307,17 @@ module Prawn
         map = @subsets[subset].to_unicode_map
 
         ranges = [[]]
-        map.keys.sort.inject("") do |s, code|
+        map.keys.sort.inject('') do |_s, code|
           ranges << [] if ranges.last.length >= 100
           unicode = map[code]
-          ranges.last << "<%02x><%04x>" % [code, unicode]
+          ranges.last << format('<%02x><%04x>', code, unicode)
         end
 
-        range_blocks = ranges.inject("") do |s, list|
-          s << "%d beginbfchar\n%s\nendbfchar\n" % [list.length, list.join("\n")]
+        range_blocks = ranges.inject('') do |s, list|
+          s << format(
+            "%d beginbfchar\n%s\nendbfchar\n",
+            list.length, list.join("\n")
+          )
         end
 
         to_unicode_cmap = UNICODE_CMAP_TEMPLATE % range_blocks.strip
@@ -320,16 +326,18 @@ module Prawn
         cmap << to_unicode_cmap
         cmap.stream.compress!
 
-        reference.data.update(:Subtype => :TrueType,
-                              :BaseFont => basename.to_sym,
-                              :FontDescriptor => descriptor,
-                              :FirstChar => 32,
-                              :LastChar => 255,
-                              :Widths => @document.ref!(widths),
-                              :ToUnicode => cmap)
+        reference.data.update(
+          Subtype: :TrueType,
+          BaseFont: basename.to_sym,
+          FontDescriptor: descriptor,
+          FirstChar: 32,
+          LastChar: 255,
+          Widths: @document.ref!(widths),
+          ToUnicode: cmap
+        )
       end
 
-      UNICODE_CMAP_TEMPLATE = <<-STR.strip.gsub(/^\s*/, "")
+      UNICODE_CMAP_TEMPLATE = <<-STR.strip.gsub(/^\s*/, '')
         /CIDInit /ProcSet findresource begin
         12 dict begin
         begincmap

data/lib/prawn/font_metric_cache.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # font_metric_cache.rb : The Prawn font class
 #
 # Copyright Dec 2012, Kenneth Kalmer. All Rights Reserved.
@@ -24,19 +22,22 @@ module Prawn
     def width_of(string, options)
       f = if options[:style]
             # override style with :style => :bold
-            @document.find_font(@document.font.family, :style => options[:style])
+            @document.find_font(@document.font.family, style: options[:style])
           else
             @document.font
           end
 
-      key = CacheEntry.new(f, options, string)
+      encoded_string = f.normalize_encoding(string)
+
+      key = CacheEntry.new(f, options, encoded_string)
+
+      @cache[key] ||= f.compute_width_of(encoded_string, options)
 
-      unless length = @cache[ key ]
-        length = @cache[ key ] = f.compute_width_of(string, options)
-      end
+      length = @cache[key]
 
       length +
-        (@document.character_spacing * @document.font.character_count(string))
+        (@document.character_spacing *
+         @document.font.character_count(encoded_string))
     end
   end
 end

data/lib/prawn/graphics.rb

@@ -1,19 +1,17 @@
-# encoding: utf-8
-
 # graphics.rb : Implements PDF drawing primitives
 #
 # Copyright April 2008, Gregory Brown.  All Rights Reserved.
 #
 # This is free software. Please see the LICENSE and COPYING files for details.
 
-require_relative "graphics/blend_mode"
-require_relative "graphics/color"
-require_relative "graphics/dash"
-require_relative "graphics/cap_style"
-require_relative "graphics/join_style"
-require_relative "graphics/transparency"
-require_relative "graphics/transformation"
-require_relative "graphics/patterns"
+require_relative 'graphics/blend_mode'
+require_relative 'graphics/color'
+require_relative 'graphics/dash'
+require_relative 'graphics/cap_style'
+require_relative 'graphics/join_style'
+require_relative 'graphics/transparency'
+require_relative 'graphics/transformation'
+require_relative 'graphics/patterns'
 
 module Prawn
   # Implements the drawing facilities for Prawn::Document.
@@ -66,9 +64,11 @@ module Prawn
     #   pdf.curve_to [100,100], :bounds => [[90,90],[75,75]]
     #
     def curve_to(dest, options = {})
-      options[:bounds] or fail Prawn::Errors::InvalidGraphicsPath,
-                               "Bounding points for bezier curve must be specified " \
-                               "as :bounds => [[x1,y1],[x2,y2]]"
+      options[:bounds] || raise(
+        Prawn::Errors::InvalidGraphicsPath,
+        'Bounding points for bezier curve must be specified ' \
+        'as :bounds => [[x1,y1],[x2,y2]]'
+      )
 
       curve_points = PDF::Core.real_params(
         (options[:bounds] << dest).flat_map { |e| map_to_absolute(e) }
@@ -97,7 +97,9 @@ module Prawn
     #
     def rounded_rectangle(point, width, height, radius)
       x, y = point
-      rounded_polygon(radius, point, [x + width, y], [x + width, y - height], [x, y - height])
+      rounded_polygon(
+        radius, point, [x + width, y], [x + width, y - height], [x, y - height]
+      )
     end
 
     ###########################################################
@@ -146,11 +148,11 @@ module Prawn
     #  horizontal_line 25, 100, :at => 75
     #
     def horizontal_line(x1, x2, options = {})
-      if options[:at]
-        y1 = options[:at]
-      else
-        y1 = y - bounds.absolute_bottom
-      end
+      y1 = if options[:at]
+             options[:at]
+           else
+             y - bounds.absolute_bottom
+           end
 
       line(x1, y1, x2, y1)
     end
@@ -186,9 +188,9 @@ module Prawn
     #
     KAPPA = 4.0 * ((Math.sqrt(2) - 1.0) / 3.0)
 
-    # Draws a circle of radius <tt>radius</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 circle.
+    # Draws a circle of radius <tt>radius</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 circle.
     #
     #    pdf.circle [100,100], 25
     #
@@ -213,19 +215,19 @@ module Prawn
 
       # Upper right hand corner
       curve_to [x,  y + r2],
-               :bounds => [[x + r1, y + l2], [x + l1, y + r2]]
+        bounds: [[x + r1, y + l2], [x + l1, y + r2]]
 
       # Upper left hand corner
       curve_to [x - r1, y],
-               :bounds => [[x - l1, y + r2], [x - r1, y + l2]]
+        bounds: [[x - l1, y + r2], [x - r1, y + l2]]
 
       # Lower left hand corner
       curve_to [x, y - r2],
-               :bounds => [[x - r1, y - l2], [x - l1, y - r2]]
+        bounds: [[x - r1, y - l2], [x - l1, y - r2]]
 
       # Lower right hand corner
       curve_to [x + r1, y],
-               :bounds => [[x + l1, y - r2], [x + r1, y - l2]]
+        bounds: [[x + l1, y - r2], [x + r1, y - l2]]
 
       move_to(x, y)
     end
@@ -241,35 +243,47 @@ module Prawn
         line_to(*point)
       end
       # close the path
-      renderer.add_content "h"
+      renderer.add_content 'h'
     end
 
-    # Draws a rounded polygon from specified points using the radius to define bezier curves
+    # Draws a rounded polygon from specified points using the radius to define
+    # bezier curves
     #
-    #  # draws a rounded filled in polygon
-    #   pdf.fill_and_stroke_rounded_polygon(10, [100, 250], [200, 300], [300, 250],
-    #                 [300, 150], [200, 100], [100, 150])
+    #   # draws a rounded filled in polygon
+    #   pdf.fill_and_stroke_rounded_polygon(
+    #     10, [100, 250], [200, 300], [300, 250], [300, 150], [200, 100],
+    #     [100, 150]
+    #   )
     def rounded_polygon(radius, *points)
       move_to point_on_line(radius, points[1], points[0])
       sides = points.size
       points << points[0] << points[1]
-      (sides).times do |i|
+      sides.times do |i|
         rounded_vertex(radius, points[i], points[i + 1], points[i + 2])
       end
       # close the path
-      renderer.add_content "h"
+      renderer.add_content 'h'
     end
 
-    # Creates a rounded vertex for a line segment used for building a rounded polygon
-    # requires a radius to define bezier curve and three points. The first two points define
-    # the line segment and the third point helps define the curve for the vertex.
+    # Creates a rounded vertex for a line segment used for building a rounded
+    # polygon requires a radius to define bezier curve and three points. The
+    # first two points define the line segment and the third point helps define
+    # the curve for the vertex.
     def rounded_vertex(radius, *points)
-      radial_point_1 = point_on_line(radius, points[0], points[1])
-      bezier_point_1 = point_on_line((radius - radius * KAPPA), points[0], points[1])
-      radial_point_2 = point_on_line(radius, points[2], points[1])
-      bezier_point_2 = point_on_line((radius - radius * KAPPA), points[2], points[1])
-      line_to(radial_point_1)
-      curve_to(radial_point_2, :bounds => [bezier_point_1, bezier_point_2])
+      radial_point1 = point_on_line(radius, points[0], points[1])
+      bezier_point1 = point_on_line(
+        (radius - radius * KAPPA),
+        points[0],
+        points[1]
+      )
+      radial_point2 = point_on_line(radius, points[2], points[1])
+      bezier_point2 = point_on_line(
+        (radius - radius * KAPPA),
+        points[2],
+        points[1]
+      )
+      line_to(radial_point1)
+      curve_to(radial_point2, bounds: [bezier_point1, bezier_point2])
     end
 
     # Strokes the current path. If a block is provided, yields to the block
@@ -277,7 +291,7 @@ module Prawn
     #
     def stroke
       yield if block_given?
-      renderer.add_content "S"
+      renderer.add_content 'S'
     end
 
     # Closes and strokes the current path. If a block is provided, yields to
@@ -285,7 +299,7 @@ module Prawn
     #
     def close_and_stroke
       yield if block_given?
-      renderer.add_content "s"
+      renderer.add_content 's'
     end
 
     # Draws and strokes a rectangle represented by the current bounding box
@@ -320,38 +334,56 @@ module Prawn
     #
     def stroke_axis(options = {})
       options = {
-        :at => [0, 0],
-        :height => bounds.height.to_i - (options[:at] || [0, 0])[1],
-        :width => bounds.width.to_i - (options[:at] || [0, 0])[0],
-        :step_length => 100,
-        :negative_axes_length => 20,
-        :color => "000000"
+        at: [0, 0],
+        height: bounds.height.to_i - (options[:at] || [0, 0])[1],
+        width: bounds.width.to_i - (options[:at] || [0, 0])[0],
+        step_length: 100,
+        negative_axes_length: 20,
+        color: '000000'
       }.merge(options)
 
-      Prawn.verify_options([:at, :width, :height, :step_length,
-                            :negative_axes_length, :color], options)
+      Prawn.verify_options(
+        [
+          :at, :width, :height, :step_length,
+          :negative_axes_length, :color
+        ], options
+      )
 
       save_graphics_state do
         fill_color(options[:color])
         stroke_color(options[:color])
 
-        dash(1, :space => 4)
-        stroke_horizontal_line(options[:at][0] - options[:negative_axes_length],
-                               options[:at][0] + options[:width], :at => options[:at][1])
-        stroke_vertical_line(options[:at][1] - options[:negative_axes_length],
-                             options[:at][1] + options[:height], :at => options[:at][0])
+        dash(1, space: 4)
+        stroke_horizontal_line(
+          options[:at][0] - options[:negative_axes_length],
+          options[:at][0] + options[:width], at: options[:at][1]
+        )
+        stroke_vertical_line(
+          options[:at][1] - options[:negative_axes_length],
+          options[:at][1] + options[:height], at: options[:at][0]
+        )
         undash
 
         fill_circle(options[:at], 1)
 
-        (options[:step_length]..options[:width]).step(options[:step_length]) do |point|
+        (options[:step_length]..options[:width])
+          .step(options[:step_length]) do |point|
           fill_circle([options[:at][0] + point, options[:at][1]], 1)
-          draw_text(point, :at => [options[:at][0] + point - 5, options[:at][1] - 10], :size => 7)
+          draw_text(
+            point,
+            at: [options[:at][0] + point - 5, options[:at][1] - 10],
+            size: 7
+          )
         end
 
-        (options[:step_length]..options[:height]).step(options[:step_length]) do |point|
+        (options[:step_length]..options[:height])
+          .step(options[:step_length]) do |point|
           fill_circle([options[:at][0], options[:at][1] + point], 1)
-          draw_text(point, :at => [options[:at][0] - 17, options[:at][1] + point - 2], :size => 7)
+          draw_text(
+            point,
+            at: [options[:at][0] - 17, options[:at][1] + point - 2],
+            size: 7
+          )
         end
       end
     end
@@ -365,7 +397,7 @@ module Prawn
     #
     def fill(options = {})
       yield if block_given?
-      renderer.add_content(options[:fill_rule] == :even_odd ? "f*" : "f")
+      renderer.add_content(options[:fill_rule] == :even_odd ? 'f*' : 'f')
     end
 
     # Closes, fills, and strokes the current path. If a block is provided,
@@ -379,13 +411,13 @@ module Prawn
     #
     def fill_and_stroke(options = {})
       yield if block_given?
-      renderer.add_content(options[:fill_rule] == :even_odd ? "b*" : "b")
+      renderer.add_content(options[:fill_rule] == :even_odd ? 'b*' : 'b')
     end
 
     # Closes the current path.
     #
     def close_path
-      renderer.add_content "h"
+      renderer.add_content 'h'
     end
 
     ##
@@ -594,12 +626,20 @@ module Prawn
     # :call-seq:
     #   fill_and_stroke_rounded_polygon(radius, *points)
 
-    ops    = %w{fill stroke fill_and_stroke}
-    shapes = %w{line_to curve_to rectangle rounded_rectangle line horizontal_line horizontal_rule vertical_line
-                curve circle_at circle ellipse_at ellipse polygon rounded_polygon rounded_vertex}
+    ops = %w[fill stroke fill_and_stroke]
+    shapes = %w[
+      line_to curve_to rectangle rounded_rectangle line horizontal_line
+      horizontal_rule vertical_line curve circle_at circle ellipse_at ellipse
+      polygon rounded_polygon rounded_vertex
+    ]
 
     ops.product(shapes).each do |operation, shape|
-      class_eval "def #{operation}_#{shape}(*args); #{shape}(*args); #{operation}; end"
+      class_eval <<-END
+        def #{operation}_#{shape}(*args)
+          #{shape}(*args)
+          #{operation}
+        end
+      END
     end
 
     private
@@ -629,8 +669,8 @@ module Prawn
       angle * Math::PI / 180
     end
 
-    # Returns the coordinates for a point on a line that is a given distance away from the second
-    # point defining the line segement
+    # Returns the coordinates for a point on a line that is a given distance
+    # away from the second point defining the line segement
     def point_on_line(distance_from_end, *points)
       x0, y0, x1, y1 = points.flatten
       length = Math.sqrt((x1 - x0)**2 + (y1 - y0)**2)