prawn-svg 0.21.0 → 0.22.1

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

@@ -0,0 +1,33 @@
+class Prawn::SVG::Elements::Rect < Prawn::SVG::Elements::Base
+  def parse
+    require_attributes 'width', 'height'
+
+    @x = x(attributes['x'] || '0')
+    @y = y(attributes['y'] || '0')
+    @width = distance(attributes['width'], :x)
+    @height = distance(attributes['height'], :y)
+
+    require_positive_value @width, @height
+
+    @radius = distance(attributes['rx'] || attributes['ry'])
+    if @radius
+      # If you implement separate rx and ry in the future, you'll want to change this
+      # so that rx is constrained to @width/2 and ry is constrained to @height/2.
+      max_value = [@width, @height].min / 2.0
+      @radius = clamp(@radius, 0, max_value)
+    end
+  end
+
+  def apply
+    if @radius
+      # n.b. does not support both rx and ry being specified with different values
+      add_call "rounded_rectangle", [@x, @y], @width, @height, @radius
+    else
+      add_call "rectangle", [@x, @y], @width, @height
+    end
+  end
+
+  def bounding_box
+    [@x, @y, @x + @width, @y - @height]
+  end
+end

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

@@ -0,0 +1,9 @@
+class Prawn::SVG::Elements::Root < Prawn::SVG::Elements::Base
+  def apply
+    add_call 'fill_color', '000000'
+    add_call 'transformation_matrix', @document.sizing.x_scale, 0, 0, @document.sizing.y_scale, 0, 0
+    add_call 'transformation_matrix', 1, 0, 0, 1, @document.sizing.x_offset, @document.sizing.y_offset
+
+    process_child_elements
+  end
+end

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

@@ -0,0 +1,10 @@
+class Prawn::SVG::Elements::Style < Prawn::SVG::Elements::Base
+  def parse
+    if @document.css_parser
+      data = source.texts.map(&:value).join
+      @document.css_parser.add_block!(data)
+    end
+
+    raise SkipElementQuietly
+  end
+end

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

@@ -0,0 +1,87 @@
+class Prawn::SVG::Elements::Text < Prawn::SVG::Elements::Base
+  def parse
+    case attributes['xml:space']
+    when 'preserve'
+      state[:preserve_space] = true
+    when 'default'
+      state[:preserve_space] = false
+    end
+
+    @relative = state[:text_relative] || false
+
+    if attributes['x'] || attributes['y']
+      @relative = false
+      @x_positions = attributes['x'].split(COMMA_WSP_REGEXP).collect {|n| document.x(n)} if attributes['x']
+      @y_positions = attributes['y'].split(COMMA_WSP_REGEXP).collect {|n| document.y(n)} if attributes['y']
+    end
+
+    @x_positions ||= state[:text_x_positions] || [document.x(0)]
+    @y_positions ||= state[:text_y_positions] || [document.y(0)]
+  end
+
+  def apply
+    raise SkipElementQuietly if state[:display] == "none"
+
+    add_call_and_enter "text_group" if name == 'text'
+
+    if attributes['dx'] || attributes['dy']
+      add_call_and_enter "translate", document.distance(attributes['dx'] || 0), -document.distance(attributes['dy'] || 0)
+    end
+
+    opts = {}
+    if size = state[:font_size]
+      opts[:size] = size
+    end
+    opts[:style] = state[:font_subfamily]
+
+    # This is not a prawn option but we can't work out how to render it here -
+    # it's handled by SVG#rewrite_call_arguments
+    if (anchor = attributes['text-anchor'] || state[:text_anchor]) &&
+        ['start', 'middle', 'end'].include?(anchor)
+      opts[:text_anchor] = anchor
+    end
+
+    if spacing = attributes['letter-spacing']
+      add_call_and_enter 'character_spacing', document.points(spacing)
+    end
+
+    source.children.each do |child|
+      if child.node_type == :text
+        text = child.value.strip.gsub(state[:preserve_space] ? /[\n\t]/ : /\s+/, " ")
+
+        while text != ""
+          opts[:at] = [@x_positions.first, @y_positions.first]
+
+          if @x_positions.length > 1 || @y_positions.length > 1
+            # TODO : isn't this just text.shift ?
+            add_call 'draw_text', text[0..0], opts.dup
+            text = text[1..-1]
+
+            @x_positions.shift if @x_positions.length > 1
+            @y_positions.shift if @y_positions.length > 1
+          else
+            add_call @relative ? 'relative_draw_text' : 'draw_text', text, opts.dup
+            @relative = true
+            break
+          end
+        end
+
+      elsif child.name == "tspan"
+        add_call 'save'
+
+        new_state = state.dup
+        new_state[:text_x_positions] = @x_positions
+        new_state[:text_y_positions] = @y_positions
+        new_state[:text_relative] = @relative
+        new_state[:text_anchor] = opts[:text_anchor]
+
+        Prawn::SVG::Elements::Text.new(document, child, calls, new_state).process
+
+        add_call 'restore'
+
+      else
+        warnings << "Unknown tag '#{child.name}' inside text tag; ignoring"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+class Prawn::SVG::Elements::Use < Prawn::SVG::Elements::Base
+  def parse
+    require_attributes 'xlink:href'
+
+    href = attributes['xlink:href']
+
+    if href[0..0] != '#'
+      raise SkipElementError, "use tag has an href that is not a reference to an id; this is not supported"
+    end
+
+    id = href[1..-1]
+    @definition_element = @document.elements_by_id[id]
+
+    if @definition_element.nil?
+      raise SkipElementError, "no tag with ID '#{id}' was found, referenced by use tag"
+    end
+
+    @x = attributes['x']
+    @y = attributes['y']
+  end
+
+  def apply
+    if @x || @y
+      add_call_and_enter "translate", distance(@x || 0, :x), -distance(@y || 0, :y)
+    end
+
+    add_calls_from_element @definition_element
+  end
+end

data/lib/prawn/svg/extension.rb

@@ -1,5 +1,5 @@
 module Prawn
-  module Svg
+  module SVG
     module Extension
       #
       # Draws an SVG document into the PDF.
@@ -15,7 +15,7 @@ module Prawn
       #   svg IO.read("example.svg"), :at => [100, 300], :width => 600
       #
       def svg(data, options = {}, &block)
-        svg = Prawn::Svg::Interface.new(data, self, options, &block)
+        svg = Prawn::SVG::Interface.new(data, self, options, &block)
         svg.draw
         {:warnings => svg.document.warnings, :width => svg.document.sizing.output_width, :height => svg.document.sizing.output_height}
       end

data/lib/prawn/svg/font.rb

@@ -1,4 +1,4 @@
-class Prawn::Svg::Font
+class Prawn::SVG::Font
   GENERIC_CSS_FONT_MAPPING = {
     "serif"      => "Times-Roman",
     "sans-serif" => "Helvetica",
@@ -34,12 +34,12 @@ class Prawn::Svg::Font
   # This method is passed prawn's font_families hash.  It'll be pre-populated with the fonts that prawn natively
   # supports.  We'll add fonts we find in the font path to this hash.
   def self.load_external_fonts(fonts)
-    Prawn::Svg::Interface.font_path.uniq.collect {|path| Dir["#{path}/**/*"]}.flatten.each do |filename|
+    Prawn::SVG::Interface.font_path.uniq.collect {|path| Dir["#{path}/**/*"]}.flatten.each do |filename|
       information = font_information(filename) rescue nil
       if information && font_name = (information[16] || information[1])
         subfamily = (information[17] || information[2] || "normal").gsub(/\s+/, "_").downcase.to_sym
         subfamily = :normal if subfamily == :regular
-        (fonts[font_name] ||= {})[subfamily] = filename
+        (fonts[font_name] ||= {})[subfamily] ||= filename
       end
     end
 

data/lib/prawn/svg/interface.rb

@@ -1,9 +1,9 @@
 #
-# Prawn::Svg::Interface makes a Prawn::Svg::Document instance, uses that object to parse the supplied
+# Prawn::SVG::Interface makes a Prawn::SVG::Document instance, uses that object to parse the supplied
 # SVG into Prawn-compatible method calls, and then calls the Prawn methods.
 #
 module Prawn
-  module Svg
+  module SVG
     class Interface
       VALID_OPTIONS = [:at, :position, :vposition, :width, :height, :cache_images, :fallback_font_name]
 
@@ -17,7 +17,7 @@ module Prawn
       attr_reader :data, :prawn, :document, :options
 
       #
-      # Creates a Prawn::Svg object.
+      # Creates a Prawn::SVG object.
       #
       # +data+ is the SVG data to convert.  +prawn+ is your Prawn::Document object.
       #
@@ -40,7 +40,7 @@ module Prawn
         @prawn = prawn
         @options = options
 
-        Prawn::Svg::Font.load_external_fonts(prawn.font_families)
+        Prawn::SVG::Font.load_external_fonts(prawn.font_families)
 
         @document = Document.new(data, [prawn.bounds.width, prawn.bounds.height], options, &block)
       end
@@ -54,10 +54,17 @@ module Prawn
           return
         end
 
+        @document.warnings.clear
+
         prawn.bounding_box(position, :width => @document.sizing.output_width, :height => @document.sizing.output_height) do
           prawn.save_graphics_state do
             clip_rectangle 0, 0, @document.sizing.output_width, @document.sizing.output_height
-            proc_creator(prawn, Parser.new(@document).parse).call
+
+            calls = []
+            root_element = Prawn::SVG::Elements::Root.new(@document, @document.root, calls, fill: true)
+            root_element.process
+
+            proc_creator(prawn, calls).call
           end
         end
       end

data/lib/prawn/svg/url_loader.rb

@@ -1,7 +1,7 @@
 require 'open-uri'
 require 'base64'
 
-class Prawn::Svg::UrlLoader
+class Prawn::SVG::UrlLoader
   attr_accessor :enable_cache, :enable_web
   attr_reader :url_cache
 

data/lib/prawn/svg/version.rb

@@ -1,5 +1,5 @@
 module Prawn
-  module Svg
-    VERSION = '0.21.0'
+  module SVG
+    VERSION = '0.22.1'
   end
 end

data/prawn-svg.gemspec

@@ -3,7 +3,7 @@ require File.expand_path('../lib/prawn/svg/version', __FILE__)
 
 spec = Gem::Specification.new do |gem|
   gem.name = 'prawn-svg'
-  gem.version = Prawn::Svg::VERSION
+  gem.version = Prawn::SVG::VERSION
   gem.summary = "SVG renderer for Prawn PDF library"
   gem.description = "This gem allows you to render SVG directly into a PDF using the 'prawn' gem.  Since PDF is vector-based, you'll get nice scaled graphics if you use SVG instead of an image."
   gem.has_rdoc = false
@@ -18,9 +18,9 @@ spec = Gem::Specification.new do |gem|
   gem.name          = "prawn-svg"
   gem.require_paths = ["lib"]
 
-  gem.required_ruby_version = '>= 1.9.3'
+  gem.required_ruby_version = '>= 2.0.0'
 
-  gem.add_runtime_dependency "prawn", ">= 0.8.4", "< 3"
+  gem.add_runtime_dependency "prawn", ">= 0.11.1", "< 3"
   gem.add_runtime_dependency "css_parser", "~> 1.3"
   gem.add_development_dependency "rspec", "~> 3.0"
   gem.add_development_dependency "rake", "~> 10.1"

data/spec/integration_spec.rb

@@ -1,8 +1,65 @@
 require 'spec_helper'
 
-describe Prawn::Svg::Interface do
+describe "Integration test" do
   root = "#{File.dirname(__FILE__)}/.."
 
+  describe "a basic SVG file" do
+    let(:document) { Prawn::SVG::Document.new(svg, [800, 600], {}) }
+    let(:element) { Prawn::SVG::Elements::Root.new(document, document.root, [], {}) }
+
+    let(:svg) do
+      <<-SVG
+<svg width="100" height="200">
+  <style><![CDATA[
+    #puppy  { fill: red; }
+    .animal { fill: green; }
+    rect    { fill: blue; }
+  ]]></style>
+
+  <rect x="0" y="0" width="10" height="10"/>
+  <rect x="10" y="0" width="10" height="10" class="animal"/>
+  <rect x="20" y="0" width="10" height="10" class="animal" id="puppy"/>
+  <rect x="30" y="0" width="10" height="10" class="animal" id="puppy" style="fill: yellow;"/>
+</svg>
+      SVG
+    end
+
+    it "is correctly converted to a call stack" do
+      element.process
+
+      expect(element.calls).to eq [
+        ["fill_color", ["000000"], []],
+        ["transformation_matrix", [1, 0, 0, 1, 0, 0], []],
+        ["transformation_matrix", [1, 0, 0, 1, 0, 0], []],
+        ["save", [], []], ["restore", [], []],
+        ["save", [], []],
+        ["fill_color", ["0000ff"], []],
+        ["fill", [], [
+          ["rectangle", [[0.0, 200.0], 10.0, 10.0], []]
+        ]],
+        ["restore", [], []],
+        ["save", [], []],
+        ["fill_color", ["008000"], []],
+        ["fill", [], [
+          ["rectangle", [[10.0, 200.0], 10.0, 10.0], []]
+        ]],
+        ["restore", [], []],
+        ["save", [], []],
+        ["fill_color", ["ff0000"], []],
+        ["fill", [], [
+          ["rectangle", [[20.0, 200.0], 10.0, 10.0], []]
+        ]],
+        ["restore", [], []],
+        ["save", [], []],
+        ["fill_color", ["ffff00"], []],
+        ["fill", [], [
+          ["rectangle", [[30.0, 200.0], 10.0, 10.0], []]
+        ]],
+        ["restore", [], []]
+      ]
+    end
+  end
+
   context "with option :position" do
     let(:svg) { IO.read("#{root}/spec/sample_svg/cubic01a.svg") }
 
@@ -51,7 +108,7 @@ describe Prawn::Svg::Interface do
             doc.url_loader.url_cache["https://raw.githubusercontent.com/mogest/prawn-svg/master/spec/sample_images/mushroom-long.jpg"] = IO.read("#{root}/spec/sample_images/mushroom-long.jpg")
           end
 
-          warnings = r[:warnings].reject {|w| w =~ /Verdana/ && w =~ /is not a known font/ }
+          warnings = r[:warnings].reject {|w| w =~ /Verdana/ && w =~ /is not a known font/ || w =~ /render gradients$/}
         end
         warnings.should == []
       end

data/spec/prawn/svg/attributes/font_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Prawn::SVG::Attributes::Font do
+  class FontTestElement
+    include Prawn::SVG::Attributes::Font
+
+    attr_accessor :attributes, :warnings
+
+    def initialize
+      @state = {}
+      @warnings = []
+    end
+  end
+
+  let(:element) { FontTestElement.new }
+  let(:document) { double(fallback_font_name: "Times-Roman") }
+
+  before do
+    allow(element).to receive(:document).and_return(document)
+    element.attributes = {"font-family" => family}
+  end
+
+  describe "#parse_font_attributes_and_call" do
+    context "with a specified existing font" do
+      let(:family) { "Helvetica" }
+
+      it "uses a font if it can find it" do
+        expect(element).to receive(:add_call_and_enter).with("font", "Helvetica", style: :normal)
+        element.parse_font_attributes_and_call
+      end
+    end
+
+    context "with a specified non-existing font" do
+      let(:family) { "Font That Doesn't Exist" }
+
+      it "uses the fallback font if specified" do
+        expect(element).to receive(:add_call_and_enter).with("font", "Times-Roman", style: :normal)
+        element.parse_font_attributes_and_call
+      end
+
+      it "doesn't call the font method if there's no fallback font" do
+        allow(document).to receive(:fallback_font_name).and_return(nil)
+        expect(element).to_not receive(:add_call_and_enter)
+        element.parse_font_attributes_and_call
+        expect(element.warnings.length).to eq 1
+      end
+    end
+  end
+end

data/spec/prawn/svg/attributes/transform_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Prawn::SVG::Attributes::Transform do
+  class TransformTestElement
+    include Prawn::SVG::Attributes::Transform
+
+    attr_accessor :attributes, :warnings
+
+    def initialize
+      @warnings = []
+      @attributes = {}
+    end
+  end
+
+  let(:element) { TransformTestElement.new }
+
+  describe "#parse_transform_attribute_and_call" do
+    subject { element.send :parse_transform_attribute_and_call }
+
+    describe "translate" do
+      it "handles a missing y argument" do
+        expect(element).to receive(:add_call_and_enter).with('translate', -5.5, 0)
+        expect(element).to receive(:distance).with(-5.5, :x).and_return(-5.5)
+        expect(element).to receive(:distance).with(0.0, :y).and_return(0.0)
+
+        element.attributes['transform'] = 'translate(-5.5)'
+        subject
+      end
+    end
+
+    describe "rotate" do
+      it "handles a single angle argument" do
+        expect(element).to receive(:add_call_and_enter).with('rotate', -5.5, :origin => [0, 0])
+        expect(element).to receive(:y).with('0').and_return(0)
+
+        element.attributes['transform'] = 'rotate(5.5)'
+        subject
+      end
+
+      it "handles three arguments" do
+        expect(element).to receive(:add_call_and_enter).with('rotate', -5.5, :origin => [1.0, 2.0])
+        expect(element).to receive(:x).with(1.0).and_return(1.0)
+        expect(element).to receive(:y).with(2.0).and_return(2.0)
+
+        element.attributes['transform'] = 'rotate(5.5 1 2)'
+        subject
+      end
+
+      it "does nothing and warns if two arguments" do
+        expect(element).to receive(:warnings).and_return([])
+        element.attributes['transform'] = 'rotate(5.5 1)'
+        subject
+      end
+    end
+  end
+end