prawn-svg 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcccb8c6d35a2f33debf7f17d04dc1a8b3099398
-  data.tar.gz: 3ac53d2c35c41f1de03582e46175a9bf296a6cd0
+  metadata.gz: fb790776a1eaf53a702045a42ea22fce3e8afa51
+  data.tar.gz: d90d2245d141bc749ec04d0b6e9239a9e2d8b48c
 SHA512:
-  metadata.gz: ea4c6fb099669924881a72e4d983a5b890a4e74d38eb5bc7e1173223485acc35a69b0dabf95c41329bc1c254a6be53771d98f5e13fcf5d5c118c2fa1b2bd85ce
-  data.tar.gz: d3440e0c86365ad251beec2011f1f243dfc35e24ee82af3684c925e2e9c08d4b44e416e366cbd036343908241567cfd75878929bc5ce98fa9e4f81cdde963317
+  metadata.gz: a0a11f3a0a93c36d838ed2bcb012cfa010f4968de481795e8f46fde61460c71c1f491586e477c24d1c55792f9293d2d52f4dfb9f28c7447cd4c3f87623e17c7f
+  data.tar.gz: 5885cb0acea63c8edd59fe563e4b6859f0d536537324026e8e18bb390fe1a0e335be7c2eaf07ef1d529ea752804a4fa8387a0f61d3b7ea362f76df60b13f0d5c

data/README.md

@@ -41,7 +41,7 @@ prawn-svg supports most but not all of the full SVG 1.1 specification.  It curre
    implementation of elliptical arc is a bit rough at the moment.
 
  - <tt>&lt;text&gt;</tt> and <tt>&lt;tspan&gt;</tt> with attributes
-   <tt>text-anchor</tt>, <tt>font-size</tt>, <tt>font-family</tt>, <tt>font-weight</tt>, <tt>font-style</tt>, <tt>dx</tt>, <tt>dy</tt>
+   <tt>text-anchor</tt>, <tt>font-size</tt>, <tt>font-family</tt>, <tt>font-weight</tt>, <tt>font-style</tt>, <tt>letter-spacing</tt>, <tt>dx</tt>, <tt>dy</tt>
 
  - <tt>&lt;svg&gt;</tt>, <tt>&lt;g&gt;</tt> and <tt>&lt;symbol&gt;</tt>
 

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

@@ -1,8 +1,11 @@
 module Prawn::Svg::Calculators
   class DocumentSizing
+    DEFAULT_WIDTH = 300
+    DEFAULT_HEIGHT = 150
+    DEFAULT_ASPECT_RATIO = "xMidYMid meet"
+
     attr_writer :document_width, :document_height
     attr_writer :view_box, :preserve_aspect_ratio
-    attr_writer :requested_width, :requested_height
 
     attr_reader :bounds
     attr_reader :x_offset, :y_offset, :x_scale, :y_scale
@@ -17,59 +20,80 @@ module Prawn::Svg::Calculators
       @document_width = attributes['width']
       @document_height = attributes['height']
       @view_box = attributes['viewBox']
-      @preserve_aspect_ratio = attributes['preserveAspectRatio']
+      @preserve_aspect_ratio = attributes['preserveAspectRatio'] || DEFAULT_ASPECT_RATIO
     end
 
     def calculate
       @x_offset = @y_offset = 0
       @x_scale = @y_scale = 1
 
-      width = Prawn::Svg::Calculators::Pixels.to_pixels(@document_width, @bounds[0])
-      height = Prawn::Svg::Calculators::Pixels.to_pixels(@document_height, @bounds[1])
-
-      default_aspect_ratio = "x#{width ? "Mid" : "Min"}Y#{height ? "Mid" : "Min"} meet"
+      container_width = @requested_width || @bounds[0]
+      container_height = @requested_height || @bounds[1]
 
-      width ||= @bounds[0]
-      height ||= @bounds[1]
+      @output_width = Pixels.to_pixels(@document_width || @requested_width, container_width)
+      @output_height = Pixels.to_pixels(@document_height || @requested_height, container_height)
 
       if @view_box
-        values = @view_box.strip.split(/\s+/)
+        values = @view_box.strip.split(Prawn::Svg::Parser::COMMA_WSP_REGEXP)
         @x_offset, @y_offset, @viewport_width, @viewport_height = values.map {|value| value.to_f}
         @x_offset = -@x_offset
 
-        @preserve_aspect_ratio ||= default_aspect_ratio
-        aspect = Prawn::Svg::Calculators::AspectRatio.new(@preserve_aspect_ratio, [width, height], [@viewport_width, @viewport_height])
-        @x_scale = aspect.width / @viewport_width
-        @y_scale = aspect.height / @viewport_height
-        @x_offset -= aspect.x
-        @y_offset -= aspect.y
+        if @viewport_width > 0 && @viewport_height > 0
+          @output_width ||= container_width
+          @output_height ||= @output_width * @viewport_height / @viewport_width
+
+          aspect = AspectRatio.new(@preserve_aspect_ratio, [@output_width, @output_height], [@viewport_width, @viewport_height])
+          @x_scale = aspect.width / @viewport_width
+          @y_scale = aspect.height / @viewport_height
+          @x_offset -= aspect.x / @x_scale
+          @y_offset -= aspect.y / @y_scale
+        end
+      else
+        @output_width ||= Pixels.to_pixels(DEFAULT_WIDTH, container_width)
+        @output_height ||= Pixels.to_pixels(DEFAULT_HEIGHT, container_height)
+
+        @viewport_width = @output_width
+        @viewport_height = @output_height
       end
 
-      @viewport_width ||= width
-      @viewport_height ||= height
+      return if invalid?
 
       # SVG 1.1 section 7.10
       @viewport_diagonal = Math.sqrt(@viewport_width**2 + @viewport_height**2) / Math.sqrt(2)
 
       if @requested_width
-        scale = @requested_width / width
-        width = @requested_width
-        height *= scale
+        scale = @requested_width / @output_width
+        @output_width = @requested_width
+        @output_height *= scale
         @x_scale *= scale
         @y_scale *= scale
 
       elsif @requested_height
-        scale = @requested_height / height
-        height = @requested_height
-        width *= scale
+        scale = @requested_height / @output_height
+        @output_height = @requested_height
+        @output_width *= scale
         @x_scale *= scale
         @y_scale *= scale
       end
 
-      @output_width = width
-      @output_height = height
-
       self
     end
+
+    def invalid?
+      @viewport_width <= 0 ||
+        @viewport_height <= 0 ||
+        @output_width <= 0 ||
+        @output_height <= 0 ||
+        (@requested_width && @requested_width <= 0) ||
+        (@requested_height && @requested_height <= 0)
+    end
+
+    def requested_width=(value)
+      @requested_width = (value.to_f if value)
+    end
+
+    def requested_height=(value)
+      @requested_height = (value.to_f if value)
+    end
   end
 end

data/lib/prawn/svg/interface.rb

@@ -49,6 +49,11 @@ module Prawn
       # Draws the SVG to the Prawn::Document object.
       #
       def draw
+        if @document.sizing.invalid?
+          @document.warnings << "Zero or negative sizing data means this SVG cannot be rendered"
+          return
+        end
+
         prawn.bounding_box(position, :width => @document.sizing.output_width, :height => @document.sizing.output_height) do
           prawn.save_graphics_state do
             clip_rectangle 0, 0, @document.sizing.output_width, @document.sizing.output_height

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

@@ -1,11 +1,11 @@
 class Prawn::Svg::Parser::Text
   def parse(element)
     element.add_call_and_enter "text_group"
-    internal_parse(element, [element.document.x(0)], [element.document.y(0)], false)
+    internal_parse(element, [element.document.x(0)], [element.document.y(0)])
   end
 
   protected
-  def internal_parse(element, x_positions, y_positions, relative)
+  def internal_parse(element, x_positions, y_positions, relative = false, preserve_space = false)
     return if element.state[:display] == "none"
 
     attrs = element.attributes
@@ -20,6 +20,13 @@ class Prawn::Svg::Parser::Text
       element.add_call_and_enter "translate", element.document.distance(attrs['dx'] || 0), -element.document.distance(attrs['dy'] || 0)
     end
 
+    case attrs['xml:space']
+    when 'preserve'
+      preserve_space = true
+    when 'default'
+      preserve_space = false
+    end
+
     opts = {}
     if size = element.state[:font_size]
       opts[:size] = size
@@ -32,9 +39,13 @@ class Prawn::Svg::Parser::Text
       opts[:text_anchor] = anchor
     end
 
+    if spacing = attrs['letter-spacing']
+      element.add_call_and_enter 'character_spacing', element.document.points(spacing)
+    end
+
     element.element.children.each do |child|
       if child.node_type == :text
-        text = child.value.strip.gsub(/\s+/, " ")
+        text = child.value.strip.gsub(preserve_space ? /[\n\t]/ : /\s+/, " ")
 
         while text != ""
           opts[:at] = [x_positions.first, y_positions.first]
@@ -56,7 +67,7 @@ class Prawn::Svg::Parser::Text
         element.add_call 'save'
         child.attributes['text-anchor'] ||= opts[:text_anchor] if opts[:text_anchor]
         child_element = Prawn::Svg::Element.new(element.document, child, element.calls, element.state.dup)
-        internal_parse(child_element, x_positions, y_positions, relative)
+        internal_parse(child_element, x_positions, y_positions, relative, preserve_space)
         child_element.append_calls_to_parent
         element.add_call 'restore'
 

data/lib/prawn/svg/version.rb

@@ -1,5 +1,5 @@
 module Prawn
   module Svg
-    VERSION = '0.19.0'
+    VERSION = '0.20.0'
   end
 end

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

@@ -31,7 +31,7 @@ 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
+      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
@@ -69,5 +69,60 @@ describe Prawn::Svg::Calculators::DocumentSizing do
       expect(sizing.output_width).to eq 600
       expect(sizing.output_height).to eq 400
     end
+
+    context "when SVG does not specify width and height" do
+      context "when a viewBox is specified" do
+        let(:attributes) { {"viewBox" => "0 0 100 200"} }
+
+        it "defaults to 100% width and the width times aspect ratio in 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 2400
+        end
+      end
+
+      context "when a requested width and height are supplied" do
+        let(:attributes) { {} }
+
+        it "uses the requested width and height" do
+          sizing.requested_width = 550
+          sizing.requested_height = 400
+          sizing.calculate
+
+          expect(sizing.viewport_width).to eq 550
+          expect(sizing.viewport_height).to eq 400
+          expect(sizing.output_width).to eq 550
+          expect(sizing.output_height).to eq 400
+        end
+      end
+
+      context "when a viewBox and a requested width/height are supplied" do
+        let(:attributes) { {"viewBox" => "0 0 100 200"} }
+
+        it "uses the requested width and height" do
+          sizing.requested_width = 550
+          sizing.requested_height = 400
+          sizing.calculate
+
+          expect(sizing.viewport_width).to eq 100
+          expect(sizing.viewport_height).to eq 200
+          expect(sizing.output_width).to eq 550
+          expect(sizing.output_height).to eq 400
+        end
+      end
+
+      context "when neither viewBox nor requested width/height specified" do
+        let(:attributes) { {} }
+
+        it "defaults to 300x150, because that's what HTML does" do
+          sizing.calculate
+
+          expect(sizing.output_width).to eq 300
+          expect(sizing.output_height).to eq 150
+        end
+      end
+    end
   end
 end

data/spec/prawn/svg/interface_spec.rb

@@ -21,20 +21,31 @@ describe Prawn::Svg::Interface do
     end
   end
 
+  describe "#draw" do
+    context "when the sizing object indicates the sizes are invalid" do
+      let(:interface) { Prawn::Svg::Interface.new('<svg width="0"></svg>', prawn, {}) }
+
+      it "doesn't draw anything and adds a warning" do
+        interface.draw
+        expect(interface.document.warnings).to eq ["Zero or negative sizing data means this SVG cannot be rendered"]
+      end
+    end
+  end
+
   describe "#position" do
+    subject { interface.position }
+
     context "when options[:at] supplied" do
-      it "returns options[:at]" do
-        interface = Prawn::Svg::Interface.new(svg, prawn, at: [1, 2], position: :left)
+      let(:interface) { Prawn::Svg::Interface.new(svg, prawn, at: [1, 2], position: :left) }
 
-        expect(interface.position).to eq [1, 2]
+      it "returns options[:at]" do
+        expect(subject).to eq [1, 2]
       end
     end
 
     context "when only a position is supplied" do
       let(:interface) { Prawn::Svg::Interface.new(svg, prawn, position: position) }
 
-      subject { interface.position }
-
       context "(:left)" do
         let(:position) { :left }
         it { is_expected.to eq [0, 600] }
@@ -55,5 +66,29 @@ describe Prawn::Svg::Interface do
         it { is_expected.to eq [25.5, 600] }
       end
     end
+
+    context "when a vposition is supplied" do
+      let(:interface) { Prawn::Svg::Interface.new(svg, prawn, vposition: vposition) }
+
+      context "(:top)" do
+        let(:vposition) { :top }
+        it { is_expected.to eq [0, 600] }
+      end
+
+      context "(:center)" do
+        let(:vposition) { :center }
+        it { is_expected.to eq [0, 350] }
+      end
+
+      context "(:bottom)" do
+        let(:vposition) { :bottom }
+        it { is_expected.to eq [0, 100] }
+      end
+
+      context "a number" do
+        let(:vposition) { 25.5 }
+        it { is_expected.to eq [0, 600 - 25.5] }
+      end
+    end
   end
 end

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

@@ -1,4 +1,53 @@
 require File.dirname(__FILE__) + '/../../../spec_helper'
 
-describe Prawn::Svg::Parser::Text do  
+describe Prawn::Svg::Parser::Text do
+  let(:document) { Prawn::Svg::Document.new(svg, [800, 600], {}) }
+  let(:element)  { Prawn::Svg::Element.new(document, document.root, [], {}) }
+  let(:parser)   { Prawn::Svg::Parser::Text.new }
+
+  describe "xml:space preserve" do
+    let(:svg) { %(<text#{attributes}>some\n\t  text</text>) }
+
+    context "when xml:space is preserve" do
+      let(:attributes) { ' xml:space="preserve"' }
+
+      it "converts newlines and tabs to spaces, and preserves spaces" do
+        parser.parse(element)
+
+        expect(element.calls).to eq [
+          ["draw_text", ["some    text", {:style=>nil, :at=>[0.0, 150.0]}], []]
+        ]
+      end
+    end
+
+    context "when xml:space is unspecified" do
+      let(:attributes) { '' }
+
+      it "strips space" do
+        parser.parse(element)
+
+        expect(element.calls).to eq [
+          ["draw_text", ["some text", {:style=>nil, :at=>[0.0, 150.0]}], []]
+        ]
+      end
+    end
+  end
+
+  describe "letter-spacing" do
+    let(:svg) { '<text letter-spacing="5">spaced</text>' }
+
+    it "calls character_spacing with the requested size" do
+      parser.parse(element)
+
+      expect(element.base_calls).to eq [
+        ["end_path", [], [
+          ["text_group", [], [
+            ["character_spacing", [5.0], [
+              ["draw_text", ["spaced", {:style=>nil, :at=>[0.0, 150.0]}], []]
+            ]]
+          ]]
+        ]]
+      ]
+    end
+  end
 end

data/spec/sample_svg/no_width_or_height.svg

@@ -0,0 +1,4 @@
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" version="1.1" viewBox="10 10 90 90">
+  <rect x="10" y="10" width="90" height="90" fill="blue" stroke="red"></rect>
+</svg>

data/spec/sample_svg/preserve-space.svg

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="utf-8"?>
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="500" height="500">
+<text x="0" y="40" xml:space="preserve" font-size="30" letter-spacing="5">Text                (Far away text)</text>
+<text x="0" y="80" font-size="30" letter-spacing="5">Text                (Close text)</text>
+<text x="0" y="120" xml:space="preserve" font-size="30" letter-spacing="5">
+  Text
+  With
+  Newlines
+  And
+  Preserve
+</text>
+<text x="0" y="160" font-size="30" letter-spacing="5">
+  Text
+  With
+  Newlines
+  No
+  Preserve
+</text>
+</svg>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-svg
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Roger Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2015-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -139,12 +139,14 @@ files:
 - spec/sample_svg/matrix_transform.svg
 - spec/sample_svg/matrix_transform_3.svg
 - spec/sample_svg/negminy.svg
+- spec/sample_svg/no_width_or_height.svg
 - spec/sample_svg/omnigraffle.svg
 - spec/sample_svg/opacity01.svg
 - spec/sample_svg/path.svg
 - spec/sample_svg/pie_piece.svg
 - spec/sample_svg/polygon01.svg
 - spec/sample_svg/polyline01.svg
+- spec/sample_svg/preserve-space.svg
 - spec/sample_svg/quad01.svg
 - spec/sample_svg/rect01.svg
 - spec/sample_svg/rect02.svg
@@ -223,12 +225,14 @@ test_files:
 - spec/sample_svg/matrix_transform.svg
 - spec/sample_svg/matrix_transform_3.svg
 - spec/sample_svg/negminy.svg
+- spec/sample_svg/no_width_or_height.svg
 - spec/sample_svg/omnigraffle.svg
 - spec/sample_svg/opacity01.svg
 - spec/sample_svg/path.svg
 - spec/sample_svg/pie_piece.svg
 - spec/sample_svg/polygon01.svg
 - spec/sample_svg/polyline01.svg
+- spec/sample_svg/preserve-space.svg
 - spec/sample_svg/quad01.svg
 - spec/sample_svg/rect01.svg
 - spec/sample_svg/rect02.svg