prawn-svg 0.23.1 → 0.24.0

data/lib/prawn/svg/version.rb

@@ -1,5 +1,5 @@
 module Prawn
   module SVG
-    VERSION = '0.23.1'
+    VERSION = '0.24.0'
   end
 end

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

@@ -25,7 +25,7 @@ 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" font-family="Helvetica"/>
+          <something transform="rotate(90)" fill-opacity="0.5" fill="red" stroke="blue" stroke-width="5"/>
         SVG
       end
 
@@ -37,9 +37,7 @@ describe Prawn::SVG::Elements::Base do
               ["fill_color", ["ff0000"], []],
               ["stroke_color", ["0000ff"], []],
               ["line_width", [5.0], []],
-              ["font", ["Helvetica", {:style=>:normal}], [
-                ["fill_and_stroke", [], []]
-              ]]
+              ["fill_and_stroke", [], []]
             ]]
           ]]
         ]
@@ -70,59 +68,47 @@ describe Prawn::SVG::Elements::Base do
     end
   end
 
-  describe "#parse_fill_and_stroke_attributes_and_call" do
+  describe "#apply_colors" do
     before do
-      element.send(:combine_attributes_and_style_declarations)
+      element.send(:extract_attributes_and_properties)
     end
 
-    subject { element.send :parse_fill_and_stroke_attributes_and_call }
+    subject { element.send :apply_colors }
 
     it "doesn't change anything if no fill attribute provided" do
+      expect(element).to_not receive(:add_call)
       subject
-      expect(element.state.fill).to be true
-
-      element.state.fill = false
-      subject
-      expect(element.state.fill).to be false
     end
 
     it "doesn't change anything if 'inherit' fill attribute provided" do
-      element.attributes['fill'] = 'inherit'
-      subject
-      expect(element.state.fill).to be true
-
-      element.state.fill = false
+      element.properties.fill = 'inherit'
+      expect(element).to_not receive(:add_call)
       subject
-      expect(element.state.fill).to be false
     end
 
-    it "turns off filling if 'none' fill attribute provided" do
-      element.attributes['fill'] = 'none'
+    it "doesn't change anything if 'none' fill attribute provided" do
+      element.properties.fill = 'none'
+      expect(element).to_not receive(:add_call)
       subject
-      expect(element.state.fill).to be false
     end
 
     it "uses the fill attribute's color" do
       expect(element).to receive(:add_call).with('fill_color', 'ff0000')
-      element.attributes['fill'] = 'red'
+      element.properties.fill = 'red'
       subject
-      expect(element.state.fill).to be true
     end
 
     it "uses black if the fill attribute's color is unparseable" do
       expect(element).to receive(:add_call).with('fill_color', '000000')
-      element.attributes['fill'] = 'blarble'
+      element.properties.fill = 'blarble'
       subject
-      expect(element.state.fill).to be true
     end
 
     it "uses the color attribute if 'currentColor' fill attribute provided" do
       expect(element).to receive(:add_call).with('fill_color', 'ff0000')
-      element.attributes['fill'] = 'currentColor'
-      element.attributes['color'] = 'red'
-      element.send :parse_color_attribute
+      element.properties.fill = 'currentColor'
+      element.state.computed_properties.color = 'red'
       subject
-      expect(element.state.fill).to be true
     end
 
     context "with a color attribute defined on a parent element" do
@@ -138,10 +124,11 @@ describe Prawn::SVG::Elements::Base do
       end
     end
 
-    it "turns off filling if UnresolvableURLWithNoFallbackError is raised" do
-      element.attributes['fill'] = 'url()'
+    it "computes to 'none' if UnresolvableURLWithNoFallbackError is raised" do
+      expect(element).to_not receive(:add_call)
+      element.properties.fill = 'url()'
       subject
-      expect(element.state.fill).to be false
+      expect(element.computed_properties.fill).to eq 'none'
     end
   end
 end

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

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+RSpec.describe Prawn::SVG::Elements::Line do
+  let(:document) { Prawn::SVG::Document.new(svg, [800, 600], {width: 800, height: 600}) }
+
+  subject do
+    Prawn::SVG::Elements::Line.new(document, document.root, [], Prawn::SVG::State.new)
+  end
+
+  context "with attributes specified" do
+    let(:svg) { '<line x1="5" y1="10" x2="15" y2="20" />' }
+
+    it "renders the line" do
+      subject.process
+      expect(subject.base_calls).to eq [
+        ["fill", [], [
+          ["move_to", [[5.0, 590.0]], []],
+          ["line_to", [[15.0, 580.0]], []]]
+        ]
+      ]
+    end
+  end
+
+  context "with no attributes specified" do
+    let(:svg) { '<line />' }
+
+    it "draws a line from 0,0 to 0,0" do
+      subject.process
+      expect(subject.base_calls).to eq [
+        ["fill", [], [
+          ["move_to", [[0, 600]], []],
+          ["line_to", [[0, 600]], []]]
+        ]
+      ]
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+RSpec.describe Prawn::SVG::Elements::Marker do
+  let(:svg) do
+    <<-SVG
+      <svg>
+        <marker id="Triangle"
+          viewBox="0 0 10 10" refX="0" refY="5"
+          markerUnits="strokeWidth"
+          markerWidth="4" markerHeight="3"
+          orient="auto">
+          <path d="M 0 0 L 10 5 L 0 10 z" />
+        </marker>
+
+        <line x2="10" y2="10" stroke-width="100" />
+      </svg>
+    SVG
+  end
+
+  let(:document) { Prawn::SVG::Document.new(svg, [800, 600], {width: 800, height: 600}) }
+  let(:state) { Prawn::SVG::State.new }
+
+  let(:line_element) do
+    Prawn::SVG::Elements::Line.new(document, document.root.elements[2], [], state)
+  end
+
+  subject do
+    Prawn::SVG::Elements::Marker.new(document, document.root.elements[1], [], state)
+  end
+
+  describe "#parse" do
+    it "forces display none" do
+      subject.parse
+      expect(subject.properties.display).to eq 'none'
+    end
+  end
+
+  describe "#apply_marker" do
+    it "adds the line and its marker to the call stack" do
+      subject.process
+      line_element.process
+
+      # We didn't use a marker-* attribute on the <line> tag, that's
+      # why the apply_marker method wasn't automatically called as part
+      # of the line_element.process call above.
+
+      subject.apply_marker(line_element, point: [10, 10], angle: 45)
+
+      # This example follows the example in the SVG 1.1 documentation
+      # in section 11.6.3.
+
+      expect(line_element.base_calls).to eq [
+        ["line_width", [100.0], []],
+        ["fill", [], [
+            ["move_to", [[0.0, 600.0]], []],
+            ["line_to", [[10.0, 590.0]], []]
+          ]
+        ],
+        ["save", [], []],
+        ["transformation_matrix", [1, 0, 0, 1, 10, -10], []],
+        ["rotate", [-45, {origin: [0, 600.0]}], [
+            ["transformation_matrix", [100.0, 0, 0, 100.0, 0, 0], []],
+            ["transformation_matrix", [1, 0, 0, 1, -0.0, 1.5], []],
+            ["rectangle", [[-0.5, 600.0], 4.0, 3.0], []],
+            ["clip", [], []],
+            ["transformation_matrix", [0.3, 0, 0, 0.3, 0, 0], []],
+            ["transparent", [1.0, 1.0], [
+                ["fill_color", ["000000"], []],
+                ["line_width", [100.0], []],
+                ["cap_style", [:butt], []],
+                ["undash", [], []],
+                ["save", [], []],
+                ["fill", [], [
+                    ["join_style", [:bevel], []],
+                    ["move_to", [[0.0, 600.0]], []],
+                    ["line_to", [[10.0, 595.0]], []],
+                    ["line_to", [[0.0, 590.0]], []],
+                    ["close_path", [], []]
+                  ]
+                ],
+                ["restore", [], []],
+              ]
+            ]
+          ]
+        ],
+        ["restore", [], []]
+      ]
+    end
+  end
+end

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

@@ -14,7 +14,7 @@ describe Prawn::SVG::Elements::Path do
 
       it "correctly parses" do
         calls = []
-        path.stub(:run_path_command) {|*args| calls << args}
+        path.stub(:parse_path_command) {|*args| calls << args}
         path.parse
 
         calls.should == [
@@ -40,7 +40,7 @@ describe Prawn::SVG::Elements::Path do
           ["m", [5,6,7,8]],
           ["l", [7,8]]
         ].each do |args|
-          path.should_receive(:run_path_command).with(*args).and_call_original
+          path.should_receive(:parse_path_command).with(*args).and_call_original
         end
 
         path.parse
@@ -81,9 +81,9 @@ describe Prawn::SVG::Elements::Path do
 
       it "uses bezier curves to approximate an arc path" do
         expect(subject).to eq [
-          ["move_to", [100.0, 200.0]],
-          ["curve_to", [150.0, 150.0, 100.0, 172.57081148225683, 122.57081148225683, 150.0]],
-          ["curve_to", [200.0, 200.0, 177.42918851774317, 150.0, 200.0, 172.57081148225683]]
+          Prawn::SVG::Elements::Path::Move.new([100.0, 200.0]),
+          Prawn::SVG::Elements::Path::Curve.new([150.0, 150.0], [100.0, 172.57081148225683], [122.57081148225683, 150.0]),
+          Prawn::SVG::Elements::Path::Curve.new([200.0, 200.0], [177.42918851774317, 150.0], [200.0, 172.57081148225683])
         ]
       end
     end
@@ -93,7 +93,7 @@ describe Prawn::SVG::Elements::Path do
 
       it "ignores the path" do
         expect(subject).to eq [
-          ["move_to", [100.0, 200.0]]
+          Prawn::SVG::Elements::Path::Move.new([100.0, 200.0]),
         ]
       end
     end
@@ -103,8 +103,8 @@ describe Prawn::SVG::Elements::Path do
 
       it "substitutes a line_to" do
         expect(subject).to eq [
-          ["move_to", [100.0, 200.0]],
-          ["line_to", [200.0, 200.0]]
+          Prawn::SVG::Elements::Path::Move.new([100.0, 200.0]),
+          Prawn::SVG::Elements::Path::Line.new([200.0, 200.0])
         ]
       end
     end
@@ -114,8 +114,8 @@ describe Prawn::SVG::Elements::Path do
 
       it "substitutes a line_to" do
         expect(subject).to eq [
-          ["move_to", [100.0, 200.0]],
-          ["line_to", [200.0, 200.0]]
+          Prawn::SVG::Elements::Path::Move.new([100.0, 200.0]),
+          Prawn::SVG::Elements::Path::Line.new([200.0, 200.0])
         ]
       end
     end

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

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+RSpec.describe Prawn::SVG::Elements::Polygon do
+  let(:document) { Prawn::SVG::Document.new(svg, [800, 600], {width: 800, height: 600}) }
+
+  subject do
+    Prawn::SVG::Elements::Polygon.new(document, document.root, [], Prawn::SVG::State.new)
+  end
+
+  context "with a valid points attribute" do
+    let(:svg) { '<polygon points="10 10 20,20 30,30" />' }
+
+    it "renders the polygon" do
+      subject.process
+      expect(subject.base_calls).to eq [
+        ["fill", [], [
+          ["move_to", [[10.0, 590.0]], []],
+          ["line_to", [[20.0, 580.0]], []],
+          ["line_to", [[30.0, 570.0]], []],
+          ["close_path", [], []]]
+        ]
+      ]
+    end
+  end
+
+  context "with a polygon that has an odd number of arguments" do
+    let(:svg) { '<polygon points="10 10 20,20 30" />' }
+
+    it "ignores the last one" do
+      subject.process
+      expect(subject.base_calls).to eq [
+        ["fill", [], [
+          ["move_to", [[10.0, 590.0]], []],
+          ["line_to", [[20.0, 580.0]], []],
+          ["close_path", [], []]]
+        ]
+      ]
+    end
+  end
+
+  context "with a polygon that has no arguments" do
+    let(:svg) { '<polygon points="" />' }
+
+    it "renders nothing" do
+      subject.process
+      expect(subject.base_calls).to eq []
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+RSpec.describe Prawn::SVG::Elements::Polyline do
+  let(:document) { Prawn::SVG::Document.new(svg, [800, 600], {width: 800, height: 600}) }
+
+  subject do
+    Prawn::SVG::Elements::Polyline.new(document, document.root, [], Prawn::SVG::State.new)
+  end
+
+  context "with a valid points attribute" do
+    let(:svg) { '<polyline points="10 10 20,20 30,30" />' }
+
+    it "renders the polyline" do
+      subject.process
+      expect(subject.base_calls).to eq [
+        ["fill", [], [
+          ["move_to", [[10.0, 590.0]], []],
+          ["line_to", [[20.0, 580.0]], []],
+          ["line_to", [[30.0, 570.0]], []]]
+        ]
+      ]
+    end
+  end
+
+  context "with a polyline that has an odd number of arguments" do
+    let(:svg) { '<polyline points="10 10 20,20 30" />' }
+
+    it "ignores the last one" do
+      subject.process
+      expect(subject.base_calls).to eq [
+        ["fill", [], [
+          ["move_to", [[10.0, 590.0]], []],
+          ["line_to", [[20.0, 580.0]], []]]
+        ]
+      ]
+    end
+  end
+
+  context "with a polyline that has no arguments" do
+    let(:svg) { '<polyline points="" />' }
+
+    it "renders nothing" do
+      subject.process
+      expect(subject.base_calls).to eq []
+    end
+  end
+end

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

@@ -14,7 +14,7 @@ z</style>
   end
 
   let(:document) { Prawn::SVG::Document.new(svg, [800, 600], {}) }
-  let(:element) { Prawn::SVG::Elements::Style.new(document, document.root, [], {}) }
+  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")

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

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../../../spec_helper'
 
 describe Prawn::SVG::Elements::Text do
-  let(:document) { Prawn::SVG::Document.new(svg, [800, 600], {}) }
+  let(:document) { Prawn::SVG::Document.new(svg, [800, 600], {}, font_registry: Prawn::SVG::FontRegistry.new("Helvetica" => {:normal => nil}, "Courier" => {normal: nil}, 'Times-Roman' => {normal: nil})) }
   let(:element)  { Prawn::SVG::Elements::Text.new(document, document.root, [], Prawn::SVG::State.new) }
 
   describe "xml:space preserve" do
@@ -14,7 +14,7 @@ describe Prawn::SVG::Elements::Text do
         element.process
 
         expect(element.calls).to eq [
-          ["draw_text", ["some    text", {:style=>nil, :at=>[0.0, 150.0]}], []]
+          ["draw_text", ["some    text", {:size=>16, :style=>:normal, :text_anchor=>'start', :at=>[0.0, 150.0]}], []]
         ]
       end
     end
@@ -26,7 +26,7 @@ describe Prawn::SVG::Elements::Text do
         element.process
 
         expect(element.calls).to eq [
-          ["draw_text", ["some text", {:style=>nil, :at=>[0.0, 150.0]}], []]
+          ["draw_text", ["some text", {:size=>16, :style=>:normal, :text_anchor=>'start', :at=>[0.0, 150.0]}], []]
         ]
       end
     end
@@ -34,10 +34,11 @@ describe Prawn::SVG::Elements::Text do
 
   describe "when text-anchor is specified" do
     let(:svg) { '<g text-anchor="middle" font-size="12"><text x="50" y="14">Text</text></g>' }
+    let(:element) { Prawn::SVG::Elements::Container.new(document, document.root, [], Prawn::SVG::State.new) }
 
     it "should inherit text-anchor from parent element" do
       element.process
-      expect(element.state.text_anchor).to eq 'middle'
+      expect(element.calls.flatten).to include(:size => 12.0, :style => :normal, :text_anchor => "middle", :at => [50.0, 136.0])
     end
   end
 
@@ -49,13 +50,44 @@ describe Prawn::SVG::Elements::Text do
 
       expect(element.base_calls).to eq [
         ["fill", [], [
+          ["font", ["Helvetica", {style: :normal}], []],
           ["text_group", [], [
             ["character_spacing", [5.0], [
-              ["draw_text", ["spaced", {:style=>nil, :at=>[0.0, 150.0]}], []]
+              ["draw_text", ["spaced", {:size=>16, :style=>:normal, :text_anchor=>'start', :at=>[0.0, 150.0]}], []]
             ]]
           ]]
         ]]
       ]
     end
   end
+
+  describe "font finding" do
+    context "with a font that exists" do
+      let(:svg) { '<text font-family="monospace">hello</text>' }
+
+      it "finds the font and uses it" do
+        element.process
+        expect(element.base_calls[0][2][0]).to eq ['font', ['Courier', {style: :normal}], []]
+      end
+    end
+
+    context "with a font that doesn't exist" do
+      let(:svg) { '<text font-family="does not exist">hello</text>' }
+
+      it "uses the fallback font" do
+        element.process
+        expect(element.base_calls[0][2][0]).to eq ['font', ['Times-Roman', {style: :normal}], []]
+      end
+
+      context "when there is no fallback font" do
+        before { document.font_registry.installed_fonts.delete("Times-Roman") }
+
+        it "doesn't call the font method and logs a warning" do
+          element.process
+          expect(element.base_calls.flatten).to_not include 'font'
+          expect(document.warnings.first).to include "is not a known font"
+        end
+      end
+    end
+  end
 end