inline_svg 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77ff506f63b6e109b845e36bcdd8ae0d5bfc7fde
-  data.tar.gz: 5e04e93613735cfec49fffa88570c875a21db5a2
+  metadata.gz: b6932c866bafacb7f12847808bb7f4b4d4c95174
+  data.tar.gz: 7238dcab1a92255185e0caeae55b454a1cddc886
 SHA512:
-  metadata.gz: 78b2163354a33b8110d466bff371a79a461d421f3904ba65013844863d591977f3da663391abaa07729cc853bdd295df5c7d63451a9d3735c42a1b7894d2c54e
-  data.tar.gz: 52569d02594958e9007964965175bfe3d9b313d6ec37c679eadf91fa035aba6984e15a7b8e229ba194084aadd1614399731f6c36d4f55cd3c7a105b1aa99d847
+  metadata.gz: 792b0ab6aeb91af7c8edcab1cbd37eca42d4fd96317a8bba31f41f4e0f53649e9b92039a8a11b8c6d880ce1fda4524c7ebec66bdac9d1a121787f51adef57ba3
+  data.tar.gz: 28605844152d134e18810c12db87c4df901b55d7c365c4b399e7b8ea0cce6b05508d90b0632d52a9e2f3d071e625405cb767ebcb595eb2c913e8d40cff8eb5d9

data/CHANGELOG.md

@@ -3,7 +3,8 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
-- Nothing
+- Allow configurable asset file implementations
+  [#61](https://github.com/jamesmartin/inline_svg/pull/61)
 
 ## [1.0.1] - 2017-04-10
 ### Fixed

data/README.md

@@ -206,6 +206,32 @@ Transforms are applied in ascending order (lowest number first).
 ***Note***: Custom transformations are always applied *after* all built-in
 transformations, regardless of priority.
 
+## Custom asset file loader
+
+An asset file loader returns a `String` representing a SVG document given a
+filename. Custom asset loaders should be a Ruby object that responds to a
+method called `named`, that takes one argument (a string representing the
+filename of the SVG document).
+
+A simple example might look like this:
+
+```ruby
+class MyAssetFileLoader
+  def self.named(filename)
+    # ... load SVG document however you like
+    return "<svg>some document</svg>"
+  end
+end
+```
+
+Configure your custom asset file loader in an initializer like so:
+
+```ruby
+InlineSvg.configure do |config|
+  config.asset_file = MyAssetFileLoader
+end
+```
+
 ## Contributing
 
 1. Fork it ( [http://github.com/jamesmartin/inline_svg/fork](http://github.com/jamesmartin/inline_svg/fork) )

data/lib/inline_svg.rb

@@ -14,10 +14,24 @@ module InlineSvg
   class Configuration
     class Invalid < ArgumentError; end
 
-    attr_reader :asset_finder, :custom_transformations
+    attr_reader :asset_file, :asset_finder, :custom_transformations
 
     def initialize
       @custom_transformations = {}
+      @asset_file = InlineSvg::AssetFile
+    end
+
+    def asset_file=(custom_asset_file)
+      begin
+        method = custom_asset_file.method(:named)
+        if method.arity == 1
+          @asset_file = custom_asset_file
+        else
+          raise InlineSvg::Configuration::Invalid.new("asset_file should implement the #named method with arity 1")
+        end
+      rescue NameError
+        raise InlineSvg::Configuration::Invalid.new("asset_file should implement the #named method")
+      end
     end
 
     def asset_finder=(finder)

data/lib/inline_svg/action_view/helpers.rb

@@ -9,7 +9,7 @@ module InlineSvg
           svg_file = if InlineSvg::IOResource === filename
             InlineSvg::IOResource.read filename
           else
-            InlineSvg::AssetFile.named filename
+            configured_asset_file.named filename
           end
         rescue InlineSvg::AssetFile::FileNotFound
           return "<svg><!-- SVG file not found: '#{filename}' #{extension_hint(filename)}--></svg>".html_safe
@@ -20,6 +20,10 @@ module InlineSvg
 
       private
 
+      def configured_asset_file
+        InlineSvg.configuration.asset_file
+      end
+
       def extension_hint(filename)
         filename.ends_with?(".svg") ? "" : "(Try adding .svg to your filename) "
       end

data/lib/inline_svg/version.rb

@@ -1,3 +1,3 @@
 module InlineSvg
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/spec/inline_svg_spec.rb

@@ -13,6 +13,10 @@ class MyInvalidCustomTransformInstance
   def self.create_with_value(value); end
 end
 
+class MyCustomAssetFile
+  def self.named(filename); end
+end
+
 describe InlineSvg do
   describe "configuration" do
     context "when a block is not given" do
@@ -42,6 +46,40 @@ describe InlineSvg do
       end
     end
 
+    context "configuring a custom asset file" do
+      it "falls back to the built-in asset file implementation by deafult" do
+        expect(InlineSvg.configuration.asset_file).to eq(InlineSvg::AssetFile)
+      end
+
+      it "adds a collaborator that meets the interface specification" do
+        InlineSvg.configure do |config|
+          config.asset_file = MyCustomAssetFile
+        end
+
+        expect(InlineSvg.configuration.asset_file).to eq MyCustomAssetFile
+      end
+
+      it "rejects a collaborator that does not conform to the interface spec" do
+        bad_asset_file = double("bad_asset_file")
+
+        expect do
+          InlineSvg.configure do |config|
+            config.asset_file = bad_asset_file
+          end
+        end.to raise_error(InlineSvg::Configuration::Invalid, /asset_file should implement the #named method/)
+      end
+
+      it "rejects a collaborator that implements the correct interface with the wrong arity" do
+        bad_asset_file = double("bad_asset_file", named: nil)
+
+        expect do
+          InlineSvg.configure do |config|
+            config.asset_file = bad_asset_file
+          end
+        end.to raise_error(InlineSvg::Configuration::Invalid, /asset_file should implement the #named method with arity 1/)
+      end
+    end
+
     context "configuring custom transformation" do
       it "allows a custom transformation to be added" do
         InlineSvg.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inline_svg
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - James Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-10 00:00:00.000000000 Z
+date: 2017-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler