prawn 0.13.0 → 2.4.0

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # prawn/font/ttf.rb : Implements AFM font support for Prawn
 #
@@ -11,43 +11,68 @@ require 'ttfunk'
 require 'ttfunk/subset_collection'
 
 module Prawn
-  class Font
+  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?
         true
       end
 
-      def initialize(document, name, options={})
+      def initialize(document, name, options = {})
         super
 
-        @ttf              = read_ttf_file
-        @subsets          = TTFunk::SubsetCollection.new(@ttf)
+        @ttf = read_ttf_file
+        @subsets = TTFunk::SubsetCollection.new(@ttf)
+        @italic_angle = nil
 
-        @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.
-      def compute_width_of(string, options={}) #:nodoc:
+      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) { |s2, u| s2 + character_width_by_code(u) }
+              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
@@ -60,9 +85,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
@@ -72,14 +100,16 @@ module Prawn
       #
       # The +text+ parameter must be UTF8-encoded.
       #
-      def encode_text(text,options={})
+      def encode_text(text, options = {})
         text = text.chomp
 
         if options[:kerning]
           last_subset = nil
-          kern(text).inject([]) do |result, element|
+          kern(text).reduce([]) 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
@@ -99,7 +129,7 @@ module Prawn
             end
           end
         else
-          @subsets.encode(text.unpack("U*"))
+          @subsets.encode(text.unpack('U*'))
         end
       end
 
@@ -108,26 +138,32 @@ module Prawn
       end
 
       # not sure how to compute this for true-type fonts...
-      def stemV
+      def stem_v
         0
       end
 
       def italic_angle
-        @italic_angle ||= if @ttf.postscript.exists?
+        return @italic_angle if @italic_angle
+
+        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
-          "#{hi}.#{low}".to_f
+          @italic_angle = "#{hi}.#{low}".to_f
         else
-          0
+          @italic_angle = 0
         end
+
+        @italic_angle
       end
 
       def cap_height
-        @cap_height ||= begin
-          height = @ttf.os2.exists? && @ttf.os2.cap_height || 0
-          height == 0 ? @ascender : height
-        end
+        @cap_height ||=
+          begin
+            height = @ttf.os2.exists? && @ttf.os2.cap_height || 0
+            height.zero? ? @ascender : height
+          end
       end
 
       def x_height
@@ -141,7 +177,7 @@ module Prawn
       end
 
       def serif?
-        @serif ||= [1,2,3,4,5,7].include?(family_class)
+        @serif ||= [1, 2, 3, 4, 5, 7].include?(family_class)
       end
 
       def script?
@@ -149,35 +185,47 @@ module Prawn
       end
 
       def pdf_flags
-        @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
-          flags |= 0x0004 # assume the font contains at least some non-latin characters
-        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.normalize_to_utf8
+        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. " \
+          'Please ensure the encoding of the string you are attempting ' \
+          'to use is set correctly'
+      end
+
+      def to_utf8(text)
+        text.encode('UTF-8')
       end
 
       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).
       #
       def character_count(str)
-        str.unicode_length
+        str.length
       end
 
       private
 
       def cmap
-        @cmap ||= @ttf.cmap.unicode.first or raise("no unicode cmap for font")
+        (@cmap ||= @ttf.cmap.unicode.first) || raise(NoUnicodeCMap.new(font: name))
       end
 
       # +string+ must be UTF8-encoded.
@@ -203,12 +251,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*")
+        @kern_pairs_table ||=
+          if has_kerning_data?
+            @ttf.kerning.tables.first.pairs
+          else
+            {}
+          end
       end
 
       def hmtx
@@ -226,16 +274,16 @@ 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)
-        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.before_render { |doc| embed(ref, subset) }
+        @document.renderer.before_render { |_doc| embed(ref, subset) }
 
         ref
       end
@@ -250,29 +298,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")
 
-        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 = @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: stem_v,
+          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.
@@ -287,15 +338,24 @@ 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 << "<%02x><%04x>" % [code, unicode]
+          ranges.last << format(
+            '<%<code>02x><%<unicode>04x>',
+            code: code,
+            unicode: unicode
+          )
         end
 
-        range_blocks = ranges.inject("") do |s, list|
-          s << "%d beginbfchar\n%s\nendbfchar\n" % [list.length, 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
 
@@ -303,16 +363,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/graphics/blend_mode.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# blend_mode.rb : Implements blend modes
+#
+# Contributed by John Ford. October, 2015
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+
+module Prawn
+  module Graphics
+    # The Prawn::BlendMode module is used to change the way
+    # two layers are blended together.
+    #
+    # Passing an array of blend modes is allowed. PDF viewers should
+    # blend layers based on the first recognized blend mode.
+    #
+    # Valid blend modes in v1.4 of the PDF spec include :Normal, :Multiply,
+    # :Screen, :Overlay, :Darken, :Lighten, :ColorDodge, :ColorBurn, :HardLight,
+    # :SoftLight, :Difference, :Exclusion, :Hue, :Saturation, :Color, and
+    # :Luminosity.
+    #
+    # Example:
+    #   pdf.fill_color('0000ff')
+    #   pdf.fill_rectangle([x, y+25], 50, 50)
+    #   pdf.blend_mode(:Multiply) do
+    #     pdf.fill_color('ff0000')
+    #     pdf.fill_circle([x, y], 25)
+    #   end
+    #
+    module BlendMode
+      # @group Stable API
+
+      def blend_mode(blend_mode = :Normal)
+        renderer.min_version(1.4)
+
+        save_graphics_state if block_given?
+        renderer.add_content "/#{blend_mode_dictionary_name(blend_mode)} gs"
+        if block_given?
+          yield
+          restore_graphics_state
+        end
+      end
+
+      private
+
+      def blend_mode_dictionary_registry
+        @blend_mode_dictionary_registry ||= {}
+      end
+
+      def blend_mode_dictionary_name(blend_mode)
+        key = Array(blend_mode).join('')
+        dictionary_name = "BM#{key}"
+
+        dictionary = blend_mode_dictionary_registry[dictionary_name] ||= ref!(
+          Type: :ExtGState,
+          BM: blend_mode
+        )
+
+        page.ext_gstates[dictionary_name] = dictionary
+        dictionary_name
+      end
+    end
+  end
+end

data/lib/prawn/graphics/cap_style.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # cap_style.rb : Implements stroke cap styling
 #
@@ -9,8 +9,9 @@
 module Prawn
   module Graphics
     module CapStyle
+      # @group Stable API
 
-      CAP_STYLES = { :butt => 0, :round => 1, :projecting_square => 2 }
+      CAP_STYLES = { butt: 0, round: 1, projecting_square: 2 }.freeze
 
       # Sets the cap style for stroked lines and curves
       #
@@ -18,7 +19,7 @@ module Prawn
       #
       # NOTE: If this method is never called, :butt will be used by default.
       #
-      def cap_style(style=nil)
+      def cap_style(style = nil)
         return current_cap_style || :butt if style.nil?
 
         self.current_cap_style = style
@@ -26,7 +27,7 @@ module Prawn
         write_stroke_cap_style
       end
 
-      alias_method :cap_style=, :cap_style
+      alias cap_style= cap_style
 
       private
 
@@ -39,7 +40,7 @@ module Prawn
       end
 
       def write_stroke_cap_style
-        add_content "#{CAP_STYLES[current_cap_style]} J"
+        renderer.add_content "#{CAP_STYLES[current_cap_style]} J"
       end
     end
   end

data/lib/prawn/graphics/color.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # color.rb : Implements color handling
 #
@@ -9,6 +9,7 @@
 module Prawn
   module Graphics
     module Color
+      # @group Stable API
 
       # Sets or returns the fill color.
       #
@@ -26,11 +27,12 @@ module Prawn
       #
       def fill_color(*color)
         return current_fill_color if color.empty?
+
         self.current_fill_color = process_color(*color)
         set_fill_color
       end
 
-      alias_method :fill_color=, :fill_color
+      alias fill_color= fill_color
 
       # Sets or returns the line stroking color.
       #
@@ -48,12 +50,13 @@ 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)
       end
 
-      alias_method :stroke_color=, :stroke_color
+      alias stroke_color= stroke_color
 
       module_function
 
@@ -64,7 +67,7 @@ module Prawn
       #   => "ff7808"
       #
       def rgb2hex(rgb)
-        rgb.map { |e| "%02x" % e }.join
+        rgb.map { |e| format '%<value>02x', value: e }.join
       end
 
       # Converts hex string into RGB value array:
@@ -73,14 +76,16 @@ module Prawn
       #  => [255, 120, 8]
       #
       def hex2rgb(hex)
-        r,g,b = hex[0..1], hex[2..3], hex[4..5]
-        [r,g,b].map { |e| e.to_i(16) }
+        r = hex[0..1]
+        g = hex[2..3]
+        b = hex[4..5]
+        [r, g, b].map { |e| e.to_i(16) }
       end
 
       private
 
       def process_color(*color)
-        case(color.size)
+        case color.size
         when 1
           color[0]
         when 4
@@ -93,7 +98,11 @@ module Prawn
       def color_type(color)
         case color
         when String
-          :RGB
+          if /\A\h{6}\z/.match?(color)
+            :RGB
+          else
+            raise ArgumentError, "Unknown type of color: #{color.inspect}"
+          end
         when Array
           case color.length
           when 3
@@ -109,16 +118,16 @@ module Prawn
       def normalize_color(color)
         case color_type(color)
         when :RGB
-          r,g,b = hex2rgb(color)
+          r, g, b = hex2rgb(color)
           [r / 255.0, g / 255.0, b / 255.0]
         when :CMYK
-          c,m,y,k = *color
+          c, m, y, k = *color
           [c / 100.0, m / 100.0, y / 100.0, k / 100.0]
         end
       end
 
       def color_to_s(color)
-        normalize_color(color).map { |c| '%.3f' % c }.join(' ')
+        PDF::Core.real_params normalize_color(color)
       end
 
       def color_space(color)
@@ -130,42 +139,48 @@ module Prawn
         end
       end
 
-      COLOR_SPACES = [:DeviceRGB, :DeviceCMYK, :Pattern]
+      COLOR_SPACES = %i[DeviceRGB DeviceCMYK Pattern].freeze
 
       def set_color_space(type, color_space)
         # don't set the same color space again
-        return if current_color_space(type) == color_space && !state.page.in_stamp_stream?
+        if current_color_space(type) == color_space &&
+            !state.page.in_stamp_stream?
+          return
+        end
+
         set_current_color_space(color_space, type)
 
         unless COLOR_SPACES.include?(color_space)
           raise ArgumentError, "unknown color space: '#{color_space}'"
         end
 
-        operator = case type
-        when :fill
-          'cs'
-        when :stroke
-          'CS'
-        else
-          raise ArgumentError, "unknown type '#{type}'"
-        end
+        operator =
+          case type
+          when :fill
+            'cs'
+          when :stroke
+            'CS'
+          else
+            raise ArgumentError, "unknown type '#{type}'"
+          end
 
-        add_content "/#{color_space} #{operator}"
+        renderer.add_content "/#{color_space} #{operator}"
       end
 
       def set_color(type, color, options = {})
-        operator = case type
-        when :fill
-          'scn'
-        when :stroke
-          'SCN'
-        else
-          raise ArgumentError, "unknown type '#{type}'"
-        end
+        operator =
+          case type
+          when :fill
+            'scn'
+          when :stroke
+            'SCN'
+          else
+            raise ArgumentError, "unknown type '#{type}'"
+          end
 
         if options[:pattern]
           set_color_space type, :Pattern
-          add_content "/#{color} #{operator}"
+          renderer.add_content "/#{color} #{operator}"
         else
           set_color_space type, color_space(color)
           color = color_to_s(color)
@@ -186,8 +201,6 @@ module Prawn
         set_stroke_color
       end
 
-      private
-
       def current_color_space(type)
         graphic_state.color_space[type]
       end
@@ -213,19 +226,9 @@ module Prawn
         graphic_state.stroke_color = color
       end
 
-      def write_fill_color
-        write_color(current_fill_color, 'scn')
-      end
-
-      def write_stroke_color
-        write_color(current_fill_color, 'SCN')
-      end
-
       def write_color(color, operator)
-        add_content "#{color} #{operator}"
+        renderer.add_content "#{color} #{operator}"
       end
-
     end
   end
 end
-