prawn-svg 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84d18077060035c9ff8e187e66224d5f8096442f
-  data.tar.gz: 5f5dfebe80da4952bb7abf990dae113ab6964f5e
+  metadata.gz: 13276a5db1c1dd04e219c4e8082205e49dca13ad
+  data.tar.gz: fc5446141d6e7d6ef9f0a393f64bc975d26e453e
 SHA512:
-  metadata.gz: 138d046a81065b80ac7ee63d249d4874deae0e4bfeb18630b2ff117ee93392823cb675b1fc21372f16a199c0efc7ae68f45e3236c0c8559c33c07423a7a31e8d
-  data.tar.gz: 477eb736af2b1b0f4cbd1789d1afb5e0807cac8a5d578790c99d5aaa75787c2413ebb571920e42b4004261401163684e82dd34be1c31af6a4434d85ec573c8b0
+  metadata.gz: 345b0a1c89e7bd4aad297bbcc398322ea7d72ca51a3ac13ea22fdfa62ed0c42ea60344940880f9c570e60f0d21b669e7b3f73ff3791aff16fef87c21c92181d6
+  data.tar.gz: 23391e2209dde7f293c12f4f36af60fc421bea3e05a74b6acd5249bb81c249b0f9bcd8f3c66898f696febf7102ac6157ab836d7d98c20764e0074d2544d6a5f3

data/README.md

@@ -6,7 +6,7 @@ This will take an SVG file as input and render it into your PDF.  Find out more
 
   http://wiki.github.com/sandal/prawn/
 
-prawn-svg is compatible with all versions of Prawn from 0.8.4 onwards, including the version 1.0 series.
+prawn-svg is compatible with all versions of Prawn from 0.8.4 onwards, including the 1.x and 2.x series.
 
 ## Using prawn-svg
 
@@ -53,6 +53,8 @@ prawn-svg does not support the full SVG specification.  It currently supports:
 
  - attributes/styles: <tt>fill</tt>, <tt>stroke</tt>, <tt>stroke-width</tt>, <tt>opacity</tt>, <tt>fill-opacity</tt>, <tt>stroke-opacity</tt>, <tt>transform</tt>, <tt>clip-path</tt>
 
+ - attribute <tt>stroke-linecap</tt>, but only when <tt>fill="none"</tt> due to a PDF limitation
+
  - the <tt>viewBox</tt> attribute on the <tt>&lt;svg&gt;</tt> tag
 
  - the <tt>preserveAspectRatio</tt> attribute on the <tt>&lt;svg&gt;</tt> and <tt>&lt;image&gt;</tt> tags
@@ -67,8 +69,7 @@ prawn-svg does not support the full SVG specification.  It currently supports:
 
 ## CSS
 
-If the css_parser gem is installed, it will handle CSS style definitions, but only simple tag, class or id definitions.  It's very basic
-so do not expect too much of it.
+prawn-svg uses the css_parser gem to parse CSS <tt>&lt;style&gt;</tt> blocks.  It only handles simple tag, class or id selectors; attribute and other advanced selectors are not supported.
 
 ## Not supported
 

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

@@ -5,7 +5,7 @@ module Prawn::Svg::Calculators
     attr_writer :requested_width, :requested_height
 
     attr_reader :x_offset, :y_offset, :x_scale, :y_scale
-    attr_reader :viewport_width, :viewport_height, :output_width, :output_height
+    attr_reader :viewport_width, :viewport_height, :viewport_diagonal, :output_width, :output_height
 
     def initialize(bounds, attributes = nil)
       @bounds = bounds
@@ -47,6 +47,9 @@ module Prawn::Svg::Calculators
       @viewport_width ||= width
       @viewport_height ||= height
 
+      # 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

data/lib/prawn/svg/document.rb

@@ -32,6 +32,8 @@ class Prawn::Svg::Document
     sizing.requested_height = options[:height]
     sizing.calculate
 
+    @axis_to_size = {:x => sizing.viewport_width, :y => sizing.viewport_height}
+
     yield self if block_given?
   end
 
@@ -48,7 +50,7 @@ class Prawn::Svg::Document
   end
 
   def points(value, axis = nil)
-    Prawn::Svg::Calculators::Pixels.to_pixels(value, axis == :y ? sizing.viewport_height : sizing.viewport_width)
+    Prawn::Svg::Calculators::Pixels.to_pixels(value, @axis_to_size.fetch(axis, sizing.viewport_diagonal))
   end
 
   def url_loader

data/lib/prawn/svg/element.rb

@@ -55,7 +55,7 @@ class Prawn::Svg::Element
     parse_opacity_attributes_and_call
     parse_clip_path_attribute_and_call
     draw_types = parse_fill_and_stroke_attributes_and_call
-    parse_stroke_width_attribute_and_call
+    parse_stroke_attributes_and_call
     parse_font_attributes_and_call
     parse_display_attribute
     apply_drawing_call(draw_types)
@@ -82,7 +82,7 @@ class Prawn::Svg::Element
       case name
       when 'translate'
         x, y = arguments
-        add_call_and_enter name, @document.distance(x), -@document.distance(y)
+        add_call_and_enter name, @document.distance(x, :x), -@document.distance(y, :y)
 
       when 'rotate'
         r, x, y = arguments.collect {|a| a.to_f}
@@ -102,7 +102,7 @@ class Prawn::Svg::Element
           @document.warnings << "transform 'matrix' must have six arguments"
         else
           a, b, c, d, e, f = arguments.collect {|argument| argument.to_f}
-          add_call_and_enter "transformation_matrix", a, -b, -c, d, @document.distance(e), -@document.distance(f)
+          add_call_and_enter "transformation_matrix", a, -b, -c, d, @document.distance(e, :x), -@document.distance(f, :y)
         end
       else
         @document.warnings << "Unknown transformation '#{name}'; ignoring"
@@ -156,8 +156,38 @@ class Prawn::Svg::Element
     end
   end
 
-  def parse_stroke_width_attribute_and_call
-    add_call('line_width', @document.distance(@attributes['stroke-width'])) if @attributes['stroke-width']
+  CAP_STYLE_TRANSLATIONS = {"butt" => :butt, "round" => :round, "square" => :projecting_square}
+
+  def parse_stroke_attributes_and_call
+    if width = @attributes['stroke-width']
+      add_call('line_width', @document.distance(width))
+    end
+
+    if (linecap = attribute_value_as_keyword('stroke-linecap')) && linecap != 'inherit'
+      add_call('cap_style', CAP_STYLE_TRANSLATIONS.fetch(linecap, :butt))
+    end
+
+    if dasharray = attribute_value_as_keyword('stroke-dasharray')
+      case dasharray
+      when 'inherit'
+        # don't do anything
+      when 'none'
+        add_call('undash')
+      else
+        array = dasharray.split(Prawn::Svg::Parser::COMMA_WSP_REGEXP)
+        array *= 2 if array.length % 2 == 1
+        number_array = array.map {|value| @document.distance(value)}
+
+        if number_array.any? {|number| number < 0}
+          @document.warnings << "stroke-dasharray cannot have negative numbers; treating as 'none'"
+          add_call('undash')
+        elsif number_array.inject(0) {|a, b| a + b} == 0
+          add_call('undash')
+        else
+          add_call('dash', number_array)
+        end
+      end
+    end
   end
 
   def parse_font_attributes_and_call
@@ -231,7 +261,11 @@ class Prawn::Svg::Element
     end
 
     @attributes = parse_css_declarations(style)
-    element.attributes.each {|n,v| @attributes[n] = v unless @attributes[n]}
+
+    element.attributes.each do |name, value|
+      name = name.downcase
+      @attributes[name] = value unless @attributes[name]
+    end
   end
 
   def parse_css_declarations(declarations)
@@ -241,10 +275,16 @@ class Prawn::Svg::Element
     output = {}
     declarations.split(/[\;$]+/m).each do |decs|
       if matches = decs.match(/\s*(.[^:]*)\s*\:\s*(.[^;]*)\s*(;|\Z)/i)
-        property, value, end_of_declaration = matches.captures
-        output[property] = value
+        property, value, _ = matches.captures
+        output[property.downcase] = value
       end
     end
     output
   end
+
+  def attribute_value_as_keyword(name)
+    if value = @attributes[name]
+      value.strip.downcase
+    end
+  end
 end

data/lib/prawn/svg/interface.rb

@@ -56,16 +56,17 @@ module Prawn
 
       def issue_prawn_command(prawn, calls)
         calls.each do |call, arguments, children|
-          if call == "end_path"
-            issue_prawn_command(prawn, children) if children.any?
-            prawn.add_content "n" # end path
+          skip = false
 
-          elsif rewrite_call_arguments(prawn, call, arguments) == false
+          rewrite_call_arguments(prawn, call, arguments) do
             issue_prawn_command(prawn, children) if children.any?
+            skip = true
+          end
 
+          if skip
+            # the call has been overridden
           elsif children.empty?
             prawn.send(call, *arguments)
-
           else
             prawn.send(call, *arguments, &proc_creator(prawn, children))
           end
@@ -81,7 +82,7 @@ module Prawn
         case call
         when 'text_group'
           @relative_text_position = nil
-          false
+          yield
 
         when 'draw_text'
           text, options = arguments
@@ -104,15 +105,26 @@ module Prawn
 
         when 'clip'
           prawn.add_content "W n" # clip to path
-          false
+          yield
 
         when 'save'
           prawn.save_graphics_state
-          false
+          yield
 
         when 'restore'
           prawn.restore_graphics_state
-          false
+          yield
+
+        when "end_path"
+          yield
+          prawn.add_content "n" # end path
+
+        when 'fill_and_stroke'
+          yield
+          # 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'
         end
       end
 

data/lib/prawn/svg/parser.rb

@@ -13,6 +13,7 @@ require 'rexml/document'
 #
 class Prawn::Svg::Parser
   CONTAINER_TAGS = %w(g svg symbol defs clipPath)
+  COMMA_WSP_REGEXP = /(?:\s+,?\s*|,\s*)/
 
   #
   # Construct a Parser object.
@@ -132,7 +133,7 @@ class Prawn::Svg::Parser
       end
 
     when 'ellipse'
-      xy, rx, ry = [x(attrs['cx'] || "0"), y(attrs['cy'] || "0")], distance(attrs['rx']), distance(attrs['ry'])
+      xy, rx, ry = [x(attrs['cx'] || "0"), y(attrs['cy'] || "0")], distance(attrs['rx'], :x), distance(attrs['ry'], :y)
 
       return if zero_argument?(rx, ry)
 
@@ -140,7 +141,7 @@ class Prawn::Svg::Parser
 
     when 'rect'
       xy            = [x(attrs['x'] || '0'), y(attrs['y'] || '0')]
-      width, height = distance(attrs['width']), distance(attrs['height'])
+      width, height = distance(attrs['width'], :x), distance(attrs['height'], :y)
       radius        = distance(attrs['rx'] || attrs['ry'])
 
       return if zero_argument?(width, height)
@@ -211,7 +212,7 @@ class Prawn::Svg::Parser
           x = element.attributes['x']
           y = element.attributes['y']
           if x || y
-            element.add_call_and_enter "translate", distance(x || 0), -distance(y || 0)
+            element.add_call_and_enter "translate", distance(x || 0, :x), -distance(y || 0, :y)
           end
           element.add_calls_from_element definition_element
         else
@@ -260,7 +261,7 @@ class Prawn::Svg::Parser
       to_s.
       strip.
       gsub(/(\d)-(\d)/, '\1 -\2').
-      split(/(?:\s+,?\s*|,\s*)/).
+      split(COMMA_WSP_REGEXP).
       each_slice(2).
       to_a
   end

data/lib/prawn/svg/version.rb

@@ -1,5 +1,5 @@
 module Prawn
   module Svg
-    VERSION = '0.17.0'
+    VERSION = '0.18.0'
   end
 end

data/prawn-svg.gemspec

@@ -18,8 +18,10 @@ spec = Gem::Specification.new do |gem|
   gem.name          = "prawn-svg"
   gem.require_paths = ["lib"]
 
+  gem.required_ruby_version = '>= 1.9.3'
+
   gem.add_runtime_dependency "prawn", ">= 0.8.4", "< 3"
   gem.add_runtime_dependency "css_parser", "~> 1.3"
-  gem.add_development_dependency "rspec", "~> 2.14"
+  gem.add_development_dependency "rspec", "~> 3.0"
   gem.add_development_dependency "rake", "~> 10.1"
 end

data/spec/prawn/svg/document_spec.rb

@@ -1,29 +1,31 @@
 require File.dirname(__FILE__) + '/../../spec_helper'
 
 describe Prawn::Svg::Document do  
-  before(:each) do
-    @document = Prawn::Svg::Document.new("<svg></svg>", [100, 100], {})
+  before do
+    sizing = instance_double(Prawn::Svg::Calculators::DocumentSizing, viewport_width: 600, viewport_height: 400, viewport_diagonal: 500, :requested_width= => nil, :requested_height= => nil)
+    expect(sizing).to receive(:calculate)
+    expect(Prawn::Svg::Calculators::DocumentSizing).to receive(:new).and_return(sizing)
   end
 
+  let(:document) { Prawn::Svg::Document.new("<svg></svg>", [100, 100], {}) }
+
   describe :points do    
     it "converts a variety of measurement units to points" do
-      @document.send(:points, 32).should == 32.0      
-      @document.send(:points, 32.0).should == 32.0      
-      @document.send(:points, "32").should == 32.0
-      @document.send(:points, "32unknown").should == 32.0
-      @document.send(:points, "32pt").should == 32.0      
-      @document.send(:points, "32in").should == 32.0 * 72
-      @document.send(:points, "32ft").should == 32.0 * 72 * 12
-      @document.send(:points, "32pc").should == 32.0 * 15
-      @document.send(:points, "32mm").should be_within(0.0001).of(32 * 72 * 0.0393700787)
-      @document.send(:points, "32cm").should be_within(0.0001).of(32 * 72 * 0.393700787)
-      @document.send(:points, "32m").should be_within(0.0001).of(32 * 72 * 39.3700787)
-      
-      @document.sizing.send :instance_variable_set, "@viewport_width", 600
-      @document.sizing.send :instance_variable_set, "@viewport_height", 400
-      @document.send(:points, "50%").should == 300
-      @document.send(:points, "50%", :x).should == 300
-      @document.send(:points, "50%", :y).should == 200
+      document.send(:points, 32).should == 32.0      
+      document.send(:points, 32.0).should == 32.0      
+      document.send(:points, "32").should == 32.0
+      document.send(:points, "32unknown").should == 32.0
+      document.send(:points, "32pt").should == 32.0      
+      document.send(:points, "32in").should == 32.0 * 72
+      document.send(:points, "32ft").should == 32.0 * 72 * 12
+      document.send(:points, "32pc").should == 32.0 * 15
+      document.send(:points, "32mm").should be_within(0.0001).of(32 * 72 * 0.0393700787)
+      document.send(:points, "32cm").should be_within(0.0001).of(32 * 72 * 0.393700787)
+      document.send(:points, "32m").should be_within(0.0001).of(32 * 72 * 39.3700787)
+
+      document.send(:points, "50%").should == 250
+      document.send(:points, "50%", :x).should == 300
+      document.send(:points, "50%", :y).should == 200
     end
   end
 end

data/spec/sample_svg/cap_styles.svg

@@ -0,0 +1,13 @@
+<svg xmlns="http://www.w3.org/2000/svg" version="1.1" width="1100" height="210">
+  <rect x="100" y="100" width="900" height="100" fill="none" stroke="blue" stroke-width="2" />
+
+  <g stroke="green" stroke-width="10">
+    <line x1="120" y1="110" x2="120" y2="190" />
+    <line x1="140" y1="110" x2="140" y2="190" stroke-linecap="butt" />
+    <line x1="160" y1="110" x2="160" y2="190" stroke-linecap="round" />
+    <line x1="180" y1="110" x2="180" y2="190" stroke-linecap="square" />
+    <line x1="200" y1="110" x2="200" y2="190" />
+    <line x1="220" y1="110" x2="220" y2="190" stroke-linecap="invalid" />
+  </g>
+</svg>
+

data/spec/sample_svg/gistfile1.svg

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" height="205pt" style="width:362px;height:205px;" version="1.1" viewBox="0 0 362 205" width="362pt">
   <g>
-    <line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="146" x2="146" y1="35.4883" y2="204.041"/>
+    <line style="stroke: blue; stroke-width: 1.0; stroke-dasharray: 20,40;" x1="146" x2="146" y1="35.4883" y2="204.041"/>
     <line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="204" x2="204" y1="35.4883" y2="204.041"/>
     <rect fill="#FEFECE" height="30.4883" style="stroke: #A80036; stroke-width: 1.5;" width="47" x="121" y="0"/>
     <text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="33" x="128" y="20.5352">Alice</text>

data/spec/sample_svg/path.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" version="1.1" width="1100" height="400">
+  <rect x="100" y="100" width="900" height="300" fill="none" stroke="blue" stroke-width="2" />
+
+  <path d="M200 200 L800 300 L800 200" stroke="green" stroke-width="10" fill="red" />
+</svg>

data/spec/spec_helper.rb

@@ -6,6 +6,13 @@ Bundler.require(:default, :development)
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
+  config.mock_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
 end
 
 Prawn::Svg::Font.load_external_fonts(Prawn::Document.new.font_families)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-svg
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Roger Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-29 00:00:00.000000000 Z
+date: 2015-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +118,7 @@ files:
 - spec/sample_images/mushroom-wide.jpg
 - spec/sample_output/directory
 - spec/sample_svg/arcs01.svg
+- spec/sample_svg/cap_styles.svg
 - spec/sample_svg/circle01.svg
 - spec/sample_svg/clip_path.svg
 - spec/sample_svg/close_path.svg
@@ -139,6 +140,7 @@ files:
 - spec/sample_svg/negminy.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
@@ -171,7 +173,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -199,6 +201,7 @@ test_files:
 - spec/sample_images/mushroom-wide.jpg
 - spec/sample_output/directory
 - spec/sample_svg/arcs01.svg
+- spec/sample_svg/cap_styles.svg
 - spec/sample_svg/circle01.svg
 - spec/sample_svg/clip_path.svg
 - spec/sample_svg/close_path.svg
@@ -220,6 +223,7 @@ test_files:
 - spec/sample_svg/negminy.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