prawn-svg 0.15.0.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61181b453d5e28bba30c87c430975b21e5e9876d
-  data.tar.gz: c1c1d6ec4e6bb4d60af290a836ed25574dbca760
+  metadata.gz: 2d7cbba75e8c3a5128d1c5136977b4b91d091407
+  data.tar.gz: e1996ddcb667032eae7777fea1decb58b470a600
 SHA512:
-  metadata.gz: 766a6cb2dc207b26e433509f1dbdce22055106c05806ff327f4203dc478d6ecfe99308502f2b1964c442d8ac2ecba1df5739593144ff2328e3c5e94aad74d440
-  data.tar.gz: 2281ec02f05246f40f4c68497d23f34da10b51ba16c60e76bd1e6d2467b0e1d80326ff76cc05aa244b794784be855f2996ceeeb6ce28465ffcecf66bee469b50
+  metadata.gz: 3fc7f25cb50723695bcb95485daad73b89e158662f5c0af06f10a062395d8c903b8bea7447c7dca2b4ed15c58bcbcc8115e3dc564b62ae8b6b22af62d2907f9b
+  data.tar.gz: 312b2b093fec372fa444c61175b843592cac404c233f54cd3ec156ea85f4615337b5e8d7bb1372819c457df9476fca1ece3fbefff41a3415ae733676e92706c6

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 version 1.0 series.
+
 ## Using prawn-svg
 
 ```ruby
@@ -16,8 +18,9 @@ end
 
 <tt>:at</tt> must be specified.
 
-<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.
 
@@ -50,11 +53,15 @@ 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>
 
+ - 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
 

data/lib/prawn-svg.rb

@@ -1,6 +1,10 @@
 require 'prawn'
 require 'prawn/svg/version'
 
+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/color'
 require 'prawn/svg/extension'
 require 'prawn/svg/interface'

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,71 @@
+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 :x_offset, :y_offset, :x_scale, :y_scale
+    attr_reader :viewport_width, :viewport_height, :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
+
+      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,32 @@ 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
 
-    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
+    @sizing = Prawn::Svg::Calculators::DocumentSizing.new(bounds, @root.attributes)
+    sizing.requested_width = options[:width]
+    sizing.requested_height = options[:height]
+    sizing.calculate
 
-    @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 == :y ? sizing.viewport_height : sizing.viewport_width)
+  end
+
+  def url_loader
+    @url_loader ||= Prawn::Svg::UrlLoader.new(:enable_cache => cache_images)
   end
 end

data/lib/prawn/svg/element.rb

@@ -57,12 +57,23 @@ class Prawn::Svg::Element
     draw_types = parse_fill_and_stroke_attributes_and_call
     parse_stroke_width_attribute_and_call
     parse_font_attributes_and_call
+    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?
+        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']
 
@@ -129,21 +140,19 @@ 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
@@ -152,7 +161,7 @@ class Prawn::Svg::Element
 
   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

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

data/lib/prawn/svg/interface.rb

@@ -24,7 +24,7 @@ module Prawn
       # +options+ can optionally contain the key :width or :height.  If both are
       # specified, only :width will be used.
       #
-      def initialize(data, prawn, options)
+      def initialize(data, prawn, options, &block)
         @data = data
         @prawn = prawn
         @options = options
@@ -33,16 +33,16 @@ module Prawn
 
         Prawn::Svg::Font.load_external_fonts(prawn.font_families)
 
-        @document = Document.new(data, [prawn.bounds.width, prawn.bounds.height], options)
+        @document = Document.new(data, [prawn.bounds.width, prawn.bounds.height], options, &block)
       end
 
       #
       # Draws the SVG to the Prawn::Document object.
       #
       def draw
-        prawn.bounding_box(@options[:at], :width => @document.width, :height => @document.height) do
+        prawn.bounding_box(@options[:at], :width => @document.sizing.output_width, :height => @document.sizing.output_height) do
           prawn.save_graphics_state do
-            clip_rectangle 0, 0, @document.width, @document.height
+            clip_rectangle 0, 0, @document.sizing.output_width, @document.sizing.output_height
             proc_creator(prawn, Parser.new(@document).parse).call
           end
         end
@@ -56,14 +56,18 @@ module Prawn
 
       def issue_prawn_command(prawn, calls)
         calls.each do |call, arguments, children|
-          if rewrite_call_arguments(prawn, call, arguments) == false
+          if call == "end_path"
             issue_prawn_command(prawn, children) if children.any?
+            prawn.add_content "n" # end path
+
+          elsif rewrite_call_arguments(prawn, call, arguments) == false
+            issue_prawn_command(prawn, children) if children.any?
+
+          elsif children.empty?
+            prawn.send(call, *arguments)
+
           else
-            if children.empty?
-              prawn.send(call, *arguments)
-            else
-              prawn.send(call, *arguments, &proc_creator(prawn, children))
-            end
+            prawn.send(call, *arguments, &proc_creator(prawn, children))
           end
         end
       end

data/lib/prawn/svg/parser.rb

@@ -42,6 +42,19 @@ class Prawn::Svg::Parser
     @document.warnings.clear
 
     calls = [['fill_color', '000000', []]]
+
+    calls << [
+      'transformation_matrix',
+      [@document.sizing.x_scale, 0, 0, @document.sizing.y_scale, 0, 0],
+      []
+    ]
+
+    calls << [
+      'transformation_matrix',
+      [1, 0, 0, 1, @document.sizing.x_offset, @document.sizing.y_offset],
+      []
+    ]
+
     root_element = Prawn::Svg::Element.new(@document, @document.root, calls, :ids => {}, :fill => true)
 
     parse_element(root_element)