prawn-svg 0.23.1 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f44a25b66d4e198d2f841ad98d277200cec4296
-  data.tar.gz: 6ce1562107ec65b0d8453826401c894dac0bb57b
+  metadata.gz: 3b7ff6138c2cf404469001e4d18217b5758af6c0
+  data.tar.gz: 15a9474c4bf2f479db7a1e167292c81037d17069
 SHA512:
-  metadata.gz: 5646e98d81e04aabeca34ae15444c7a6f9f210bae25e3217ee411a479c861544f43521fcafe272f3bdcc774a99b19327b5446857de6c633b7605fa86e98e3937
-  data.tar.gz: 266cb1f5721dfd3cc363650c9bd27a601e52f76f79f672e2da0d04ca97ed505fb9a03d50f6f3bbfacfd768ca92153b01e49a1062ad748aee9c20b724435e118c
+  metadata.gz: a446a4b93bc4e590eb76ad93c3b3df2786a300a54c4fd0d28a6e2c1360ea7e7f5ff05ed7759e61cd723c6c16048639d2bc44f6f6be3126d43d59a3259b698465
+  data.tar.gz: e383d553e521457d5b248f6043086dcf0a9573060c50044e9d631dc5b5e2deff7ed0ad39aaae5c0291f9225608beb038fe488c90390a56a44042c1cd94da72e9

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
   - 2.0.0
-  - 2.1.6
-  - 2.2.2
-
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0

data/README.md

@@ -7,7 +7,7 @@ An SVG renderer for the Prawn PDF library.
 
 This will take an SVG document as input and render it into your PDF.  Find out more about the Prawn PDF library at:
 
-  http://github.com/prawnpdf/prawn 
+  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.0.0.
@@ -69,18 +69,24 @@ prawn-svg supports most but not all of the full SVG 1.1 specification.  It curre
 
  - <tt>&lt;style&gt;</tt> plus <tt>id</tt>, <tt>class</tt> and <tt>style</tt> attributes (see CSS section below)
 
- - <tt>&lt;image&gt;</tt> with <tt>http:</tt>, <tt>https:</tt> and <tt>data:image/\*;base64</tt> schemes
+ - <tt>&lt;image&gt;</tt> with <tt>http:</tt>, <tt>https:</tt>, <tt>data:image/\*;base64</tt> and `file:` schemes
+   (`file:` is disabled by default for security reasons, see Options section above)
 
  - <tt>&lt;clipPath&gt;</tt>
 
- - <tt>&lt;linearGradient&gt;</tt> but only with Prawn 2.0.4+. gradientTransform, spreadMethod and stop-opacity are
-   unimplemented.
+ - `<marker>`
 
- - attributes/styles: <tt>fill</tt>, <tt>stroke</tt>, <tt>stroke-width</tt>, <tt>stroke-linecap</tt>, <tt>stroke-dasharray</tt>, <tt>opacity</tt>, <tt>fill-opacity</tt>, <tt>stroke-opacity</tt>, <tt>transform</tt>, <tt>clip-path</tt>, <tt>display</tt>
+ - <tt>&lt;linearGradient&gt;</tt> is implemented but not currently working as we are waiting for a pull request to be accepted
+   into Prawn. (gradientTransform, spreadMethod and stop-opacity are unimplemented.)
 
- - the <tt>viewBox</tt> attribute on the <tt>&lt;svg&gt;</tt> tag
+ - `<switch>` and `<foreignObject>`, although prawn-svg cannot handle any data that is not SVG so `<foreignObject>`
+   tags are always ignored.
 
- - the <tt>preserveAspectRatio</tt> attribute on the <tt>&lt;svg&gt;</tt> and <tt>&lt;image&gt;</tt> tags
+ - attributes/styles: <tt>fill</tt>, <tt>stroke</tt>, <tt>stroke-width</tt>, <tt>stroke-linecap</tt>, <tt>stroke-dasharray</tt>, <tt>opacity</tt>, <tt>fill-opacity</tt>, <tt>stroke-opacity</tt>, <tt>transform</tt>, <tt>clip-path</tt>, <tt>display</tt>, `marker-start`, `marker-mid`, `marker-end`
+
+ - the <tt>viewBox</tt> attribute on <tt>&lt;svg&gt;</tt> and `<marker>` tags
+
+ - the <tt>preserveAspectRatio</tt> attribute on <tt>&lt;svg&gt;</tt>, <tt>&lt;image&gt;</tt> and `<marker>` tags
 
  - transform methods: <tt>translate</tt>, <tt>rotate</tt>, <tt>scale</tt>, <tt>matrix</tt>
 
@@ -92,11 +98,11 @@ 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.
+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.
 
 ## Not supported
 
-prawn-svg does not support external <tt>url()</tt> references, measurements in <tt>en</tt> or <tt>em</tt>, sub-viewports, radial gradients, patterns or markers.
+prawn-svg does not support sub-viewports, radial gradients, or patterns.
 
 ## Configuration
 

data/lib/prawn-svg.rb

@@ -6,6 +6,7 @@ require 'prawn/svg/version'
 require 'css_parser'
 
 require 'prawn/svg/font_registry'
+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'
@@ -15,6 +16,8 @@ require 'prawn/svg/loaders/file'
 require 'prawn/svg/loaders/web'
 require 'prawn/svg/color'
 require 'prawn/svg/attributes'
+require 'prawn/svg/properties'
+require 'prawn/svg/pathable'
 require 'prawn/svg/elements'
 require 'prawn/svg/extension'
 require 'prawn/svg/interface'

data/lib/prawn/svg/attributes.rb

@@ -1,6 +1,6 @@
 module Prawn::SVG::Attributes
 end
 
-%w(transform opacity clip_path stroke font display color).each do |name|
+%w(transform opacity clip_path stroke).each do |name|
   require "prawn/svg/attributes/#{name}"
 end

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

@@ -1,13 +1,12 @@
 module Prawn::SVG::Attributes::ClipPath
   def parse_clip_path_attribute_and_call
-    return unless clip_path = attributes['clip-path']
+    return unless clip_path = properties.clip_path
+    return if clip_path == 'none'
 
-    if (matches = clip_path.strip.match(/\Aurl\(#(.*)\)\z/)).nil?
-      document.warnings << "Only clip-path attributes with the form 'url(#xxx)' are supported"
-    elsif (clip_path_element = @document.elements_by_id[matches[1]]).nil?
-      document.warnings << "clip-path ID '#{matches[1]}' not defined"
-    elsif clip_path_element.source.name != "clipPath"
-      document.warnings << "clip-path ID '#{matches[1]}' does not point to a clipPath tag"
+    clip_path_element = extract_element_from_url_id_reference(clip_path, 'clipPath')
+
+    if clip_path_element.nil?
+      document.warnings << "Could not resolve clip-path URI to a clipPath element"
     else
       add_call_and_enter 'save_graphics_state'
       add_calls_from_element clip_path_element

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

@@ -1,9 +1,9 @@
 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(attributes['opacity'].to_f, 0, 1) if attributes['opacity']
-    fill_opacity = clamp(attributes['fill-opacity'].to_f, 0, 1) if attributes['fill-opacity']
-    stroke_opacity = clamp(attributes['stroke-opacity'].to_f, 0, 1) if attributes['stroke-opacity']
+    fill_opacity = stroke_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

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

@@ -2,15 +2,17 @@ module Prawn::SVG::Attributes::Stroke
   CAP_STYLE_TRANSLATIONS = {"butt" => :butt, "round" => :round, "square" => :projecting_square}
 
   def parse_stroke_attributes_and_call
-    if width = attributes['stroke-width']
-      add_call('line_width', distance(width))
+    if width_string = properties.stroke_width
+      width = distance(width_string)
+      state.stroke_width = width
+      add_call('line_width', width)
     end
 
-    if (linecap = attribute_value_as_keyword('stroke-linecap')) && linecap != 'inherit'
+    if (linecap = properties.stroke_linecap) && linecap != 'inherit'
       add_call('cap_style', CAP_STYLE_TRANSLATIONS.fetch(linecap, :butt))
     end
 
-    if dasharray = attribute_value_as_keyword('stroke-dasharray')
+    if dasharray = properties.stroke_dasharray
       case dasharray
       when 'inherit'
         # don't do anything

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

@@ -0,0 +1,114 @@
+module Prawn::SVG::Calculators
+  module ArcToBezierCurve
+    protected
+
+    # Convert the elliptical arc to a cubic bézier curve using this algorithm:
+    # http://www.spaceroots.org/documents/ellipse/elliptical-arc.pdf
+    def calculate_bezier_curve_points_for_arc(cx, cy, a, b, lambda_1, lambda_2, theta)
+      e = lambda do |eta|
+        [
+          cx + a * Math.cos(theta) * Math.cos(eta) - b * Math.sin(theta) * Math.sin(eta),
+          cy + a * Math.sin(theta) * Math.cos(eta) + b * Math.cos(theta) * Math.sin(eta)
+        ]
+      end
+
+      ep = lambda do |eta|
+        [
+          -a * Math.cos(theta) * Math.sin(eta) - b * Math.sin(theta) * Math.cos(eta),
+          -a * Math.sin(theta) * Math.sin(eta) + b * Math.cos(theta) * Math.cos(eta)
+        ]
+      end
+
+      iterations = 1
+      d_lambda = lambda_2 - lambda_1
+
+      while iterations < 1024
+        if d_lambda.abs <= Math::PI / 2.0
+          # TODO : run error algorithm, see whether it meets threshold or not
+          # puts "error = #{calculate_curve_approximation_error(a, b, eta1, eta1 + d_eta)}"
+          break
+        end
+        iterations *= 2
+        d_lambda = (lambda_2 - lambda_1) / iterations
+      end
+
+      (0...iterations).collect do |iteration|
+        eta_a, eta_b = calculate_eta_from_lambda(a, b, lambda_1+iteration*d_lambda, lambda_1+(iteration+1)*d_lambda)
+        d_eta = eta_b - eta_a
+
+        alpha = Math.sin(d_eta) * ((Math.sqrt(4 + 3 * Math.tan(d_eta / 2) ** 2) - 1) / 3)
+
+        x1, y1 = e[eta_a]
+        x2, y2 = e[eta_b]
+
+        ep_eta1_x, ep_eta1_y = ep[eta_a]
+        q1_x = x1 + alpha * ep_eta1_x
+        q1_y = y1 + alpha * ep_eta1_y
+
+        ep_eta2_x, ep_eta2_y = ep[eta_b]
+        q2_x = x2 - alpha * ep_eta2_x
+        q2_y = y2 - alpha * ep_eta2_y
+
+        {:p2 => [x2, y2], :q1 => [q1_x, q1_y], :q2 => [q2_x, q2_y]}
+      end
+    end
+
+    private
+
+    ERROR_COEFFICIENTS_A = [
+      [
+        [3.85268, -21.229, -0.330434, 0.0127842],
+        [-1.61486, 0.706564, 0.225945, 0.263682],
+        [-0.910164, 0.388383, 0.00551445, 0.00671814],
+        [-0.630184, 0.192402, 0.0098871, 0.0102527]
+      ],
+      [
+        [-0.162211, 9.94329, 0.13723, 0.0124084],
+        [-0.253135, 0.00187735, 0.0230286, 0.01264],
+        [-0.0695069, -0.0437594, 0.0120636, 0.0163087],
+        [-0.0328856, -0.00926032, -0.00173573, 0.00527385]
+      ]
+    ]
+
+    ERROR_COEFFICIENTS_B = [
+      [
+        [0.0899116, -19.2349, -4.11711, 0.183362],
+        [0.138148, -1.45804, 1.32044, 1.38474],
+        [0.230903, -0.450262, 0.219963, 0.414038],
+        [0.0590565, -0.101062, 0.0430592, 0.0204699]
+      ],
+      [
+        [0.0164649, 9.89394, 0.0919496, 0.00760802],
+        [0.0191603, -0.0322058, 0.0134667, -0.0825018],
+        [0.0156192, -0.017535, 0.00326508, -0.228157],
+        [-0.0236752, 0.0405821, -0.0173086, 0.176187]
+      ]
+    ]
+
+    def calculate_curve_approximation_error(a, b, eta1, eta2)
+      b_over_a = b / a
+      coefficents = b_over_a < 0.25 ? ERROR_COEFFICIENTS_A : ERROR_COEFFICIENTS_B
+
+      c = lambda do |i|
+        (0..3).inject(0) do |accumulator, j|
+          coef = coefficents[i][j]
+          accumulator + ((coef[0] * b_over_a**2 + coef[1] * b_over_a + coef[2]) / (b_over_a * coef[3])) * Math.cos(j * (eta1 + eta2))
+        end
+      end
+
+      ((0.001 * b_over_a**2 + 4.98 * b_over_a + 0.207) / (b_over_a * 0.0067)) * a * Math.exp(c[0] + c[1] * (eta2 - eta1))
+    end
+
+    def calculate_eta_from_lambda(a, b, lambda_1, lambda_2)
+      # 2.2.1
+      eta1 = Math.atan2(Math.sin(lambda_1) / b, Math.cos(lambda_1) / a)
+      eta2 = Math.atan2(Math.sin(lambda_2) / b, Math.cos(lambda_2) / a)
+
+      # ensure eta1 <= eta2 <= eta1 + 2*PI
+      eta2 -= 2 * Math::PI * ((eta2 - eta1) / (2 * Math::PI)).floor
+      eta2 += 2 * Math::PI if lambda_2 - lambda_1 > Math::PI && eta2 - eta1 < Math::PI
+
+      [eta1, eta2]
+    end
+  end
+end

data/lib/prawn/svg/elements.rb

@@ -2,7 +2,7 @@ module Prawn::SVG::Elements
   COMMA_WSP_REGEXP = /(?:\s+,?\s*|,\s*)/
 end
 
-%w(base root container style text line polyline polygon circle ellipse rect path use image gradient ignored).each do |filename|
+%w(base root container style text line polyline polygon circle ellipse rect path use image gradient marker ignored).each do |filename|
   require "prawn/svg/elements/#{filename}"
 end
 
@@ -13,6 +13,7 @@ module Prawn::SVG::Elements
     symbol: Prawn::SVG::Elements::Container,
     defs: Prawn::SVG::Elements::Container,
     clipPath: Prawn::SVG::Elements::Container,
+    switch: Prawn::SVG::Elements::Container,
     style: Prawn::SVG::Elements::Style,
     text: Prawn::SVG::Elements::Text,
     line: Prawn::SVG::Elements::Line,
@@ -25,9 +26,11 @@ module Prawn::SVG::Elements
     use: Prawn::SVG::Elements::Use,
     image: Prawn::SVG::Elements::Image,
     linearGradient: Prawn::SVG::Elements::Gradient,
+    marker: Prawn::SVG::Elements::Marker,
     title: Prawn::SVG::Elements::Ignored,
     desc: Prawn::SVG::Elements::Ignored,
     metadata: Prawn::SVG::Elements::Ignored,
+    foreignObject: Prawn::SVG::Elements::Ignored,
     :"font-face" => Prawn::SVG::Elements::Ignored,
   }
 end

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

@@ -5,20 +5,19 @@ class Prawn::SVG::Elements::Base
   include Prawn::SVG::Attributes::Opacity
   include Prawn::SVG::Attributes::ClipPath
   include Prawn::SVG::Attributes::Stroke
-  include Prawn::SVG::Attributes::Font
-  include Prawn::SVG::Attributes::Display
-  include Prawn::SVG::Attributes::Color
 
+  PAINT_TYPES = %w(fill stroke)
   COMMA_WSP_REGEXP = Prawn::SVG::Elements::COMMA_WSP_REGEXP
 
   SkipElementQuietly = Class.new(StandardError)
   SkipElementError = Class.new(StandardError)
   MissingAttributesError = Class.new(SkipElementError)
 
-  attr_reader :document, :source, :parent_calls, :base_calls, :state, :attributes
+  attr_reader :document, :source, :parent_calls, :base_calls, :state, :attributes, :properties
   attr_accessor :calls
 
   def_delegators :@document, :x, :y, :distance, :points, :warnings
+  def_delegator :@state, :computed_properties
 
   def initialize(document, source, parent_calls, state)
     @document = document
@@ -26,28 +25,35 @@ class Prawn::SVG::Elements::Base
     @parent_calls = parent_calls
     @state = state
     @base_calls = @calls = []
+    @attributes = {}
+    @properties = Prawn::SVG::Properties.new
 
-    if id = source.attributes["id"]
+    if source && id = source.attributes["id"]
       document.elements_by_id[id] = self
     end
   end
 
   def process
-    combine_attributes_and_style_declarations
-    parse_standard_attributes
+    extract_attributes_and_properties
+    parse_and_apply
+  end
+
+  def parse_and_apply
     parse
 
     apply_calls_from_standard_attributes
     apply
 
-    append_calls_to_parent
+    process_child_elements if container?
+
+    append_calls_to_parent unless computed_properties.display == 'none'
   rescue SkipElementQuietly
   rescue SkipElementError => e
     @document.warnings << e.message
   end
 
   def name
-    @name ||= source.name
+    @name ||= source ? source.name : "???"
   end
 
   protected
@@ -74,6 +80,15 @@ class Prawn::SVG::Elements::Base
     @calls = @calls.last.last
   end
 
+  def push_call_position
+    @call_positions ||= []
+    @call_positions << @calls
+  end
+
+  def pop_call_position
+    @calls = @call_positions.pop
+  end
+
   def append_calls_to_parent
     @parent_calls.concat(@base_calls)
   end
@@ -82,7 +97,16 @@ class Prawn::SVG::Elements::Base
     @calls.concat other.base_calls
   end
 
+  def new_call_context_from_base
+    old_calls = @calls
+    @calls = @base_calls
+    yield
+    @calls = old_calls
+  end
+
   def process_child_elements
+    return unless source
+
     source.elements.each do |elem|
       if element_class = Prawn::SVG::Elements::TAG_CLASS_MAPPING[elem.name.to_sym]
         add_call "save"
@@ -101,16 +125,16 @@ class Prawn::SVG::Elements::Base
     parse_transform_attribute_and_call
     parse_opacity_attributes_and_call
     parse_clip_path_attribute_and_call
-    draw_types = parse_fill_and_stroke_attributes_and_call
+    apply_colors
     parse_stroke_attributes_and_call
-    parse_font_attributes_and_call
-    parse_display_attribute
-    apply_drawing_call(draw_types)
+    apply_drawing_call
   end
 
-  def apply_drawing_call(draw_types)
+  def apply_drawing_call
     if !state.disable_drawing && !container?
-      if draw_types.empty? || state.display == "none"
+      draw_types = PAINT_TYPES.select { |property| computed_properties.send(property) != 'none' }
+
+      if draw_types.empty?
         add_call_and_enter("end_path")
       else
         add_call_and_enter(draw_types.join("_and_"))
@@ -118,46 +142,37 @@ class Prawn::SVG::Elements::Base
     end
   end
 
-  def parse_standard_attributes
-    parse_color_attribute
-  end
+  def apply_colors
+    PAINT_TYPES.each do |type|
+      color = properties.send(type)
 
-  def parse_fill_and_stroke_attributes_and_call
-    ["fill", "stroke"].select do |type|
-      case keyword = attribute_value_as_keyword(type)
-      when nil
-      when 'inherit'
-      when 'none'
-        state.disable_draw_type(type)
-      else
-        state.disable_draw_type(type)
+      next if [nil, 'inherit', 'none'].include?(color)
 
-        if keyword == 'currentcolor'
-          color = state.color
-        else
-          color = @attributes[type]
-        end
+      if color == 'currentColor'
+        color = computed_properties.color
+      end
 
-        results = Prawn::SVG::Color.parse(color, document.gradients)
-
-        results.each do |result|
-          case result
-          when Prawn::SVG::Color::Hex
-            state.enable_draw_type(type)
-            add_call "#{type}_color", result.value
-            break
-          when Prawn::SVG::Elements::Gradient
-            arguments = result.gradient_arguments(self)
-            if arguments
-              state.enable_draw_type(type)
-              add_call "#{type}_gradient", **arguments
-              break
-            end
+      results = Prawn::SVG::Color.parse(color, document.gradients)
+
+      success = results.detect do |result|
+        case result
+        when Prawn::SVG::Color::Hex
+          add_call "#{type}_color", result.value
+          true
+        when Prawn::SVG::Elements::Gradient
+          arguments = result.gradient_arguments(self)
+          if arguments
+            add_call "#{type}_gradient", **arguments
+            true
           end
         end
       end
 
-      state.draw_type(type)
+      # If we were unable to find a suitable color candidate,
+      # we turn off this type of paint.
+      if success.nil?
+        computed_properties.set(type, 'none')
+      end
     end
   end
 
@@ -165,7 +180,7 @@ class Prawn::SVG::Elements::Base
     [[value, min_value].max, max_value].min
   end
 
-  def combine_attributes_and_style_declarations
+  def extract_attributes_and_properties
     if @document && @document.css_parser
       tag_style = @document.css_parser.find_by_selector(source.name)
       id_style = @document.css_parser.find_by_selector("##{source.attributes["id"]}") if source.attributes["id"]
@@ -185,12 +200,14 @@ class Prawn::SVG::Elements::Base
       style = source.attributes['style'] || ""
     end
 
-    @attributes = parse_css_declarations(style)
-
     source.attributes.each do |name, value|
-      name = name.downcase # TODO : this is incorrect; attributes are case sensitive
-      @attributes[name] = value unless @attributes[name]
+      # Properties#set returns nil if it's not a recognised property name
+      @properties.set(name, value) or @attributes[name] = value
     end
+
+    @properties.load_hash(parse_css_declarations(style))
+
+    state.computed_properties.compute_properties(@properties)
   end
 
   def parse_css_declarations(declarations)
@@ -207,22 +224,6 @@ class Prawn::SVG::Elements::Base
     output
   end
 
-  def attribute_value_as_keyword(name)
-    if value = @attributes[name]
-      value.strip.downcase
-    end
-  end
-
-  def parse_points(points_string)
-    points_string.
-      to_s.
-      strip.
-      gsub(/(\d)-(\d)/, '\1 -\2').
-      split(COMMA_WSP_REGEXP).
-      each_slice(2).
-      map {|x, y| [x(x), y(y)]}
-  end
-
   def require_attributes(*names)
     missing_attrs = names - attributes.keys
     if missing_attrs.any?
@@ -235,4 +236,10 @@ class Prawn::SVG::Elements::Base
       raise SkipElementError, "Invalid attributes on tag #{name}; skipping tag"
     end
   end
+
+  def extract_element_from_url_id_reference(value, expected_type = nil)
+    matches = value.strip.match(/\Aurl\(\s*#(\S+)\s*\)\z/i) if value
+    element = document.elements_by_id[matches[1]] if matches
+    element if element && (expected_type.nil? || element.name == expected_type)
+  end
 end