prawn-svg 0.35.0 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0567f606c8d50a83ca8521e9af1a39cda59c570086d624eb08f415e13e2e0623
-  data.tar.gz: 37e4d144020f202b293fb7106c7e9bcbe47b47bf3dd85ee6f811c757b89e1dc9
+  metadata.gz: b833a9af0fae6fd2934c6b5ef37bd6d6d90aba36fa9a161520ac6a9a1c19f9db
+  data.tar.gz: 550aa711e413cac65e8af39f029096e3606f84a852b982729ca0252e758805ac
 SHA512:
-  metadata.gz: 89263ec912e718bb6405d0b4fd6b963665c1165bcedd8ec62226f7cfc4f8a80e9be771ceb55cfec45a65320e718724763f82dce20c274a6258da78f23394d91b
-  data.tar.gz: b87dfa3862f6679c530e2dfce0fcf9ef7a1e942cc2dff68f54bc6c053dd1b66915d2cae096a5d82e9905f35d3348a4e3a64bf02c0bb8491ef17826c890465e15
+  metadata.gz: 9a522f7b4aa8f713fc453cc3d6061968fce1a28ab60e58f6c321b92979bcb909748a81b8c9cb9a373f918d152e969ea7d0974afd975c8fba7ae70c03cec18a25
+  data.tar.gz: 537a912b7daab1581662cabfc5de5776ebe771d15e448e99a7c7d6125eb29644bbc40de6508429f5a3451f16ebb226f53402320ef4430118b16d05913cd3ede4

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    prawn-svg (0.34.2)
+    prawn-svg (0.36.0)
       css_parser (~> 1.6)
       matrix (~> 0.4.2)
       prawn (>= 0.11.1, < 3)
-      rexml (~> 3.2)
+      rexml (>= 3.3.9, < 4)
 
 GEM
   remote: http://rubygems.org/
@@ -34,8 +34,7 @@ GEM
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.9.2)
-    rexml (3.3.0)
-      strscan
+    rexml (3.4.0)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -63,7 +62,6 @@ GEM
     rubocop-ast (1.31.3)
       parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
-    strscan (3.1.0)
     ttfunk (1.8.0)
       bigdecimal (~> 3.1)
     unicode-display_width (2.5.0)

data/README.md

@@ -62,7 +62,7 @@ prawn-svg supports most but not all of the full SVG 1.1 specification.  It curre
    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`,
+   and with extra properties `text-anchor`, `text-decoration` (underline only), `font`, `font-size`, `font-family`,
    `font-weight`, `font-style`, `letter-spacing`, `dominant-baseline` (middle only)
 
  - `<svg>`, `<g>` and `<symbol>`
@@ -80,13 +80,14 @@ prawn-svg supports most but not all of the full SVG 1.1 specification.  It curre
  - `<marker>`
 
  - `<linearGradient>` and `<radialGradient>` are implemented on Prawn 2.2.0+ with attributes `gradientUnits` and
-   `gradientTransform` (`spreadMethod` and `stop-opacity` are unimplemented.)
+   `gradientTransform`
 
  - `<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-linejoin`, `stroke-opacity`, `stroke-width`
+   `stroke`, `stroke-dasharray`, `stroke-linecap`, `stroke-linejoin`, `stroke-opacity`, `stroke-width`,
+   `visibility`
 
  - properties on lines, polylines, polygons and paths: `marker-end`, `marker-mid`, `marker-start`
 
@@ -114,10 +115,6 @@ 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.
 

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

@@ -1,15 +1,30 @@
 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.
-    opacity = properties.opacity.to_f.clamp(0, 1) if properties.opacity
-    fill_opacity = properties.fill_opacity.to_f.clamp(0, 1) if properties.fill_opacity
-    stroke_opacity = properties.stroke_opacity.to_f.clamp(0, 1) if properties.stroke_opacity
+    # The opacity property is not inherited, but the opacity applies to all children underneath the element.
+    #
+    # Having an opacity property on a parent, and again on a child, multiplies the parent and child's opacities
+    # when drawing the children.
+    #
+    # The fill-opacity and stroke-opacity properties are inherited, but children which have a different value
+    # are displayed at that opacity rather than multiplying the parent's fill/stroke opacity with the child's.
+    #
+    # opacity and fill/stroke opacity can both be applied to the same element, and they multiply together.
 
-    if opacity || fill_opacity || stroke_opacity
-      state.fill_opacity *= [opacity || 1, fill_opacity || 1].min
-      state.stroke_opacity *= [opacity || 1, stroke_opacity || 1].min
+    opacity = computed_properties.opacity&.to_f&.clamp(0, 1)
+    fill_opacity = computed_properties.fill_opacity.to_f.clamp(0, 1)
+    stroke_opacity = computed_properties.stroke_opacity.to_f.clamp(0, 1)
 
-      add_call_and_enter 'transparent', state.fill_opacity, state.stroke_opacity
+    state.opacity *= opacity if opacity
+
+    fill_opacity = (fill_opacity || 1) * state.opacity
+    stroke_opacity = (stroke_opacity || 1) * state.opacity
+
+    fill_opacity = stroke_opacity = 0 if computed_properties.visibility != 'visible'
+
+    if state.last_fill_opacity != fill_opacity || state.last_stroke_opacity != stroke_opacity
+      state.last_fill_opacity = fill_opacity
+      state.last_stroke_opacity = stroke_opacity
+      add_call_and_enter 'transparent', fill_opacity, stroke_opacity
     end
   end
 end

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

@@ -23,19 +23,17 @@ module Prawn::SVG::Attributes::Stroke
         # don't do anything
       when 'none'
         add_call('undash')
-      else
-        array = dasharray.split(Prawn::SVG::Elements::COMMA_WSP_REGEXP)
-        array *= 2 if array.length.odd?
-        number_array = array.map { |value| pixels(value) }
+      when Array
+        dasharray *= 2 if dasharray.length.odd?
+        values = dasharray.map { |value| pixels(value) }
 
-        if number_array.any?(&:negative?)
-          @document.warnings << "stroke-dasharray cannot have negative numbers; treating as 'none'"
-          add_call('undash')
-        elsif number_array.inject(0) { |a, b| a + b }.zero?
+        if values.inject(0) { |a, b| a + b }.zero?
           add_call('undash')
         else
-          add_call('dash', number_array)
+          add_call('dash', values)
         end
+      else
+        raise "Unknown dasharray value: #{dasharray.inspect}"
       end
     end
   end

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

@@ -2,7 +2,7 @@ module Prawn::SVG::Attributes::Transform
   def parse_transform_attribute_and_call
     return unless (transform = attributes['transform'])
 
-    matrix = parse_transform_attribute(transform)
+    matrix = matrix_for_pdf(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/pixels.rb

@@ -1,25 +1,12 @@
 module Prawn::SVG::Calculators::Pixels
   class Measurement
-    extend Prawn::Measurements
-
     def self.to_pixels(value, axis_length = nil, font_size: Prawn::SVG::Properties::EM)
-      if value.is_a?(String)
-        if (match = value.match(/\d(em|ex|pc|cm|mm|in)$/))
-          case match[1]
-          when 'em'
-            value.to_f * font_size
-          when 'ex'
-            value.to_f * (font_size / 2.0) # we don't have access to the x-height, so this is an approximation approved by the CSS spec
-          when 'pc'
-            value.to_f * 15 # according to http://www.w3.org/TR/SVG11/coords.html
-          else
-            send("#{match[1]}2pt", value.to_f)
-          end
-        elsif value[-1..] == '%'
-          value.to_f * axis_length / 100.0
-        else
-          value.to_f
-        end
+      if value.respond_to?(:to_pixels)
+        value.to_pixels(axis_length, font_size)
+      elsif value.is_a?(String)
+        value = value.strip
+        value = Prawn::SVG::Length.parse(value) || Prawn::SVG::Percentage.parse(value)
+        value&.to_pixels(axis_length, font_size) || 0.0
       elsif value
         value.to_f
       end
@@ -40,16 +27,16 @@ module Prawn::SVG::Calculators::Pixels
 
   def pixels(value)
     value && Measurement.to_pixels(value, state.viewport_sizing.viewport_diagonal,
-      font_size: computed_properties.numerical_font_size)
+      font_size: computed_properties.numeric_font_size)
   end
 
   def x_pixels(value)
     value && Measurement.to_pixels(value, state.viewport_sizing.viewport_width,
-      font_size: computed_properties.numerical_font_size)
+      font_size: computed_properties.numeric_font_size)
   end
 
   def y_pixels(value)
     value && Measurement.to_pixels(value, state.viewport_sizing.viewport_height,
-      font_size: computed_properties.numerical_font_size)
+      font_size: computed_properties.numeric_font_size)
   end
 end

data/lib/prawn/svg/color.rb

@@ -1,6 +1,28 @@
 class Prawn::SVG::Color
-  RGB = Struct.new(:value)
-  CMYK = Struct.new(:value)
+  CMYK = Struct.new(:value) do
+    def to_cmyk
+      self
+    end
+  end
+
+  RGB = Struct.new(:value) do
+    def to_rgb
+      [value[0..1], value[2..3], value[4..5]].map { |h| h.to_i(16) / 255.0 }
+    end
+
+    def to_cmyk
+      r, g, b = rgb = to_rgb
+      k = 1 - rgb.max
+      if k == 1
+        CMYK.new([0, 0, 0, 100])
+      else
+        c = (1 - r - k) / (1 - k)
+        m = (1 - g - k) / (1 - k)
+        y = (1 - b - k) / (1 - k)
+        CMYK.new([c, m, y, k].map { |v| (v * 100).round })
+      end
+    end
+  end
 
   RGB_DEFAULT_COLOR = RGB.new('000000')
   CMYK_DEFAULT_COLOR = CMYK.new([0, 0, 0, 100])
@@ -156,63 +178,48 @@ class Prawn::SVG::Color
   }.freeze
 
   class << self
-    def parse(color_string, gradients = nil, color_mode = :rgb)
-      url_specified = false
+    def black
+      RGB_DEFAULT_COLOR
+    end
 
-      values = ::Prawn::SVG::CSS::ValuesParser.parse(color_string)
+    def parse(value)
+      case value
+      in ['rgb', args]
+        return unless args.length == 3
 
-      result = values.map do |value|
-        case value
-        in ['rgb', args]
-          hex = (0..2).collect do |n|
-            number = args[n].to_f
-            number *= 2.55 if args[n][-1..] == '%'
+        rgb =
+          args.map do |arg|
+            number = to_float(arg, 2.55) or break
             format('%02x', number.round.clamp(0, 255))
-          end.join
-
-          RGB.new(hex)
-
-        in ['device-cmyk', args]
-          cmyk = (0..3).collect do |n|
-            number = args[n].to_f
-            number *= 100 unless args[n][-1..] == '%'
-            number.clamp(0, 100)
           end
 
-          CMYK.new(cmyk)
+        rgb && RGB.new(rgb.join)
+
+      in ['device-cmyk', args]
+        return unless args.length == 4
 
-        in ['url', [url]]
-          url_specified = true
-          if url[0] == '#' && gradients && (gradient = gradients[url[1..]])
-            gradient
+        cymk =
+          args.map do |arg|
+            number = to_float(arg, 0.01) or break
+            (number * 100).clamp(0, 100)
           end
 
-        in /\A#([0-9a-f])([0-9a-f])([0-9a-f])\z/i
-          RGB.new("#{$1 * 2}#{$2 * 2}#{$3 * 2}")
+        cymk && CMYK.new(cymk)
 
-        in /\A#[0-9a-f]{6}\z/i
-          RGB.new(value[1..])
+      in /\A#([0-9a-f])([0-9a-f])([0-9a-f])\z/i
+        RGB.new("#{$1 * 2}#{$2 * 2}#{$3 * 2}")
 
-        in String => color
-          if (hex = HTML_COLORS[color.downcase])
-            hex_color(hex, color_mode)
-          end
+      in /\A#[0-9a-f]{6}\z/i
+        RGB.new(value[1..])
 
-        else
-          nil
+      in String => color
+        if (hex = HTML_COLORS[color.downcase])
+          RGB.new(hex)
         end
-      end
-
-      # Generally, we default to black if the colour was unparseable.
-      # http://www.w3.org/TR/SVG/painting.html section 11.2 says if a URL was
-      # supplied without a fallback, that's an error.
-      result << default_color(color_mode) unless url_specified
 
-      result.compact
-    end
-
-    def css_color_to_prawn_color(color)
-      parse(color).detect { |value| value.is_a?(RGB) || value.is_a?(CMYK) }&.value
+      else
+        nil
+      end
     end
 
     def default_color(color_mode)
@@ -221,20 +228,12 @@ class Prawn::SVG::Color
 
     private
 
-    def hex_color(hex, color_mode)
-      if color_mode == :cmyk
-        r, g, b = [hex[0..1], hex[2..3], hex[4..5]].map { |h| h.to_i(16) / 255.0 }
-        k = 1 - [r, g, b].max
-        if k == 1
-          CMYK.new([0, 0, 0, 100])
-        else
-          c = (1 - r - k) / (1 - k)
-          m = (1 - g - k) / (1 - k)
-          y = (1 - b - k) / (1 - k)
-          CMYK.new([c, m, y, k].map { |v| (v * 100).round })
-        end
+    def to_float(string, percentage_multiplier)
+      if string[-1] == '%'
+        number = Float(string[0..-2], exception: false)
+        number && (number * percentage_multiplier)
       else
-        RGB.new(hex)
+        Float(string, exception: false)
       end
     end
   end

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

@@ -0,0 +1,46 @@
+module Prawn::SVG::CSS
+  class FontParser
+    def self.parse(string)
+      in_quote = nil
+      in_escape = false
+      in_list_delimiter = false
+      current = nil
+      values = []
+
+      string.each_char do |char|
+        if in_escape
+          in_escape = false
+          if current.nil?
+            current = char
+            values << current
+          else
+            current << char
+          end
+        elsif char == ',' && in_quote.nil? && !in_escape && current
+          current << char
+          in_list_delimiter = true
+        elsif char == '\\'
+          in_escape = true
+        elsif current.nil?
+          if char.match(/\s/).nil?
+            in_list_delimiter = false
+            current = char
+            values << current
+          end
+        elsif !in_quote && !in_escape && !in_list_delimiter && char.match(/\s/)
+          current = nil
+        else
+          current << char
+        end
+
+        if char == in_quote
+          in_quote = nil
+        elsif in_quote.nil? && ['"', "'"].include?(char)
+          in_quote = char
+        end
+      end
+
+      values.map(&:rstrip)
+    end
+  end
+end

data/lib/prawn/svg/document.rb

@@ -17,7 +17,11 @@ class Prawn::SVG::Document
     :color_mode
 
   def initialize(data, bounds, options, font_registry: nil, css_parser: CssParser::Parser.new, attribute_overrides: {})
-    @root = REXML::Document.new(data).root
+    begin
+      @root = REXML::Document.new(data).root
+    rescue REXML::ParseException
+      @root = nil
+    end
 
     if @root.nil?
       if data.respond_to?(:end_with?) && data.end_with?('.svg')

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

@@ -158,8 +158,8 @@ class Prawn::SVG::Elements::Base
   def apply_drawing_call
     return if state.disable_drawing || !drawable?
 
-    fill   = computed_properties.fill != 'none'
-    stroke = computed_properties.stroke != 'none'
+    fill   = !computed_properties.fill.none? # rubocop:disable Style/InverseMethods
+    stroke = !computed_properties.stroke.none? # rubocop:disable Style/InverseMethods
 
     if fill
       command = stroke ? 'fill_and_stroke' : 'fill'
@@ -178,31 +178,27 @@ class Prawn::SVG::Elements::Base
 
   def apply_colors
     PAINT_TYPES.each do |type|
-      color = properties.send(type)
+      paint = properties.send(type)
 
-      next if [nil, 'inherit', 'none'].include?(color)
+      case paint
+      when nil, 'inherit'
+        next
+      when Prawn::SVG::Paint
+        color = paint.resolve(document.gradients, computed_properties.color, document.color_mode)
 
-      color = computed_properties.color if color == 'currentColor'
-
-      results = Prawn::SVG::Color.parse(color, document.gradients, document.color_mode)
-
-      success = results.detect do |result|
-        case result
+        case color
         when Prawn::SVG::Color::RGB, Prawn::SVG::Color::CMYK
-          add_call "#{type}_color", result.value
-          true
+          add_call "#{type}_color", color.value
         when Prawn::SVG::Elements::Gradient
-          arguments = result.gradient_arguments(self)
-          if arguments
-            add_call "#{type}_gradient", **arguments
-            true
-          end
+          add_call 'svg:render_gradient', type.to_sym, **color.gradient_arguments(self)
+        when nil
+          nil
+        else
+          raise "Unknown resolved color type: #{color.inspect}"
         end
+      else
+        raise "Unknown paint type: #{paint.inspect}"
       end
-
-      # If we were unable to find a suitable color candidate,
-      # we turn off this type of paint.
-      computed_properties.set(type, 'none') if success.nil?
     end
   end
 
@@ -250,15 +246,11 @@ class Prawn::SVG::Elements::Base
     end
   end
 
-  def extract_element_from_url_id_reference(values, expected_type = nil)
-    Prawn::SVG::CSS::ValuesParser.parse(values).detect do |value|
-      case value
-      in ['url', [url]]
-        element = document.elements_by_id[url[1..]] if url.start_with?('#')
-        break element if element && (expected_type.nil? || element.name == expected_type)
-      else
-        nil
-      end
+  def extract_element_from_url_id_reference(value, expected_type = nil)
+    case value
+    when Prawn::SVG::FuncIRI
+      element = document.elements_by_id[value.url[1..]] if value.url.start_with?('#')
+      element if element && (expected_type.nil? || element.name == expected_type)
     end
   end