prawn-svg 0.22.1 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d93ba261ddc059e43122549f72a3e3daa676171f
-  data.tar.gz: d0497cb84295f9202f84c62b5db79f9d29608019
+  metadata.gz: 0455251b1d5e7c430660f51c4843d26adb8d9913
+  data.tar.gz: caf87db1d427b7b528b5ae09b826b4dddec7a8a0
 SHA512:
-  metadata.gz: acf2f6d51a5fda648bed5efd25ba85de91887867badccde3ce4d713cebddcc851280d524ba3006d7014651cd73ccf8c5a54185038a41dfa37612b522cb99ea17
-  data.tar.gz: 2dc23eac65fc5be3299015309d8e2f94d5598ba016f7776090f886fe9bd4551ae90bd129252428b65b617bf8472ca4adcf9cdc5760f3e5f3f635793415d09622
+  metadata.gz: e1068767350107317ce264382ead9432a8ca98118d82301a402ef5fb50f6da65bdc2f547101955911cd24cf291745dd3f7b55f51d2374c96b9442673833df638
+  data.tar.gz: 47b83cd0def9edaec474ec458fa01831801abefadeebe797840b64bd7b3b2f38ff869e135893bb16a9f23b6a9fea28ab46c9f843775fa1c3f72bcd11964d8b33

data/README.md

@@ -7,7 +7,7 @@ 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.
@@ -15,23 +15,39 @@ 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
 ```
 
-Supply <tt>:at</tt> if you want to render it at a specific location on the page.
-Use <tt>:position</tt> with a value of <tt>:left</tt>, <tt>:center</tt>, <tt>:right</tt> or a number to render it at the current cursor position, or use <tt>:vposition</tt> with a value
-of <tt>:top</tt>, <tt>:center</tt>, <tt>:bottom</tt> or a number to specify its Y position too.
+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:
 
-Either <tt>:width</tt>, <tt>:height</tt>, or neither may be specified; if neither is present,
-the dimensions specified in the SVG will be used, or if the dimensions aren't specified, it'll
-fit to the space available on the page.
+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
 
@@ -90,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.rb

@@ -3,17 +3,24 @@ require 'rexml/document'
 require 'prawn'
 require 'prawn/svg/version'
 
+require 'prawn/svg/font_registry'
 require 'prawn/svg/calculators/aspect_ratio'
 require 'prawn/svg/calculators/document_sizing'
 require 'prawn/svg/calculators/pixels'
 require 'prawn/svg/url_loader'
+require 'prawn/svg/loaders/data'
+require 'prawn/svg/loaders/file'
+require 'prawn/svg/loaders/web'
 require 'prawn/svg/color'
 require 'prawn/svg/attributes'
 require 'prawn/svg/elements'
 require 'prawn/svg/extension'
 require 'prawn/svg/interface'
+require 'prawn/svg/css'
+require 'prawn/svg/ttf'
 require 'prawn/svg/font'
 require 'prawn/svg/document'
+require 'prawn/svg/state'
 
 module Prawn
   Svg = SVG # backwards compatibility

data/lib/prawn/svg/attributes.rb

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

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

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

@@ -1,37 +1,37 @@
 module Prawn::SVG::Attributes::Font
   def parse_font_attributes_and_call
     if size = attributes['font-size']
-      @state[:font_size] = size.to_f
+      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)
+      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
+      state.font_style = style == 'italic' ? :italic : nil
     end
     if (family = attributes['font-family']) && family.strip != ""
       font_updated = true
-      @state[:font_family] = family
+      state.font_family = family
     end
     if (anchor = attributes['text-anchor'])
-      @state[:text_anchor] = anchor
+      state.text_anchor = anchor
     end
 
-    if @state[:font_family] && font_updated
-      usable_font_families = [@state[:font_family], document.fallback_font_name]
+    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]
+        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."
+        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

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

@@ -6,10 +6,10 @@ module Prawn::SVG::Attributes::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)
+      state.fill_opacity *= fill_opacity || 1
+      state.stroke_opacity *= stroke_opacity || 1
 
-      add_call_and_enter 'transparent', state[:fill_opacity], state[:stroke_opacity]
+      add_call_and_enter 'transparent', state.fill_opacity, state.stroke_opacity
     end
   end
 end

data/lib/prawn/svg/css.rb

@@ -0,0 +1,40 @@
+class Prawn::SVG::CSS
+  class << self
+    def parse_font_family_string(string)
+      in_quote = nil
+      in_escape = false
+      current = nil
+      fonts = []
+
+      string.chars.each do |char|
+        if in_escape
+          in_escape = false
+          if current.nil?
+            current = char
+            fonts << current
+          else
+            current << char
+          end
+        elsif char == ',' && in_quote.nil?
+          current = nil
+        elsif char == in_quote
+          in_quote = nil
+        elsif in_quote.nil? && (char == '"' || char == "'")
+          in_quote = char
+        elsif char == '\\'
+          in_escape = true
+        elsif current.nil?
+          if char.match(/\s/).nil?
+            current = char
+            fonts << current
+          end
+        else
+          current << char
+        end
+      end
+
+      fonts.map(&:rstrip)
+    end
+  end
+end
+

data/lib/prawn/svg/document.rb

@@ -1,4 +1,7 @@
 class Prawn::SVG::Document
+  Error = Class.new(StandardError)
+  InvalidSVGData = Class.new(Error)
+
   begin
     require 'css_parser'
     CSS_PARSER_LOADED = true
@@ -10,23 +13,39 @@ class Prawn::SVG::Document
 
   # An +Array+ of warnings that occurred while parsing the SVG data.
   attr_reader :warnings
-  attr_writer :url_cache
 
   attr_reader :root,
     :sizing,
-    :cache_images, :fallback_font_name,
+    :fallback_font_name,
+    :font_registry,
+    :url_loader,
     :css_parser, :elements_by_id, :gradients
 
-  def initialize(data, bounds, options)
+  def initialize(data, bounds, options, font_registry: nil)
     @css_parser = CssParser::Parser.new if CSS_PARSER_LOADED
 
     @root = REXML::Document.new(data).root
+
+    if @root.nil?
+      if data.respond_to?(:end_with?) && data.end_with?(".svg")
+        raise InvalidSVGData, "The data supplied is not a valid SVG document.  It looks like you've supplied a filename instead; use IO.read(filename) to get the data before you pass it to prawn-svg."
+      else
+        raise InvalidSVGData, "The data supplied is not a valid SVG document."
+      end
+    end
+
     @warnings = []
     @options = options
     @elements_by_id = {}
     @gradients = {}
-    @cache_images = options[:cache_images]
     @fallback_font_name = options.fetch(:fallback_font_name, DEFAULT_FALLBACK_FONT_NAME)
+    @font_registry = font_registry
+
+    @url_loader = Prawn::SVG::UrlLoader.new(
+      enable_cache:          options[:cache_images],
+      enable_web:            options.fetch(:enable_web_requests, true),
+      enable_file_with_root: options[:enable_file_requests_with_root]
+    )
 
     @sizing = Prawn::SVG::Calculators::DocumentSizing.new(bounds, @root.attributes)
     sizing.requested_width = options[:width]
@@ -53,8 +72,4 @@ class Prawn::SVG::Document
   def points(value, axis = nil)
     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)
-  end
 end

data/lib/prawn/svg/elements/base.rb

@@ -7,6 +7,7 @@ class Prawn::SVG::Elements::Base
   include Prawn::SVG::Attributes::Stroke
   include Prawn::SVG::Attributes::Font
   include Prawn::SVG::Attributes::Display
+  include Prawn::SVG::Attributes::Color
 
   COMMA_WSP_REGEXP = Prawn::SVG::Elements::COMMA_WSP_REGEXP
 
@@ -33,6 +34,7 @@ class Prawn::SVG::Elements::Base
 
   def process
     combine_attributes_and_style_declarations
+    parse_standard_attributes
     parse
 
     apply_calls_from_standard_attributes
@@ -85,7 +87,7 @@ class Prawn::SVG::Elements::Base
       if element_class = Prawn::SVG::Elements::TAG_CLASS_MAPPING[elem.name.to_sym]
         add_call "save"
 
-        child = element_class.new(@document, elem, @calls, @state.dup)
+        child = element_class.new(@document, elem, @calls, state.dup)
         child.process
 
         add_call "restore"
@@ -107,8 +109,8 @@ class Prawn::SVG::Elements::Base
   end
 
   def apply_drawing_call(draw_types)
-    if !@state[:disable_drawing] && !container?
-      if draw_types.empty? || @state[:display] == "none"
+    if !state.disable_drawing && !container?
+      if draw_types.empty? || state.display == "none"
         add_call_and_enter("end_path")
       else
         add_call_and_enter(draw_types.join("_and_"))
@@ -116,30 +118,38 @@ class Prawn::SVG::Elements::Base
     end
   end
 
+  def parse_standard_attributes
+    parse_color_attribute
+  end
+
   def parse_fill_and_stroke_attributes_and_call
     ["fill", "stroke"].select do |type|
       case keyword = attribute_value_as_keyword(type)
       when nil
       when 'inherit'
       when 'none'
-        state[type.to_sym] = false
+        state.disable_draw_type(type)
       else
-        state[type.to_sym] = false
-        color_attribute = keyword == 'currentcolor' ? 'color' : type
-        color = @attributes[color_attribute]
+        state.disable_draw_type(type)
+
+        if keyword == 'currentcolor'
+          color = state.color
+        else
+          color = @attributes[type]
+        end
 
         results = Prawn::SVG::Color.parse(color, document.gradients)
 
         results.each do |result|
           case result
           when Prawn::SVG::Color::Hex
-            state[type.to_sym] = true
+            state.enable_draw_type(type)
             add_call "#{type}_color", result.value
             break
           when Prawn::SVG::Elements::Gradient
             arguments = result.gradient_arguments(self)
             if arguments
-              state[type.to_sym] = true
+              state.enable_draw_type(type)
               add_call "#{type}_gradient", **arguments
               break
             end
@@ -147,7 +157,7 @@ class Prawn::SVG::Elements::Base
         end
       end
 
-      state[type.to_sym]
+      state.draw_type(type)
     end
   end
 

data/lib/prawn/svg/elements/container.rb

@@ -1,6 +1,6 @@
 class Prawn::SVG::Elements::Container < Prawn::SVG::Elements::Base
   def parse
-    state[:disable_drawing] = true if name == "clipPath"
+    state.disable_drawing = true if name == "clipPath"
   end
 
   def apply

data/lib/prawn/svg/elements/gradient.rb

@@ -42,9 +42,12 @@ class Prawn::SVG::Elements::Gradient < Prawn::SVG::Elements::Base
   end
 
   def assert_compatible_prawn_version
-    if (Prawn::VERSION.split(".").map(&:to_i) <=> [2, 0, 4]) == -1
-      raise SkipElementError, "Prawn 2.0.4+ must be used if you'd like prawn-svg to render gradients"
-    end
+    # At the moment, the patch required for this functionality to work in prawn has not been merged.
+    raise SkipElementError, "We are unfortunately still waiting on the Prawn project to merge a pull request that is required for this feature to correctly function"
+
+#    if (Prawn::VERSION.split(".").map(&:to_i) <=> [2, 0, 4]) == -1
+#      raise SkipElementError, "Prawn 2.0.4+ must be used if you'd like prawn-svg to render gradients"
+#    end
   end
 
   def load_gradient_configuration
@@ -80,7 +83,7 @@ class Prawn::SVG::Elements::Gradient < Prawn::SVG::Elements::Base
 
   def load_stops
     stop_elements = source.elements.map do |child|
-      element = Prawn::SVG::Elements::Base.new(document, child, [], {})
+      element = Prawn::SVG::Elements::Base.new(document, child, [], Prawn::SVG::State.new)
       element.process
       element
     end.select do |element|

data/lib/prawn/svg/elements/image.rb

@@ -13,17 +13,13 @@ class Prawn::SVG::Elements::Image < Prawn::SVG::Elements::Base
   def parse
     require_attributes 'width', 'height'
 
-    raise SkipElementQuietly if state[:display] == "none"
+    raise SkipElementQuietly if state.display == "none"
 
     @url = attributes['xlink:href'] || attributes['href']
     if @url.nil?
       raise SkipElementError, "image tag must have an xlink:href"
     end
 
-    if !@document.url_loader.valid?(@url)
-      raise SkipElementError, "image tag xlink:href attribute must use http, https or data scheme"
-    end
-
     x = x(attributes['x'] || 0)
     y = y(attributes['y'] || 0)
     width = distance(attributes['width'])
@@ -34,7 +30,7 @@ class Prawn::SVG::Elements::Image < Prawn::SVG::Elements::Base
 
     @image = begin
       @document.url_loader.load(@url)
-    rescue => e
+    rescue Prawn::SVG::UrlLoader::Error => e
       raise SkipElementError, "Error retrieving URL #{@url}: #{e.message}"
     end