prawn-svg 0.28.0 → 0.32.0

data/lib/prawn/svg/elements/image.rb

@@ -15,9 +15,9 @@ class Prawn::SVG::Elements::Image < Prawn::SVG::Elements::Base
 
     raise SkipElementQuietly if state.computed_properties.display == "none"
 
-    @url = attributes['xlink:href'] || attributes['href']
+    @url = href_attribute
     if @url.nil?
-      raise SkipElementError, "image tag must have an xlink:href"
+      raise SkipElementError, "image tag must have an href or xlink:href"
     end
 
     x = x(attributes['x'] || 0)

data/lib/prawn/svg/elements/path.rb

@@ -4,10 +4,31 @@ class Prawn::SVG::Elements::Path < Prawn::SVG::Elements::Base
 
   INSIDE_SPACE_REGEXP = /[ \t\r\n,]*/
   OUTSIDE_SPACE_REGEXP = /[ \t\r\n]*/
-  INSIDE_REGEXP = /#{INSIDE_SPACE_REGEXP}([+-]?(?:[0-9]+(?:\.[0-9]*)?|\.[0-9]+)(?:(?<=[0-9])[eE][+-]?[0-9]+)?)/
-  VALUES_REGEXP = /^#{INSIDE_REGEXP}/
+  INSIDE_REGEXP = /#{INSIDE_SPACE_REGEXP}(?>([+-]?(?:[0-9]+(?:\.[0-9]*)?|\.[0-9]+)(?:(?<=[0-9])[eE][+-]?[0-9]+)?))/
+  FLAG_REGEXP = /#{INSIDE_SPACE_REGEXP}([01])/
   COMMAND_REGEXP = /^#{OUTSIDE_SPACE_REGEXP}([A-Za-z])((?:#{INSIDE_REGEXP})*)#{OUTSIDE_SPACE_REGEXP}/
 
+  A_PARAMETERS_REGEXP = /^#{INSIDE_REGEXP}#{INSIDE_REGEXP}#{INSIDE_REGEXP}#{FLAG_REGEXP}#{FLAG_REGEXP}#{INSIDE_REGEXP}#{INSIDE_REGEXP}/
+  ONE_PARAMETER_REGEXP = /^#{INSIDE_REGEXP}/
+  TWO_PARAMETER_REGEXP = /^#{INSIDE_REGEXP}#{INSIDE_REGEXP}/
+  FOUR_PARAMETER_REGEXP = /^#{INSIDE_REGEXP}#{INSIDE_REGEXP}#{INSIDE_REGEXP}#{INSIDE_REGEXP}/
+  SIX_PARAMETER_REGEXP = /^#{INSIDE_REGEXP}#{INSIDE_REGEXP}#{INSIDE_REGEXP}#{INSIDE_REGEXP}#{INSIDE_REGEXP}#{INSIDE_REGEXP}/
+
+  COMMAND_MATCH_MAP = {
+    'A' => A_PARAMETERS_REGEXP,
+    'C' => SIX_PARAMETER_REGEXP,
+    'H' => ONE_PARAMETER_REGEXP,
+    'L' => TWO_PARAMETER_REGEXP,
+    'M' => TWO_PARAMETER_REGEXP,
+    'Q' => FOUR_PARAMETER_REGEXP,
+    'S' => FOUR_PARAMETER_REGEXP,
+    'T' => TWO_PARAMETER_REGEXP,
+    'V' => ONE_PARAMETER_REGEXP,
+    'Z' => //,
+  }
+
+  PARAMETERLESS_COMMANDS = COMMAND_MATCH_MAP.select { |_, v| v == // }.map(&:first)
+
   FLOAT_ERROR_DELTA = 1e-10
 
   attr_reader :commands
@@ -16,20 +37,20 @@ class Prawn::SVG::Elements::Path < Prawn::SVG::Elements::Base
     require_attributes 'd'
 
     @commands = []
+    @last_point = nil
 
     data = attributes["d"].gsub(/#{OUTSIDE_SPACE_REGEXP}$/, '')
 
     matched_commands = match_all(data, COMMAND_REGEXP)
     raise SkipElementError, "Invalid/unsupported syntax for SVG path data" if matched_commands.nil?
 
-    catch :invalid_command do
-      matched_commands.each do |matched_command|
-        command = matched_command[1]
-        matched_values = match_all(matched_command[2], VALUES_REGEXP)
-        raise "should be impossible to have invalid inside data, but we ended up here" if matched_values.nil?
-        values = matched_values.collect {|value| value[1].to_f}
-        parse_path_command(command, values)
-      end
+    matched_commands.each do |(command, parameters)|
+      regexp = COMMAND_MATCH_MAP[command.upcase] or break
+      matched_values = match_all(parameters, regexp) or break
+      values = matched_values.map { |value| value.map(&:to_f) }
+      break if values.empty? && !PARAMETERLESS_COMMANDS.include?(command.upcase)
+
+      parse_path_command(command, values)
     end
   end
 
@@ -48,8 +69,7 @@ class Prawn::SVG::Elements::Path < Prawn::SVG::Elements::Base
 
     case upcase_command
     when 'M' # moveto
-      x = values.shift or throw :invalid_command
-      y = values.shift or throw :invalid_command
+      x, y = values.shift
 
       if relative && @last_point
         x += @last_point.first
@@ -68,8 +88,7 @@ class Prawn::SVG::Elements::Path < Prawn::SVG::Elements::Base
 
     when 'L' # lineto
       while values.any?
-        x = values.shift
-        y = values.shift or throw :invalid_command
+        x, y = values.shift
         if relative && @last_point
           x += @last_point.first
           y += @last_point.last
@@ -80,22 +99,21 @@ class Prawn::SVG::Elements::Path < Prawn::SVG::Elements::Base
 
     when 'H' # horizontal lineto
       while values.any?
-        x = values.shift
+        x = values.shift.first
         x += @last_point.first if relative && @last_point
         push_command Prawn::SVG::Pathable::Line.new([x, @last_point.last])
       end
 
     when 'V' # vertical lineto
       while values.any?
-        y = values.shift
+        y = values.shift.first
         y += @last_point.last if relative && @last_point
         push_command Prawn::SVG::Pathable::Line.new([@last_point.first, y])
       end
 
     when 'C' # curveto
       while values.any?
-        x1, y1, x2, y2, x, y = values.shift(6)
-        throw :invalid_command unless y
+        x1, y1, x2, y2, x, y = values.shift
 
         if relative && @last_point
           x += @last_point.first
@@ -112,8 +130,7 @@ class Prawn::SVG::Elements::Path < Prawn::SVG::Elements::Base
 
     when 'S' # shorthand/smooth curveto
       while values.any?
-        x2, y2, x, y = values.shift(4)
-        throw :invalid_command unless y
+        x2, y2, x, y = values.shift
 
         if relative && @last_point
           x += @last_point.first
@@ -136,13 +153,11 @@ class Prawn::SVG::Elements::Path < Prawn::SVG::Elements::Base
     when 'Q', 'T' # quadratic curveto
       while values.any?
         if shorthand = upcase_command == 'T'
-          x, y = values.shift(2)
+          x, y = values.shift
         else
-          x1, y1, x, y = values.shift(4)
+          x1, y1, x, y = values.shift
         end
 
-        throw :invalid_command unless y
-
         if relative && @last_point
           x += @last_point.first
           x1 += @last_point.first if x1
@@ -174,8 +189,7 @@ class Prawn::SVG::Elements::Path < Prawn::SVG::Elements::Base
       return unless @last_point
 
       while values.any?
-        rx, ry, phi, fa, fs, x2, y2 = values.shift(7)
-        throw :invalid_command unless y2
+        rx, ry, phi, fa, fs, x2, y2 = values.shift
 
         x1, y1 = @last_point
 
@@ -276,9 +290,8 @@ class Prawn::SVG::Elements::Path < Prawn::SVG::Elements::Base
   def match_all(string, regexp) # regexp must start with ^
     result = []
     while string != ""
-      matches = string.match(regexp)
-      result << matches
-      return if matches.nil?
+      matches = string.match(regexp) or return
+      result << matches.captures
       string = matches.post_match
     end
     result

data/lib/prawn/svg/elements/root.rb

@@ -8,7 +8,10 @@ class Prawn::SVG::Elements::Root < Prawn::SVG::Elements::Base
   end
 
   def apply
-    add_call 'fill_color', '000000'
+    if [nil, 'inherit', 'none', 'currentColor'].include?(properties.fill)
+      add_call 'fill_color', '000000'
+    end
+
     add_call 'transformation_matrix', @document.sizing.x_scale, 0, 0, @document.sizing.y_scale, 0, 0
     add_call 'transformation_matrix', 1, 0, 0, 1, -@document.sizing.x_offset, @document.sizing.y_offset
   end

data/lib/prawn/svg/elements/text_component.rb

@@ -2,7 +2,7 @@ class Prawn::SVG::Elements::TextComponent < Prawn::SVG::Elements::DepthFirstBase
   attr_reader :commands
 
   Printable = Struct.new(:element, :text, :leading_space?, :trailing_space?)
-  TextState = Struct.new(:parent, :x, :y, :dx, :dy, :rotation, :spacing, :mode)
+  TextState = Struct.new(:parent, :x, :y, :dx, :dy, :rotation, :spacing, :mode, :text_length, :length_adjust)
 
   def parse
     if state.inside_clip_path
@@ -14,6 +14,8 @@ class Prawn::SVG::Elements::TextComponent < Prawn::SVG::Elements::DepthFirstBase
     state.text.dx = (attributes['dx'] || "").split(COMMA_WSP_REGEXP).collect { |n| x_pixels(n) }
     state.text.dy = (attributes['dy'] || "").split(COMMA_WSP_REGEXP).collect { |n| y_pixels(n) }
     state.text.rotation = (attributes['rotate'] || "").split(COMMA_WSP_REGEXP).collect(&:to_f)
+    state.text.text_length = normalize_length(attributes['textLength'])
+    state.text.length_adjust = attributes['lengthAdjust']
     state.text.spacing = calculate_character_spacing
     state.text.mode = calculate_text_rendering_mode
 
@@ -44,9 +46,11 @@ class Prawn::SVG::Elements::TextComponent < Prawn::SVG::Elements::DepthFirstBase
     opts = {
       size:        computed_properties.numerical_font_size,
       style:       font && font.subfamily,
-      text_anchor: computed_properties.text_anchor
+      text_anchor: computed_properties.text_anchor,
     }
 
+    opts[:decoration] = computed_properties.text_decoration unless computed_properties.text_decoration == 'none'
+
     if state.text.parent
       add_call_and_enter 'character_spacing', state.text.spacing unless state.text.spacing == state.text.parent.spacing
       add_call_and_enter 'text_rendering_mode', state.text.mode unless state.text.mode == state.text.parent.mode
@@ -133,11 +137,19 @@ class Prawn::SVG::Elements::TextComponent < Prawn::SVG::Elements::DepthFirstBase
         opts.delete(:rotate)
       end
 
+      if state.text.text_length
+        if state.text.length_adjust == 'spacingAndGlyphs'
+          opts[:stretch_to_width] = state.text.text_length
+        else
+          opts[:pad_to_width] = state.text.text_length
+        end
+      end
+
       if remaining
-        add_call 'draw_text', text[0..0], opts.dup
+        add_call 'draw_text', text[0..0], **opts.dup
         text = text[1..-1]
       else
-        add_call 'draw_text', text, opts.dup
+        add_call 'draw_text', text, **opts.dup
 
         # we can get to this path with rotations still pending
         # solve this by shifting them out by the number of
@@ -173,7 +185,7 @@ class Prawn::SVG::Elements::TextComponent < Prawn::SVG::Elements::DepthFirstBase
   end
 
   def find_referenced_element
-    href = attributes['xlink:href']
+    href = href_attribute
 
     if href && href[0..0] == '#'
       element = document.elements_by_id[href[1..-1]]
@@ -222,4 +234,8 @@ class Prawn::SVG::Elements::TextComponent < Prawn::SVG::Elements::DepthFirstBase
   # overridden, we don't want to call fill/stroke as draw_text does this for us
   def apply_drawing_call
   end
+
+  def normalize_length(length)
+    x_pixels(length) if length && length.match(/\d/)
+  end
 end

data/lib/prawn/svg/elements/use.rb

@@ -1,19 +1,35 @@
 class Prawn::SVG::Elements::Use < Prawn::SVG::Elements::Base
-  attr_reader :referenced_element
+  attr_reader :referenced_element_class
+  attr_reader :referenced_element_source
 
   def parse
-    require_attributes 'xlink:href'
-
-    href = attributes['xlink:href']
+    href = href_attribute
+    if href.nil?
+      raise SkipElementError, "use tag must have an href or xlink:href"
+    end
 
     if href[0..0] != '#'
       raise SkipElementError, "use tag has an href that is not a reference to an id; this is not supported"
     end
 
     id = href[1..-1]
-    @referenced_element = @document.elements_by_id[id]
+    referenced_element = @document.elements_by_id[id]
+
+    if referenced_element
+      @referenced_element_class = referenced_element.class
+      @referenced_element_source = referenced_element.source
+    else
+      # Perhaps the element is defined further down in the document.  This is not recommended but still valid SVG,
+      # so we'll support it with an exception case that's not particularly performant.
+      raw_element = REXML::XPath.match(@document.root, %(//*[@id="#{id.gsub('"', '\"')}"])).first
+
+      if raw_element
+        @referenced_element_class = Prawn::SVG::Elements::TAG_CLASS_MAPPING[raw_element.name.to_sym]
+        @referenced_element_source = raw_element
+      end
+    end
 
-    if referenced_element.nil?
+    if referenced_element_class.nil?
       raise SkipElementError, "no tag with ID '#{id}' was found, referenced by use tag"
     end
 
@@ -36,7 +52,7 @@ class Prawn::SVG::Elements::Use < Prawn::SVG::Elements::Base
   def process_child_elements
     add_call "save"
 
-    child = referenced_element.class.new(referenced_element.document, referenced_element.source, calls, state.dup)
+    child = referenced_element_class.new(document, referenced_element_source, calls, state.dup)
     child.process
 
     add_call "restore"

data/lib/prawn/svg/extensions/additional_gradient_transforms.rb

@@ -0,0 +1,23 @@
+module Prawn::SVG::Extensions
+  module AdditionalGradientTransforms
+    def gradient_coordinates(gradient)
+      # As of Prawn 2.2.0, apply_transformations is used as purely a boolean.
+      #
+      # Here we're using it to optionally pass in a 6-tuple transformation matrix that gets applied to the
+      # gradient.  This should be added to Prawn properly, and then this monkey patch will not be necessary.
+
+      if gradient.apply_transformations.is_a?(Array)
+        x1, y1, x2, y2, transformation = super
+        a, b, c, d, e, f = transformation
+        na, nb, nc, nd, ne, nf = gradient.apply_transformations
+
+        matrix = Matrix[[a, c, e], [b, d, f], [0, 0, 1]] * Matrix[[na, nc, ne], [nb, nd, nf], [0, 0, 1]]
+        new_transformation = matrix.to_a[0..1].transpose.flatten
+
+        [x1, y1, x2, y2, new_transformation]
+      else
+        super
+      end
+    end
+  end
+end

data/lib/prawn/svg/interface.rb

@@ -109,32 +109,40 @@ module Prawn
       end
 
       def issue_prawn_command(prawn, calls)
-        calls.each do |call, arguments, children|
+        calls.each do |call, arguments, kwarguments, children|
           skip = false
 
-          rewrite_call_arguments(prawn, call, arguments) do
+          rewrite_call_arguments(prawn, call, arguments, kwarguments) do
             issue_prawn_command(prawn, children) if children.any?
             skip = true
           end
 
           if skip
             # the call has been overridden
-          elsif children.empty?
-            prawn.send(call, *arguments)
+          elsif children.empty? && call != 'transparent' # some prawn calls complain if they aren't supplied a block
+            if RUBY_VERSION >= '2.7' || !kwarguments.empty?
+              prawn.send(call, *arguments, **kwarguments)
+            else
+              prawn.send(call, *arguments)
+            end
           else
-            prawn.send(call, *arguments, &proc_creator(prawn, children))
+            if RUBY_VERSION >= '2.7' || !kwarguments.empty?
+              prawn.send(call, *arguments, **kwarguments, &proc_creator(prawn, children))
+            else
+              prawn.send(call, *arguments, &proc_creator(prawn, children))
+            end
           end
         end
       end
 
-      def rewrite_call_arguments(prawn, call, arguments)
+      def rewrite_call_arguments(prawn, call, arguments, kwarguments)
         case call
         when 'text_group'
           @cursor = [0, document.sizing.output_height]
           yield
 
         when 'draw_text'
-          text, options = arguments
+          text, options = arguments.first, kwarguments
 
           at = options.fetch(:at)
 
@@ -148,6 +156,19 @@ module Prawn
 
           width = prawn.width_of(text, options.merge(kerning: true))
 
+          if stretch_to_width = options.delete(:stretch_to_width)
+            factor = stretch_to_width.to_f * 100 / width.to_f
+            prawn.add_content "#{factor} Tz"
+            width = stretch_to_width.to_f
+          end
+
+          if pad_to_width = options.delete(:pad_to_width)
+            padding_required = pad_to_width.to_f - width.to_f
+            padding_per_character = padding_required / text.length.to_f
+            prawn.add_content "#{padding_per_character} Tc"
+            width = pad_to_width.to_f
+          end
+
           case options.delete(:text_anchor)
           when 'middle'
             at[0] -= width / 2
@@ -159,6 +180,15 @@ module Prawn
             @cursor = [at[0] + width, at[1]]
           end
 
+          decoration = options.delete(:decoration)
+          if decoration == 'underline'
+            prawn.save_graphics_state do
+              prawn.line_width 1
+              prawn.line [at[0], at[1] - 1.25], [at[0] + width, at[1] - 1.25]
+              prawn.stroke
+            end
+          end
+
         when 'transformation_matrix'
           left = prawn.bounds.absolute_left
           top = prawn.bounds.absolute_top
@@ -186,7 +216,7 @@ module Prawn
           # prawn (as at 2.0.1 anyway) uses 'b' for its fill_and_stroke.  'b' is 'h' (closepath) + 'B', and we
           # never want closepath to be automatically run as it stuffs up many drawing operations, such as dashes
           # and line caps, and makes paths close that we didn't ask to be closed when fill is specified.
-          even_odd = arguments[0].is_a?(Hash) && arguments[0][:fill_rule] == :even_odd
+          even_odd = kwarguments[:fill_rule] == :even_odd
           content  = even_odd ? 'B*' : 'B'
           prawn.add_content content
 

data/lib/prawn/svg/loaders/data.rb

@@ -2,7 +2,7 @@ require 'base64'
 
 module Prawn::SVG::Loaders
   class Data
-    REGEXP = %r[\A(?i:data):image/(png|jpeg);base64(;[a-z0-9]+)*,]
+    REGEXP = %r[\Adata:image/(png|jpeg);base64(;[a-z0-9]+)*,]i
 
     def from_url(url)
       return if url[0..4].downcase != "data:"

data/lib/prawn/svg/loaders/file.rb

@@ -1,3 +1,5 @@
+require 'addressable/uri'
+
 #
 # Load a file from disk.
 #
@@ -56,7 +58,7 @@ module Prawn::SVG::Loaders
     private
 
     def load_file(path)
-      path = URI.decode(path)
+      path = Addressable::URI.unencode(path)
       path = build_absolute_and_expand_path(path)
       assert_valid_path!(path)
       assert_file_exists!(path)
@@ -85,7 +87,7 @@ module Prawn::SVG::Loaders
     end
 
     def assert_valid_file_uri!(uri)
-      if uri.host
+      unless uri.host.nil? || uri.host.empty?
         raise Prawn::SVG::UrlLoader::Error, "prawn-svg does not suport file: URLs with a host. Your URL probably doesn't start with three slashes, and it should."
       end
     end