prawn-svg 0.27.1 → 0.28.0

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

@@ -0,0 +1,12 @@
+class Prawn::SVG::Elements::ClipPath < Prawn::SVG::Elements::Base
+  def parse
+    state.inside_clip_path = true
+    properties.display = 'none'
+    computed_properties.display = 'none'
+  end
+
+  def container?
+    true
+  end
+end
+

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

@@ -1,9 +1,7 @@
 class Prawn::SVG::Elements::Container < Prawn::SVG::Elements::Base
   def parse
-    state.disable_drawing = true if name == 'clipPath'
-
     set_display_none if name == 'symbol' && !state.inside_use
-    set_display_none if %w(defs clipPath).include?(name)
+    set_display_none if name == 'defs'
   end
 
   def container?

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

@@ -7,7 +7,7 @@ class Prawn::SVG::Elements::Text < Prawn::SVG::Elements::DepthFirstBase
   # of the element, delegating it to our root text component.
 
   def parse_step
-    state.text = Prawn::SVG::Elements::TextComponent::PositionsList.new([], [], [], [], [], nil)
+    state.text = Prawn::SVG::Elements::TextComponent::TextState.new
 
     @text_root = Prawn::SVG::Elements::TextComponent.new(document, source, nil, state.dup)
     @text_root.parse_step

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

@@ -2,14 +2,20 @@ class Prawn::SVG::Elements::TextComponent < Prawn::SVG::Elements::DepthFirstBase
   attr_reader :commands
 
   Printable = Struct.new(:element, :text, :leading_space?, :trailing_space?)
-  PositionsList = Struct.new(:x, :y, :dx, :dy, :rotation, :parent)
+  TextState = Struct.new(:parent, :x, :y, :dx, :dy, :rotation, :spacing, :mode)
 
   def parse
-    state.text.x = attributes['x'].split(COMMA_WSP_REGEXP).collect {|n| x(n)} if attributes['x']
-    state.text.y = attributes['y'].split(COMMA_WSP_REGEXP).collect {|n| y(n)} if attributes['y']
-    state.text.dx = attributes['dx'].split(COMMA_WSP_REGEXP).collect {|n| x_pixels(n)} if attributes['dx']
-    state.text.dy = attributes['dy'].split(COMMA_WSP_REGEXP).collect {|n| y_pixels(n)} if attributes['dy']
-    state.text.rotation = attributes['rotate'].split(COMMA_WSP_REGEXP).collect(&:to_f) if attributes['rotate']
+    if state.inside_clip_path
+      raise SkipElementError, "<text> elements are not supported in clip paths"
+    end
+
+    state.text.x = (attributes['x'] || "").split(COMMA_WSP_REGEXP).collect { |n| x(n) }
+    state.text.y = (attributes['y'] || "").split(COMMA_WSP_REGEXP).collect { |n| y(n) }
+    state.text.dx = (attributes['dx'] || "").split(COMMA_WSP_REGEXP).collect { |n| x_pixels(n) }
+    state.text.dy = (attributes['dy'] || "").split(COMMA_WSP_REGEXP).collect { |n| y_pixels(n) }
+    state.text.rotation = (attributes['rotate'] || "").split(COMMA_WSP_REGEXP).collect(&:to_f)
+    state.text.spacing = calculate_character_spacing
+    state.text.mode = calculate_text_rendering_mode
 
     @commands = []
 
@@ -41,10 +47,13 @@ class Prawn::SVG::Elements::TextComponent < Prawn::SVG::Elements::DepthFirstBase
       text_anchor: computed_properties.text_anchor
     }
 
-    spacing = computed_properties.letter_spacing
-    spacing = spacing == 'normal' ? 0 : pixels(spacing)
-
-    add_call_and_enter 'character_spacing', spacing
+    if state.text.parent
+      add_call_and_enter 'character_spacing', state.text.spacing unless state.text.spacing == state.text.parent.spacing
+      add_call_and_enter 'text_rendering_mode', state.text.mode unless state.text.mode == state.text.parent.mode
+    else
+      add_call_and_enter 'character_spacing', state.text.spacing unless state.text.spacing == 0
+      add_call_and_enter 'text_rendering_mode', state.text.mode unless state.text.mode == :fill
+    end
 
     @commands.each do |command|
       case command
@@ -59,8 +68,8 @@ class Prawn::SVG::Elements::TextComponent < Prawn::SVG::Elements::DepthFirstBase
       end
     end
 
-    # It's possible there was no text to render.  In that case, add a 'noop' so
-    # character_spacing doesn't blow up when it finds it doesn't have a block to execute.
+    # It's possible there was no text to render.  In that case, add a 'noop' so character_spacing/text_rendering_mode
+    # don't blow up when they find they don't have a block to execute.
     add_call 'noop' if calls.empty?
   end
 
@@ -81,7 +90,7 @@ class Prawn::SVG::Elements::TextComponent < Prawn::SVG::Elements::DepthFirstBase
 
   def append_child(child)
     new_state = state.dup
-    new_state.text = PositionsList.new([], [], [], [], [], state.text)
+    new_state.text = TextState.new(state.text)
 
     element = self.class.new(document, child, calls, new_state)
     @commands << element
@@ -189,4 +198,28 @@ class Prawn::SVG::Elements::TextComponent < Prawn::SVG::Elements::DepthFirstBase
   def apply_font(font)
     add_call 'font', font.name, style: font.subfamily
   end
+
+  def calculate_text_rendering_mode
+    fill = computed_properties.fill != 'none'
+    stroke = computed_properties.stroke != 'none'
+
+    if fill && stroke
+      :fill_stroke
+    elsif fill
+      :fill
+    elsif stroke
+      :stroke
+    else
+      :invisible
+    end
+  end
+
+  def calculate_character_spacing
+    spacing = computed_properties.letter_spacing
+    spacing == 'normal' ? 0 : pixels(spacing)
+  end
+
+  # overridden, we don't want to call fill/stroke as draw_text does this for us
+  def apply_drawing_call
+  end
 end

data/lib/prawn/svg/font_registry.rb

@@ -24,7 +24,7 @@ class Prawn::SVG::FontRegistry
   end
 
   def load(family, weight = nil, style = nil)
-    Prawn::SVG::CSS.parse_font_family_string(family).detect do |name|
+    Prawn::SVG::CSS::FontFamilyParser.parse(family).detect do |name|
       name = name.gsub(/\s{2,}/, ' ').downcase
 
       font = Prawn::SVG::Font.new(name, weight, style, font_registry: self)
@@ -37,8 +37,9 @@ class Prawn::SVG::FontRegistry
   def merge_external_fonts
     if @font_case_mapping.nil?
       self.class.load_external_fonts unless self.class.external_font_families
-      @font_families.merge!(self.class.external_font_families)
-
+      @font_families.merge!(self.class.external_font_families) do |key, v1, v2|
+       v1
+      end
       @font_case_mapping = @font_families.keys.each.with_object({}) do |key, result|
         result[key.downcase] = key
       end

data/lib/prawn/svg/interface.rb

@@ -186,7 +186,9 @@ module Prawn
           # prawn (as at 2.0.1 anyway) uses 'b' for its fill_and_stroke.  'b' is 'h' (closepath) + 'B', and we
           # never want closepath to be automatically run as it stuffs up many drawing operations, such as dashes
           # and line caps, and makes paths close that we didn't ask to be closed when fill is specified.
-          prawn.add_content 'B'
+          even_odd = arguments[0].is_a?(Hash) && arguments[0][:fill_rule] == :even_odd
+          content  = even_odd ? 'B*' : 'B'
+          prawn.add_content content
 
         when 'noop'
           yield

data/lib/prawn/svg/properties.rb

@@ -18,6 +18,7 @@ class Prawn::SVG::Properties
     "display"          => Config.new("inline", false, %w(inherit inline none), true),
     "fill"             => Config.new("black", true, %w(inherit none currentColor)),
     "fill-opacity"     => Config.new("1", true),
+    "fill-rule"        => Config.new("nonzero", true, %w(inherit nonzero evenodd)),
     "font-family"      => Config.new("sans-serif", true),
     "font-size"        => Config.new("medium", true, %w(inherit xx-small x-small small medium large x-large xx-large larger smaller)),
     "font-style"       => Config.new("normal", true, %w(inherit normal italic oblique), true),

data/lib/prawn/svg/state.rb

@@ -1,10 +1,9 @@
 class Prawn::SVG::State
-  attr_accessor :disable_drawing,
-    :text, :preserve_space,
+  attr_accessor :text, :preserve_space,
     :fill_opacity, :stroke_opacity, :stroke_width,
     :computed_properties,
     :viewport_sizing,
-    :inside_use
+    :inside_use, :inside_clip_path
 
   def initialize
     @stroke_width = 1
@@ -16,4 +15,8 @@ class Prawn::SVG::State
   def initialize_dup(other)
     @computed_properties = @computed_properties.dup
   end
+
+  def disable_drawing
+    inside_clip_path
+  end
 end

data/lib/prawn/svg/version.rb

@@ -1,5 +1,5 @@
 module Prawn
   module SVG
-    VERSION = '0.27.1'
+    VERSION = '0.28.0'
   end
 end

data/prawn-svg.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 require File.expand_path('../lib/prawn/svg/version', __FILE__)
 
-spec = Gem::Specification.new do |gem|
+Gem::Specification.new do |gem|
   gem.name = 'prawn-svg'
   gem.version = Prawn::SVG::VERSION
   gem.summary = "SVG renderer for Prawn PDF library"
@@ -21,7 +21,7 @@ spec = Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 2.1.0'
 
   gem.add_runtime_dependency "prawn", ">= 0.11.1", "< 3"
-  gem.add_runtime_dependency "css_parser", "~> 1.3"
+  gem.add_runtime_dependency "css_parser", "~> 1.6"
   gem.add_development_dependency "rspec", "~> 3.0"
   gem.add_development_dependency "rake", "~> 10.1"
 end

data/spec/prawn/svg/{css_spec.rb → css/font_family_parser_spec.rb}

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
-RSpec.describe Prawn::SVG::CSS do
-  describe "#parse_font_family_string" do
+RSpec.describe Prawn::SVG::CSS::FontFamilyParser do
+  describe "#parse" do
     it "correctly handles quotes and escaping" do
       tests = {
         "" => [],
@@ -17,7 +17,7 @@ RSpec.describe Prawn::SVG::CSS do
       }
 
       tests.each do |string, expected|
-        expect(Prawn::SVG::CSS.parse_font_family_string(string)).to eq expected
+        expect(Prawn::SVG::CSS::FontFamilyParser.parse(string)).to eq expected
       end
     end
   end

data/spec/prawn/svg/css/selector_parser_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.describe Prawn::SVG::CSS::SelectorParser do
+  describe "::parse" do
+    it "parses a simple selector" do
+      expect(described_class.parse("div")).to eq [{name: "div"}]
+      expect(described_class.parse(".c1")).to eq [{class: ["c1"]}]
+    end
+
+    it "parses a complex selector" do
+      result = described_class.parse("div#count .c1.c2 > span.large + div~.other:first-child *:nth-child(3)")
+      expect(result).to eq [
+        {name: "div", id: ["count"]},
+        {combinator: :descendant, class: ["c1", "c2"]},
+        {combinator: :child, name: "span", class: ["large"]},
+        {combinator: :adjacent, name: "div"},
+        {combinator: :siblings, class: ["other"], pseudo_class: ["first-child"]},
+        {combinator: :descendant, name: "*", pseudo_class: ["nth-child(3)"]},
+      ]
+    end
+
+    it "parses attributes" do
+      expect(described_class.parse("[abc]")).to eq [{attribute: [["abc", nil, nil]]}]
+      expect(described_class.parse("[abc=123]")).to eq [{attribute: [["abc", '=', '123']]}]
+      expect(described_class.parse("[abc^=123]")).to eq [{attribute: [["abc", '^=', '123']]}]
+      expect(described_class.parse("[ abc ^= 123 ]")).to eq [{attribute: [["abc", '^=', '123']]}]
+      expect(described_class.parse("[abc^='123']")).to eq [{attribute: [["abc", '^=', '123']]}]
+      expect(described_class.parse("[abc^= '123' ]")).to eq [{attribute: [["abc", '^=', '123']]}]
+      expect(described_class.parse("[abc^= '123\\'456' ]")).to eq [{attribute: [["abc", '^=', '123\'456']]}]
+      expect(described_class.parse('[abc^= "123\\"456" ]')).to eq [{attribute: [["abc", '^=', '123"456']]}]
+    end
+  end
+end

data/spec/prawn/svg/css/stylesheets_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+RSpec.describe Prawn::SVG::CSS::Stylesheets do
+  describe "typical usage" do
+    let(:svg) { <<-SVG }
+      <svg>
+        <style>
+          #inner rect { fill: #0000ff; }
+          #outer { fill: #220000; }
+          .hero > rect { fill: #00ff00; }
+          rect { fill: #ff0000; }
+          rect ~ rect { fill: #330000; }
+          rect + rect { fill: #440000; }
+
+          circle:first-child { fill: #550000; }
+          circle:nth-child(2) { fill: #660000; }
+          circle:last-child { fill: #770000; }
+
+          square[chocolate] { fill: #880000; }
+          square[abc=def] { fill: #990000; }
+          square[abc^=ghi] { fill: #aa0000; }
+          square[abc$=jkl] { fill: #bb0000; }
+          square[abc*=mno] { fill: #cc0000; }
+          square[abc~=pqr] { fill: #dd0000; }
+          square[abc|=stu] { fill: #ee0000; }
+        </style>
+
+        <rect width="1" height="1" />
+        <rect width="2" height="2" id="outer" />
+
+        <g class="hero large">
+          <rect width="3" height="3" />
+          <rect width="4" height="4" style="fill: #777777;" />
+          <rect width="5" height="5" />
+
+          <g id="inner">
+            <rect width="6" height="6" />
+          </g>
+
+          <circle width="7" />
+          <circle width="8" />
+          <circle width="9" />
+        </g>
+
+        <square width="10" chocolate="hi there" />
+        <square width="11" abc="def" />
+        <square width="12" abc="ghidef" />
+        <square width="13" abc="aghidefjkl" />
+        <square width="14" abc="agmnohidefjklx" />
+        <square width="15" abc="aeo cnj pqr" />
+        <square width="16" abc="eij-stu-asd" />
+      </svg>
+    SVG
+
+    it "associates styles with elements" do
+      result = Prawn::SVG::CSS::Stylesheets.new(CssParser::Parser.new, REXML::Document.new(svg)).load
+      width_and_styles = result.map { |k, v| [k.attributes["width"].to_i, v] }.sort_by(&:first)
+
+      expect(width_and_styles).to eq [
+        [1, [["fill", "#ff0000", false]]],
+        [2, [["fill", "#ff0000", false], ["fill", "#330000", false], ["fill", "#440000", false], ["fill", "#220000", false]]],
+        [3, [["fill", "#ff0000", false], ["fill", "#00ff00", false]]],
+        [4, [["fill", "#ff0000", false], ["fill", "#330000", false], ["fill", "#440000", false], ["fill", "#00ff00", false]]],
+        [5, [["fill", "#ff0000", false], ["fill", "#330000", false], ["fill", "#330000", false], ["fill", "#00ff00", false]]],
+        [6, [["fill", "#ff0000", false], ["fill", "#0000ff", false]]],
+        [7, [["fill", "#550000", false]]],
+        [8, [["fill", "#660000", false]]],
+        [9, [["fill", "#770000", false]]],
+        [10, [["fill", "#880000", false]]],
+        [11, [["fill", "#990000", false]]],
+        [12, [["fill", "#aa0000", false]]],
+        [13, [["fill", "#bb0000", false]]],
+        [14, [["fill", "#cc0000", false]]],
+        [15, [["fill", "#dd0000", false]]],
+        [16, [["fill", "#ee0000", false]]],
+      ]
+    end
+  end
+
+  describe "style tag parsing" 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")
+      allow(css_parser).to receive(:each_rule_set)
+
+      Prawn::SVG::CSS::Stylesheets.new(css_parser, REXML::Document.new(svg)).load
+    end
+  end
+end

data/spec/prawn/svg/document_spec.rb

@@ -25,37 +25,4 @@ 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/base_spec.rb

@@ -44,6 +44,36 @@ describe Prawn::SVG::Elements::Base do
       end
     end
 
+    describe "fills and strokes" do
+      before { element.process }
+      subject { element.base_calls.last }
+
+      context "with neither fill nor stroke" do
+        let(:svg) { '<rect style="fill: none;"></rect>' }
+        it        { is_expected.to eq ['end_path', [], []] }
+      end
+
+      context "with a fill only" do
+        let(:svg) { '<rect style="fill: black;"></rect>' }
+        it        { is_expected.to eq ['fill', [], []] }
+      end
+
+      context "with a stroke only" do
+        let(:svg) { '<rect style="fill: none; stroke: black;"></rect>' }
+        it        { is_expected.to eq ['stroke', [], []] }
+      end
+
+      context "with fill and stroke" do
+        let(:svg) { '<rect style="fill: black; stroke: black;"></rect>' }
+        it        { is_expected.to eq ['fill_and_stroke', [], []] }
+      end
+
+      context "with fill with evenodd fill rule" do
+        let(:svg) { '<rect style="fill: black; fill-rule: evenodd;"></rect>' }
+        it        { is_expected.to eq ['fill', [{fill_rule: :even_odd}], []] }
+      end
+    end
+
     it "appends calls to the parent element" do
       expect(element).to receive(:apply) do
         element.send :add_call, "test", "argument"
@@ -131,4 +161,30 @@ describe Prawn::SVG::Elements::Base do
       expect(element.computed_properties.fill).to eq 'none'
     end
   end
+
+  describe "stylesheets" do
+    let(:svg) { <<-SVG }
+      <svg>
+        <style>
+          .special rect { fill: green; }
+          rect { fill: red; }
+        </style>
+        <rect width="100" height="100"></rect>
+        <g class="special">
+          <rect width="100" height="100"></rect>
+          <rect width="100" height="100" style="fill: yellow;"></rect>
+        </g>
+      </svg>
+    SVG
+
+    it "applies stylesheet styling but style attributes take precedence" do
+      document = Prawn::SVG::Document.new(svg, [100, 100], {})
+      calls = []
+      element = Prawn::SVG::Elements::Root.new(document, document.root, calls)
+      element.process
+
+      fill_colors = calls.select { |cmd, _, _| cmd == 'fill_color' }.map { |_, args, _| args.first }
+      expect(fill_colors).to eq ['000000', 'ff0000', '008000', 'ffff00']
+    end
+  end
 end