inline_svg 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d53e3e703f3681894bee4523d13869a70d9d8d85
-  data.tar.gz: 114b05c6779d93d8f8a8cd2f19b6c19f8e32dc2b
+  metadata.gz: 61bd9c6cf28c29ebf83c1ced886bf9454a2e3c18
+  data.tar.gz: f6ddecc2e711e872d8c0c62eb08876a1ccfff832
 SHA512:
-  metadata.gz: a5f10abb1ebcff4ae18bda0f7600b14e0e8f2fb3123f100229e942fb63d8ea5cb6aaeb76a7f192dff2cbbfd1744370325c43e7a620000530d3b9877dad0a9fec
-  data.tar.gz: aa1a416596f428d0afd41e028f8e1ccd3003a3e292f08046d5d3166c2d32f3e5cf99c47799b6e209f0b979821a65e1ac9bd6c99c8c553a0bd559d518620e8dbf
+  metadata.gz: 73e10466544c51fd1d52aa94a75520000da86d32c243440853f7e5cf7d330a35b55dac5508d954627d3bc3fd10e1e06f9eba155a3ed6e15c2cd3770a1b9bbb14
+  data.tar.gz: 44cff146215df03b09301c3b3bc8cd060b631250a619887a78ef67224ce42e78b2b970570be70e9a968c8725635110eaaeafccde236be1a269f89b3d998b11ec

data/CHANGELOG.md

@@ -3,6 +3,15 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
+- Nothing.
+
+## [0.6.3] - 2016-04-19
+### Added
+- Accept `IO` objects as arguments to `inline_svg`. Thanks,
+  [@ASnow](https://github.com/ASnow).
+
+## [0.6.2] - 2016-01-24
+### Fixed
 - Support Sprockets >= 3.0 and config.assets.precompile = false
 
 ## [0.6.1] - 2015-08-06
@@ -65,7 +74,9 @@ transformations](https://github.com/jamesmartin/inline_svg/blob/master/README.md
 ### Added
 - Basic Railtie and view helper to inline SVG documents to Rails views.
 
-[unreleased]: https://github.com/jamesmartin/inline_svg/compare/v0.6.1...HEAD
+[unreleased]: https://github.com/jamesmartin/inline_svg/compare/v0.6.3...HEAD
+[0.6.2]: https://github.com/jamesmartin/inline_svg/compare/v0.6.2...v0.6.3
+[0.6.2]: https://github.com/jamesmartin/inline_svg/compare/v0.6.1...v0.6.2
 [0.6.1]: https://github.com/jamesmartin/inline_svg/compare/v0.6.0...v0.6.1
 [0.6.0]: https://github.com/jamesmartin/inline_svg/compare/v0.5.3...v0.6.0
 [0.5.3]: https://github.com/jamesmartin/inline_svg/compare/v0.5.2...v0.5.3

data/README.md

@@ -35,10 +35,12 @@ Or install it yourself as:
 ```
 inline_svg(file_name, options={})
 ```
-The `file_name` can be a full path to a file, or just the file's basename. The
+
+The `file_name` can be a full path to a file, the file's basename or an `IO`
+object. The
 actual path of the file on disk is resolved using
-[Sprockets](://github.com/sstephenson/sprockets), which means you can pre-process
-and fingerprint your SVG files like any other Rails asset.
+[Sprockets](://github.com/sstephenson/sprockets) (when available), a naive file finder (`/public/assets/...`) or in the case of `IO` objects the SVG data is read from the object.
+This means you can pre-process and fingerprint your SVG files like other Rails assets, or choose to find SVG data yourself.
 
 Here's an example of embedding an SVG document and applying a 'class' attribute in
 HAML:

data/lib/inline_svg/action_view/helpers.rb

@@ -6,7 +6,11 @@ module InlineSvg
     module Helpers
       def inline_svg(filename, transform_params={})
         begin
-          svg_file = AssetFile.named(filename)
+          svg_file = if InlineSvg::IOResource === filename
+            InlineSvg::IOResource.read filename
+          else
+            InlineSvg::AssetFile.named filename
+          end
         rescue InlineSvg::AssetFile::FileNotFound
           return "<svg><!-- SVG file not found: '#{filename}' --></svg>".html_safe
         end

data/lib/inline_svg/io_resource.rb

@@ -0,0 +1,20 @@
+module InlineSvg
+  module IOResource
+    def self.=== object
+      object.is_a?(IO) || object.is_a?(StringIO)
+    end
+
+    def self.default_for object
+      case object
+      when StringIO then ''
+      when IO then 1
+      end
+    end
+    def self.read object
+      start = object.pos
+      str = object.read
+      object.seek start
+      str
+    end
+  end
+end

data/lib/inline_svg/version.rb

@@ -1,3 +1,3 @@
 module InlineSvg
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
 end

data/lib/inline_svg.rb

@@ -4,6 +4,7 @@ require "inline_svg/asset_file"
 require "inline_svg/finds_asset_paths"
 require "inline_svg/static_asset_finder"
 require "inline_svg/transform_pipeline"
+require "inline_svg/io_resource"
 
 require "inline_svg/railtie" if defined?(Rails)
 require 'active_support/core_ext/string'

data/spec/helpers/inline_svg_spec.rb

@@ -111,6 +111,41 @@ SVG
           expect(helper.inline_svg('some-file', custom: 'some value')).to eq expected_output
         end
       end
+
+    end
+    context 'argument polimorphizm' do
+      let(:argument) { double('argument') }
+      it 'accept IO' do
+        expect(InlineSvg::IOResource).to receive(:===).with(argument).and_return(true)
+        expect(InlineSvg::IOResource).to receive(:read).with(argument)
+        expect(InlineSvg::AssetFile).to_not receive(:named)
+        helper.inline_svg(argument)
+      end
+      it 'accept filename' do
+        expect(InlineSvg::IOResource).to receive(:===).with(argument).and_return(false)
+        expect(InlineSvg::IOResource).to_not receive(:read)
+        expect(InlineSvg::AssetFile).to receive(:named).with(argument)
+        helper.inline_svg(argument)
+      end
+    end
+    context 'when passed IO object argument' do
+      let(:io_object) { double('io_object') }
+      let(:file_path) { File.expand_path('../../files/example.svg', __FILE__) }
+      let(:answer) { File.read(file_path) }
+      it 'return valid svg' do
+        expect(InlineSvg::IOResource).to receive(:===).with(io_object).and_return(true)
+        expect(InlineSvg::IOResource).to receive(:read).with(io_object).and_return("<svg><!-- Test IO --></svg>")
+        output = helper.inline_svg(io_object)
+        expect(output).to eq "<svg><!-- Test IO --></svg>\n"
+        expect(output).to be_html_safe
+      end
+
+      it 'return valid svg for file' do
+        output = helper.inline_svg(File.new(file_path))
+        expect(output).to eq "<svg xmlns=\"http://www.w3.org/2000/svg\" xml:lang=\"en\" role=\"presentation\"><!-- This is a test comment --></svg>\n"
+        expect(output).to be_html_safe
+      end
+
     end
   end
 end

data/spec/io_resource_spec.rb

@@ -0,0 +1,80 @@
+require_relative '../lib/inline_svg'
+require "stringio"
+require "tempfile"
+
+describe InlineSvg::IOResource do
+  it "support api methods" do
+    is_expected.to respond_to(:===, :read)
+  end
+
+  describe '#===' do
+    context 'return true' do
+      it "for IO object" do
+        read_io, write_io = IO.pipe
+        expect(subject === read_io).to be true
+        expect(subject === write_io).to be true
+      end
+
+      it "for StringIO object" do
+        expect(subject === StringIO.new).to be true
+      end
+
+      it "for File object" do
+        expect(subject === File.new("#{Dir.tmpdir}/testfile", "w")).to be true
+      end
+    end
+    context 'return false' do
+      it "for String object" do
+        expect(subject === "string/filename").to be false
+      end
+    end
+  end
+
+  describe '#read' do
+
+    tests = proc do
+      it "closed raise error" do
+        rio.close
+        expect do 
+          subject.read(rio)
+        end.to raise_error(IOError)
+      end
+
+      it "empty" do
+        rio.read
+        expect(subject.read rio).to eq ''
+      end
+
+      it "twice" do
+        expect(subject.read rio).to eq answer
+        expect(subject.read rio).to eq answer
+      end
+
+      it "write only raise error" do
+        expect do 
+          subject.read wio
+        end.to raise_error(IOError)
+      end
+    end
+
+    context 'IO object' do
+      let(:answer) { 'read' }
+      let(:rio) { StringIO.new(answer, 'r') }
+      let(:wio) { StringIO.new('write', 'w') }
+      instance_exec &tests
+    end
+
+    context 'File object' do
+      let(:file_path) { File.expand_path('../files/example.svg', __FILE__) }
+      let(:answer) { File.read(file_path) }
+      let(:rio) { File.new(file_path, 'r') }
+      let(:wio) { File.new('/dev/null', 'w') }
+      instance_exec &tests
+      it 'has non empty body' do
+        expect(answer).to_not eq ''
+      end
+    end
+
+    
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inline_svg
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - James Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-24 00:00:00.000000000 Z
+date: 2016-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,6 +112,7 @@ files:
 - lib/inline_svg/action_view/helpers.rb
 - lib/inline_svg/asset_file.rb
 - lib/inline_svg/finds_asset_paths.rb
+- lib/inline_svg/io_resource.rb
 - lib/inline_svg/railtie.rb
 - lib/inline_svg/static_asset_finder.rb
 - lib/inline_svg/transform_pipeline.rb
@@ -133,6 +134,7 @@ files:
 - spec/finds_asset_paths_spec.rb
 - spec/helpers/inline_svg_spec.rb
 - spec/inline_svg_spec.rb
+- spec/io_resource_spec.rb
 - spec/transformation_pipeline/transformations/data_attributes_spec.rb
 - spec/transformation_pipeline/transformations/height_spec.rb
 - spec/transformation_pipeline/transformations/id_attribute_spec.rb
@@ -170,6 +172,7 @@ test_files:
 - spec/finds_asset_paths_spec.rb
 - spec/helpers/inline_svg_spec.rb
 - spec/inline_svg_spec.rb
+- spec/io_resource_spec.rb
 - spec/transformation_pipeline/transformations/data_attributes_spec.rb
 - spec/transformation_pipeline/transformations/height_spec.rb
 - spec/transformation_pipeline/transformations/id_attribute_spec.rb