prawn-svg 0.21.0 → 0.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40c0c884ffef68848fa7314e085647ffc907a003
-  data.tar.gz: 87341061bdfcb99e9cf8157cfb3c84f72ec3bb2b
+  metadata.gz: d93ba261ddc059e43122549f72a3e3daa676171f
+  data.tar.gz: d0497cb84295f9202f84c62b5db79f9d29608019
 SHA512:
-  metadata.gz: 002745c7063d0013609343b4e383372058cde46835e240496f813855ea489287d6aad117ab98d89c3367e02d64a502deb038cdf00a7d9d381238e9d02f66149f
-  data.tar.gz: ce3f448a22be98027ad0be5e154924839e080969cfeeb27322c57e017d249c767b4a073b2faed164a290d102cda0e18c80aa9665840385a6cbfc124714f76808
+  metadata.gz: acf2f6d51a5fda648bed5efd25ba85de91887867badccde3ce4d713cebddcc851280d524ba3006d7014651cd73ccf8c5a54185038a41dfa37612b522cb99ea17
+  data.tar.gz: 2dc23eac65fc5be3299015309d8e2f94d5598ba016f7776090f886fe9bd4551ae90bd129252428b65b617bf8472ca4adcf9cdc5760f3e5f3f635793415d09622

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2
+

data/README.md

@@ -1,12 +1,16 @@
 # prawn-svg
 
+[![Gem Version](https://badge.fury.io/rb/prawn-svg.svg)](https://badge.fury.io/rb/prawn-svg)
+[![Build Status](https://travis-ci.org/mogest/prawn-svg.svg?branch=master)](https://travis-ci.org/mogest/prawn-svg)
+
 An SVG renderer for the Prawn PDF library.
 
 This will take an SVG file as input and render it into your PDF.  Find out more about the Prawn PDF library at:
 
   http://wiki.github.com/sandal/prawn/
 
-prawn-svg is compatible with all versions of Prawn from 0.8.4 onwards, including the 1.x and 2.x series.
+prawn-svg is compatible with all versions of Prawn from 0.11.1 onwards, including the 1.x and 2.x series.
+The minimum Ruby version required is 2.0.0.
 
 ## Using prawn-svg
 
@@ -49,10 +53,13 @@ prawn-svg supports most but not all of the full SVG 1.1 specification.  It curre
 
  - <tt>&lt;style&gt;</tt> plus <tt>id</tt>, <tt>class</tt> and <tt>style</tt> attributes (see CSS section below)
 
- - <tt>&lt;image&gt;</tt> with <tt>http:</tt>, <tt>https:</tt> and <tt>data:image/*;base64</tt> schemes
+ - <tt>&lt;image&gt;</tt> with <tt>http:</tt>, <tt>https:</tt> and <tt>data:image/\*;base64</tt> schemes
 
  - <tt>&lt;clipPath&gt;</tt>
 
+ - <tt>&lt;linearGradient&gt;</tt> but only with Prawn 2.0.4+. gradientTransform, spreadMethod and stop-opacity are
+   unimplemented.
+
  - attributes/styles: <tt>fill</tt>, <tt>stroke</tt>, <tt>stroke-width</tt>, <tt>stroke-linecap</tt>, <tt>stroke-dasharray</tt>, <tt>opacity</tt>, <tt>fill-opacity</tt>, <tt>stroke-opacity</tt>, <tt>transform</tt>, <tt>clip-path</tt>, <tt>display</tt>
 
  - the <tt>viewBox</tt> attribute on the <tt>&lt;svg&gt;</tt> tag
@@ -73,7 +80,7 @@ prawn-svg uses the css_parser gem to parse CSS <tt>&lt;style&gt;</tt> blocks.  I
 
 ## Not supported
 
-prawn-svg does not support external <tt>url()</tt> references, measurements in <tt>en</tt> or <tt>em</tt>, sub-viewports, gradients/patterns or markers.
+prawn-svg does not support external <tt>url()</tt> references, measurements in <tt>en</tt> or <tt>em</tt>, sub-viewports, radial gradients, patterns or markers.
 
 ## Configuration
 
@@ -83,7 +90,7 @@ By default, prawn-svg has a fonts path of <tt>["/Library/Fonts", "/System/Librar
 Mac OS X and Debian Linux users.  You can add to the font path:
 
 ```ruby
-  Prawn::Svg::Interface.font_path << "/my/font/directory"
+  Prawn::SVG::Interface.font_path << "/my/font/directory"
 ```
 
 

data/lib/prawn-svg.rb

@@ -1,3 +1,5 @@
+require 'rexml/document'
+
 require 'prawn'
 require 'prawn/svg/version'
 
@@ -6,14 +8,15 @@ require 'prawn/svg/calculators/document_sizing'
 require 'prawn/svg/calculators/pixels'
 require 'prawn/svg/url_loader'
 require 'prawn/svg/color'
+require 'prawn/svg/attributes'
+require 'prawn/svg/elements'
 require 'prawn/svg/extension'
 require 'prawn/svg/interface'
 require 'prawn/svg/font'
 require 'prawn/svg/document'
-require 'prawn/svg/element'
-require 'prawn/svg/parser'
-require 'prawn/svg/parser/path'
-require 'prawn/svg/parser/text'
-require 'prawn/svg/parser/image'
 
-Prawn::Document.extensions << Prawn::Svg::Extension
+module Prawn
+  Svg = SVG # backwards compatibility
+end
+
+Prawn::Document.extensions << Prawn::SVG::Extension

data/lib/prawn/svg/attributes.rb

@@ -0,0 +1,6 @@
+module Prawn::SVG::Attributes
+end
+
+%w(transform opacity clip_path stroke font display).each do |name|
+  require "prawn/svg/attributes/#{name}"
+end

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

@@ -0,0 +1,17 @@
+module Prawn::SVG::Attributes::ClipPath
+  def parse_clip_path_attribute_and_call
+    return unless clip_path = attributes['clip-path']
+
+    if (matches = clip_path.strip.match(/\Aurl\(#(.*)\)\z/)).nil?
+      document.warnings << "Only clip-path attributes with the form 'url(#xxx)' are supported"
+    elsif (clip_path_element = @document.elements_by_id[matches[1]]).nil?
+      document.warnings << "clip-path ID '#{matches[1]}' not defined"
+    elsif clip_path_element.source.name != "clipPath"
+      document.warnings << "clip-path ID '#{matches[1]}' does not point to a clipPath tag"
+    else
+      add_call_and_enter 'save_graphics_state'
+      add_calls_from_element clip_path_element
+      add_call "clip"
+    end
+  end
+end

data/lib/prawn/svg/attributes/display.rb

@@ -0,0 +1,5 @@
+module Prawn::SVG::Attributes::Display
+  def parse_display_attribute
+    @state[:display] = attributes['display'].strip if attributes['display']
+  end
+end

data/lib/prawn/svg/attributes/font.rb

@@ -0,0 +1,38 @@
+module Prawn::SVG::Attributes::Font
+  def parse_font_attributes_and_call
+    if size = attributes['font-size']
+      @state[:font_size] = size.to_f
+    end
+    if weight = attributes['font-weight']
+      font_updated = true
+      @state[:font_weight] = Prawn::SVG::Font.weight_for_css_font_weight(weight)
+    end
+    if style = attributes['font-style']
+      font_updated = true
+      @state[:font_style] = style == 'italic' ? :italic : nil
+    end
+    if (family = attributes['font-family']) && family.strip != ""
+      font_updated = true
+      @state[:font_family] = family
+    end
+    if (anchor = attributes['text-anchor'])
+      @state[:text_anchor] = anchor
+    end
+
+    if @state[:font_family] && font_updated
+      usable_font_families = [@state[:font_family], document.fallback_font_name]
+
+      font_used = usable_font_families.compact.detect do |name|
+        if font = Prawn::SVG::Font.load(name, @state[:font_weight], @state[:font_style])
+          @state[:font_subfamily] = font.subfamily
+          add_call_and_enter 'font', font.name, :style => @state[:font_subfamily]
+          true
+        end
+      end
+
+      if font_used.nil?
+        warnings << "Font family '#{@state[:font_family]}' style '#{@state[:font_style] || 'normal'}' is not a known font, and the fallback font could not be found."
+      end
+    end
+  end
+end

data/lib/prawn/svg/attributes/opacity.rb

@@ -0,0 +1,15 @@
+module Prawn::SVG::Attributes::Opacity
+  def parse_opacity_attributes_and_call
+    # We can't do nested opacities quite like the SVG requires, but this is close enough.
+    fill_opacity = stroke_opacity = clamp(attributes['opacity'].to_f, 0, 1) if attributes['opacity']
+    fill_opacity = clamp(attributes['fill-opacity'].to_f, 0, 1) if attributes['fill-opacity']
+    stroke_opacity = clamp(attributes['stroke-opacity'].to_f, 0, 1) if attributes['stroke-opacity']
+
+    if fill_opacity || stroke_opacity
+      state[:fill_opacity] = (state[:fill_opacity] || 1) * (fill_opacity || 1)
+      state[:stroke_opacity] = (state[:stroke_opacity] || 1) * (stroke_opacity || 1)
+
+      add_call_and_enter 'transparent', state[:fill_opacity], state[:stroke_opacity]
+    end
+  end
+end

data/lib/prawn/svg/attributes/stroke.rb

@@ -0,0 +1,35 @@
+module Prawn::SVG::Attributes::Stroke
+  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', 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::Elements::COMMA_WSP_REGEXP)
+        array *= 2 if array.length % 2 == 1
+        number_array = array.map {|value| 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
+end

data/lib/prawn/svg/attributes/transform.rb

@@ -0,0 +1,50 @@
+module Prawn::SVG::Attributes::Transform
+  def parse_transform_attribute_and_call
+    return unless transform = attributes['transform']
+
+    parse_css_method_calls(transform).each do |name, arguments|
+      case name
+      when 'translate'
+        x, y = arguments
+        add_call_and_enter name, distance(x.to_f, :x), -distance(y.to_f, :y)
+
+      when 'rotate'
+        r, x, y = arguments.collect {|a| a.to_f}
+        case arguments.length
+        when 1
+          add_call_and_enter name, -r, :origin => [0, y('0')]
+        when 3
+          add_call_and_enter name, -r, :origin => [x(x), y(y)]
+        else
+          warnings << "transform 'rotate' must have either one or three arguments"
+        end
+
+      when 'scale'
+        x_scale = arguments[0].to_f
+        y_scale = (arguments[1] || x_scale).to_f
+        add_call_and_enter "transformation_matrix", x_scale, 0, 0, y_scale, 0, 0
+
+      when 'matrix'
+        if arguments.length != 6
+          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, distance(e, :x), -distance(f, :y)
+        end
+
+      else
+        warnings << "Unknown transformation '#{name}'; ignoring"
+      end
+    end
+  end
+
+  private
+
+  def parse_css_method_calls(string)
+    string.scan(/\s*(\w+)\(([^)]+)\)\s*/).collect do |call|
+      name, argument_string = call
+      arguments = argument_string.strip.split(/\s*[,\s]\s*/)
+      [name, arguments]
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-module Prawn::Svg::Calculators
+module Prawn::SVG::Calculators
   class AspectRatio
     attr_reader :align, :defer
     attr_reader :width, :height, :x, :y

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

@@ -1,4 +1,4 @@
-module Prawn::Svg::Calculators
+module Prawn::SVG::Calculators
   class DocumentSizing
     DEFAULT_WIDTH = 300
     DEFAULT_HEIGHT = 150
@@ -34,7 +34,7 @@ module Prawn::Svg::Calculators
       @output_height = Pixels.to_pixels(@document_height || @requested_height, container_height)
 
       if @view_box
-        values = @view_box.strip.split(Prawn::Svg::Parser::COMMA_WSP_REGEXP)
+        values = @view_box.strip.split(Prawn::SVG::Elements::COMMA_WSP_REGEXP)
         @x_offset, @y_offset, @viewport_width, @viewport_height = values.map {|value| value.to_f}
         @x_offset = -@x_offset
 

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

@@ -1,4 +1,4 @@
-module Prawn::Svg::Calculators
+module Prawn::SVG::Calculators
   class Pixels
     extend Prawn::Measurements
 

data/lib/prawn/svg/color.rb

@@ -1,5 +1,17 @@
-class Prawn::Svg::Color
-  UnresolvableURLWithNoFallbackError = Class.new(StandardError)
+class Prawn::SVG::Color
+  class Hex
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+
+    def ==(other)
+      value == other.value
+    end
+  end
+
+  DEFAULT_COLOR = Hex.new("000000")
 
   HTML_COLORS = {
     'aliceblue' => 'f0f8ff',
@@ -153,34 +165,52 @@ class Prawn::Svg::Color
 
   RGB_VALUE_REGEXP = "\s*(-?[0-9.]+%?)\s*"
   RGB_REGEXP = /\Argb\(#{RGB_VALUE_REGEXP},#{RGB_VALUE_REGEXP},#{RGB_VALUE_REGEXP}\)\z/i
-  URL_REGEXP = /\Aurl\([^)]*\)\z/i
+  URL_REGEXP = /\Aurl\(([^)]*)\)\z/i
 
-  def self.color_to_hex(color_string)
+  def self.parse(color_string, gradients = nil)
     url_specified = false
 
-    result = color_string.strip.scan(/([^(\s]+(\([^)]*\))?)/).detect do |color, *_|
+    components = color_string.to_s.strip.scan(/([^(\s]+(\([^)]*\))?)/)
+
+    result = components.map do |color, *_|
       if m = color.match(/\A#([0-9a-f])([0-9a-f])([0-9a-f])\z/i)
-        break "#{m[1] * 2}#{m[2] * 2}#{m[3] * 2}"
+        Hex.new("#{m[1] * 2}#{m[2] * 2}#{m[3] * 2}")
+
       elsif color.match(/\A#[0-9a-f]{6}\z/i)
-        break color[1..6]
+        Hex.new(color[1..6])
+
       elsif hex = HTML_COLORS[color.downcase]
-        break hex
+        Hex.new(hex)
+
       elsif m = color.match(RGB_REGEXP)
-        break (1..3).collect do |n|
+        hex = (1..3).collect do |n|
           value = m[n].to_f
           value *= 2.55 if m[n][-1..-1] == '%'
           "%02x" % clamp(value.round, 0, 255)
         end.join
-      elsif color.match(URL_REGEXP)
+
+        Hex.new(hex)
+
+      elsif matches = color.match(URL_REGEXP)
         url_specified = true
-        nil # we can't handle these so we find the next thing that matches
+        url = matches[1]
+        if url[0] == "#" && gradients && gradient = gradients[url[1..-1]]
+          gradient
+        end
       end
     end
 
-    # http://www.w3.org/TR/SVG/painting.html section 11.2
-    raise UnresolvableURLWithNoFallbackError if result.nil? && url_specified
+    # Generally, we default to black if the colour was unparseable.
+    # http://www.w3.org/TR/SVG/painting.html section 11.2 says if a URL was
+    # supplied without a fallback, that's an error.
+    result << DEFAULT_COLOR unless url_specified
+
+    result.compact
+  end
 
-    result
+  def self.color_to_hex(color)
+    result = parse(color).detect {|result| result.is_a?(Hex)}
+    result.value if result
   end
 
   protected

data/lib/prawn/svg/document.rb

@@ -1,4 +1,4 @@
-class Prawn::Svg::Document
+class Prawn::SVG::Document
   begin
     require 'css_parser'
     CSS_PARSER_LOADED = true
@@ -15,7 +15,7 @@ class Prawn::Svg::Document
   attr_reader :root,
     :sizing,
     :cache_images, :fallback_font_name,
-    :css_parser, :elements_by_id
+    :css_parser, :elements_by_id, :gradients
 
   def initialize(data, bounds, options)
     @css_parser = CssParser::Parser.new if CSS_PARSER_LOADED
@@ -24,10 +24,11 @@ class Prawn::Svg::Document
     @warnings = []
     @options = options
     @elements_by_id = {}
+    @gradients = {}
     @cache_images = options[:cache_images]
     @fallback_font_name = options.fetch(:fallback_font_name, DEFAULT_FALLBACK_FONT_NAME)
 
-    @sizing = Prawn::Svg::Calculators::DocumentSizing.new(bounds, @root.attributes)
+    @sizing = Prawn::SVG::Calculators::DocumentSizing.new(bounds, @root.attributes)
     sizing.requested_width = options[:width]
     sizing.requested_height = options[:height]
     sizing.calculate
@@ -50,10 +51,10 @@ class Prawn::Svg::Document
   end
 
   def points(value, axis = nil)
-    Prawn::Svg::Calculators::Pixels.to_pixels(value, @axis_to_size.fetch(axis, sizing.viewport_diagonal))
+    Prawn::SVG::Calculators::Pixels.to_pixels(value, @axis_to_size.fetch(axis, sizing.viewport_diagonal))
   end
 
   def url_loader
-    @url_loader ||= Prawn::Svg::UrlLoader.new(:enable_cache => cache_images)
+    @url_loader ||= Prawn::SVG::UrlLoader.new(:enable_cache => cache_images)
   end
 end

data/lib/prawn/svg/elements.rb

@@ -0,0 +1,33 @@
+module Prawn::SVG::Elements
+  COMMA_WSP_REGEXP = /(?:\s+,?\s*|,\s*)/
+end
+
+%w(base root container style text line polyline polygon circle ellipse rect path use image gradient ignored).each do |filename|
+  require "prawn/svg/elements/#{filename}"
+end
+
+module Prawn::SVG::Elements
+  TAG_CLASS_MAPPING = {
+    svg: Prawn::SVG::Elements::Container,
+    g: Prawn::SVG::Elements::Container,
+    symbol: Prawn::SVG::Elements::Container,
+    defs: Prawn::SVG::Elements::Container,
+    clipPath: Prawn::SVG::Elements::Container,
+    style: Prawn::SVG::Elements::Style,
+    text: Prawn::SVG::Elements::Text,
+    line: Prawn::SVG::Elements::Line,
+    polyline: Prawn::SVG::Elements::Polyline,
+    polygon: Prawn::SVG::Elements::Polygon,
+    circle: Prawn::SVG::Elements::Circle,
+    ellipse: Prawn::SVG::Elements::Ellipse,
+    rect: Prawn::SVG::Elements::Rect,
+    path: Prawn::SVG::Elements::Path,
+    use: Prawn::SVG::Elements::Use,
+    image: Prawn::SVG::Elements::Image,
+    linearGradient: Prawn::SVG::Elements::Gradient,
+    title: Prawn::SVG::Elements::Ignored,
+    desc: Prawn::SVG::Elements::Ignored,
+    metadata: Prawn::SVG::Elements::Ignored,
+    :"font-face" => Prawn::SVG::Elements::Ignored,
+  }
+end