prawn-svg 0.15.0.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61181b453d5e28bba30c87c430975b21e5e9876d
-  data.tar.gz: c1c1d6ec4e6bb4d60af290a836ed25574dbca760
+  metadata.gz: dcccb8c6d35a2f33debf7f17d04dc1a8b3099398
+  data.tar.gz: 3ac53d2c35c41f1de03582e46175a9bf296a6cd0
 SHA512:
-  metadata.gz: 766a6cb2dc207b26e433509f1dbdce22055106c05806ff327f4203dc478d6ecfe99308502f2b1964c442d8ac2ecba1df5739593144ff2328e3c5e94aad74d440
-  data.tar.gz: 2281ec02f05246f40f4c68497d23f34da10b51ba16c60e76bd1e6d2467b0e1d80326ff76cc05aa244b794784be855f2996ceeeb6ce28465ffcecf66bee469b50
+  metadata.gz: ea4c6fb099669924881a72e4d983a5b890a4e74d38eb5bc7e1173223485acc35a69b0dabf95c41329bc1c254a6be53771d98f5e13fcf5d5c118c2fa1b2bd85ce
+  data.tar.gz: d3440e0c86365ad251beec2011f1f243dfc35e24ee82af3684c925e2e9c08d4b44e416e366cbd036343908241567cfd75878929bc5ce98fa9e4f81cdde963317

data/README.md

@@ -6,6 +6,8 @@ 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 1.x and 2.x series.
+
 ## Using prawn-svg
 
 ```ruby
@@ -14,10 +16,13 @@ Prawn::Document.generate("svg.pdf") do
 end
 ```
 
-<tt>:at</tt> must be specified.
+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.
 
-<tt>:width</tt>, <tt>:height</tt>, or neither may be specified; if neither is present,
-the resolution specified in the SVG will be used.
+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.
 
 <tt>:cache_images</tt>, if set to true, will cache images per document based on their URL.
 
@@ -26,7 +31,7 @@ If this value is set to <tt>nil</tt>, prawn-svg will ignore a request for an unk
 
 ## 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 +41,39 @@ 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>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;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>
+ - 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, gradients/patterns or markers.
 
 ## Configuration
 

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,75 @@
+module Prawn::Svg::Calculators
+  class DocumentSizing
+    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
+    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']
+    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"
+
+      width ||= @bounds[0]
+      height ||= @bounds[1]
+
+      if @view_box
+        values = @view_box.strip.split(/\s+/)
+        @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
+      end
+
+      @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
+        height *= scale
+        @x_scale *= scale
+        @y_scale *= scale
+
+      elsif @requested_height
+        scale = @requested_height / height
+        height = @requested_height
+        width *= scale
+        @x_scale *= scale
+        @y_scale *= scale
+      end
+
+      @output_width = width
+      @output_height = height
+
+      self
+    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

data/lib/prawn/svg/document.rb

@@ -1,6 +1,4 @@
 class Prawn::Svg::Document
-  include Prawn::Measurements
-
   begin
     require 'css_parser'
     CSS_PARSER_LOADED = true
@@ -8,18 +6,14 @@ class Prawn::Svg::Document
     CSS_PARSER_LOADED = false
   end
 
-  DEFAULT_WIDTH  = 640
-  DEFAULT_HEIGHT = 480
   DEFAULT_FALLBACK_FONT_NAME = "Times-Roman"
 
   # An +Array+ of warnings that occurred while parsing the SVG data.
   attr_reader :warnings
-
-  # The scaling factor, as determined by the :width or :height options.
-  attr_accessor :scale
+  attr_writer :url_cache
 
   attr_reader :root,
-    :actual_width, :actual_height, :width, :height, :x_offset, :y_offset,
+    :sizing,
     :cache_images, :fallback_font_name,
     :css_parser, :elements_by_id
 
@@ -32,55 +26,34 @@ class Prawn::Svg::Document
     @elements_by_id = {}
     @cache_images = options[:cache_images]
     @fallback_font_name = options.fetch(:fallback_font_name, DEFAULT_FALLBACK_FONT_NAME)
-    @actual_width, @actual_height = bounds # set this first so % width/heights can be used
 
-    if vb = @root.attributes['viewBox']
-      x1, y1, x2, y2 = vb.strip.split(/\s+/)
-      @x_offset, @y_offset = [x1.to_f, y1.to_f]
-      @actual_width, @actual_height = [x2.to_f - x1.to_f, y2.to_f - y1.to_f]
-    else
-      @x_offset, @y_offset = [0, 0]
-      @actual_width = points(@root.attributes['width'] || DEFAULT_WIDTH, :x)
-      @actual_height = points(@root.attributes['height'] || DEFAULT_HEIGHT, :y)
-    end
+    @sizing = Prawn::Svg::Calculators::DocumentSizing.new(bounds, @root.attributes)
+    sizing.requested_width = options[:width]
+    sizing.requested_height = options[:height]
+    sizing.calculate
 
-    if @options[:width]
-      @width = @options[:width]
-      @scale = @options[:width] / @actual_width.to_f
-    elsif @options[:height]
-      @height = @options[:height]
-      @scale = @options[:height] / @actual_height.to_f
-    else
-      @scale = 1
-    end
+    @axis_to_size = {:x => sizing.viewport_width, :y => sizing.viewport_height}
 
-    @width ||= @actual_width * @scale
-    @height ||= @actual_height * @scale
+    yield self if block_given?
   end
 
   def x(value)
-    (points(value, :x) - @x_offset) * scale
+    points(value, :x)
   end
 
   def y(value)
-    (@actual_height - (points(value, :y) - @y_offset)) * scale
+    sizing.output_height - points(value, :y)
   end
 
   def distance(value, axis = nil)
-    value && (points(value, axis) * scale)
+    value && points(value, axis)
   end
 
   def points(value, axis = nil)
-    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 value[-1..-1] == "%"
-        value.to_f * (axis == :y ? @actual_height : @actual_width) / 100.0
-      else
-        value.to_f
-      end
-    else
-      value.to_f
-    end
+    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/element.rb

@@ -55,14 +55,26 @@ 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)
+  end
 
-    if draw_types.length > 0 && !@state[:disable_drawing] && !Prawn::Svg::Parser::CONTAINER_TAGS.include?(element.name)
-      add_call_and_enter(draw_types.join("_and_"))
+  def apply_drawing_call(draw_types)
+    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_"))
+      end
     end
   end
 
+  def container?
+    Prawn::Svg::Parser::CONTAINER_TAGS.include?(name)
+  end
+
   def parse_transform_attribute_and_call
     return unless transform = @attributes['transform']
 
@@ -70,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}
@@ -90,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"
@@ -129,30 +141,58 @@ class Prawn::Svg::Element
   end
 
   def parse_fill_and_stroke_attributes_and_call
-    draw_types = []
-    [:fill, :stroke].each do |type|
-      dec = @attributes[type.to_s]
+    ["fill", "stroke"].select do |type|
+      dec = @attributes[type]
       if dec == "none"
-        state[type] = false
+        state[type.to_sym] = false
       elsif dec
-        state[type] = true
+        state[type.to_sym] = true
         if color = Prawn::Svg::Color.color_to_hex(dec)
           add_call "#{type}_color", color
         end
       end
 
-      draw_types << type.to_s if state[type]
+      state[type.to_sym]
     end
-    draw_types
   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
     if size = @attributes['font-size']
-      @state[:font_size] = size.to_f * @document.scale
+      @state[:font_size] = size.to_f
     end
     if weight = @attributes['font-weight']
       font_updated = true
@@ -184,6 +224,9 @@ class Prawn::Svg::Element
     end
   end
 
+  def parse_display_attribute
+    @state[:display] = @attributes['display'].strip if @attributes['display']
+  end
 
   def parse_css_method_calls(string)
     string.scan(/\s*(\w+)\(([^)]+)\)\s*/).collect do |call|
@@ -218,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)
@@ -228,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/extension.rb

@@ -14,10 +14,10 @@ module Prawn
       #
       #   svg IO.read("example.svg"), :at => [100, 300], :width => 600
       #
-      def svg(data, options={})
-        svg = Prawn::Svg::Interface.new(data, self, options)
+      def svg(data, options = {}, &block)
+        svg = Prawn::Svg::Interface.new(data, self, options, &block)
         svg.draw
-        {:warnings => svg.document.warnings, :width => svg.document.width, :height => svg.document.height}
+        {:warnings => svg.document.warnings, :width => svg.document.sizing.output_width, :height => svg.document.sizing.output_height}
       end
     end
   end