inline_svg 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bd0dc863ab3a27cdd10a6c7377b0a065792367a
-  data.tar.gz: 515ff976eac0d9b795d75a7906c9889a7c006b67
+  metadata.gz: fde0d0a49947181287301e1187f1997776562082
+  data.tar.gz: cf777cfc4ca0b6df101d1f40c18b1dc48d1421d7
 SHA512:
-  metadata.gz: 030d7333cfc87e0bcbb0f47932a5e10405903aebaf55d2ceb350edbf11fcc4993dfd9eb95f37418a6aa34f67c60d79c365379aeadc874dddd4c94cd10f6d3ae0
-  data.tar.gz: bb3fd6d2022b283f8494472bbf5a1865a818b1fd22c1b0b265a0d8328913b53889a08acf83a1923bbd50465a42972ac1eb065f883906fd9464c5a259187e3a99
+  metadata.gz: 2efa11f12a1c8caaae63242dd9f389e97edbbbd9ce3104c02ae7f319325bd8474743dc902ccea28cfb23481bf29c6337d31187895e84f58c0b70e91d21530995
+  data.tar.gz: 50613509d30a572898a1c7108a93885b202eb2a61b0afaf8179b4a8fcbc5c54e44ff38a259f061566585e1cb27f5d559c9aebd9769e81f323c16be572f417aea

data/CHANGELOG.md

@@ -5,6 +5,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased][unreleased]
 - Nothing.
 
+## [0.6.0] - 2015-07-07
+### Added
+- Apply user-supplied [custom
+transformations](https://github.com/jamesmartin/inline_svg/blob/master/README.md#custom-transformations) to a document.
+
 ## [0.5.3] - 2015-06-22
 ### Added
 - `preserveAspectRatio` transformation on SVG root node. Thanks, @paulozoom.
@@ -56,7 +61,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Basic Railtie and view helper to inline SVG documents to Rails views.
 
-[unreleased]: https://github.com/jamesmartin/inline_svg/compare/v0.5.3...HEAD
+[unreleased]: https://github.com/jamesmartin/inline_svg/compare/v0.6.0...HEAD
+[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
 [0.5.2]: https://github.com/jamesmartin/inline_svg/compare/v0.5.1...v0.5.2
 [0.5.1]: https://github.com/jamesmartin/inline_svg/compare/v0.5.0...v0.5.1

data/README.md

@@ -84,6 +84,47 @@ inline_svg("some-document.svg", id: 'some-id', class: 'some-class', data: {some:
 'Some description', nocomment: true, preserve_aspect_ratio: 'xMaxYMax meet')
 ```
 
+## Custom Transformations
+
+The transformation behavior of `inline_svg` can be customized by creating custom transformation classes.
+
+For example, inherit from `InlineSvg::CustomTransformation` and implement the `#transform` method:
+
+```ruby
+# Sets the `custom` attribute on the root SVG element to supplied value
+# Remember to return a document, as this will be passed along the transformation chain
+
+class MyCustomTransform < InlineSvg::CustomTransformation
+  def transform(doc)
+    doc = Nokogiri::XML::Document.parse(doc.to_html)
+    svg = doc.at_css 'svg'
+    svg['custom'] = value
+    doc
+  end
+end
+```
+
+Add the custom configuration in an initializer (E.g. `./config/initializers/inline_svg.rb`):
+
+```ruby
+# Note that the named `attribute` will be used to pass a value to your custom transform
+InlineSvg.configure do |config|
+  config.add_custom_transformation(attribute: :my_custom_attribute, transform: MyCustomTransform)
+end
+```
+
+The custom transformation can then be called like so:
+```haml
+%div
+  = inline_svg "some-document.svg", my_custom_attribute: 'some value'
+```
+
+In this example, the following transformation would be applied to a SVG document:
+
+```xml
+<svg custom="some value">...</svg>
+```
+
 ## Contributing
 
 1. Fork it ( [http://github.com/jamesmartin/inline_svg/fork](http://github.com/jamesmartin/inline_svg/fork) )

data/lib/inline_svg.rb

@@ -12,7 +12,11 @@ module InlineSvg
   class Configuration
     class Invalid < ArgumentError; end
 
-    attr_reader :asset_finder
+    attr_reader :asset_finder, :custom_transformations
+
+    def initialize
+      @custom_transformations = {}
+    end
 
     def asset_finder=(finder)
       if finder.respond_to?(:find_asset)
@@ -22,6 +26,23 @@ module InlineSvg
       end
       asset_finder
     end
+
+    def add_custom_transformation(options)
+      if incompatible_transformation?(options.fetch(:transform))
+        raise InlineSvg::Configuration::Invalid.new("#{options.fetch(:transform)} should implement the .create_with_value and #transform methods")
+      end
+      @custom_transformations.merge!(Hash[ *[options.fetch(:attribute, :no_attribute), options.fetch(:transform, no_transform)] ])
+    end
+
+    private
+
+    def incompatible_transformation?(klass)
+      !klass.is_a?(Class) || !klass.respond_to?(:create_with_value) || !klass.instance_methods.include?(:transform)
+    end
+
+    def no_transform
+      InlineSvg::TransformPipeline::Transformations::NullTransformation
+    end
   end
 
   @configuration = InlineSvg::Configuration.new
@@ -36,5 +57,9 @@ module InlineSvg
         raise InlineSvg::Configuration::Invalid.new('Please set configuration options with a block')
       end
     end
+
+    def reset_configuration!
+      @configuration = InlineSvg::Configuration.new
+    end
   end
 end

data/lib/inline_svg/transform_pipeline/transformations.rb

@@ -1,5 +1,5 @@
 module InlineSvg::TransformPipeline::Transformations
-  def self.all_transformations
+  def self.built_in_transformations
     {
       nocomment: NoComment,
       class: ClassAttribute,
@@ -14,6 +14,14 @@ module InlineSvg::TransformPipeline::Transformations
     }
   end
 
+  def self.custom_transformations
+    InlineSvg.configuration.custom_transformations
+  end
+
+  def self.all_transformations
+    built_in_transformations.merge(custom_transformations)
+  end
+
   def self.lookup(transform_params)
     without_empty_values(transform_params).map do |key, value|
       all_transformations.fetch(key, NullTransformation).create_with_value(value)

data/lib/inline_svg/transform_pipeline/transformations/transformation.rb

@@ -21,3 +21,15 @@ module InlineSvg::TransformPipeline::Transformations
     end
   end
 end
+
+module InlineSvg
+  class CustomTransformation < InlineSvg::TransformPipeline::Transformations::Transformation
+    # Inherit from this class to keep custom transformation class definitions short
+    # E.g.
+    # class MyTransform < InlineSvg::CustomTransformation
+    #   def transform(doc)
+    #     # Your code here...
+    #   end
+    # end
+  end
+end

data/lib/inline_svg/version.rb

@@ -1,3 +1,3 @@
 module InlineSvg
-  VERSION = "0.5.3"
+  VERSION = "0.6.0"
 end

data/spec/helpers/inline_svg_spec.rb

@@ -1,5 +1,14 @@
 require 'inline_svg'
 
+class WorkingCustomTransform < InlineSvg::CustomTransformation
+  def transform(doc)
+    doc = Nokogiri::XML::Document.parse(doc.to_html)
+    svg = doc.at_css 'svg'
+    svg['custom'] = value
+    doc
+  end
+end
+
 describe InlineSvg::ActionView::Helpers do
 
   let(:helper) { ( Class.new { include InlineSvg::ActionView::Helpers } ).new }
@@ -79,6 +88,29 @@ SVG
           expect(helper.inline_svg('some-file', title: 'A title', desc: 'A description', nocomment: true)).to eq expected_output
         end
       end
+
+      context "with custom transformations" do
+        before(:each) do
+          InlineSvg.configure do |config|
+            config.add_custom_transformation({attribute: :custom, transform: WorkingCustomTransform})
+          end
+        end
+
+        after(:each) do
+          InlineSvg.reset_configuration!
+        end
+
+        it "applies custm transformations to the output" do
+          input_svg = <<-SVG
+<svg></svg>
+SVG
+          expected_output = <<-SVG
+<svg custom="some value"></svg>
+SVG
+          allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
+          expect(helper.inline_svg('some-file', custom: 'some value')).to eq expected_output
+        end
+      end
     end
   end
 end

data/spec/inline_svg_spec.rb

@@ -1,5 +1,18 @@
 require_relative '../lib/inline_svg'
 
+class MyCustomTransform
+  def self.create_with_value(value); end
+  def transform(doc); end
+end
+
+class MyInvalidCustomTransformKlass
+  def transform(doc); end
+end
+
+class MyInvalidCustomTransformInstance
+  def self.create_with_value(value); end
+end
+
 describe InlineSvg do
   describe "configuration" do
     context "when a block is not given" do
@@ -28,5 +41,40 @@ describe InlineSvg do
         end.to raise_error(InlineSvg::Configuration::Invalid, /asset finder.*find_asset/i)
       end
     end
+
+    context "configuring custom transformation" do
+      it "allows a custom transformation to be added" do
+        InlineSvg.configure do |config|
+          config.add_custom_transformation(attribute: :my_transform, transform: MyCustomTransform)
+        end
+
+        expect(InlineSvg.configuration.custom_transformations).to eq({my_transform: MyCustomTransform})
+      end
+
+      it "rejects transformations that do not implement .create_with_value" do
+        expect do
+          InlineSvg.configure do |config|
+            config.add_custom_transformation(attribute: :irrelevant, transform: MyInvalidCustomTransformKlass)
+          end
+        end.to raise_error(InlineSvg::Configuration::Invalid, /#{MyInvalidCustomTransformKlass} should implement the .create_with_value and #transform methods/)
+      end
+
+      it "rejects transformations that does not implement #transform" do
+        expect do
+          InlineSvg.configure do |config|
+            config.add_custom_transformation(attribute: :irrelevant, transform: MyInvalidCustomTransformInstance)
+          end
+        end.to raise_error(InlineSvg::Configuration::Invalid, /#{MyInvalidCustomTransformInstance} should implement the .create_with_value and #transform methods/)
+      end
+
+      it "rejects transformations that are not classes" do
+        expect do
+          InlineSvg.configure do |config|
+            config.add_custom_transformation(attribute: :irrelevant, transform: :not_a_class)
+          end
+        end.to raise_error(InlineSvg::Configuration::Invalid, /#{:not_a_class} should implement the .create_with_value and #transform methods/)
+      end
+
+    end
   end
 end

data/spec/transformation_pipeline/transformations_spec.rb

@@ -1,8 +1,15 @@
+require 'inline_svg'
 require 'inline_svg/transform_pipeline'
 
+class ACustomTransform < InlineSvg::CustomTransformation
+  def transform(doc)
+    doc
+  end
+end
+
 describe InlineSvg::TransformPipeline::Transformations do
   context "looking up transformations" do
-    it "returns configured transformations when parameters are supplied" do
+    it "returns built-in transformations when parameters are supplied" do
       transformations = InlineSvg::TransformPipeline::Transformations.lookup(
         nocomment: 'irrelevant',
         class: 'irrelevant',
@@ -48,4 +55,25 @@ describe InlineSvg::TransformPipeline::Transformations do
       expect(transformations.map(&:class)).to match_array([])
     end
   end
+
+  context "custom transformations" do
+    before(:each) do
+      InlineSvg.configure do |config|
+        config.add_custom_transformation({transform: ACustomTransform, attribute: :my_transform})
+      end
+    end
+
+    after(:each) do
+      InlineSvg.reset_configuration!
+    end
+
+    it "returns configured custom transformations" do
+      transformations = InlineSvg::TransformPipeline::Transformations.lookup(
+        my_transform: :irrelevant
+      )
+
+      expect(transformations.map(&:class)).to match_array([ACustomTransform])
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inline_svg
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - James Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-22 00:00:00.000000000 Z
+date: 2015-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler