prawn 0.13.0 → 2.4.0

data/lib/prawn/text/formatted/parser.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # text/formatted/parser.rb : Implements a bi-directional parser between a subset
 #                            of html and formatted text arrays
@@ -11,86 +11,91 @@
 module Prawn
   module Text
     module Formatted
-
       class Parser
-        PARSER_REGEX = begin
-          regex_string = "\n|" +
-                         "<b>|</b>|" +
-                         "<i>|</i>|" +
-                         "<u>|</u>|" +
-                         "<strikethrough>|</strikethrough>|" +
-                         "<sub>|</sub>|" +
-                         "<sup>|</sup>|" +
-                         "<link[^>]*>|</link>|" +
-                         "<color[^>]*>|</color>|" +
-                         "<font[^>]*>|</font>|" +
-                         "<strong>|</strong>|" +
-                         "<em>|</em>|" +
-                         "<a[^>]*>|</a>|" +
-                         "[^<\n]+"
-          Regexp.new(regex_string, Regexp::MULTILINE)
-        end
+        # @group Extension API
+
+        PARSER_REGEX =
+          begin
+            regex_string = "\n|" \
+                          '<b>|</b>|' \
+                          '<i>|</i>|' \
+                          '<u>|</u>|' \
+                          '<strikethrough>|</strikethrough>|' \
+                          '<sub>|</sub>|' \
+                          '<sup>|</sup>|' \
+                          '<link[^>]*>|</link>|' \
+                          '<color[^>]*>|</color>|' \
+                          '<font[^>]*>|</font>|' \
+                          '<strong>|</strong>|' \
+                          '<em>|</em>|' \
+                          '<a[^>]*>|</a>|' \
+                          "[^<\n]+"
+            Regexp.new(regex_string, Regexp::MULTILINE)
+          end
 
-        def self.format(string, *args)
-          tokens = string.gsub(/<br\s*\/?>/, "\n").scan(PARSER_REGEX)
-          self.array_from_tokens(tokens)
+        def self.format(string, *_args)
+          tokens = string.gsub(%r{<br\s*/?>}, "\n").scan(PARSER_REGEX)
+          array_from_tokens(tokens)
         end
 
         def self.to_string(array)
-          prefixes = { :bold => "<b>",
-                       :italic => "<i>",
-                       :underline => "<u>",
-                       :strikethrough => "<strikethrough>",
-                       :subscript => "<sub>",
-                       :superscript => "<sup>" }
-          suffixes = { :bold => "</b>",
-                       :italic => "</i>",
-                       :underline => "</u>",
-                       :strikethrough => "</strikethrough>",
-                       :subscript => "</sub>",
-                       :superscript => "</sup>" }
-          array.collect do |hash|
-            prefix = ""
-            suffix = ""
-            if hash[:styles]
-              hash[:styles].each do |style|
-                prefix = prefix + prefixes[style]
-                suffix = suffixes[style] + suffix
-              end
+          prefixes = {
+            bold: '<b>',
+            italic: '<i>',
+            underline: '<u>',
+            strikethrough: '<strikethrough>',
+            subscript: '<sub>',
+            superscript: '<sup>'
+          }
+          suffixes = {
+            bold: '</b>',
+            italic: '</i>',
+            underline: '</u>',
+            strikethrough: '</strikethrough>',
+            subscript: '</sub>',
+            superscript: '</sup>'
+          }
+          array.map do |hash|
+            prefix = ''
+            suffix = ''
+            hash[:styles]&.each do |style|
+              prefix += prefixes[style]
+              suffix = suffixes[style] + suffix
             end
 
             font = hash[:font] ? " name='#{hash[:font]}'" : nil
             size = hash[:size] ? " size='#{hash[:size]}'" : nil
-            if hash[:character_spacing]
-              character_spacing = " character_spacing='#{hash[:character_spacing]}'"
-            else
-              character_spacing = nil
-            end
+            character_spacing =
+              if hash[:character_spacing]
+                " character_spacing='#{hash[:character_spacing]}'"
+              end
             if font || size || character_spacing
-              prefix = prefix + "<font#{font}#{size}#{character_spacing}>"
-              suffix = "</font>"
+              prefix += "<font#{font}#{size}#{character_spacing}>"
+              suffix = '</font>'
             end
 
             link = hash[:link] ? " href='#{hash[:link]}'" : nil
             anchor = hash[:anchor] ? " anchor='#{hash[:anchor]}'" : nil
             if link || anchor
-              prefix = prefix + "<link#{link}#{anchor}>"
-              suffix = "</link>"
+              prefix += "<link#{link}#{anchor}>"
+              suffix = '</link>'
             end
 
             if hash[:color]
-              if hash[:color].kind_of?(Array)
-                prefix = prefix + "<color c='#{hash[:color][0]}'" +
-                                        " m='#{hash[:color][1]}'" +
-                                        " y='#{hash[:color][2]}'" +
-                                        " k='#{hash[:color][3]}'>"
-              else
-                prefix = prefix + "<color rgb='#{hash[:color]}'>"
-              end
-              suffix = "</color>"
+              prefix +=
+                if hash[:color].is_a?(Array)
+                  "<color c='#{hash[:color][0]}'" \
+                    " m='#{hash[:color][1]}'" \
+                    " y='#{hash[:color][2]}'" \
+                    " k='#{hash[:color][3]}'>"
+                else
+                  "<color rgb='#{hash[:color]}'>"
+                end
+              suffix = '</color>'
             end
 
-            string = hash[:text].gsub("&", "&amp;").gsub(">", "&gt;").gsub("<", "&lt;")
+            string = hash[:text].gsub('&', '&amp;').gsub('>', '&gt;')
+              .gsub('<', '&lt;')
             prefix + string + suffix
           end.join
         end
@@ -103,11 +108,13 @@ module Prawn
           array.each do |hash|
             hash[:text].scan(scan_pattern).each do |string|
               if string == "\n"
-                paragraph << hash.dup.merge(:text => "\n") if previous_string == "\n"
+                if previous_string == "\n"
+                  paragraph << hash.dup.merge(text: "\n")
+                end
                 paragraphs << paragraph unless paragraph.empty?
                 paragraph = []
               else
-                paragraph << hash.dup.merge(:text => string)
+                paragraph << hash.dup.merge(text: string)
               end
               previous_string = string
             end
@@ -116,8 +123,6 @@ module Prawn
           paragraphs
         end
 
-        private
-
         def self.array_from_tokens(tokens)
           array = []
           styles = []
@@ -129,93 +134,110 @@ module Prawn
           sizes = []
           character_spacings = []
 
-          while token = tokens.shift
+          tokens.each do |token|
             case token
-            when "<b>", "<strong>"
+            when '<b>', '<strong>'
               styles << :bold
-            when "<i>", "<em>"
+            when '<i>', '<em>'
               styles << :italic
-            when "<u>"
+            when '<u>'
               styles << :underline
-            when "<strikethrough>"
+            when '<strikethrough>'
               styles << :strikethrough
-            when "<sub>"
+            when '<sub>'
               styles << :subscript
-            when "<sup>"
+            when '<sup>'
               styles << :superscript
-            when "</b>", "</strong>"
+            when '</b>', '</strong>'
               styles.delete(:bold)
-            when "</i>", "</em>"
+            when '</i>', '</em>'
               styles.delete(:italic)
-            when "</u>"
+            when '</u>'
               styles.delete(:underline)
-            when "</strikethrough>"
+            when '</strikethrough>'
               styles.delete(:strikethrough)
-            when "</sub>"
+            when '</sub>'
               styles.delete(:subscript)
-            when "</sup>"
+            when '</sup>'
               styles.delete(:superscript)
-            when "</link>", "</a>"
+            when '</link>', '</a>'
               link = nil
               anchor = nil
               local = nil
-            when "</color>"
+            when '</color>'
               colors.pop
-            when "</font>"
+            when '</font>'
               fonts.pop
               sizes.pop
               character_spacings.pop
+            when /^<link[^>]*>$/, /^<a[^>]*>$/
+              matches = /href="([^"]*)"/.match(token) ||
+                /href='([^']*)'/.match(token)
+              link = matches[1] unless matches.nil?
+
+              matches = /anchor="([^"]*)"/.match(token) ||
+                /anchor='([^']*)'/.match(token)
+              anchor = matches[1] unless matches.nil?
+
+              matches = /local="([^"]*)"/.match(token) ||
+                /local='([^']*)'/.match(token)
+              local = matches[1] unless matches.nil?
+            when /^<color[^>]*>$/
+              matches = /rgb="#?([^"]*)"/.match(token) ||
+                /rgb='#?([^']*)'/.match(token)
+              colors << matches[1] if matches
+
+              match = /c="#?([^"]*)"/.match(token) ||
+                /c='#?([^']*)'/.match(token)
+              c = match[1].to_i unless match.nil?
+              match = /m="#?([^"]*)"/.match(token) ||
+                /m='#?([^']*)'/.match(token)
+              m = match[1].to_i unless match.nil?
+              match = /y="#?([^"]*)"/.match(token) ||
+                /y='#?([^']*)'/.match(token)
+              y = match[1].to_i unless match.nil?
+              match = /k="#?([^"]*)"/.match(token) ||
+                /k='#?([^']*)'/.match(token)
+              k = match[1].to_i unless match.nil?
+              colors << [c, m, y, k] if [c, m, y, k].all?
+
+              # intend to support rgb="#ffffff" or rgb='#ffffff',
+              # r="255" g="255" b="255" or r='255' g='255' b='255',
+              # and c="100" m="100" y="100" k="100" or
+              # c='100' m='100' y='100' k='100'
+              # color = { :rgb => "#ffffff" }
+              # color = { :r => 255, :g => 255, :b => 255 }
+              # color = { :c => 100, :m => 100, :y => 100, :k => 100 }
+            when /^<font[^>]*>$/
+              matches = /name="([^"]*)"/.match(token) ||
+                /name='([^']*)'/.match(token)
+              fonts << matches[1] unless matches.nil?
+
+              matches = /size="([^"]*)"/.match(token) ||
+                /size='([^']*)'/.match(token)
+              sizes << matches[1].to_f unless matches.nil?
+
+              matches = /character_spacing="([^"]*)"/.match(token) ||
+                /character_spacing='([^']*)'/.match(token)
+              character_spacings << matches[1].to_f unless matches.nil?
             else
-              if token =~ /^<link[^>]*>$/ or token =~ /^<a[^>]*>$/
-                matches = /href="([^"]*)"/.match(token) || /href='([^']*)'/.match(token)
-                link = matches[1] unless matches.nil?
-
-                matches = /anchor="([^"]*)"/.match(token) || /anchor='([^']*)'/.match(token)
-                anchor = matches[1] unless matches.nil?
-
-                matches = /local="([^"]*)"/.match(token) || /local='([^']*)'/.match(token)
-                local = matches[1] unless matches.nil?
-              elsif token =~ /^<color[^>]*>$/
-                matches = /rgb="#?([^"]*)"/.match(token) || /rgb='#?([^']*)'/.match(token)
-                colors << matches[1] if matches
-
-                matches = /c="#?([^"]*)" +m="#?([^"]*)" +y="#?([^"]*)" +k="#?([^"]*)"/.match(token) ||
-                          /c='#?([^']*)' +m='#?([^']*)' +y='#?([^']*)' +k='#?([^']*)'/.match(token)
-                colors << [matches[1].to_i, matches[2].to_i, matches[3].to_i, matches[4].to_i] if matches
-
-                # intend to support rgb="#ffffff" or rgb='#ffffff',
-                # r="255" g="255" b="255" or r='255' g='255' b='255',
-                # and c="100" m="100" y="100" k="100" or
-                # c='100' m='100' y='100' k='100'
-                # color = { :rgb => "#ffffff" }
-                # color = { :r => 255, :g => 255, :b => 255 }
-                # color = { :c => 100, :m => 100, :y => 100, :k => 100 }
-              elsif token =~ /^<font[^>]*>$/
-                matches = /name="([^"]*)"/.match(token) || /name='([^']*)'/.match(token)
-                fonts << matches[1] unless matches.nil?
-
-                matches = /size="([^"]*)"/.match(token) || /size='([^']*)'/.match(token)
-                sizes << matches[1].to_f unless matches.nil?
-
-                matches = /character_spacing="([^"]*)"/.match(token) || /character_spacing='([^']*)'/.match(token)
-                character_spacings << matches[1].to_f unless matches.nil?
-              else
-                string = token.gsub("&lt;", "<").gsub("&gt;", ">").gsub("&amp;", "&")
-                array << { :text => string,
-                           :styles => styles.dup,
-                           :color => colors.last,
-                           :local => local,
-                           :link => link,
-                           :anchor => anchor,
-                           :font => fonts.last,
-                           :size => sizes.last,
-                           :character_spacing => character_spacings.last }
-              end
+              string = token.gsub('&lt;', '<').gsub('&gt;', '>')
+                .gsub('&amp;', '&')
+              array << {
+                text: string,
+                styles: styles.dup,
+                color: colors.last,
+                local: local,
+                link: link,
+                anchor: anchor,
+                font: fonts.last,
+                size: sizes.last,
+                character_spacing: character_spacings.last
+              }
             end
           end
           array
         end
-
       end
     end
   end

data/lib/prawn/text/formatted/wrap.rb

@@ -1,18 +1,29 @@
-require_relative "line_wrap"
-require_relative "arranger"
+# frozen_string_literal: true
+
+# wrap.rb: Handles text wrapping for for formatted text
+#
+# Contributed by Daniel Nelson
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+require_relative 'line_wrap'
+require_relative 'arranger'
 
 module Prawn
   module Text
     module Formatted #:nodoc:
-      module Wrap #:nodoc:
+      # @private
 
-        def initialize(array, options)
+      module Wrap #:nodoc:
+        def initialize(_array, options)
           @line_wrap = Prawn::Text::Formatted::LineWrap.new
-          @arranger = Prawn::Text::Formatted::Arranger.new(@document,
-            :kerning => options[:kerning])
+          @arranger = Prawn::Text::Formatted::Arranger.new(
+            @document,
+            kerning: options[:kerning]
+          )
+          @disable_wrap_by_char = options[:disable_wrap_by_char]
         end
 
-
         # See the developer documentation for PDF::Core::Text#wrap
         #
         # Formatted#wrap should set the following variables:
@@ -37,14 +48,17 @@ module Prawn
           initialize_wrap(array)
 
           stop = false
-          while !stop
+          until stop
             # wrap before testing if enough height for this line because the
             # height of the highest fragment on this line will be used to
             # determine the line height
-            @line_wrap.wrap_line(:document => @document,
-                                 :kerning => @kerning,
-                                 :width => available_width,
-                                 :arranger => @arranger)
+            @line_wrap.wrap_line(
+              document: @document,
+              kerning: @kerning,
+              width: available_width,
+              arranger: @arranger,
+              disable_wrap_by_char: @disable_wrap_by_char
+            )
 
             if enough_height_for_this_line?
               move_baseline_down
@@ -68,34 +82,37 @@ module Prawn
           fragments_this_line = []
 
           word_spacing = word_spacing_for_this_line
-          while fragment = @arranger.retrieve_fragment
+          @arranger.fragments.each do |fragment|
             fragment.word_spacing = word_spacing
             if fragment.text == "\n"
-              printed_fragments << "\n" if @printed_lines.last == ""
+              printed_fragments << "\n" if @printed_lines.last == ''
               break
             end
             printed_fragments << fragment.text
             fragments_this_line << fragment
           end
+          @arranger.fragments.replace []
 
           accumulated_width = 0
           fragments_this_line.reverse! if @direction == :rtl
           fragments_this_line.each do |fragment_this_line|
             fragment_this_line.default_direction = @direction
-            format_and_draw_fragment(fragment_this_line, accumulated_width,
-                                     @line_wrap.width, word_spacing)
+            format_and_draw_fragment(
+              fragment_this_line,
+              accumulated_width,
+              @line_wrap.width,
+              word_spacing
+            )
             accumulated_width += fragment_this_line.width
           end
 
-          if "".respond_to?(:force_encoding)
-            printed_fragments.map! { |s| s.force_encoding("utf-8") }
-          end
-          @printed_lines << printed_fragments.join
+          @printed_lines << printed_fragments.map do |s|
+            s.dup.force_encoding(::Encoding::UTF_8)
+          end.join
         end
 
         def word_spacing_for_this_line
-          if @align == :justify &&
-              @line_wrap.space_count > 0 &&
+          if @align == :justify && @line_wrap.space_count.positive? &&
               !@line_wrap.paragraph_finished?
             (available_width - @line_wrap.width) / @line_wrap.space_count
           else
@@ -105,13 +122,14 @@ module Prawn
 
         def enough_height_for_this_line?
           @line_height = @arranger.max_line_height
-          @descender   = @arranger.max_descender
-          @ascender    = @arranger.max_ascender
-          if @baseline_y == 0
-            diff = @ascender + @descender
-          else
-            diff = @descender + @line_height + @leading
-          end
+          @descender = @arranger.max_descender
+          @ascender = @arranger.max_ascender
+          diff =
+            if @baseline_y.zero?
+              @ascender + @descender
+            else
+              @descender + @line_height + @leading
+            end
           require_relatived_total_height = @baseline_y.abs + diff
           if require_relatived_total_height > @height + 0.0001
             # no room for the full height of this line
@@ -128,23 +146,25 @@ module Prawn
 
           # these values will depend on the maximum value within a given line
           @line_height = 0
-          @descender   = 0
-          @ascender    = 0
-          @baseline_y  = 0
+          @descender = 0
+          @ascender = 0
+          @baseline_y = 0
 
           @printed_lines = []
           @nothing_printed = true
           @everything_printed = false
         end
 
-        def format_and_draw_fragment(fragment, accumulated_width,
-                                     line_width, word_spacing)
+        def format_and_draw_fragment(fragment, accumulated_width, line_width, word_spacing)
           @arranger.apply_color_and_font_settings(fragment) do
-            draw_fragment(fragment, accumulated_width,
-                          line_width, word_spacing)
+            draw_fragment(
+              fragment,
+              accumulated_width,
+              line_width,
+              word_spacing
+            )
           end
         end
-
       end
     end
   end

data/lib/prawn/text/formatted.rb

@@ -1,5 +1,7 @@
-require_relative "formatted/wrap"
+# frozen_string_literal: true
 
-require_relative "formatted/box"
-require_relative "formatted/parser"
-require_relative "formatted/fragment"
+require_relative 'formatted/wrap'
+
+require_relative 'formatted/box'
+require_relative 'formatted/parser'
+require_relative 'formatted/fragment'