prawn-svg 0.25.2 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc0f179818ef67c8d26893204ed003aade48b1e2
-  data.tar.gz: 061d2ab83b313f9973d2a480e51f2fd5d288fb0e
+  metadata.gz: fc43729a870492246519b983633bc96720650d74
+  data.tar.gz: d577a115a0cf7fcb8fc8d9f389d83755dbc5acda
 SHA512:
-  metadata.gz: 1df75e7819f4b9c3d016e386ca48bf4041d490da015f808880ff5bc78f40659b37313eb31bbf4106e1d17212e4965bb43bb0b32899ea6fd3003a7e8e3bf3270f
-  data.tar.gz: a693b8ed00d9ee605dc924a0fce2160936662fa11f5555b98b02cf480e8057808f2b6ae2b5ad07d2b42939777ce3f60fb1123d481ea8f2f1e5b97ade42293b82
+  metadata.gz: 97c5a9deaf6d7429c9f6f532ca97044d2bd73658009dbb16dd396d5c5b37b8465e9c2366f35e6eee7156b4f9e8450a44e5e284fe65f8b3c4b273515fc86bbb01
+  data.tar.gz: ddc2a03914c5614d9ddb3c90e70a71983546b6e554cfe073ad6faca81e6a1afed7293de0b906f0eda3af02f8b14a775eedd9e5d69de7737aaee23751052d1a2f

data/.gitignore

@@ -5,3 +5,5 @@ Gemfile.lock
 .rvmrc
 .*.swp
 .ruby-version
+vendor/bundle/
+.bundle/

data/README.md

@@ -106,7 +106,7 @@ prawn-svg uses the css_parser gem to parse CSS <tt>&lt;style&gt;</tt> blocks.  I
 
 ## Not supported
 
-prawn-svg does not support radial gradients or patterns.
+prawn-svg does not support radial gradients, patterns or filters.
 
 ## Configuration
 

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

@@ -4,7 +4,7 @@ module Prawn::SVG::Calculators
     attr_reader :width, :height, :x, :y
 
     def initialize(value, container_dimensions, object_dimensions)
-      values = (value || "xMidYMid meet").strip.split(/\s+/)
+      values = (value || "xMidYMid meet").split(' ')
       @x = @y = 0
 
       if values.first == "defer"

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

@@ -2,12 +2,19 @@ module Prawn::SVG::Calculators::Pixels
   class Measurement
     extend Prawn::Measurements
 
-    def self.to_pixels(value, axis_length = nil)
+    def self.to_pixels(value, axis_length = nil, font_size: Prawn::SVG::Properties::EM)
       if value.is_a?(String)
-        if match = value.match(/\d(cm|dm|ft|in|m|mm|yd)$/)
-          send("#{match[1]}2pt", value.to_f)
-        elsif match = value.match(/\dpc$/)
-          value.to_f * 15 # according to http://www.w3.org/TR/SVG11/coords.html
+        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..-1] == "%"
           value.to_f * axis_length / 100.0
         else
@@ -32,14 +39,14 @@ module Prawn::SVG::Calculators::Pixels
   end
 
   def pixels(value)
-    value && Measurement.to_pixels(value, state.viewport_sizing.viewport_diagonal)
+    value && Measurement.to_pixels(value, state.viewport_sizing.viewport_diagonal, font_size: computed_properties.numerical_font_size)
   end
 
   def x_pixels(value)
-    value && Measurement.to_pixels(value, state.viewport_sizing.viewport_width)
+    value && Measurement.to_pixels(value, state.viewport_sizing.viewport_width, font_size: computed_properties.numerical_font_size)
   end
 
   def y_pixels(value)
-    value && Measurement.to_pixels(value, state.viewport_sizing.viewport_height)
+    value && Measurement.to_pixels(value, state.viewport_sizing.viewport_height, font_size: computed_properties.numerical_font_size)
   end
 end

data/lib/prawn/svg/document.rb

@@ -14,7 +14,7 @@ class Prawn::SVG::Document
     :url_loader,
     :css_parser, :elements_by_id, :gradients
 
-  def initialize(data, bounds, options, font_registry: nil)
+  def initialize(data, bounds, options, font_registry: nil, css_parser: CssParser::Parser.new)
     @root = REXML::Document.new(data).root
 
     if @root.nil?
@@ -31,6 +31,7 @@ class Prawn::SVG::Document
     @gradients = {}
     @fallback_font_name = options.fetch(:fallback_font_name, DEFAULT_FALLBACK_FONT_NAME)
     @font_registry = font_registry
+    @css_parser = css_parser
 
     @url_loader = Prawn::SVG::UrlLoader.new(
       enable_cache:          options[:cache_images],
@@ -41,7 +42,7 @@ class Prawn::SVG::Document
     @sizing = Prawn::SVG::Calculators::DocumentSizing.new(bounds, @root.attributes)
     calculate_sizing(requested_width: options[:width], requested_height: options[:height])
 
-    @css_parser = CssParser::Parser.new
+    parse_style_elements
 
     yield self if block_given?
   end
@@ -51,4 +52,16 @@ class Prawn::SVG::Document
     sizing.requested_height = requested_height
     sizing.calculate
   end
+
+  private
+
+  # <style> elements specified anywhere in the document apply to the entire
+  # document.  Because of this, we load all <style> elements before parsing
+  # the rest of the document.
+  def parse_style_elements
+    REXML::XPath.match(root, '//style').each do |source|
+      data = source.texts.map(&:value).join
+      css_parser.add_block!(data)
+    end
+  end
 end

data/lib/prawn/svg/elements.rb

@@ -4,7 +4,7 @@ end
 
 require 'prawn/svg/elements/call_duplicator'
 
-%w(base depth_first_base root container viewport style text text_component line polyline polygon circle ellipse rect path use image gradient marker ignored).each do |filename|
+%w(base depth_first_base root container viewport text text_component line polyline polygon circle ellipse rect path use image gradient marker ignored).each do |filename|
   require "prawn/svg/elements/#{filename}"
 end
 
@@ -16,7 +16,6 @@ module Prawn::SVG::Elements
     clipPath: Prawn::SVG::Elements::Container,
     switch: Prawn::SVG::Elements::Container,
     svg: Prawn::SVG::Elements::Viewport,
-    style: Prawn::SVG::Elements::Style,
     text: Prawn::SVG::Elements::Text,
     line: Prawn::SVG::Elements::Line,
     polyline: Prawn::SVG::Elements::Polyline,
@@ -29,10 +28,12 @@ module Prawn::SVG::Elements
     image: Prawn::SVG::Elements::Image,
     linearGradient: 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,
     desc: Prawn::SVG::Elements::Ignored,
     metadata: Prawn::SVG::Elements::Ignored,
     foreignObject: Prawn::SVG::Elements::Ignored,
     :"font-face" => Prawn::SVG::Elements::Ignored,
+    filter: Prawn::SVG::Elements::Ignored, # unsupported
   }
 end

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

@@ -13,6 +13,7 @@ class Prawn::SVG::Elements::Base
 
   PAINT_TYPES = %w(fill stroke)
   COMMA_WSP_REGEXP = Prawn::SVG::Elements::COMMA_WSP_REGEXP
+  SVG_NAMESPACE = "http://www.w3.org/2000/svg"
 
   SkipElementQuietly = Class.new(StandardError)
   SkipElementError = Class.new(StandardError)
@@ -33,8 +34,11 @@ class Prawn::SVG::Elements::Base
     @attributes = {}
     @properties = Prawn::SVG::Properties.new
 
-    if source && id = source.attributes["id"]
-      document.elements_by_id[id] = self
+    if source && !state.inside_use
+      id = source.attributes["id"]
+      id = id.strip if id
+
+      document.elements_by_id[id] = self if id && id != ''
     end
   end
 
@@ -121,7 +125,7 @@ class Prawn::SVG::Elements::Base
   def process_child_elements
     return unless source
 
-    source.elements.each do |elem|
+    svg_child_elements.each do |elem|
       if element_class = Prawn::SVG::Elements::TAG_CLASS_MAPPING[elem.name.to_sym]
         add_call "save"
 
@@ -135,6 +139,14 @@ class Prawn::SVG::Elements::Base
     end
   end
 
+  def svg_child_elements
+    source.elements.select do |elem|
+      # To be strict, we shouldn't treat namespace-less elements as SVG, but for
+      # backwards compatibility, and because it doesn't hurt, we will.
+      elem.namespace == SVG_NAMESPACE || elem.namespace == ''
+    end
+  end
+
   def apply_calls_from_standard_attributes
     parse_transform_attribute_and_call
     parse_opacity_attributes_and_call
@@ -200,7 +212,7 @@ class Prawn::SVG::Elements::Base
       id_style = @document.css_parser.find_by_selector("##{source.attributes["id"]}") if source.attributes["id"]
 
       if classes = source.attributes["class"]
-        class_styles = classes.strip.split(/\s+/).collect do |class_name|
+        class_styles = classes.split(' ').collect do |class_name|
           @document.css_parser.find_by_selector(".#{class_name}")
         end
       end

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

@@ -2,13 +2,18 @@ class Prawn::SVG::Elements::Container < Prawn::SVG::Elements::Base
   def parse
     state.disable_drawing = true if name == 'clipPath'
 
-    if %w(symbol defs clipPath).include?(name)
-      properties.display = 'none'
-      computed_properties.display = 'none'
-    end
+    set_display_none if name == 'symbol' && !state.inside_use
+    set_display_none if %w(defs clipPath).include?(name)
   end
 
   def container?
     true
   end
+
+  private
+
+  def set_display_none
+    properties.display = 'none'
+    computed_properties.display = 'none'
+  end
 end

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

@@ -35,7 +35,7 @@ class Prawn::SVG::Elements::DepthFirstBase < Prawn::SVG::Elements::Base
   def parse_child_elements
     return unless source
 
-    source.elements.each do |elem|
+    svg_child_elements.each do |elem|
       if element_class = Prawn::SVG::Elements::TAG_CLASS_MAPPING[elem.name.to_sym]
         child = element_class.new(@document, elem, @calls, state.dup)
         child.parse_step

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

@@ -4,7 +4,7 @@ class Prawn::SVG::Elements::Path < Prawn::SVG::Elements::Base
 
   INSIDE_SPACE_REGEXP = /[ \t\r\n,]*/
   OUTSIDE_SPACE_REGEXP = /[ \t\r\n]*/
-  INSIDE_REGEXP = /#{INSIDE_SPACE_REGEXP}([+-]?(?:[0-9]+(?:\.[0-9]*)?|\.[0-9]+)(?:(?<=[0-9])e[+-]?[0-9]+)?)/
+  INSIDE_REGEXP = /#{INSIDE_SPACE_REGEXP}([+-]?(?:[0-9]+(?:\.[0-9]*)?|\.[0-9]+)(?:(?<=[0-9])[eE][+-]?[0-9]+)?)/
   VALUES_REGEXP = /^#{INSIDE_REGEXP}/
   COMMAND_REGEXP = /^#{OUTSIDE_SPACE_REGEXP}([A-Za-z])((?:#{INSIDE_REGEXP})*)#{OUTSIDE_SPACE_REGEXP}/
 

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

@@ -1,5 +1,12 @@
 class Prawn::SVG::Elements::Text < Prawn::SVG::Elements::DepthFirstBase
-  def parse
+  private
+
+  # This class doesn't represent an element in the SVG document; it's here
+  # to hold together text information.  Because of this, we overload the
+  # parse_step and apply_step methods, and bypass all the normal processing
+  # of the element, delegating it to our root text component.
+
+  def parse_step
     state.text = Prawn::SVG::Elements::TextComponent::PositionsList.new([], [], [], [], [], nil)
 
     @text_root = Prawn::SVG::Elements::TextComponent.new(document, source, nil, state.dup)
@@ -8,22 +15,16 @@ class Prawn::SVG::Elements::Text < Prawn::SVG::Elements::DepthFirstBase
     reintroduce_trailing_and_leading_whitespace
   end
 
-  def apply
+  def apply_step(calls)
+    @base_calls = @calls = calls
     add_call_and_enter "text_group"
-    @text_root.apply_step(calls)
+    @text_root.apply_step(@calls)
   end
 
-  private
-
   def drawable?
     false
   end
 
-  def apply_calls_from_standard_attributes
-    # overridden because we want the attributes to be applied in the TextComponent root,
-    # which is a duplicate of this element.
-  end
-
   def reintroduce_trailing_and_leading_whitespace
     printables = []
     built_printable_queue(printables, @text_root)

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

@@ -13,7 +13,7 @@ class Prawn::SVG::Elements::TextComponent < Prawn::SVG::Elements::DepthFirstBase
 
     @commands = []
 
-    text_children.each do |child|
+    svg_text_children.each do |child|
       if child.node_type == :text
         append_text(child)
       else
@@ -148,6 +148,12 @@ class Prawn::SVG::Elements::TextComponent < Prawn::SVG::Elements::DepthFirstBase
     end
   end
 
+  def svg_text_children
+    text_children.select do |child|
+      child.node_type == :text || child.namespace == SVG_NAMESPACE || child.namespace == ''
+    end
+  end
+
   def text_children
     if name == 'tref'
       reference = find_referenced_element

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

@@ -1,4 +1,6 @@
 class Prawn::SVG::Elements::Use < Prawn::SVG::Elements::Base
+  attr_reader :referenced_element
+
   def parse
     require_attributes 'xlink:href'
 
@@ -9,21 +11,34 @@ class Prawn::SVG::Elements::Use < Prawn::SVG::Elements::Base
     end
 
     id = href[1..-1]
-    @definition_element = @document.elements_by_id[id]
+    @referenced_element = @document.elements_by_id[id]
 
-    if @definition_element.nil?
+    if referenced_element.nil?
       raise SkipElementError, "no tag with ID '#{id}' was found, referenced by use tag"
     end
 
+    state.inside_use = true
+
     @x = attributes['x']
     @y = attributes['y']
   end
 
+  def container?
+    true
+  end
+
   def apply
     if @x || @y
       add_call_and_enter "translate", x_pixels(@x || 0), -y_pixels(@y || 0)
     end
+  end
+
+  def process_child_elements
+    add_call "save"
+
+    child = referenced_element.class.new(referenced_element.document, referenced_element.source, calls, state.dup)
+    child.process
 
-    add_calls_from_element @definition_element
+    add_call "restore"
   end
 end

data/lib/prawn/svg/state.rb

@@ -3,7 +3,8 @@ class Prawn::SVG::State
     :text, :preserve_space,
     :fill_opacity, :stroke_opacity, :stroke_width,
     :computed_properties,
-    :viewport_sizing
+    :viewport_sizing,
+    :inside_use
 
   def initialize
     @stroke_width = 1

data/lib/prawn/svg/version.rb

@@ -1,5 +1,5 @@
 module Prawn
   module SVG
-    VERSION = '0.25.2'
+    VERSION = '0.26.0'
   end
 end

data/spec/prawn/svg/calculators/pixels_spec.rb

@@ -4,6 +4,10 @@ describe Prawn::SVG::Calculators::Pixels do
   class TestPixelsCalculator
     include Prawn::SVG::Calculators::Pixels
 
+    def computed_properties
+      Struct.new(:numerical_font_size).new(16)
+    end
+
     [:x, :y, :pixels, :x_pixels, :y_pixels].each { |method| public method }
   end
 
@@ -31,13 +35,14 @@ describe Prawn::SVG::Calculators::Pixels do
       expect(subject.pixels(32.0)).to eq 32.0
       expect(subject.pixels("32")).to eq 32.0
       expect(subject.pixels("32unknown")).to eq 32.0
+      expect(subject.pixels("32px")).to eq 32.0
       expect(subject.pixels("32pt")).to eq 32.0
       expect(subject.pixels("32in")).to eq 32.0 * 72
-      expect(subject.pixels("32ft")).to eq 32.0 * 72 * 12
       expect(subject.pixels("32pc")).to eq 32.0 * 15
+      expect(subject.pixels("4em")).to eq 4 * 16
+      expect(subject.pixels("4ex")).to eq 4 * 8
       expect(subject.pixels("32mm")).to be_within(0.0001).of(32 * 72 * 0.0393700787)
       expect(subject.pixels("32cm")).to be_within(0.0001).of(32 * 72 * 0.393700787)
-      expect(subject.pixels("32m")).to be_within(0.0001).of(32 * 72 * 39.3700787)
       expect(subject.pixels("50%")).to eq 250
     end
   end

data/spec/prawn/svg/document_spec.rb

@@ -25,4 +25,37 @@ describe Prawn::SVG::Document do
       end
     end
   end
+
+  describe "#parse_style_elements" do
+    let(:svg) do
+      <<-SVG
+<svg>
+  <some-tag>
+    <style>a
+  before&gt;
+  x <![CDATA[ y
+  inside <>&gt;
+  k ]]> j
+  after
+z</style>
+  </some-tag>
+
+  <other-tag>
+    <more-tag>
+      <style>hello</style>
+    </more-tag>
+  </other-tag>
+</svg>
+      SVG
+    end
+
+    it "scans the document for style tags and adds the style information to the css parser" do
+      css_parser = instance_double(CssParser::Parser)
+
+      expect(css_parser).to receive(:add_block!).with("a\n  before>\n  x  y\n  inside <>&gt;\n  k  j\n  after\nz")
+      expect(css_parser).to receive(:add_block!).with("hello")
+
+      Prawn::SVG::Document.new(svg, bounds, options, css_parser: css_parser)
+    end
+  end
 end

data/spec/prawn/svg/elements/path_spec.rb

@@ -2,7 +2,8 @@ require 'spec_helper'
 
 describe Prawn::SVG::Elements::Path do
   let(:source) { double(name: "path", attributes: {}) }
-  let(:path) { Prawn::SVG::Elements::Path.new(nil, source, [], {}) }
+  let(:state) { Prawn::SVG::State.new }
+  let(:path) { Prawn::SVG::Elements::Path.new(nil, source, [], state) }
 
   before do
     allow(path).to receive(:attributes).and_return("d" => d)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-svg
 version: !ruby/object:Gem::Version
-  version: 0.25.2
+  version: 0.26.0
 platform: ruby
 authors:
 - Roger Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-10 00:00:00.000000000 Z
+date: 2016-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -118,7 +118,6 @@ files:
 - lib/prawn/svg/elements/polyline.rb
 - lib/prawn/svg/elements/rect.rb
 - lib/prawn/svg/elements/root.rb
-- lib/prawn/svg/elements/style.rb
 - lib/prawn/svg/elements/text.rb
 - lib/prawn/svg/elements/text_component.rb
 - lib/prawn/svg/elements/use.rb
@@ -152,7 +151,6 @@ files:
 - spec/prawn/svg/elements/path_spec.rb
 - spec/prawn/svg/elements/polygon_spec.rb
 - spec/prawn/svg/elements/polyline_spec.rb
-- spec/prawn/svg/elements/style_spec.rb
 - spec/prawn/svg/elements/text_spec.rb
 - spec/prawn/svg/font_registry_spec.rb
 - spec/prawn/svg/font_spec.rb

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

@@ -1,10 +0,0 @@
-class Prawn::SVG::Elements::Style < Prawn::SVG::Elements::Base
-  def parse
-    if @document.css_parser
-      data = source.texts.map(&:value).join
-      @document.css_parser.add_block!(data)
-    end
-
-    raise SkipElementQuietly
-  end
-end

data/spec/prawn/svg/elements/style_spec.rb

@@ -1,23 +0,0 @@
-require 'spec_helper'
-
-describe Prawn::SVG::Elements::Style do
-  let(:svg) do
-    <<-SVG
-<style>a
-  before&gt;
-  x <![CDATA[ y
-  inside <>&gt;
-  k ]]> j
-  after
-z</style>
-    SVG
-  end
-
-  let(:document) { Prawn::SVG::Document.new(svg, [800, 600], {}) }
-  let(:element) { Prawn::SVG::Elements::Style.new(document, document.root, [], Prawn::SVG::State.new) }
-
-  it "correctly collects the style information in a <style> tag" do
-    expect(document.css_parser).to receive(:add_block!).with("a\n  before>\n  x  y\n  inside <>&gt;\n  k  j\n  after\nz")
-    element.process
-  end
-end