prawn-svg 0.33.0 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9f71b82858f8ee91e1ccaf2903c2e2a0d49108b1532a81d15c2275362a0d136
-  data.tar.gz: f3336c6a727df24e6a5877e4d26cf030eabbb1c9af9852f95c35c5bfe5128995
+  metadata.gz: fa5a995fd0ec6d8426dcc87603695e91ff743e1fddc559da6cc7fcc08ab5eb88
+  data.tar.gz: d76a03c53c2d7dab41db812e3309f59f32baefb730970015a8bb35d6fb791653
 SHA512:
-  metadata.gz: 94f1a140e837ab37b088cc659bc8ef63a3e89778539236441f43e7b4885b9028cce1cb83c9e9636b00ff2ac740770ec8d853c123aa42b0764fb1264405269e76
-  data.tar.gz: 4d02f2e14875214bb5460ace33925f9ab17302b39f46e0a37e0e5521e63b0fdd2f23f6018c8e048bf2bce7d148548aa86b5b9967dca827faddccfa23e8e09b13
+  metadata.gz: 0a686e69f4759243fc9b672a4bad663f17bf3f4f1a7016e560d816859d3d49464dfbb6416d877cf35f5362cd316111661e96817b645f707cc19999bae7e98f17
+  data.tar.gz: 57fbf5408c56228a286ca10221759440c4fc1326c0855acc4c5a74a30652ca59af277d170cf5bcb7f40b24bfe511e6ff82fd24e81da301e15595dc7f9d283e7a

data/.github/workflows/test.yml

@@ -6,7 +6,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.6, 2.7, '3.0', 3.1, 3.2]
+        ruby: [2.6, 2.7, '3.0', 3.1, 3.2, 3.3]
     steps:
     - uses: actions/checkout@v4
     - name: Set up Ruby

data/.gitignore

@@ -7,3 +7,4 @@ Gemfile.lock
 .ruby-version
 vendor/bundle/
 .bundle/
+.mise.toml

data/README.md

@@ -10,7 +10,7 @@ This will take an SVG document as input and render it into your PDF.  Find out m
   http://github.com/prawnpdf/prawn
 
 prawn-svg is compatible with all versions of Prawn from 0.11.1 onwards, including the 1.x and 2.x series.
-The minimum Ruby version required is 2.3.0.
+The minimum Ruby version required is 2.5.0.
 
 ## Using prawn-svg
 
@@ -33,7 +33,7 @@ Option      | Data type | Description
 :enable_web_requests | boolean | If true, prawn-svg will make http and https requests to fetch images.  Defaults to true.
 :enable_file_requests_with_root | string | If not nil, prawn-svg will serve `file:` URLs from your local disk if the file is located under the specified directory. It is very dangerous to specify the root path ("/") if you're not fully in control of your input SVG.  Defaults to `nil` (off).
 :cache_images | boolean   | If true, prawn-svg will cache the result of all URL requests. Defaults to false.
-:fallback_font_name | string | A font name which will override the default fallback font of Times-Roman.  If this value is set to <tt>nil</tt>, prawn-svg will ignore a request for an unknown font and log a warning.
+:fallback_font_name | string | A font name which will override the default fallback font of Times-Roman.  If this value is set to `nil`, prawn-svg will ignore a request for an unknown font and log a warning.
 :color_mode | :rgb, :cmyk | Output color mode.  Defaults to :rgb.
 
 ## Examples
@@ -54,52 +54,57 @@ Option      | Data type | Description
 
 prawn-svg supports most but not all of the full SVG 1.1 specification.  It currently supports:
 
- - <tt>&lt;line&gt;</tt>, <tt>&lt;polyline&gt;</tt>, <tt>&lt;polygon&gt;</tt>, <tt>&lt;circle&gt;</tt> and <tt>&lt;ellipse&gt;</tt>
+ - `<line>`, `<polyline>`, `<polygon>`, `<circle>` and `<ellipse>`
 
- - <tt>&lt;rect&gt;</tt>.  Rounded rects are supported, but only one radius is applied to all corners.
+ - `<rect>`.  Rounded rects are supported, but only one radius is applied to all corners.
 
- - <tt>&lt;path&gt;</tt> supports all commands defined in SVG 1.1, although the
+ - `<path>` supports all commands defined in SVG 1.1, although the
    implementation of elliptical arc is a bit rough at the moment.
 
- - `<text>`, `<tspan>` and `<tref>` with attributes `x`, `y`, `dx`, `dy`, `rotate`, 'textLength', 'lengthAdjust', and with extra properties
-   `text-anchor`, `text-decoration` (underline only), `font-size`, `font-family`, `font-weight`, `font-style`, `letter-spacing`, `dominant-baseline` (middle only)
+ - `<text>`, `<tspan>` and `<tref>` with attributes `x`, `y`, `dx`, `dy`, `rotate`, `textLength`, `lengthAdjust`,
+   and with extra properties `text-anchor`, `text-decoration` (underline only), `font-size`, `font-family`,
+   `font-weight`, `font-style`, `letter-spacing`, `dominant-baseline` (middle only)
 
- - <tt>&lt;svg&gt;</tt>, <tt>&lt;g&gt;</tt> and <tt>&lt;symbol&gt;</tt>
+ - `<svg>`, `<g>` and `<symbol>`
 
- - <tt>&lt;use&gt;</tt>
+ - `<use>`
 
- - <tt>&lt;style&gt;</tt> (see CSS section below)
+ - `<style>` (see CSS section below)
 
- - `<image>` referencing a JPEG or PNG image,  with `http:`, `https:`, `data:image/jpeg;base64`, `data:image/png;base64` and `file:` schemes
-   (`file:` is disabled by default for security reasons, see Options section above)
+ - `<image>` referencing a JPEG, PNG, or SVG image,  with `http:`, `https:`, `data:image/jpeg;base64`,
+   `data:image/png;base64`, `data:image/svg+xml;base64` and `file:` schemes (`file:` is disabled by default for
+   security reasons, see Options section above)
 
- - <tt>&lt;clipPath&gt;</tt>
+ - `<clipPath>`
 
  - `<marker>`
 
- - `<linearGradient>` and `<radialGradient>` are implemented on Prawn 2.2.0+ with attributes `gradientUnits` and `gradientTransform` (spreadMethod and stop-opacity are unimplemented.)
+ - `<linearGradient>` and `<radialGradient>` are implemented on Prawn 2.2.0+ with attributes `gradientUnits` and
+   `gradientTransform` (`spreadMethod` and `stop-opacity` are unimplemented.)
 
  - `<switch>` and `<foreignObject>`, although prawn-svg cannot handle any data that is not SVG so `<foreignObject>`
    tags are always ignored.
 
- - properties: `clip-path`, `color`, `display`, `fill`, `fill-opacity`, `fill-rule`, `opacity`, `overflow`, `stroke`, `stroke-dasharray`, `stroke-linecap`, `stroke-opacity`, `stroke-width`
+ - properties: `clip-path`, `color`, `display`, `fill`, `fill-opacity`, `fill-rule`, `opacity`, `overflow`,
+   `stroke`, `stroke-dasharray`, `stroke-linecap`, `stroke-linejoin`, `stroke-opacity`, `stroke-width`
 
  - properties on lines, polylines, polygons and paths: `marker-end`, `marker-mid`, `marker-start`
 
  - attributes on all elements: `class`, `id`, `style`, `transform`, `xml:space`
 
- - the <tt>viewBox</tt> attribute on <tt>&lt;svg&gt;</tt> and `<marker>` elements
+ - the `viewBox` attribute on `<svg>` and `<marker>` elements
 
- - the <tt>preserveAspectRatio</tt> attribute on <tt>&lt;svg&gt;</tt>, <tt>&lt;image&gt;</tt> and `<marker>` elements
+ - the `preserveAspectRatio` attribute on `<svg>`, `<image>` and `<marker>` elements
 
  - transform methods: `translate`, `translateX`, `translateY`, `rotate`, `scale`, `skewX`, `skewY`, `matrix`
 
- - colors: HTML standard names, <tt>#xxx</tt>, <tt>#xxxxxx</tt>, <tt>rgb(1, 2, 3)</tt>, <tt>rgb(1%, 2%, 3%)</tt>,
-   and also the non-standard `device-cmyk(1, 2, 3, 4)` for CMYK colors
+ - colors: HTML standard names, `#xxx`, `#xxxxxx`, `rgb(1, 2, 3)`, `rgb(1%, 2%, 3%)`, and also the non-standard
+   `device-cmyk(1, 2, 3, 4)` for CMYK colors
 
- - measurements specified in <tt>pt</tt>, <tt>cm</tt>, <tt>dm</tt>, <tt>ft</tt>, <tt>in</tt>, <tt>m</tt>, <tt>mm</tt>, <tt>yd</tt>, <tt>pc</tt>, <tt>%</tt>
+ - measurements specified in `pt`, `cm`, `dm`, `ft`, `in`, `m`, `mm`, `yd`, `pc`, `%`
 
- - fonts: generic CSS fonts, built-in PDF fonts, and any TTF fonts in your fonts path, specified in any of the measurements above plus `em` or `rem`
+ - fonts: generic CSS fonts, built-in PDF fonts, and any TTF fonts in your fonts path, specified in any of the
+   measurements above plus `em` or `rem`
 
 ## CSS
 
@@ -126,8 +131,9 @@ It does not support text in the clip area, but you can clip shapes and text by a
 
 ### Fonts
 
-By default, prawn-svg has a fonts path of <tt>["/Library/Fonts", "/System/Library/Fonts", "#{ENV["HOME"]}/Library/Fonts", "/usr/share/fonts/truetype"]</tt> to catch
-Mac OS X and Debian Linux users.  You can add to the font path:
+By default, prawn-svg has a fonts path of `["/Library/Fonts", "/System/Library/Fonts",
+"#{ENV["HOME"]}/Library/Fonts", "/usr/share/fonts/truetype"]` to catch MacOS and Debian Linux users.  You can add
+to the font path:
 
 ```ruby
   Prawn::SVG::FontRegistry.font_path << "/my/font/directory"
@@ -139,4 +145,4 @@ In your Gemfile, put `gem 'prawn-svg'` before `gem 'prawn-rails'` so that prawn-
 
 ## Licence
 
-MIT licence.  Copyright Roger Nesbitt.
+MIT licence.  Copyright Mog Nesbitt.

data/lib/prawn/svg/document.rb

@@ -16,7 +16,7 @@ class Prawn::SVG::Document
     :element_styles,
     :color_mode
 
-  def initialize(data, bounds, options, font_registry: nil, css_parser: CssParser::Parser.new)
+  def initialize(data, bounds, options, font_registry: nil, css_parser: CssParser::Parser.new, attribute_overrides: {})
     @root = REXML::Document.new(data).root
 
     if @root.nil?
@@ -41,7 +41,10 @@ class Prawn::SVG::Document
       enable_file_with_root: options[:enable_file_requests_with_root]
     )
 
-    @sizing = Prawn::SVG::Calculators::DocumentSizing.new(bounds, @root.attributes)
+    attributes = @root.attributes.dup
+    attribute_overrides.each { |key, value| attributes.add(REXML::Attribute.new(key, value)) }
+
+    @sizing = Prawn::SVG::Calculators::DocumentSizing.new(bounds, attributes)
     calculate_sizing(requested_width: options[:width], requested_height: options[:height])
 
     @element_styles = Prawn::SVG::CSS::Stylesheets.new(css_parser, root).load

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

@@ -3,29 +3,32 @@ class Prawn::SVG::Elements::Image < Prawn::SVG::Elements::Base
     def initialize(data)
       @data = data
     end
+
     def read
       @data
     end
-    def rewind
-    end
+
+    def rewind; end
   end
 
+  ImageData = Struct.new(:dimensions, :document)
+
   def parse
     require_attributes 'width', 'height'
 
-    raise SkipElementQuietly if state.computed_properties.display == "none"
+    raise SkipElementQuietly if state.computed_properties.display == 'none'
 
     @url = href_attribute
-    if @url.nil?
-      raise SkipElementError, "image tag must have an href or xlink:href"
-    end
+    raise SkipElementError, 'image tag must have an href or xlink:href' if @url.nil?
 
     x = x(attributes['x'] || 0)
     y = y(attributes['y'] || 0)
     width = x_pixels(attributes['width'])
     height = y_pixels(attributes['height'])
+    preserveAspectRatio = attributes['preserveAspectRatio']
 
     raise SkipElementQuietly if width.zero? || height.zero?
+
     require_positive_value width, height
 
     @image = begin
@@ -34,7 +37,9 @@ class Prawn::SVG::Elements::Image < Prawn::SVG::Elements::Base
       raise SkipElementError, "Error retrieving URL #{@url}: #{e.message}"
     end
 
-    @aspect = Prawn::SVG::Calculators::AspectRatio.new(attributes['preserveAspectRatio'], [width, height], image_dimensions(@image))
+    @image_data = process_image(@image, width, height, preserveAspectRatio)
+
+    @aspect = Prawn::SVG::Calculators::AspectRatio.new(preserveAspectRatio, [width, height], @image_data.dimensions)
 
     @clip_x = x
     @clip_y = y
@@ -49,15 +54,21 @@ class Prawn::SVG::Elements::Image < Prawn::SVG::Elements::Base
 
   def apply
     if @aspect.slice?
-      add_call "save"
-      add_call "rectangle", [@clip_x, @clip_y], @clip_width, @clip_height
-      add_call "clip"
+      add_call 'save'
+      add_call 'rectangle', [@clip_x, @clip_y], @clip_width, @clip_height
+      add_call 'clip'
     end
 
-    options = {:width => @width, :height => @height, :at => [@x, @y]}
+    if (document = @image_data.document)
+      add_call_and_enter 'translate', @x, @y
+      add_call 'svg:render_sub_document', document
+    else
+      options = { width: @width, height: @height, at: [@x, @y] }
+
+      add_call 'image', FakeIO.new(@image), options
+    end
 
-    add_call "image", FakeIO.new(@image), options
-    add_call "restore" if @aspect.slice?
+    add_call 'restore' if @aspect.slice?
   end
 
   def bounding_box
@@ -66,15 +77,38 @@ class Prawn::SVG::Elements::Image < Prawn::SVG::Elements::Base
 
   protected
 
-  def image_dimensions(data)
-    unless (handler = find_image_handler(data))
-      raise SkipElementError, 'Unsupported image type supplied to image tag'
+  def process_image(data, width, height, preserveAspectRatio)
+    if (handler = find_image_handler(data))
+      image = handler.new(data)
+      ImageData.new([image.width.to_f, image.height.to_f], nil)
+
+    elsif potentially_svg?(data)
+      document = Prawn::SVG::Document.new(
+        data, [width, height], { width: width, height: height },
+        attribute_overrides: { 'preserveAspectRatio' => preserveAspectRatio }
+      )
+
+      dimensions = [document.sizing.output_width, document.sizing.output_height]
+      ImageData.new(dimensions, document)
+
+    else
+      raise_invalid_image_type
     end
-    image = handler.new(data)
-    [image.width.to_f, image.height.to_f]
+  rescue Prawn::SVG::Document::InvalidSVGData
+    raise_invalid_image_type
   end
 
   def find_image_handler(data)
-    Prawn.image_handler.find(data) rescue nil
+    Prawn.image_handler.find(data)
+  rescue StandardError
+    nil
+  end
+
+  def potentially_svg?(data)
+    data.include?('<svg')
+  end
+
+  def raise_invalid_image_type
+    raise SkipElementError, 'Unsupported image type supplied to image tag'
   end
 end

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) }

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/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, :color_mode]
+      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,183 +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
-
-          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
-        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/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.33.0'
+    VERSION = '0.34.0'
   end
 end

data/lib/prawn-svg.rb

@@ -21,6 +21,7 @@ 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'

data/prawn-svg.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 2.5.0'
 
+  gem.add_runtime_dependency 'base64', '~> 0.1.0'
   gem.add_runtime_dependency 'css_parser', '~> 1.6'
   gem.add_runtime_dependency 'matrix', '~> 0.4.2'
   gem.add_runtime_dependency 'prawn', '>= 0.11.1', '< 3'

data/spec/sample_images/image_svg_embed.svg

@@ -0,0 +1,6 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg viewBox="0 0 100 100" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1">
+    <rect x="0" y="0" width="100" height="100" fill="red" stroke="blue" stroke-width="5" />
+</svg>
+

data/spec/sample_svg/image_svg.svg

@@ -0,0 +1,9 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg viewBox="0 0 1000 500" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1">
+    <rect x="20" y="20" width="960" height="460" stroke="black" fill="white" />
+    <image xlink:href="data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgd2lkdGg9IjExMDAiIGhlaWdodD0iNDAwIj4KICA8cmVjdCB4PSIxMDAiIHk9IjEwMCIgd2lkdGg9IjkwMCIgaGVpZ2h0PSIzMDAiIGZpbGw9Im5vbmUiIHN0cm9rZT0iYmx1ZSIgc3Ryb2tlLXdpZHRoPSIyIiAvPgoKICA8cGF0aCBkPSJNMjAwIDIwMCBMODAwIDMwMCBMODAwIDIwMCIgc3Ryb2tlPSJncmVlbiIgc3Ryb2tlLXdpZHRoPSIxMCIgZmlsbD0icmVkIiAvPgo8L3N2Zz4K" x="100" y="200" width="200" height="200" />
+    <image xlink:href="sample_images/image_svg_embed.svg" x="400" y="200" width="200" height="200" />
+    <image xlink:href="sample_images/image_svg_embed.svg" x="650" y="200" width="100" height="200" />
+    <image xlink:href="sample_images/image_svg_embed.svg" x="800" y="200" width="100" height="200" preserveAspectRatio="none" />
+</svg>

data/spec/sample_svg/symbol.svg

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg viewBox="0 0 1000 1000" xmlns="http://www.w3.org/2000/svg" xmlns:xlink='http://www.w3.org/1999/xlink' version="1.1">
+  <symbol id="rects" viewBox="0 0 100 100">
+    <rect x="10" y="10" width="80" height="80" fill="none" stroke="red"/>
+    <rect x="20" y="20" width="60" height="60" fill="none" stroke="green"/>
+    <rect x="30" y="30" width="40" height="40" fill="none" stroke="blue"/>
+  </symbol>
+  <rect width="1000" height="1000" fill="none" stroke="black"/>
+  <use x="100" y="100" width="800" height="800" xlink:href="#rects"/>
+  <use x="400" y="400" width="200" height="200" xlink:href="#rects"/>
+</svg>

data/spec/spec_helper.rb

@@ -3,12 +3,12 @@ Bundler.require(:default, :development)
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 module Support
-  def flatten_calls(calls)
+  def flatten_calls(_calls)
     [].tap do |flattened_calls|
-      add = -> (local_calls) do
+      add = lambda do |local_calls|
         local_calls.each do |call|
           flattened_calls << call[0..2]
           add.call call[3]
@@ -28,12 +28,36 @@ end
 
 RSpec.configure do |config|
   config.mock_with :rspec do |c|
-    c.syntax = [:should, :expect]
+    c.syntax = %i[should expect]
   end
 
   config.expect_with :rspec do |c|
-    c.syntax = [:should, :expect]
+    c.syntax = %i[should expect]
   end
 
   config.include Support
+
+  config.before(:suite) do
+    # calculate the MD5 of all files in spec/sample_output and store in a hash
+    $hashes = {}
+
+    Dir["#{File.dirname(__FILE__)}/sample_output/*.pdf"].each do |file|
+      hash = Digest::MD5.file(file).hexdigest
+      $hashes[file] = hash
+    end
+  end
+
+  config.after(:suite) do
+    # print out the PDFs that have changed
+    changed = $hashes.select do |file, hash|
+      new_hash = Digest::MD5.file(file).hexdigest
+      new_hash != hash
+    end
+
+    if changed.any?
+      puts "\nThese PDFs have changed since the last test run:"
+      cwd = "#{Dir.pwd}/"
+      changed.each { |file, _| puts "  #{file.sub(cwd, '')}" }
+    end
+  end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: prawn-svg
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 0.34.0
 platform: ruby
 authors:
 - Mog Nesbitt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-16 00:00:00.000000000 Z
+date: 2024-01-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: css_parser
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +178,7 @@ files:
 - lib/prawn/svg/loaders/web.rb
 - lib/prawn/svg/pathable.rb
 - lib/prawn/svg/properties.rb
+- lib/prawn/svg/renderer.rb
 - lib/prawn/svg/state.rb
 - lib/prawn/svg/transform_parser.rb
 - lib/prawn/svg/ttf.rb
@@ -201,6 +216,7 @@ files:
 - spec/prawn/svg/transform_parser_spec.rb
 - spec/prawn/svg/ttf_spec.rb
 - spec/prawn/svg/url_loader_spec.rb
+- spec/sample_images/image_svg_embed.svg
 - spec/sample_images/mushroom-long.jpg
 - spec/sample_images/mushroom-wide.jpg
 - spec/sample_output/.keep
@@ -227,6 +243,7 @@ files:
 - spec/sample_svg/image01.svg
 - spec/sample_svg/image02_base64.svg
 - spec/sample_svg/image03.svg
+- spec/sample_svg/image_svg.svg
 - spec/sample_svg/line01.svg
 - spec/sample_svg/links.svg
 - spec/sample_svg/marker.svg
@@ -257,6 +274,7 @@ files:
 - spec/sample_svg/subviewports.svg
 - spec/sample_svg/subviewports2.svg
 - spec/sample_svg/svg_fill.svg
+- spec/sample_svg/symbol.svg
 - spec/sample_svg/text-decoration.svg
 - spec/sample_svg/text_entities.svg
 - spec/sample_svg/text_stroke.svg
@@ -296,7 +314,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: SVG renderer for Prawn PDF library
@@ -332,6 +350,7 @@ test_files:
 - spec/prawn/svg/transform_parser_spec.rb
 - spec/prawn/svg/ttf_spec.rb
 - spec/prawn/svg/url_loader_spec.rb
+- spec/sample_images/image_svg_embed.svg
 - spec/sample_images/mushroom-long.jpg
 - spec/sample_images/mushroom-wide.jpg
 - spec/sample_output/.keep
@@ -358,6 +377,7 @@ test_files:
 - spec/sample_svg/image01.svg
 - spec/sample_svg/image02_base64.svg
 - spec/sample_svg/image03.svg
+- spec/sample_svg/image_svg.svg
 - spec/sample_svg/line01.svg
 - spec/sample_svg/links.svg
 - spec/sample_svg/marker.svg
@@ -388,6 +408,7 @@ test_files:
 - spec/sample_svg/subviewports.svg
 - spec/sample_svg/subviewports2.svg
 - spec/sample_svg/svg_fill.svg
+- spec/sample_svg/symbol.svg
 - spec/sample_svg/text-decoration.svg
 - spec/sample_svg/text_entities.svg
 - spec/sample_svg/text_stroke.svg