prawn-svg 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13276a5db1c1dd04e219c4e8082205e49dca13ad
-  data.tar.gz: fc5446141d6e7d6ef9f0a393f64bc975d26e453e
+  metadata.gz: dcccb8c6d35a2f33debf7f17d04dc1a8b3099398
+  data.tar.gz: 3ac53d2c35c41f1de03582e46175a9bf296a6cd0
 SHA512:
-  metadata.gz: 345b0a1c89e7bd4aad297bbcc398322ea7d72ca51a3ac13ea22fdfa62ed0c42ea60344940880f9c570e60f0d21b669e7b3f73ff3791aff16fef87c21c92181d6
-  data.tar.gz: 23391e2209dde7f293c12f4f36af60fc421bea3e05a74b6acd5249bb81c249b0f9bcd8f3c66898f696febf7102ac6157ab836d7d98c20764e0074d2544d6a5f3
+  metadata.gz: ea4c6fb099669924881a72e4d983a5b890a4e74d38eb5bc7e1173223485acc35a69b0dabf95c41329bc1c254a6be53771d98f5e13fcf5d5c118c2fa1b2bd85ce
+  data.tar.gz: d3440e0c86365ad251beec2011f1f243dfc35e24ee82af3684c925e2e9c08d4b44e416e366cbd036343908241567cfd75878929bc5ce98fa9e4f81cdde963317

data/README.md

@@ -16,7 +16,9 @@ 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.
 
 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
@@ -29,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>
 
@@ -39,21 +41,19 @@ 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>
-
- - attribute <tt>stroke-linecap</tt>, but only when <tt>fill="none"</tt> due to a PDF limitation
+ - 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
 
@@ -65,7 +65,7 @@ prawn-svg does not support the full SVG specification.  It currently supports:
 
  - 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
 
@@ -73,7 +73,7 @@ prawn-svg uses the css_parser gem to parse CSS <tt>&lt;style&gt;</tt> blocks.  I
 
 ## 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/document_sizing.rb

@@ -4,6 +4,7 @@ module Prawn::Svg::Calculators
     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
 

data/lib/prawn/svg/interface.rb

@@ -5,6 +5,8 @@
 module Prawn
   module Svg
     class Interface
+      VALID_OPTIONS = [:at, :position, :vposition, :width, :height, :cache_images, :fallback_font_name]
+
       DEFAULT_FONT_PATHS = ["/Library/Fonts", "/System/Library/Fonts", "#{ENV["HOME"]}/Library/Fonts", "/usr/share/fonts/truetype"]
 
       @font_path = []
@@ -19,18 +21,25 @@ module Prawn
       #
       # +data+ is the SVG data to convert.  +prawn+ is your Prawn::Document object.
       #
-      # +options+ must contain the key :at, which takes a tuple of x and y co-ordinates.
+      # Options:
+      # <tt>:at</tt>:: an array [x,y] specifying the location of the top-left corner of the SVG.
+      # <tt>:position</tt>::  one of (nil, :left, :center, :right) or an x-offset
+      # <tt>:vposition</tt>::  one of (nil, :top, :center, :bottom) or a y-offset
+      # <tt>:width</tt>:: the width that the SVG is to be rendered
+      # <tt>:height</tt>:: the height that the SVG is to be rendered
+      #
+      # If <tt>:at</tt> is provided, the SVG will be placed in the current page but
+      # the text position will not be changed.
       #
-      # +options+ can optionally contain the key :width or :height.  If both are
-      # specified, only :width will be used.
+      # If both <tt>:width</tt> and <tt>:height</tt> are specified, only the width will be used.
       #
       def initialize(data, prawn, options, &block)
+        Prawn.verify_options VALID_OPTIONS, options
+
         @data = data
         @prawn = prawn
         @options = options
 
-        @options[:at] or raise "options[:at] must be specified"
-
         Prawn::Svg::Font.load_external_fonts(prawn.font_families)
 
         @document = Document.new(data, [prawn.bounds.width, prawn.bounds.height], options, &block)
@@ -40,7 +49,7 @@ module Prawn
       # Draws the SVG to the Prawn::Document object.
       #
       def draw
-        prawn.bounding_box(@options[:at], :width => @document.sizing.output_width, :height => @document.sizing.output_height) do
+        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
@@ -48,8 +57,44 @@ module Prawn
         end
       end
 
+      def position
+        @options[:at] || [x_based_on_requested_alignment, y_based_on_requested_alignment]
+      end
 
       private
+
+      def x_based_on_requested_alignment
+        case options[:position]
+        when :left, nil
+          0
+        when :center, :centre
+          (@document.sizing.bounds[0] - @document.sizing.output_width) / 2.0
+        when :right
+          @document.sizing.bounds[0] - @document.sizing.output_width
+        when Numeric
+          options[:position]
+        else
+          raise ArgumentError, "options[:position] must be one of nil, :left, :right, :center or a number"
+        end
+      end
+
+      def y_based_on_requested_alignment
+        case options[:vposition]
+        when nil
+          prawn.cursor
+        when :top
+          @document.sizing.bounds[1]
+        when :center, :centre
+          @document.sizing.bounds[1] - (@document.sizing.bounds[1] - @document.sizing.output_height) / 2.0
+        when :bottom
+          @document.sizing.output_height
+        when Numeric
+          @document.sizing.bounds[1] - options[:vposition]
+        else
+          raise ArgumentError, "options[:vposition] must be one of nil, :top, :right, :bottom or a number"
+        end
+      end
+
       def proc_creator(prawn, calls)
         Proc.new {issue_prawn_command(prawn, calls)}
       end

data/lib/prawn/svg/version.rb

@@ -1,5 +1,5 @@
 module Prawn
   module Svg
-    VERSION = '0.18.0'
+    VERSION = '0.19.0'
   end
 end

data/spec/integration_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Prawn::Svg::Interface do
+  root = "#{File.dirname(__FILE__)}/.."
+
+  context "with option :position" do
+    let(:svg) { IO.read("#{root}/spec/sample_svg/cubic01a.svg") }
+
+    it "aligns the image as requested" do
+      Prawn::Document.generate("#{root}/spec/sample_output/_with_position.pdf") do |prawn|
+        width = prawn.bounds.width / 3
+
+        prawn.svg svg, :width => width, :position => :left
+        prawn.svg svg, :width => width, :position => :center
+        prawn.svg svg, :width => width, :position => :right
+        prawn.svg svg, :width => width, :position => 50
+        prawn.svg svg, :width => width
+      end
+    end
+  end
+
+  context "with option :vposition" do
+    let(:svg) { IO.read("#{root}/spec/sample_svg/cubic01a.svg") }
+
+    it "aligns the image as requested" do
+      Prawn::Document.generate("#{root}/spec/sample_output/_with_vposition.pdf") do |prawn|
+        width = prawn.bounds.width / 3
+
+        prawn.svg svg, :width => width, :position => :left, :vposition => :bottom
+        prawn.svg svg, :width => width, :position => :center, :vposition => :center
+        prawn.svg svg, :width => width, :position => :right, :vposition => :top
+        prawn.svg svg, :width => width, :position => 50, :vposition => 50
+      end
+    end
+  end
+
+  describe "sample file rendering" do
+    files = Dir["#{root}/spec/sample_svg/*.svg"]
+
+    it "has at least 10 SVG sample files to test" do
+      files.length.should >= 10
+    end
+
+    files.each do |file|
+      it "renders the #{File.basename file} sample file without warnings or crashing" do
+        warnings = nil
+        Prawn::Document.generate("#{root}/spec/sample_output/#{File.basename file}.pdf") do |prawn|
+          r = prawn.svg IO.read(file), :at => [0, prawn.bounds.top], :width => prawn.bounds.width do |doc|
+            doc.url_loader.enable_web = false
+            doc.url_loader.url_cache["https://raw.githubusercontent.com/mogest/prawn-svg/master/spec/sample_images/mushroom-wide.jpg"] = IO.read("#{root}/spec/sample_images/mushroom-wide.jpg")
+            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/ }
+        end
+        warnings.should == []
+      end
+    end
+  end
+
+  describe "multiple file rendering" do
+    it "renders multiple files on to the same PDF" do
+      Prawn::Document.generate("#{root}/spec/sample_output/_multiple.pdf") do |prawn|
+        width = prawn.bounds.width
+
+        y = prawn.bounds.top - 12
+        prawn.draw_text "This is multiple SVGs being output to the same PDF", :at => [0, y]
+
+        y -= 12
+        prawn.svg IO.read("#{root}/spec/sample_svg/arcs01.svg"),   :at => [0, y],         :width => width / 2
+        prawn.svg IO.read("#{root}/spec/sample_svg/circle01.svg"), :at => [width / 2, y], :width => width / 2
+
+        y -= 120
+        prawn.draw_text "Here are some more PDFs below", :at => [0, y]
+
+        y -= 12
+        prawn.svg IO.read("#{root}/spec/sample_svg/quad01.svg"), :at => [0, y],             :width => width / 3
+        prawn.svg IO.read("#{root}/spec/sample_svg/rect01.svg"), :at => [width / 3, y],     :width => width / 3
+        prawn.svg IO.read("#{root}/spec/sample_svg/rect02.svg"), :at => [width / 3 * 2, y], :width => width / 3
+      end
+    end
+  end
+end

data/spec/prawn/svg/interface_spec.rb

@@ -1,51 +1,58 @@
 require 'spec_helper'
 
 describe Prawn::Svg::Interface do
-  root = "#{File.dirname(__FILE__)}/../../.."
-
-  describe "sample file rendering" do
-    files = Dir["#{root}/spec/sample_svg/*.svg"]
+  let(:bounds) { double(width: 800, height: 600) }
+  let(:prawn)  { instance_double(Prawn::Document, font_families: {}, bounds: bounds, cursor: 600) }
+  let(:svg)    { '<svg width="250" height="100"></svg>' }
+
+  describe "#initialize" do
+    describe "invalid option detection" do
+      it "rejects invalid options when debug is on" do
+        allow(Prawn).to receive(:debug).and_return(true)
+
+        expect {
+          Prawn::Svg::Interface.new(svg, prawn, :invalid => "option")
+        }.to raise_error(Prawn::Errors::UnknownOption)
+      end
 
-    it "has at least 10 SVG sample files to test" do
-      files.length.should >= 10
+      it "does nothing if an invalid option is given and debug is off" do
+        Prawn::Svg::Interface.new(svg, prawn, :invalid => "option")
+      end
     end
+  end
+
+  describe "#position" do
+    context "when options[:at] supplied" do
+      it "returns options[:at]" do
+        interface = Prawn::Svg::Interface.new(svg, prawn, at: [1, 2], position: :left)
 
-    files.each do |file|
-      it "renders the #{File.basename file} sample file without warnings or crashing" do
-        warnings = nil
-        Prawn::Document.generate("#{root}/spec/sample_output/#{File.basename file}.pdf") do |prawn|
-          r = prawn.svg IO.read(file), :at => [0, prawn.bounds.top], :width => prawn.bounds.width do |doc|
-            doc.url_loader.enable_web = false
-            doc.url_loader.url_cache["https://raw.githubusercontent.com/mogest/prawn-svg/master/spec/sample_images/mushroom-wide.jpg"] = IO.read("#{root}/spec/sample_images/mushroom-wide.jpg")
-            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/ }
-        end
-        warnings.should == []
+        expect(interface.position).to eq [1, 2]
       end
     end
-  end
 
-  describe "multiple file rendering" do
-    it "renders multiple files on to the same PDF" do
-      Prawn::Document.generate("#{root}/spec/sample_output/multiple.pdf") do |prawn|
-        width = prawn.bounds.width
+    context "when only a position is supplied" do
+      let(:interface) { Prawn::Svg::Interface.new(svg, prawn, position: position) }
 
-        y = prawn.bounds.top - 12
-        prawn.draw_text "This is multiple SVGs being output to the same PDF", :at => [0, y]
+      subject { interface.position }
 
-        y -= 12
-        prawn.svg IO.read("#{root}/spec/sample_svg/arcs01.svg"),   :at => [0, y],         :width => width / 2
-        prawn.svg IO.read("#{root}/spec/sample_svg/circle01.svg"), :at => [width / 2, y], :width => width / 2
+      context "(:left)" do
+        let(:position) { :left }
+        it { is_expected.to eq [0, 600] }
+      end
 
-        y -= 120
-        prawn.draw_text "Here are some more PDFs below", :at => [0, y]
+      context "(:center)" do
+        let(:position) { :center }
+        it { is_expected.to eq [275, 600] }
+      end
+
+      context "(:right)" do
+        let(:position) { :right }
+        it { is_expected.to eq [550, 600] }
+      end
 
-        y -= 12
-        prawn.svg IO.read("#{root}/spec/sample_svg/quad01.svg"), :at => [0, y],             :width => width / 3
-        prawn.svg IO.read("#{root}/spec/sample_svg/rect01.svg"), :at => [width / 3, y],     :width => width / 3
-        prawn.svg IO.read("#{root}/spec/sample_svg/rect02.svg"), :at => [width / 3 * 2, y], :width => width / 3
+      context "a number" do
+        let(:position) { 25.5 }
+        it { is_expected.to eq [25.5, 600] }
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-svg
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Roger Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-02 00:00:00.000000000 Z
+date: 2015-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -103,6 +103,7 @@ files:
 - lib/prawn/svg/url_loader.rb
 - lib/prawn/svg/version.rb
 - prawn-svg.gemspec
+- spec/integration_spec.rb
 - spec/prawn/svg/calculators/aspect_ratio_spec.rb
 - spec/prawn/svg/calculators/document_sizing_spec.rb
 - spec/prawn/svg/color_spec.rb
@@ -186,6 +187,7 @@ signing_key:
 specification_version: 4
 summary: SVG renderer for Prawn PDF library
 test_files:
+- spec/integration_spec.rb
 - spec/prawn/svg/calculators/aspect_ratio_spec.rb
 - spec/prawn/svg/calculators/document_sizing_spec.rb
 - spec/prawn/svg/color_spec.rb