prawn-svg 0.27.1 → 0.31.0

data/prawn-svg.gemspec

@@ -1,12 +1,11 @@
 # -*- 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"
   gem.description = "This gem allows you to render SVG directly into a PDF using the 'prawn' gem.  Since PDF is vector-based, you'll get nice scaled graphics if you use SVG instead of an image."
-  gem.has_rdoc = false
   gem.author = "Roger Nesbitt"
   gem.email = "roger@seriousorange.com"
   gem.homepage = "http://github.com/mogest/prawn-svg"
@@ -21,7 +20,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"
+  gem.add_development_dependency "rake", "~> 13.0"
 end

data/spec/prawn/svg/attributes/opacity_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe Prawn::SVG::Attributes::Opacity do
+  class OpacityTestElement
+    include Prawn::SVG::Attributes::Opacity
+
+    attr_accessor :properties, :state
+
+    def initialize
+      @properties = ::Prawn::SVG::Properties.new
+      @state = ::Prawn::SVG::State.new
+    end
+
+    def clamp(value, min_value, max_value)
+      [[value, min_value].max, max_value].min
+    end
+  end
+
+  let(:element) { OpacityTestElement.new }
+
+  describe "#parse_opacity_attributes_and_call" do
+    subject { element.parse_opacity_attributes_and_call }
+
+    context "with no opacity specified" do
+      it "does nothing" do
+        expect(element).not_to receive(:add_call_and_enter)
+        subject
+      end
+    end
+
+    context "with opacity" do
+      it "sets fill and stroke opacity" do
+        element.properties.opacity = '0.4'
+
+        expect(element).to receive(:add_call_and_enter).with('transparent', 0.4, 0.4)
+        subject
+
+        expect(element.state.fill_opacity).to eq 0.4
+        expect(element.state.stroke_opacity).to eq 0.4
+      end
+    end
+
+    context "with just fill opacity" do
+      it "sets fill opacity and sets stroke opacity to 1" do
+        element.properties.fill_opacity = '0.4'
+
+        expect(element).to receive(:add_call_and_enter).with('transparent', 0.4, 1)
+        subject
+
+        expect(element.state.fill_opacity).to eq 0.4
+        expect(element.state.stroke_opacity).to eq 1
+      end
+    end
+
+    context "with an existing fill/stroke opacity" do
+      it "multiplies the new opacity by the old" do
+        element.state.fill_opacity = 0.5
+        element.state.stroke_opacity = 0.8
+
+        element.properties.fill_opacity = '0.4'
+        element.properties.stroke_opacity = '0.5'
+
+        expect(element).to receive(:add_call_and_enter).with('transparent', 0.2, 0.4)
+        subject
+
+        expect(element.state.fill_opacity).to eq 0.2
+        expect(element.state.stroke_opacity).to eq 0.4
+      end
+    end
+
+    context "with stroke, fill, and opacity all specified" do
+      it "choses the lower of them" do
+        element.properties.fill_opacity = '0.4'
+        element.properties.stroke_opacity = '0.6'
+        element.properties.opacity = '0.5'
+
+        expect(element).to receive(:add_call_and_enter).with('transparent', 0.4, 0.5)
+        subject
+
+        expect(element.state.fill_opacity).to eq 0.4
+        expect(element.state.stroke_opacity).to eq 0.5
+      end
+    end
+  end
+end

data/spec/prawn/svg/attributes/transform_spec.rb

@@ -14,43 +14,38 @@ describe Prawn::SVG::Attributes::Transform do
 
   let(:element) { TransformTestElement.new }
 
-  describe "#parse_transform_attribute_and_call" do
-    subject { element.send :parse_transform_attribute_and_call }
-
-    describe "translate" do
-      it "handles a missing y argument" do
-        expect(element).to receive(:add_call_and_enter).with('translate', -5.5, 0)
-        expect(element).to receive(:x_pixels).with(-5.5).and_return(-5.5)
-        expect(element).to receive(:y_pixels).with(0.0).and_return(0.0)
-
-        element.attributes['transform'] = 'translate(-5.5)'
-        subject
-      end
+  subject { element.send :parse_transform_attribute_and_call }
+
+  context "when a non-identity matrix is requested" do
+    let(:transform) { 'translate(-5.5)' }
+
+    it "passes the transform and executes the returned matrix" do
+      expect(element).to receive(:parse_transform_attribute).with(transform).and_return([1, 2, 3, 4, 5, 6])
+      expect(element).to receive(:add_call_and_enter).with('transformation_matrix', 1, 2, 3, 4, 5, 6)
+
+      element.attributes['transform'] = transform
+      subject
+    end
+  end
+
+  context "when an identity matrix is requested" do
+    let(:transform) { 'translate(0)' }
+
+    it "does not execute any commands" do
+      expect(element).to receive(:parse_transform_attribute).with(transform).and_return([1, 0, 0, 1, 0, 0])
+      expect(element).not_to receive(:add_call_and_enter)
+
+      element.attributes['transform'] = transform
+      subject
     end
+  end
+
+  context "when transform is blank" do
+    it "does nothing" do
+      expect(element).not_to receive(:parse_transform_attribute)
+      expect(element).not_to receive(:add_call_and_enter)
 
-    describe "rotate" do
-      it "handles a single angle argument" do
-        expect(element).to receive(:add_call_and_enter).with('rotate', -5.5, :origin => [0, 0])
-        expect(element).to receive(:y).with('0').and_return(0)
-
-        element.attributes['transform'] = 'rotate(5.5)'
-        subject
-      end
-
-      it "handles three arguments" do
-        expect(element).to receive(:add_call_and_enter).with('rotate', -5.5, :origin => [1.0, 2.0])
-        expect(element).to receive(:x).with(1.0).and_return(1.0)
-        expect(element).to receive(:y).with(2.0).and_return(2.0)
-
-        element.attributes['transform'] = 'rotate(5.5 1 2)'
-        subject
-      end
-
-      it "does nothing and warns if two arguments" do
-        expect(element).to receive(:warnings).and_return([])
-        element.attributes['transform'] = 'rotate(5.5 1)'
-        subject
-      end
+      subject
     end
   end
 end

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

@@ -31,8 +31,8 @@ describe Prawn::SVG::Calculators::DocumentSizing do
   describe "#calculate" do
     it "calculates the document sizing measurements for a given set of inputs" do
       sizing.calculate
-      expect(sizing.x_offset).to eq -75 / 0.25
-      expect(sizing.y_offset).to eq -30
+      expect(sizing.x_offset).to eq(-75 / 0.25)
+      expect(sizing.y_offset).to eq(-30)
       expect(sizing.x_scale).to eq 0.25
       expect(sizing.y_scale).to eq 0.25
       expect(sizing.viewport_width).to eq 300
@@ -74,12 +74,12 @@ describe Prawn::SVG::Calculators::DocumentSizing do
       context "when a viewBox is specified" do
         let(:attributes) { {"viewBox" => "0 0 100 200"} }
 
-        it "defaults to 100% width and height" do
+        it "defaults to 100% width and uses the viewbox ratio for height" do
           sizing.calculate
           expect(sizing.viewport_width).to eq 100
           expect(sizing.viewport_height).to eq 200
           expect(sizing.output_width).to eq 1200
-          expect(sizing.output_height).to eq 800
+          expect(sizing.output_height).to eq 2400
         end
       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,142 @@
+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; }
+          rect:first-child:last-child { fill: #441234; }
+
+          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="100" />
+
+          <g id="circles">
+            <circle width="7" />
+            <circle width="8" />
+            <circle width="9" />
+          </g>
+        </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)
+
+      expected = [
+        [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]]],
+      ]
+
+      #
+      # Under ruby < 2.6, a bug in REXML causes the /following-sibling selector to
+      # only pick the first matching sibling.  This means the + CSS combinator behaves
+      # incorrectly in the following example:
+      #
+      # <a>
+      #   <b a="1" />
+      #   <b a="2" />
+      #   <b a="3" />
+      # </a>
+      #
+      # The css selector `a b + b` will only pick the second <b>, whereas it should
+      # pick both the second and third <b> elements.
+      #
+      if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.6.0')
+        expected << [5, [["fill", "#ff0000", false], ["fill", "#330000", false], ["fill", "#330000", false], ["fill", "#00ff00", false]]]
+      else
+        expected << [5, [["fill", "#ff0000", false], ["fill", "#330000", false], ["fill", "#330000", false], ["fill", "#440000", false], ["fill", "#00ff00", false]]]
+      end
+
+      expected.concat [
+        [6, [["fill", "#ff0000", false], ["fill", "#441234", 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]]],
+      ]
+
+      expect(width_and_styles).to eq(expected)
+    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

@@ -25,14 +25,14 @@ describe Prawn::SVG::Elements::Base do
     describe "applying calls from the standard attributes" do
       let(:svg) do
         <<-SVG
-          <something transform="rotate(90)" fill-opacity="0.5" fill="red" stroke="blue" stroke-width="5"/>
+          <something transform="scale(2)" fill-opacity="0.5" fill="red" stroke="blue" stroke-width="5"/>
         SVG
       end
 
       it "appends the relevant calls" do
         element.process
         expect(element.base_calls).to eq [
-          ["rotate", [-90.0, {origin: [0, 600.0]}], [
+          ["transformation_matrix", [2, 0, 0, 2, 0, 0], [
             ["transparent", [0.5, 1], [
               ["fill_color", ["ff0000"], []],
               ["stroke_color", ["0000ff"], []],
@@ -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