prawn-svg 0.32.0 → 0.34.0

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

@@ -9,6 +9,10 @@ class Prawn::SVG::Elements::TextComponent < Prawn::SVG::Elements::DepthFirstBase
       raise SkipElementError, "<text> elements are not supported in clip paths"
     end
 
+    if state.text.nil?
+      raise SkipElementError, "attempted to <use> an component inside a text element, this is not supported"
+    end
+
     state.text.x = (attributes['x'] || "").split(COMMA_WSP_REGEXP).collect { |n| x(n) }
     state.text.y = (attributes['y'] || "").split(COMMA_WSP_REGEXP).collect { |n| y(n) }
     state.text.dx = (attributes['dx'] || "").split(COMMA_WSP_REGEXP).collect { |n| x_pixels(n) }
@@ -41,14 +45,15 @@ class Prawn::SVG::Elements::TextComponent < Prawn::SVG::Elements::DepthFirstBase
     font = select_font
     apply_font(font) if font
 
-    # text_anchor isn't a Prawn option; we have to do some math to support it
-    # and so we handle this in Prawn::SVG::Interface#rewrite_call_arguments
+    # text_anchor and dominant_baseline aren't Prawn options; we have to do some math to support them
+    # and so we handle them in Prawn::SVG::Interface#rewrite_call_arguments
     opts = {
       size:        computed_properties.numerical_font_size,
       style:       font && font.subfamily,
       text_anchor: computed_properties.text_anchor,
     }
 
+    opts[:dominant_baseline] = computed_properties.dominant_baseline unless computed_properties.dominant_baseline == 'auto'
     opts[:decoration] = computed_properties.text_decoration unless computed_properties.text_decoration == 'none'
 
     if state.text.parent
@@ -171,7 +176,11 @@ class Prawn::SVG::Elements::TextComponent < Prawn::SVG::Elements::DepthFirstBase
 
   def svg_text_children
     text_children.select do |child|
-      child.node_type == :text || child.namespace == SVG_NAMESPACE || child.namespace == ''
+      child.node_type == :text || (
+        child.node_type == :element && (
+          child.namespace == SVG_NAMESPACE || child.namespace == ''
+        )
+      )
     end
   end
 

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

@@ -1,15 +1,12 @@
 class Prawn::SVG::Elements::Use < Prawn::SVG::Elements::Base
-  attr_reader :referenced_element_class
-  attr_reader :referenced_element_source
+  attr_reader :referenced_element_class, :referenced_element_source
 
   def parse
     href = href_attribute
-    if href.nil?
-      raise SkipElementError, "use tag must have an href or xlink:href"
-    end
+    raise SkipElementError, 'use tag must have an href or xlink:href' if href.nil?
 
     if href[0..0] != '#'
-      raise SkipElementError, "use tag has an href that is not a reference to an id; this is not supported"
+      raise SkipElementError, 'use tag has an href that is not a reference to an id; this is not supported'
     end
 
     id = href[1..-1]
@@ -29,14 +26,18 @@ class Prawn::SVG::Elements::Use < Prawn::SVG::Elements::Base
       end
     end
 
-    if referenced_element_class.nil?
-      raise SkipElementError, "no tag with ID '#{id}' was found, referenced by use tag"
+    raise SkipElementError, "no tag with ID '#{id}' was found, referenced by use tag" if referenced_element_class.nil?
+
+    if referenced_element_source.name == 'symbol'
+      @referenced_element_class = Prawn::SVG::Elements::Viewport
     end
 
     state.inside_use = true
 
     @x = attributes['x']
     @y = attributes['y']
+    @width = attributes['width']
+    @height = attributes['height']
   end
 
   def container?
@@ -45,16 +46,23 @@ class Prawn::SVG::Elements::Use < Prawn::SVG::Elements::Base
 
   def apply
     if @x || @y
-      add_call_and_enter "translate", x_pixels(@x || 0), -y_pixels(@y || 0)
+      add_call_and_enter 'translate', x_pixels(@x || 0), -y_pixels(@y || 0)
     end
   end
 
   def process_child_elements
-    add_call "save"
+    add_call 'save'
+
+    source = referenced_element_source.dup
+
+    if referenced_element_class == Prawn::SVG::Elements::Viewport
+      source.attributes['width'] = @width || '100%'
+      source.attributes['height'] = @height || '100%'
+    end
 
-    child = referenced_element_class.new(document, referenced_element_source, calls, state.dup)
+    child = referenced_element_class.new(document, source, calls, state.dup)
     child.process
 
-    add_call "restore"
+    add_call 'restore'
   end
 end

data/lib/prawn/svg/elements.rb

@@ -37,5 +37,6 @@ module Prawn::SVG::Elements
     foreignObject: Prawn::SVG::Elements::Ignored,
     :"font-face" => Prawn::SVG::Elements::Ignored,
     filter: Prawn::SVG::Elements::Ignored, # unsupported
+    mask: Prawn::SVG::Elements::Ignored, # unsupported
   }
 end

data/lib/prawn/svg/gradients.rb

@@ -0,0 +1,48 @@
+module Prawn::SVG
+  class Gradients
+    def initialize(document)
+      @document = document
+      @gradients_by_id = {}
+    end
+
+    def [](id)
+      id &&= id.strip
+      return unless id && id != ''
+
+      if element = @gradients_by_id[id]
+        element
+      elsif raw_element = find_raw_gradient_element_by_id(id)
+        create_gradient_element(raw_element)
+      end
+    end
+
+    def []=(id, gradient)
+      @gradients_by_id[id] = gradient
+    end
+
+    private
+
+    def find_raw_gradient_element_by_id(id)
+      raw_element = find_raw_element_by_id(id)
+      raw_element if gradient_element?(raw_element)
+    end
+
+    def create_gradient_element(raw_element)
+      Elements::Gradient.new(@document, raw_element, [], new_state).tap(&:process)
+    end
+
+    def find_raw_element_by_id(id)
+      REXML::XPath.match(@document.root, %(//*[@id="#{id.gsub('"', '\"')}"])).first
+    end
+
+    def gradient_element?(raw_element)
+      Elements::TAG_CLASS_MAPPING[raw_element.name.to_sym] == Elements::Gradient
+    end
+
+    def new_state
+      State.new.tap do |state|
+        state.viewport_sizing = @document.sizing
+      end
+    end
+  end
+end

data/lib/prawn/svg/interface.rb

@@ -5,7 +5,15 @@
 module Prawn
   module SVG
     class Interface
-      VALID_OPTIONS = [:at, :position, :vposition, :width, :height, :cache_images, :enable_web_requests, :enable_file_requests_with_root, :fallback_font_name]
+      VALID_OPTIONS = %i[
+        at position vposition width height cache_images enable_web_requests
+        enable_file_requests_with_root fallback_font_name color_mode
+      ]
+
+      INHERITABLE_OPTIONS = %i[
+        enable_web_requests enable_file_requests_with_root
+        cache_images fallback_font_name color_mode
+      ]
 
       attr_reader :data, :prawn, :document, :options
 
@@ -25,33 +33,19 @@ module Prawn
 
         font_registry = Prawn::SVG::FontRegistry.new(prawn.font_families)
 
-        @document = Document.new(data, [prawn.bounds.width, prawn.bounds.height], options, font_registry: font_registry, &block)
+        @document = Document.new(
+          data, [prawn.bounds.width, prawn.bounds.height], options,
+          font_registry: font_registry, &block
+        )
+
+        @renderer = Renderer.new(prawn, document, options)
       end
 
       #
       # Draws the SVG to the Prawn::Document object.
       #
       def draw
-        if @document.sizing.invalid?
-          @document.warnings << "Zero or negative sizing data means this SVG cannot be rendered"
-          return
-        end
-
-        @document.warnings.clear
-
-        prawn.save_font do
-          prawn.bounding_box(position, :width => @document.sizing.output_width, :height => @document.sizing.output_height) do
-            prawn.save_graphics_state do
-              clip_rectangle 0, 0, @document.sizing.output_width, @document.sizing.output_height
-
-              calls = []
-              root_element = Prawn::SVG::Elements::Root.new(@document, @document.root, calls)
-              root_element.process
-
-              proc_creator(prawn, calls).call
-            end
-          end
-        end
+        @renderer.draw
       end
 
       def sizing
@@ -63,176 +57,12 @@ module Prawn
       end
 
       def position
-        @options[:at] || [x_based_on_requested_alignment, y_based_on_requested_alignment]
+        @renderer.position
       end
 
       def self.font_path # backwards support for when the font_path used to be stored on this class
         Prawn::SVG::FontRegistry.font_path
       end
-
-      private
-
-      def x_based_on_requested_alignment
-        case options[:position]
-        when :left, nil
-          0
-        when :center, :centre
-          (@document.sizing.bounds[0] - @document.sizing.output_width) / 2.0
-        when :right
-          @document.sizing.bounds[0] - @document.sizing.output_width
-        when Numeric
-          options[:position]
-        else
-          raise ArgumentError, "options[:position] must be one of nil, :left, :right, :center or a number"
-        end
-      end
-
-      def y_based_on_requested_alignment
-        case options[:vposition]
-        when nil
-          prawn.cursor
-        when :top
-          @document.sizing.bounds[1]
-        when :center, :centre
-          @document.sizing.bounds[1] - (@document.sizing.bounds[1] - @document.sizing.output_height) / 2.0
-        when :bottom
-          @document.sizing.output_height
-        when Numeric
-          @document.sizing.bounds[1] - options[:vposition]
-        else
-          raise ArgumentError, "options[:vposition] must be one of nil, :top, :right, :bottom or a number"
-        end
-      end
-
-      def proc_creator(prawn, calls)
-        Proc.new {issue_prawn_command(prawn, calls)}
-      end
-
-      def issue_prawn_command(prawn, calls)
-        calls.each do |call, arguments, kwarguments, children|
-          skip = false
-
-          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? && 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
-            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, kwarguments)
-        case call
-        when 'text_group'
-          @cursor = [0, document.sizing.output_height]
-          yield
-
-        when 'draw_text'
-          text, options = arguments.first, kwarguments
-
-          at = options.fetch(:at)
-
-          at[0] = @cursor[0] if at[0] == :relative
-          at[1] = @cursor[1] if at[1] == :relative
-
-          if offset = options.delete(:offset)
-            at[0] += offset[0]
-            at[1] -= offset[1]
-          end
-
-          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
-            @cursor = [at[0] + width / 2, at[1]]
-          when 'end'
-            at[0] -= width
-            @cursor = at.dup
-          else
-            @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
-          arguments[4] += left - (left * arguments[0] + top * arguments[2])
-          arguments[5] += top - (left * arguments[1] + top * arguments[3])
-
-        when 'clip'
-          prawn.add_content "W n" # clip to path
-          yield
-
-        when 'save'
-          prawn.save_graphics_state
-          yield
-
-        when 'restore'
-          prawn.restore_graphics_state
-          yield
-
-        when "end_path"
-          yield
-          prawn.add_content "n" # end path
-
-        when 'fill_and_stroke'
-          yield
-          # 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 = kwarguments[:fill_rule] == :even_odd
-          content  = even_odd ? 'B*' : 'B'
-          prawn.add_content content
-
-        when 'noop'
-          yield
-        end
-      end
-
-      def clip_rectangle(x, y, width, height)
-        prawn.move_to x, y
-        prawn.line_to x + width, y
-        prawn.line_to x + width, y + height
-        prawn.line_to x, y + height
-        prawn.close_path
-        prawn.add_content "W n" # clip to path
-      end
     end
   end
 end

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

@@ -2,14 +2,15 @@ require 'base64'
 
 module Prawn::SVG::Loaders
   class Data
-    REGEXP = %r[\Adata:image/(png|jpeg);base64(;[a-z0-9]+)*,]i
+    REGEXP = %r{\Adata:image/(png|jpeg|svg\+xml);base64(;[a-z0-9]+)*,}i
 
     def from_url(url)
-      return if url[0..4].downcase != "data:"
+      return if url[0..4].downcase != 'data:'
 
       matches = url.match(REGEXP)
       if matches.nil?
-        raise Prawn::SVG::UrlLoader::Error, "prawn-svg only supports base64-encoded image/png and image/jpeg data URLs"
+        raise Prawn::SVG::UrlLoader::Error,
+              'prawn-svg only supports base64-encoded image/png, image/jpeg, and image/svg+xml data URLs'
       end
 
       Base64.decode64(matches.post_match)

data/lib/prawn/svg/properties.rb

@@ -34,10 +34,12 @@ class Prawn::SVG::Properties
     "stroke"           => Config.new("none", true, %w(inherit none currentColor)),
     "stroke-dasharray" => Config.new("none", true, %w(inherit none)),
     "stroke-linecap"   => Config.new("butt", true, %w(inherit butt round square), true),
+    "stroke-linejoin"  => Config.new("miter", true, %w(inherit miter round bevel), true),
     "stroke-opacity"   => Config.new("1", true),
     "stroke-width"     => Config.new("1", true),
     "text-anchor"      => Config.new("start", true, %w(inherit start middle end), true),
     'text-decoration'  => Config.new('none', true, %w(inherit none underline), true),
+    "dominant-baseline" => Config.new("auto", true, %w(inherit auto middle), true),
   }.freeze
 
   PROPERTIES.each do |name, value|

data/lib/prawn/svg/renderer.rb

@@ -0,0 +1,236 @@
+module Prawn
+  module SVG
+    class Renderer
+      attr_reader :prawn, :document, :options
+
+      #
+      # Creates a Prawn::SVG object.
+      #
+      # +data+ is the SVG data to convert.  +prawn+ is your Prawn::Document object.
+      #
+      # See README.md for the options that can be passed to this method.
+      #
+      def initialize(prawn, document, options)
+        @prawn = prawn
+        @document = document
+        @options = options
+      end
+
+      #
+      # Draws the SVG to the Prawn::Document object.
+      #
+      def draw
+        if sizing.invalid?
+          document.warnings << 'Zero or negative sizing data means this SVG cannot be rendered'
+          return
+        end
+
+        document.warnings.clear
+
+        prawn.save_font do
+          prawn.bounding_box(position, width: sizing.output_width, height: sizing.output_height) do
+            prawn.save_graphics_state do
+              clip_rectangle 0, 0, sizing.output_width, sizing.output_height
+
+              calls = []
+              root_element = Prawn::SVG::Elements::Root.new(document, document.root, calls)
+              root_element.process
+
+              proc_creator(prawn, calls).call
+            end
+          end
+        end
+      end
+
+      def sizing
+        document.sizing
+      end
+
+      def position
+        options[:at] || [x_based_on_requested_alignment, y_based_on_requested_alignment]
+      end
+
+      private
+
+      def x_based_on_requested_alignment
+        case options[:position]
+        when :left, nil
+          0
+        when :center, :centre
+          (sizing.bounds[0] - sizing.output_width) / 2.0
+        when :right
+          sizing.bounds[0] - sizing.output_width
+        when Numeric
+          options[:position]
+        else
+          raise ArgumentError, 'options[:position] must be one of nil, :left, :right, :center or a number'
+        end
+      end
+
+      def y_based_on_requested_alignment
+        case options[:vposition]
+        when nil
+          prawn.cursor
+        when :top
+          sizing.bounds[1]
+        when :center, :centre
+          sizing.bounds[1] - (sizing.bounds[1] - sizing.output_height) / 2.0
+        when :bottom
+          sizing.output_height
+        when Numeric
+          sizing.bounds[1] - options[:vposition]
+        else
+          raise ArgumentError, 'options[:vposition] must be one of nil, :top, :right, :bottom or a number'
+        end
+      end
+
+      def proc_creator(prawn, calls)
+        proc { issue_prawn_command(prawn, calls) }
+      end
+
+      def issue_prawn_command(prawn, calls)
+        calls.each do |call, arguments, kwarguments, children|
+          skip = false
+
+          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? && 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
+          elsif 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
+
+      def rewrite_call_arguments(prawn, call, arguments, kwarguments)
+        case call
+        when 'text_group'
+          @cursor = [0, sizing.output_height]
+          yield
+
+        when 'draw_text'
+          text = arguments.first
+          options = kwarguments
+
+          at = options.fetch(:at)
+
+          at[0] = @cursor[0] if at[0] == :relative
+          at[1] = @cursor[1] if at[1] == :relative
+
+          case options.delete(:dominant_baseline)
+          when 'middle'
+            height = prawn.font.height
+            at[1] -= height / 2.0
+            @cursor = [at[0], at[1]]
+          end
+
+          if offset = options.delete(:offset)
+            at[0] += offset[0]
+            at[1] -= offset[1]
+          end
+
+          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
+            @cursor = [at[0] + width / 2, at[1]]
+          when 'end'
+            at[0] -= width
+            @cursor = at.dup
+          else
+            @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
+          arguments[4] += left - (left * arguments[0] + top * arguments[2])
+          arguments[5] += top - (left * arguments[1] + top * arguments[3])
+
+        when 'clip'
+          prawn.add_content 'W n' # clip to path
+          yield
+
+        when 'save'
+          prawn.save_graphics_state
+          yield
+
+        when 'restore'
+          prawn.restore_graphics_state
+          yield
+
+        when 'end_path'
+          yield
+          prawn.add_content 'n' # end path
+
+        when 'fill_and_stroke'
+          yield
+          # 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 = kwarguments[:fill_rule] == :even_odd
+          content  = even_odd ? 'B*' : 'B'
+          prawn.add_content content
+
+        when 'noop'
+          yield
+
+        when 'svg:render_sub_document'
+          sub_document = arguments.first
+          sub_options = inheritable_options.merge({ at: [0, 0] })
+
+          Renderer.new(prawn, sub_document, sub_options).draw
+          document.warnings.concat(sub_document.warnings)
+          yield
+        end
+      end
+
+      def inheritable_options
+        (options || {}).slice(Prawn::SVG::Interface::INHERITABLE_OPTIONS)
+      end
+
+      def clip_rectangle(x, y, width, height)
+        prawn.move_to x, y
+        prawn.line_to x + width, y
+        prawn.line_to x + width, y + height
+        prawn.line_to x, y + height
+        prawn.close_path
+        prawn.add_content 'W n' # clip to path
+      end
+    end
+  end
+end

data/lib/prawn/svg/version.rb

@@ -1,5 +1,5 @@
 module Prawn
   module SVG
-    VERSION = '0.32.0'
+    VERSION = '0.34.0'
   end
 end

data/lib/prawn-svg.rb

@@ -21,12 +21,14 @@ require 'prawn/svg/properties'
 require 'prawn/svg/pathable'
 require 'prawn/svg/elements'
 require 'prawn/svg/extension'
+require 'prawn/svg/renderer'
 require 'prawn/svg/interface'
 require 'prawn/svg/css/font_family_parser'
 require 'prawn/svg/css/selector_parser'
 require 'prawn/svg/css/stylesheets'
 require 'prawn/svg/ttf'
 require 'prawn/svg/font'
+require 'prawn/svg/gradients'
 require 'prawn/svg/document'
 require 'prawn/svg/state'