prawn-svg 0.28.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5f5f1b932d2ff278ac37b5957a18b57d51013345
-  data.tar.gz: 7502fc93ebe947b1955d478292bf71c7b5dd40c0
+SHA256:
+  metadata.gz: d054ded3422dc4cd1cb870dc09549c0a82c1e2813e314565c7a3aec70d95d188
+  data.tar.gz: 123a00b97f78f284a8e11fad37fed42cbec06d678675ec15ff7dafbcfe6505d5
 SHA512:
-  metadata.gz: 770335f6cd4fbff5a30d6d6ff965ff2148e66543342de66a320583f4f24ec040d341054749c619c7a9ef1491e1e0155158ba63ea407b440406791dec60fc57f2
-  data.tar.gz: 8e1d9b9a00984309065c1ffc93b7695aafb97d4fbc91c3b6b76d7cc9ee4fe106365b23672f7a87fe0edc97e2612a7d7d3adfe557d5aaa1af4a0c90fb15652717
+  metadata.gz: 4ece284ced16e7b6f4d7562c17a97780375f4e255eb4199d489cfb1fa473dc1f65e6b9fa48894079f0756b42a749cc58f34c00507e19ccdfddab55723c82311d
+  data.tar.gz: 8826f6f457372cc7df38869e6448974f5731fdee1040bca44b8446b71c57e0713340481a3400705c8fd11ec5d13959dcd99f24a0fe8820c89a37ca725545656c

data/.github/workflows/test.yml

@@ -0,0 +1,18 @@
+name: test
+on: [push, pull_request]
+jobs:
+  rake:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, '3.0']
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+        ruby-version: ${{ matrix.ruby }}
+    - name: Run tests
+      run:  bundle exec rake

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright 2010-2013 Roger Nesbitt
+Copyright 2010-2019 Roger Nesbitt
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,7 +1,7 @@
 # prawn-svg
 
 [![Gem Version](https://badge.fury.io/rb/prawn-svg.svg)](https://badge.fury.io/rb/prawn-svg)
-[![Build Status](https://travis-ci.org/mogest/prawn-svg.svg?branch=master)](https://travis-ci.org/mogest/prawn-svg)
+![Build Status](https://github.com/mogest/prawn-svg/actions/workflows/test.yml/badge.svg?branch=master)
 
 An SVG renderer for the Prawn PDF library.
 
@@ -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.1.0.
+The minimum Ruby version required is 2.3.0.
 
 ## Using prawn-svg
 
@@ -60,8 +60,8 @@ prawn-svg supports most but not all of the full SVG 1.1 specification.  It curre
  - <tt>&lt;path&gt;</tt> 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`, and with extra properties
-   `text-anchor`, `font-size`, `font-family`, `font-weight`, `font-style`, `letter-spacing`
+ - `<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`
 
  - <tt>&lt;svg&gt;</tt>, <tt>&lt;g&gt;</tt> and <tt>&lt;symbol&gt;</tt>
 
@@ -76,7 +76,7 @@ prawn-svg supports most but not all of the full SVG 1.1 specification.  It curre
 
  - `<marker>`
 
- - `<linearGradient>` is implemented with Prawn 2.2.0+ (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.
@@ -91,7 +91,7 @@ prawn-svg supports most but not all of the full SVG 1.1 specification.  It curre
 
  - the <tt>preserveAspectRatio</tt> attribute on <tt>&lt;svg&gt;</tt>, <tt>&lt;image&gt;</tt> and `<marker>` elements
 
- - transform methods: <tt>translate()</tt>, <tt>rotate()</tt>, <tt>scale()</tt>, <tt>matrix()</tt>
+ - 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>
 
@@ -107,12 +107,16 @@ In CSS selectors you can use element names, IDs, classes, attributes (existence,
 and all combinators (` `, `>`, `+`, `~`).
 The pseudo-classes `:first-child`, `:last-child` and `:nth-child(n)` (where n is a number) also work.
 
+Warning: Ruby versions less than 2.6.0 have a bug in the REXML XPath implementation which means under some
+conditions the `+` combinator will not pick up all matching elements.  See `stylesheets_spec.rb` for an
+explanation if you're stuck on an old version of Ruby.
+
 Pseudo-elements and the other pseudo-classes are not supported.  Specificity ordering is
 implemented, but `!important` is not.
 
 ## Not supported
 
-prawn-svg does not support radial gradients, patterns or filters.
+prawn-svg does not support hyperlinks, patterns or filters.
 
 It does not support text in the clip area, but you can clip shapes and text by any shape.
 
@@ -131,5 +135,6 @@ Mac OS X and Debian Linux users.  You can add to the font path:
 
 In your Gemfile, put `gem 'prawn-svg'` before `gem 'prawn-rails'` so that prawn-rails can see the prawn-svg extension.
 
---
-Copyright Roger Nesbitt <roger@seriousorange.com>.  MIT licence.
+## Licence
+
+MIT licence.  Copyright Roger Nesbitt.

data/lib/prawn-svg.rb

@@ -10,6 +10,7 @@ require 'prawn/svg/calculators/arc_to_bezier_curve'
 require 'prawn/svg/calculators/aspect_ratio'
 require 'prawn/svg/calculators/document_sizing'
 require 'prawn/svg/calculators/pixels'
+require 'prawn/svg/transform_parser'
 require 'prawn/svg/url_loader'
 require 'prawn/svg/loaders/data'
 require 'prawn/svg/loaders/file'
@@ -29,6 +30,9 @@ require 'prawn/svg/font'
 require 'prawn/svg/document'
 require 'prawn/svg/state'
 
+require 'prawn/svg/extensions/additional_gradient_transforms'
+Prawn::Document.prepend Prawn::SVG::Extensions::AdditionalGradientTransforms
+
 module Prawn
   Svg = SVG # backwards compatibility
 end

data/lib/prawn/svg/attributes/opacity.rb

@@ -1,13 +1,13 @@
 module Prawn::SVG::Attributes::Opacity
   def parse_opacity_attributes_and_call
     # We can't do nested opacities quite like the SVG requires, but this is close enough.
-    fill_opacity = stroke_opacity = clamp(properties.opacity.to_f, 0, 1) if properties.opacity
+    opacity = clamp(properties.opacity.to_f, 0, 1) if properties.opacity
     fill_opacity = clamp(properties.fill_opacity.to_f, 0, 1) if properties.fill_opacity
     stroke_opacity = clamp(properties.stroke_opacity.to_f, 0, 1) if properties.stroke_opacity
 
-    if fill_opacity || stroke_opacity
-      state.fill_opacity *= fill_opacity || 1
-      state.stroke_opacity *= stroke_opacity || 1
+    if opacity || fill_opacity || stroke_opacity
+      state.fill_opacity *= [opacity || 1, fill_opacity || 1].min
+      state.stroke_opacity *= [opacity || 1, stroke_opacity || 1].min
 
       add_call_and_enter 'transparent', state.fill_opacity, state.stroke_opacity
     end

data/lib/prawn/svg/attributes/transform.rb

@@ -2,49 +2,7 @@ module Prawn::SVG::Attributes::Transform
   def parse_transform_attribute_and_call
     return unless transform = attributes['transform']
 
-    parse_css_method_calls(transform).each do |name, arguments|
-      case name
-      when 'translate'
-        x, y = arguments
-        add_call_and_enter name, x_pixels(x.to_f), -y_pixels(y.to_f)
-
-      when 'rotate'
-        r, x, y = arguments.collect {|a| a.to_f}
-        case arguments.length
-        when 1
-          add_call_and_enter name, -r, :origin => [0, y('0')]
-        when 3
-          add_call_and_enter name, -r, :origin => [x(x), y(y)]
-        else
-          warnings << "transform 'rotate' must have either one or three arguments"
-        end
-
-      when 'scale'
-        x_scale = arguments[0].to_f
-        y_scale = (arguments[1] || x_scale).to_f
-        add_call_and_enter "transformation_matrix", x_scale, 0, 0, y_scale, 0, 0
-
-      when 'matrix'
-        if arguments.length != 6
-          warnings << "transform 'matrix' must have six arguments"
-        else
-          a, b, c, d, e, f = arguments.collect {|argument| argument.to_f}
-          add_call_and_enter "transformation_matrix", a, -b, -c, d, x_pixels(e), -y_pixels(f)
-        end
-
-      else
-        warnings << "Unknown transformation '#{name}'; ignoring"
-      end
-    end
-  end
-
-  private
-
-  def parse_css_method_calls(string)
-    string.scan(/\s*(\w+)\(([^)]+)\)\s*/).collect do |call|
-      name, argument_string = call
-      arguments = argument_string.strip.split(/\s*[,\s]\s*/)
-      [name, arguments]
-    end
+    matrix = parse_transform_attribute(transform)
+    add_call_and_enter "transformation_matrix", *matrix unless matrix == [1, 0, 0, 1, 0, 0]
   end
 end

data/lib/prawn/svg/calculators/document_sizing.rb

@@ -36,10 +36,10 @@ module Prawn::SVG::Calculators
         @x_offset, @y_offset, @viewport_width, @viewport_height = values.map {|value| value.to_f}
 
         if @viewport_width > 0 && @viewport_height > 0
-          # If neither the width nor height was specified, use the entire space available
+          # If neither the width nor height was specified, use the entire width and the viewbox ratio
+          # to determine the height.
           if @output_width.nil? && @output_height.nil?
             @output_width = container_width
-            @output_height = container_height
           end
 
           # If one of the output dimensions is missing, calculate it from the other one

data/lib/prawn/svg/css/stylesheets.rb

@@ -32,13 +32,14 @@ module Prawn::SVG::CSS
         rule_set.each_declaration { |*data| declarations << data }
 
         rule_set.selectors.each do |selector_text|
-          selector = Prawn::SVG::CSS::SelectorParser.parse(selector_text)
-          xpath = css_selector_to_xpath(selector)
-          specificity = calculate_specificity(selector)
-          specificity << order
-          order += 1
+          if selector = Prawn::SVG::CSS::SelectorParser.parse(selector_text)
+            xpath = css_selector_to_xpath(selector)
+            specificity = calculate_specificity(selector)
+            specificity << order
+            order += 1
 
-          xpath_styles << [xpath, declarations, specificity]
+            xpath_styles << [xpath, declarations, specificity]
+          end
         end
       end
 
@@ -64,20 +65,48 @@ module Prawn::SVG::CSS
     def css_selector_to_xpath(selector)
       selector.map do |element|
         pseudo_classes = Set.new(element[:pseudo_class])
+        require_function_name = false
 
         result = case element[:combinator]
                  when :child
-                   '/'
+                   "/"
                  when :adjacent
                    pseudo_classes << 'first-child'
-                   '/following-sibling::'
+                   "/following-sibling::"
                  when :siblings
-                   '/following-sibling::'
+                   "/following-sibling::"
                  else
-                   '//'
+                   "//"
                  end
 
-        result << element[:name] if element[:name]
+        positions = []
+        pseudo_classes.each do |pc|
+          case pc
+          when "first-child" then positions << '1'
+          when "last-child"  then positions << 'last()'
+          when /^nth-child\((\d+)\)$/ then positions << $1
+          end
+        end
+
+        if !positions.empty?
+          result << "*" unless require_function_name
+          require_function_name = true
+
+          logic = if positions.length == 1
+                    positions.first
+                  else
+                    positions.map { |position| "position()=#{position}" }.join(" and ")
+                  end
+
+          result << "[#{logic}]"
+        end
+
+        if require_function_name
+          result << "[name()=#{xpath_quote element[:name]}]" if element[:name]
+        else
+          result << (element[:name] || '*')
+        end
+
         result << ((element[:class] || []).map { |name| "[contains(concat(' ',@class,' '), ' #{name} ')]" }.join)
         result << ((element[:id] || []).map { |name| "[@id='#{name}']" }.join)
 
@@ -100,14 +129,6 @@ module Prawn::SVG::CSS
           end
         end
 
-        pseudo_classes.each do |pc|
-          case pc
-          when "first-child" then result << "[1]"
-          when "last-child"  then result << "[last()]"
-          when /^nth-child\((\d+)\)$/ then result << "[#{$1}]"
-          end
-        end
-
         result
       end.join
     end

data/lib/prawn/svg/elements.rb

@@ -13,6 +13,7 @@ module Prawn::SVG::Elements
     g: Prawn::SVG::Elements::Container,
     symbol: Prawn::SVG::Elements::Container,
     defs: Prawn::SVG::Elements::Container,
+    a: Prawn::SVG::Elements::Container,
     clipPath: Prawn::SVG::Elements::ClipPath,
     switch: Prawn::SVG::Elements::Container,
     svg: Prawn::SVG::Elements::Viewport,
@@ -27,6 +28,7 @@ module Prawn::SVG::Elements
     use: Prawn::SVG::Elements::Use,
     image: Prawn::SVG::Elements::Image,
     linearGradient: Prawn::SVG::Elements::Gradient,
+    radialGradient: Prawn::SVG::Elements::Gradient,
     marker: Prawn::SVG::Elements::Marker,
     style: Prawn::SVG::Elements::Ignored, # because it is pre-parsed by Document
     title: Prawn::SVG::Elements::Ignored,

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

@@ -11,6 +11,8 @@ class Prawn::SVG::Elements::Base
   include Prawn::SVG::Attributes::Stroke
   include Prawn::SVG::Attributes::Space
 
+  include Prawn::SVG::TransformParser
+
   PAINT_TYPES = %w(fill stroke)
   COMMA_WSP_REGEXP = Prawn::SVG::Elements::COMMA_WSP_REGEXP
   SVG_NAMESPACE = "http://www.w3.org/2000/svg"
@@ -89,12 +91,12 @@ class Prawn::SVG::Elements::Base
     parse_xml_space_attribute
   end
 
-  def add_call(name, *arguments)
-    @calls << [name.to_s, arguments, []]
+  def add_call(name, *arguments, **kwarguments)
+    @calls << [name.to_s, arguments, kwarguments, []]
   end
 
-  def add_call_and_enter(name, *arguments)
-    @calls << [name.to_s, arguments, []]
+  def add_call_and_enter(name, *arguments, **kwarguments)
+    @calls << [name.to_s, arguments, kwarguments, []]
     @calls = @calls.last.last
   end
 
@@ -166,7 +168,7 @@ class Prawn::SVG::Elements::Base
       command = stroke ? 'fill_and_stroke' : 'fill'
 
       if computed_properties.fill_rule == 'evenodd'
-        add_call_and_enter(command, {fill_rule: :even_odd})
+        add_call_and_enter(command, fill_rule: :even_odd)
       else
         add_call_and_enter(command)
       end
@@ -265,4 +267,8 @@ class Prawn::SVG::Elements::Base
     element = document.elements_by_id[matches[1]] if matches
     element if element && (expected_type.nil? || element.name == expected_type)
   end
+
+  def href_attribute
+    attributes['xlink:href'] || attributes['href']
+  end
 end

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

@@ -12,7 +12,7 @@ module Prawn::SVG::Elements::CallDuplicator
   end
 
   def duplicate_call(call)
-    [call[0], duplicate_array(call[1]), duplicate_calls(call[2])]
+    [call[0], duplicate_array(call[1]), duplicate_hash(call[2]), duplicate_calls(call[3])]
   end
 
   def duplicate_array(array)

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

@@ -1,10 +1,18 @@
 class Prawn::SVG::Elements::Gradient < Prawn::SVG::Elements::Base
-  TAG_NAME_TO_TYPE = {"linearGradient" => :linear}
+  attr_reader :parent_gradient
+  attr_reader :x1, :y1, :x2, :y2, :cx, :cy, :fx, :fy, :radius, :units, :stops, :transform_matrix
+
+  TAG_NAME_TO_TYPE = {
+    "linearGradient" => :linear,
+    "radialGradient" => :radial
+  }
 
   def parse
     # A gradient tag without an ID is inaccessible and can never be used
     raise SkipElementQuietly if attributes['id'].nil?
 
+    @parent_gradient = document.gradients[href_attribute[1..-1]] if href_attribute && href_attribute[0] == '#'
+
     assert_compatible_prawn_version
     load_gradient_configuration
     load_coordinates
@@ -16,26 +24,56 @@ class Prawn::SVG::Elements::Gradient < Prawn::SVG::Elements::Base
   end
 
   def gradient_arguments(element)
-    case @units
-    when :bounding_box
-      x1, y1, x2, y2 = element.bounding_box
-      return if y2.nil?
+    # Passing in a transformation matrix to the apply_transformations option is supported
+    # by a monkey patch installed by prawn-svg.  Prawn only sees this as a truthy variable.
+    #
+    # See Prawn::SVG::Extensions::AdditionalGradientTransforms for details.
+    base_arguments = {stops: stops, apply_transformations: transform_matrix || true}
+
+    arguments = specific_gradient_arguments(element)
+    arguments.merge(base_arguments) if arguments
+  end
 
-      width = x2 - x1
-      height = y1 - y2
+  private
 
-      from = [x1 + width * @x1, y1 - height * @y1]
-      to   = [x1 + width * @x2, y1 - height * @y2]
+  def specific_gradient_arguments(element)
+    if units == :bounding_box
+      bounding_x1, bounding_y1, bounding_x2, bounding_y2 = element.bounding_box
+      return if bounding_y2.nil?
 
-    when :user_space
-      from = [@x1, @y1]
-      to   = [@x2, @y2]
+      width = bounding_x2 - bounding_x1
+      height = bounding_y1 - bounding_y2
     end
 
-    {from: from, to: to, stops: @stops}
-  end
+    case [type, units]
+    when [:linear, :bounding_box]
+      from = [bounding_x1 + width * x1, bounding_y1 - height * y1]
+      to   = [bounding_x1 + width * x2, bounding_y1 - height * y2]
 
-  private
+      {from: from, to: to}
+
+    when [:linear, :user_space]
+      {from: [x1, y1], to: [x2, y2]}
+
+    when [:radial, :bounding_box]
+      center = [bounding_x1 + width * cx, bounding_y1 - height * cy]
+      focus  = [bounding_x1 + width * fx, bounding_y1 - height * fy]
+
+      # Note: Chrome, at least, implements radial bounding box radiuses as
+      # having separate X and Y components, so in bounding box mode their
+      # gradients come out as ovals instead of circles.  PDF radial shading
+      # doesn't have the option to do this, and it's confusing why the
+      # Chrome user space gradients don't apply the same logic anyway.
+      hypot = Math.sqrt(width * width + height * height)
+      {from: focus, r1: 0, to: center, r2: radius * hypot}
+
+    when [:radial, :user_space]
+      {from: [fx, fy], r1: 0, to: [cx, cy], r2: radius}
+
+    else
+      raise "unexpected type/unit system"
+    end
+  end
 
   def type
     TAG_NAME_TO_TYPE.fetch(name)
@@ -51,10 +89,7 @@ class Prawn::SVG::Elements::Gradient < Prawn::SVG::Elements::Base
     @units = attributes["gradientUnits"] == 'userSpaceOnUse' ? :user_space : :bounding_box
 
     if transform = attributes["gradientTransform"]
-      matrix = transform.split(COMMA_WSP_REGEXP).map(&:to_f)
-      if matrix != [1, 0, 0, 1, 0, 0]
-        raise SkipElementError, "prawn-svg does not yet support gradients with a non-identity gradientTransform attribute"
-      end
+      @transform_matrix = parse_transform_attribute(transform)
     end
 
     if (spread_method = attributes['spreadMethod']) && spread_method != "pad"
@@ -63,18 +98,35 @@ class Prawn::SVG::Elements::Gradient < Prawn::SVG::Elements::Base
   end
 
   def load_coordinates
-    case @units
-    when :bounding_box
+    case [type, units]
+    when [:linear, :bounding_box]
       @x1 = parse_zero_to_one(attributes["x1"], 0)
       @y1 = parse_zero_to_one(attributes["y1"], 0)
       @x2 = parse_zero_to_one(attributes["x2"], 1)
       @y2 = parse_zero_to_one(attributes["y2"], 0)
 
-    when :user_space
+    when [:linear, :user_space]
       @x1 = x(attributes["x1"])
       @y1 = y(attributes["y1"])
       @x2 = x(attributes["x2"])
       @y2 = y(attributes["y2"])
+
+    when [:radial, :bounding_box]
+      @cx = parse_zero_to_one(attributes["cx"], 0.5)
+      @cy = parse_zero_to_one(attributes["cy"], 0.5)
+      @fx = parse_zero_to_one(attributes["fx"], cx)
+      @fy = parse_zero_to_one(attributes["fy"], cy)
+      @radius = parse_zero_to_one(attributes["r"], 0.5)
+
+    when [:radial, :user_space]
+      @cx = x(attributes["cx"] || '50%')
+      @cy = y(attributes["cy"] || '50%')
+      @fx = x(attributes["fx"] || attributes["cx"])
+      @fy = y(attributes["fy"] || attributes["cy"])
+      @radius = pixels(attributes["r"] || '50%')
+
+    else
+      raise "unexpected type/unit system"
     end
   end
 
@@ -100,10 +152,16 @@ class Prawn::SVG::Elements::Gradient < Prawn::SVG::Elements::Base
       end
     end
 
-    raise SkipElementError, "gradient does not have any valid stops" if @stops.empty?
+    if stops.empty?
+      if parent_gradient.nil? || parent_gradient.stops.empty?
+        raise SkipElementError, "gradient does not have any valid stops"
+      end
 
-    @stops.unshift([0, @stops.first.last]) if @stops.first.first > 0
-    @stops.push([1, @stops.last.last])     if @stops.last.first  < 1
+      @stops = parent_gradient.stops
+    else
+      stops.unshift([0, stops.first.last]) if stops.first.first > 0
+      stops.push([1, stops.last.last])     if stops.last.first  < 1
+    end
   end
 
   def parse_zero_to_one(string, default = 0)