prawn-svg 0.15.0.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61181b453d5e28bba30c87c430975b21e5e9876d
-  data.tar.gz: c1c1d6ec4e6bb4d60af290a836ed25574dbca760
+  metadata.gz: 0455251b1d5e7c430660f51c4843d26adb8d9913
+  data.tar.gz: caf87db1d427b7b528b5ae09b826b4dddec7a8a0
 SHA512:
-  metadata.gz: 766a6cb2dc207b26e433509f1dbdce22055106c05806ff327f4203dc478d6ecfe99308502f2b1964c442d8ac2ecba1df5739593144ff2328e3c5e94aad74d440
-  data.tar.gz: 2281ec02f05246f40f4c68497d23f34da10b51ba16c60e76bd1e6d2467b0e1d80326ff76cc05aa244b794784be855f2996ceeeb6ce28465ffcecf66bee469b50
+  metadata.gz: e1068767350107317ce264382ead9432a8ca98118d82301a402ef5fb50f6da65bdc2f547101955911cd24cf291745dd3f7b55f51d2374c96b9442673833df638
+  data.tar.gz: 47b83cd0def9edaec474ec458fa01831801abefadeebe797840b64bd7b3b2f38ff869e135893bb16a9f23b6a9fea28ab46c9f843775fa1c3f72bcd11964d8b33

data/.travis.yml

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

data/README.md

@@ -1,32 +1,57 @@
 # 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/
+  http://github.com/prawnpdf/prawn 
+
+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
 
 ```ruby
-Prawn::Document.generate("svg.pdf") do
-  svg svg_data, :at => [x, y], :width => w
+Prawn::Document.generate("test.pdf") do
+  svg '<svg><rect width="100" height="100" fill="red"></rect></svg>'
 end
 ```
 
-<tt>:at</tt> must be specified.
+prawn-svg will do something sensible if you call it with only an SVG document, but you can also
+pass the following options to tailor its operation:
 
-<tt>:width</tt>, <tt>:height</tt>, or neither may be specified; if neither is present,
-the resolution specified in the SVG will be used.
+Option      | Data type | Description
+----------- | --------- | -----------
+:at         | [integer, integer] | Specify the location on the page you want the SVG to appear.
+:position   | :left, :center, :right, integer | If :at not specified, specifies the horizontal position to show the SVG.  Defaults to :left.
+:vposition  | :top, :center, :bottom, integer | If :at not specified, specifies the vertical position to show the SVG.  Defaults to current cursor position.
+:width      | integer   | Desired width of the SVG.  Defaults to horizontal space available.
+:height     | integer   | Desired height of the SVG.  Defaults to vertical space available.
+:enable_web_requests | boolean | If true, prawn-svg will make http and https requests to fetch images.  Defaults to true.
+:enable_file_requests_with_root | string | If not nil, prawn-svg will serve `file:` URLs from your local disk if the file is located under the specified directory. It is very dangerous to specify the root path ("/") if you're not fully in control of your input SVG.  Defaults to `nil` (off).
+:cache_images | boolean   | If true, prawn-svg will cache the result of all URL requests. Defaults to false.
+:fallback_font_name | string | A font name which will override the default fallback font of Times-Roman.  If this value is set to <tt>nil</tt>, prawn-svg will ignore a request for an unknown font and log a warning.
 
-<tt>:cache_images</tt>, if set to true, will cache images per document based on their URL.
+## Examples
 
-<tt>:fallback_font_name</tt> takes a font name which will override the default fallback font of Times-Roman.
-If this value is set to <tt>nil</tt>, prawn-svg will ignore a request for an unknown font and log a warning.
+```ruby
+  # Render the logo contained in the file logo.svg at 100, 100 with a width of 300
+  svg IO.read("logo.svg"), at: [100, 100], width: 300
+
+  # Render the logo at the current Y cursor position, centered in the current bounding box
+  svg IO.read("logo.svg"), position: :center
+
+  # Render the logo at the current Y cursor position, and serve file: links relative to its directory
+  root_path = "/apps/myapp/current/images"
+  svg IO.read("#{root_path}/logo.svg"), enable_file_requests_with_root: root_path
+```
 
 ## Supported features
 
-prawn-svg does not support the full SVG specification.  It currently supports:
+prawn-svg supports most but not all of the full SVG 1.1 specification.  It currently supports:
 
  - <tt>&lt;line&gt;</tt>, <tt>&lt;polyline&gt;</tt>, <tt>&lt;polygon&gt;</tt>, <tt>&lt;circle&gt;</tt> and <tt>&lt;ellipse&gt;</tt>
 
@@ -36,36 +61,42 @@ prawn-svg does not support the full SVG specification.  It currently supports:
    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>size</tt>, <tt>text-anchor</tt>, <tt>font-family</tt>, <tt>font-weight</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>
 
  - <tt>&lt;use&gt;</tt>
 
- - <tt>&lt;style&gt;</tt>, if css_parser gem is installed on the system (see CSS section below)
+ - <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>
 
- - 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>
+ - <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
+
+ - the <tt>preserveAspectRatio</tt> attribute on the <tt>&lt;svg&gt;</tt> and <tt>&lt;image&gt;</tt> tags
 
  - transform methods: <tt>translate</tt>, <tt>rotate</tt>, <tt>scale</tt>, <tt>matrix</tt>
 
  - colors: HTML standard names, <tt>#xxx</tt>, <tt>#xxxxxx</tt>, <tt>rgb(1, 2, 3)</tt>, <tt>rgb(1%, 2%, 3%)</tt>
 
- - measurements specified in <tt>pt</tt>, <tt>cm</tt>, <tt>dm</tt>, <tt>ft</tt>, <tt>in</tt>, <tt>m</tt>, <tt>mm</tt>, <tt>yd</tt>, <tt>%</tt>
+ - measurements specified in <tt>pt</tt>, <tt>cm</tt>, <tt>dm</tt>, <tt>ft</tt>, <tt>in</tt>, <tt>m</tt>, <tt>mm</tt>, <tt>yd</tt>, <tt>pc</tt>, <tt>%</tt>
 
- - fonts: generic CSS fonts, built in PDF fonts, and any TTF fonts in your fonts path
+ - fonts: generic CSS fonts, built-in PDF fonts, and any TTF fonts in your fonts path
 
 ## 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
 
-prawn-svg does not support external 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
 
@@ -75,7 +106,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::FontRegistry.font_path << "/my/font/directory"
 ```
 
 

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/color.rb

@@ -0,0 +1,5 @@
+module Prawn::SVG::Attributes::Color
+  def parse_color_attribute
+    state.color = attributes['color'] if attributes['color']
+  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 = document.font_registry.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 *= fill_opacity || 1
+      state.stroke_opacity *= 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/attributes.rb

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

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

@@ -0,0 +1,58 @@
+module Prawn::SVG::Calculators
+  class AspectRatio
+    attr_reader :align, :defer
+    attr_reader :width, :height, :x, :y
+
+    def initialize(value, container_dimensions, object_dimensions)
+      values = (value || "xMidYMid meet").strip.split(/\s+/)
+      @x = @y = 0
+
+      if values.first == "defer"
+        @defer = true
+        values.shift
+      end
+
+      @align, @meet_or_slice = values
+
+      w_container, h_container = container_dimensions
+      w_object,    h_object    = object_dimensions
+
+      container_ratio = w_container / h_container.to_f
+      object_ratio    = w_object / h_object.to_f
+
+      if @align == "none"
+        @width, @height = container_dimensions
+      else
+        matches = @align.to_s.strip.match(/\Ax(Min|Mid|Max)Y(Min|Mid|Max)\z/i) || [nil, "Mid", "Mid"]
+
+        if (container_ratio > object_ratio) == slice?
+          @width, @height = [w_container, w_container / object_ratio]
+          @y = case matches[2].downcase
+               when "min" then 0
+               when "mid" then (h_container - w_container/object_ratio)/2
+               when "max" then h_container - w_container/object_ratio
+               end
+        else
+          @width, @height = [h_container * object_ratio, h_container]
+          @x = case matches[1].downcase
+               when "min" then 0
+               when "mid" then (w_container - h_container*object_ratio)/2
+               when "max" then w_container - h_container*object_ratio
+               end
+        end
+      end
+    end
+
+    def slice?
+      @meet_or_slice == "slice"
+    end
+
+    def meet?
+      @meet_or_slice != "slice"
+    end
+
+    def inspect
+      "[AspectRatio: #{@width},#{@height} offset #{@x},#{@y}]"
+    end
+  end
+end

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

@@ -0,0 +1,99 @@
+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_reader :bounds
+    attr_reader :x_offset, :y_offset, :x_scale, :y_scale
+    attr_reader :viewport_width, :viewport_height, :viewport_diagonal, :output_width, :output_height
+
+    def initialize(bounds, attributes = nil)
+      @bounds = bounds
+      set_from_attributes(attributes) if attributes
+    end
+
+    def set_from_attributes(attributes)
+      @document_width = attributes['width']
+      @document_height = attributes['height']
+      @view_box = attributes['viewBox']
+      @preserve_aspect_ratio = attributes['preserveAspectRatio'] || DEFAULT_ASPECT_RATIO
+    end
+
+    def calculate
+      @x_offset = @y_offset = 0
+      @x_scale = @y_scale = 1
+
+      container_width = @requested_width || @bounds[0]
+      container_height = @requested_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(Prawn::SVG::Elements::COMMA_WSP_REGEXP)
+        @x_offset, @y_offset, @viewport_width, @viewport_height = values.map {|value| value.to_f}
+        @x_offset = -@x_offset
+
+        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
+
+      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 / @output_width
+        @output_width = @requested_width
+        @output_height *= scale
+        @x_scale *= scale
+        @y_scale *= scale
+
+      elsif @requested_height
+        scale = @requested_height / @output_height
+        @output_height = @requested_height
+        @output_width *= scale
+        @x_scale *= scale
+        @y_scale *= scale
+      end
+
+      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/calculators/pixels.rb

@@ -0,0 +1,21 @@
+module Prawn::SVG::Calculators
+  class Pixels
+    extend Prawn::Measurements
+
+    def self.to_pixels(value, axis_length)
+      if value.is_a?(String)
+        if match = value.match(/\d(cm|dm|ft|in|m|mm|yd)$/)
+          send("#{match[1]}2pt", value.to_f)
+        elsif match = value.match(/\dpc$/)
+          value.to_f * 15 # according to http://www.w3.org/TR/SVG11/coords.html
+        elsif value[-1..-1] == "%"
+          value.to_f * axis_length / 100.0
+        else
+          value.to_f
+        end
+      elsif value
+        value.to_f
+      end
+    end
+  end
+end