prawn-svg 0.27.1 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 78e98b74bfb10e36c2de7a051662546c98ddcfa5
-  data.tar.gz: 9fe692aebb49298a976f9436141c9bf9f4e3b750
+SHA256:
+  metadata.gz: 9ed78a64dc94709fc5e53f1d6f521f93e3bf41196c29dde616c6139743c9c889
+  data.tar.gz: 7a0a5683370d3478e8b9717069e0f4012337aaf6250106065dfd5ad9b4458a91
 SHA512:
-  metadata.gz: bca8bd9a84bb372434d0a6aac7911c13e097fbdc30e788c9dad883a922237b384cc6f9786a3992193bd46ee47e562274bbe5e7f39a7ad6eba0a9311422e40c24
-  data.tar.gz: 67af84522eb27d03b18afa2d9f6309b4a2588f411ddf123681dd69bf34992a85c2aab62946d87ab025bb12c66df3e2189b3543c5eba4e79c4de691003206696b
+  metadata.gz: a58fd3f4508d486b3632f2e337f5e2fe97ef8c2baeeeda9b4f53f816ff18eb10b3e8879c98ea10c645becb29c8351a7addc6867c22abfeda77a7edf654607f44
+  data.tar.gz: 3bdbbc06f25405d3f51de30e81c39406f7ccf535e507bb36b43df3939d1a4931b763cb5308bde72674ab3f2ffcb55171b958f93a3b603bf5cf17a1bbd24d44b4

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 rvm:
-  - 2.1.10
-  - 2.2.7
-  - 2.3.3
-  - 2.4.0
+  - 2.2.10
+  - 2.3.8
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1

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

@@ -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,12 +76,12 @@ 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.
 
- - properties: `clip-path`, `color`, `display`, `fill-opacity`, `fill`, `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-opacity`, `stroke-width`
 
  - properties on lines, polylines, polygons and paths: `marker-end`, `marker-mid`, `marker-start`
 
@@ -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>
 
@@ -101,11 +101,24 @@ prawn-svg supports most but not all of the full SVG 1.1 specification.  It curre
 
 ## CSS
 
-prawn-svg uses the css_parser gem to parse CSS <tt>&lt;style&gt;</tt> blocks.  It only handles simple tag, class or id selectors; attribute and other advanced selectors are not supported by the gem.
+prawn-svg supports CSS, both in `<style>` blocks and `style` attributes.
+
+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.
 
 ## Configuration
 
@@ -122,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'
@@ -21,12 +22,17 @@ require 'prawn/svg/pathable'
 require 'prawn/svg/elements'
 require 'prawn/svg/extension'
 require 'prawn/svg/interface'
-require 'prawn/svg/css'
+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/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.rb → css/font_family_parser.rb}

@@ -1,6 +1,6 @@
-class Prawn::SVG::CSS
-  class << self
-    def parse_font_family_string(string)
+module Prawn::SVG::CSS
+  class FontFamilyParser
+    def self.parse(string)
       in_quote = nil
       in_escape = false
       current = nil
@@ -37,4 +37,3 @@ class Prawn::SVG::CSS
     end
   end
 end
-

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

@@ -0,0 +1,174 @@
+module Prawn::SVG::CSS
+  class SelectorParser
+    def self.parse(selector)
+      tokens = tokenise_css_selector(selector) or return
+
+      result = [{}]
+      part = nil
+
+      tokens.each do |token|
+        case token
+        when Modifier
+          part = token.type
+          result.last[part] ||= part == :name ? "" : []
+        when Identifier
+          return unless part
+          result.last[part] << token.name
+        when Attribute
+          return unless ["=", "*=", "~=", "^=", "|=", "$=", nil].include?(token.operator)
+          (result.last[:attribute] ||= []) << [token.key, token.operator, token.value]
+        when Combinator
+          result << {combinator: token.type}
+          part = nil
+        end
+      end
+
+      result
+    end
+
+    private
+
+    VALID_CSS_IDENTIFIER_CHAR = /[a-zA-Z0-9_\u00a0-\uffff-]/
+    Identifier = Struct.new(:name)
+    Modifier = Struct.new(:type)
+    Combinator = Struct.new(:type)
+    Attribute = Struct.new(:key, :operator, :value)
+
+    def self.tokenise_css_selector(selector)
+      result = []
+      brackets = false
+      attribute = false
+      quote = false
+
+      selector.strip.chars do |char|
+        if brackets
+          result.last.name << char
+          brackets = false if char == ')'
+        elsif attribute
+          case attribute
+          when :pre_key
+            if VALID_CSS_IDENTIFIER_CHAR.match(char)
+              result.last.key = char
+              attribute = :key
+            elsif char != " " && char != "\t"
+              return
+            end
+
+          when :key
+            if VALID_CSS_IDENTIFIER_CHAR.match(char)
+              result.last.key << char
+            elsif char == "]"
+              attribute = nil
+            elsif "=*~^|$".include?(char)
+              result.last.operator = char
+              attribute = :operator
+            elsif char == " " || char == "\t"
+              attribute = :pre_operator
+            else
+              return
+            end
+
+          when :pre_operator
+            if "=*~^|$".include?(char)
+              result.last.operator = char
+              attribute = :operator
+            elsif char != " " && char != "\t"
+              return
+            end
+
+          when :operator
+            if "=*~^|$".include?(char)
+              result.last.operator << char
+            elsif char == " " || char == "\t"
+              attribute = :pre_value
+            elsif char == '"' || char == "'"
+              result.last.value = ''
+              attribute = char
+            else
+              result.last.value = char
+              attribute = :value
+            end
+
+          when :pre_value
+            if char == '"' || char == "'"
+              result.last.value = ''
+              attribute = char
+            elsif char != " " && char != "\t"
+              result.last.value = char
+              attribute = :value
+            end
+
+          when :value
+            if char == "]"
+              result.last.value = result.last.value.rstrip
+              attribute = nil
+            else
+              result.last.value << char
+            end
+
+          when '"', "'"
+            if char == "\\" && !quote
+              quote = true
+            elsif char == attribute && !quote
+              attribute = :post_string
+            else
+              quote = false
+              result.last.value << char
+            end
+
+          when :post_string
+            if char == "]"
+              attribute = nil
+            elsif char != " " && char != "\t"
+              return
+            end
+          end
+
+        elsif VALID_CSS_IDENTIFIER_CHAR.match(char)
+          case result.last
+          when Identifier
+            result.last.name << char
+          else
+            result << Modifier.new(:name) if !result.last.is_a?(Modifier)
+            result << Identifier.new(char)
+          end
+        else
+          case char
+          when "."
+            result << Modifier.new(:class)
+          when "#"
+            result << Modifier.new(:id)
+          when ":"
+            result << Modifier.new(:pseudo_class)
+          when " ", "\t"
+            result << Combinator.new(:descendant) unless result.last.is_a?(Combinator)
+          when ">"
+            result.pop if result.last == Combinator.new(:descendant)
+            result << Combinator.new(:child)
+          when "+"
+            result.pop if result.last == Combinator.new(:descendant)
+            result << Combinator.new(:adjacent)
+          when "~"
+            result.pop if result.last == Combinator.new(:descendant)
+            result << Combinator.new(:siblings)
+          when "*"
+            return unless result.empty? || result.last.is_a?(Combinator)
+            result << Modifier.new(:name)
+            result << Identifier.new("*")
+          when "(" # e.g. :nth-child(3n+4)
+            return unless result.last.is_a?(Identifier) && result[-2] && result[-2].is_a?(Modifier) && result[-2].type == :pseudo_class
+            result.last.name << "("
+            brackets = true
+          when "["
+            result << Attribute.new
+            attribute = :pre_key
+          else
+            return # unsupported Combinator
+          end
+        end
+      end
+
+      result unless brackets || attribute
+    end
+  end
+end

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

@@ -0,0 +1,146 @@
+module Prawn::SVG::CSS
+  class Stylesheets
+    attr_reader :css_parser, :root, :media
+
+    def initialize(css_parser, root, media = :all)
+      @css_parser = css_parser
+      @root = root
+      @media = media
+    end
+
+    def load
+      load_style_elements
+      xpath_styles = gather_xpath_styles
+      associate_xpath_styles_with_elements(xpath_styles)
+    end
+
+    private
+
+    def load_style_elements
+      REXML::XPath.match(root, '//style').each do |source|
+        data = source.texts.map(&:value).join
+        css_parser.add_block!(data)
+      end
+    end
+
+    def gather_xpath_styles
+      xpath_styles = []
+      order = 0
+
+      css_parser.each_rule_set(media) do |rule_set, _|
+        declarations = []
+        rule_set.each_declaration { |*data| declarations << data }
+
+        rule_set.selectors.each do |selector_text|
+          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]
+          end
+        end
+      end
+
+      xpath_styles.sort_by(&:last)
+    end
+
+    def associate_xpath_styles_with_elements(xpath_styles)
+      element_styles = {}
+
+      xpath_styles.each do |xpath, declarations, _|
+        REXML::XPath.match(root, xpath).each do |element|
+          (element_styles[element] ||= []).concat declarations
+        end
+      end
+
+      element_styles
+    end
+
+    def xpath_quote(value)
+      %{"#{value.gsub('\\', '\\\\').gsub('"', '\\"')}"} if value
+    end
+
+    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::"
+                 when :siblings
+                   "/following-sibling::"
+                 else
+                   "//"
+                 end
+
+        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)
+
+        (element[:attribute] || []).each do |key, operator, value|
+          case operator
+          when nil
+            result << "[@#{key}]"
+          when "="
+            result << "[@#{key}=#{xpath_quote value}]"
+          when "^="
+            result << "[starts-with(@#{key}, #{xpath_quote value})]"
+          when "$="
+            result << "[substring(@#{key}, string-length(@#{key}) - #{value.length - 1}) = #{xpath_quote value})]"
+          when "*="
+            result << "[contains(@#{key}, #{xpath_quote value})]"
+          when "~="
+            result << "[contains(concat(' ',@#{key},' '), #{xpath_quote " #{value} "})]"
+          when "|="
+            result << "[contains(concat('-',@#{key},'-'), #{xpath_quote "-#{value}-"})]"
+          end
+        end
+
+        result
+      end.join
+    end
+
+    def calculate_specificity(selector)
+      selector.reduce([0, 0, 0]) do |(a, b, c), element|
+        [
+          a + (element[:id] || []).length,
+          b + (element[:class] || []).length + (element[:attribute] || []).length + (element[:pseudo_class] || []).length,
+          c + (element[:name] && element[:name] != "*" ? 1 : 0)
+        ]
+      end
+    end
+  end
+end