inline_svg 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c003e0cd953e58b743df9c836748124cac54bab
-  data.tar.gz: 58b09ffa5695e837d113957adeb339db0f0484dc
+  metadata.gz: 9be73c7539f050fff8b70b78686af612b47bce30
+  data.tar.gz: 03a319e6d961e16550a4fb20f7427586a4374850
 SHA512:
-  metadata.gz: ba4074f8ae922fc6ef08a0e9ecbe66e334350e21be1374b6f72b20a9093f73652540cf248bc5392e41678233580135bf1609dab4a6e2ded08ae1b4f7c72b6541
-  data.tar.gz: ec749c7628ad273fb5605e70abe309aa74be1dec9c307ae1656de02d34294d81fd8a6244bd24293b03a17fff3558ec3a8c33706c22e5c7e3b9f2b25cd7169bb1
+  metadata.gz: d991a3f66c45f6b889f6533d093f3e20021ce97197adf61a174e653f6c26cebaa70013887650df56d9740e812eb460572d2c0656589db18cf4eccc6e5da11420
+  data.tar.gz: 4f99e93a2951dc4b3cb7424442aafa8858312076a3d45d39e60fd67116a2219829db8e3f57378172a8a563bb8774960ef6523a63e652146631528030cdd91cb1

data/CHANGELOG.md

@@ -3,7 +3,13 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
-- Nothing.
+- Nothing
+
+## [0.8.0] - 2016-05-23
+### Added
+- Default values for custom transformations
+  [#36](https://github.com/jamesmartin/inline_svg/issues/36). Thanks,
+  [@andrewaguiar](https://github.com/andrewaguiar)
 
 ## [0.7.0] - 2016-05-03
 ### Added
@@ -85,8 +91,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.7.0...HEAD
-[0.7.0]: https://github.com/jamesmartin/inline_svg/compare/v0.6.3...v0.7.0
+[unreleased]: https://github.com/jamesmartin/inline_svg/compare/v0.8.0...HEAD
+[0.8.0]: https://github.com/jamesmartin/inline_svg/compare/v0.7.0...v0.8.0
+[0.7.0]: https://github.com/jamesmartin/inline_svg/compare/v0.6.4...v0.7.0
 [0.6.4]: https://github.com/jamesmartin/inline_svg/compare/v0.6.3...v0.6.4
 [0.6.3]: 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

data/README.md

@@ -131,6 +131,34 @@ In this example, the following transformation would be applied to a SVG document
 <svg custom="some value">...</svg>
 ```
 
+You can also provide a default_value to the custom transformation, so even if you don't pass a value it will be triggered
+
+```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, default_value: 'default value')
+end
+```
+
+The custom transformation will be triggered even if you don't pass any attribute value
+```haml
+%div
+  = inline_svg "some-document.svg"
+  = 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="default value">...</svg>
+```
+
+And
+
+```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

@@ -36,7 +36,7 @@ module InlineSvg
       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)] ])
+      @custom_transformations.merge!(Hash[ *[options.fetch(:attribute, :no_attribute), options] ])
     end
 
     private
@@ -45,9 +45,6 @@ module InlineSvg
       !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

data/lib/inline_svg/transform_pipeline/transformations.rb

@@ -1,17 +1,17 @@
 module InlineSvg::TransformPipeline::Transformations
   def self.built_in_transformations
     {
-      nocomment: NoComment,
-      class: ClassAttribute,
-      title: Title,
-      desc: Description,
-      size: Size,
-      height: Height,
-      width: Width,
-      id: IdAttribute,
-      data: DataAttributes,
-      preserve_aspect_ratio: PreserveAspectRatio,
-      aria: AriaAttributes
+      nocomment: { transform: NoComment },
+      class: { transform: ClassAttribute },
+      title: { transform: Title },
+      desc: { transform: Description },
+      size: { transform: Size },
+      height: { transform: Height },
+      width: { transform: Width },
+      id: { transform: IdAttribute },
+      data: { transform: DataAttributes },
+      preserve_aspect_ratio: { transform: PreserveAspectRatio },
+      aria: { transform: AriaAttributes }
     }
   end
 
@@ -24,14 +24,27 @@ module InlineSvg::TransformPipeline::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)
+    all_default_values.merge(without_empty_values(transform_params)).map do |key, value|
+      options = all_transformations.fetch(key, { transform: NullTransformation })
+      options.fetch(:transform, no_transform).create_with_value(value)
     end
   end
 
   def self.without_empty_values(params)
     params.reject {|key, value| value.nil?}
   end
+
+  def self.all_default_values
+    custom_transformations
+      .values
+      .select {|opt| opt[:default_value] != nil}
+      .map {|opt| [opt[:attribute], opt[:default_value]]}
+      .inject({}) {|hash, array| hash.merge!(array[0] => array[1])}
+  end
+
+  def self.no_transform
+    InlineSvg::TransformPipeline::Transformations::NullTransformation
+  end
 end
 
 require 'inline_svg/transform_pipeline/transformations/transformation'

data/lib/inline_svg/version.rb

@@ -1,3 +1,3 @@
 module InlineSvg
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/spec/helpers/inline_svg_spec.rb

@@ -112,6 +112,38 @@ SVG
         end
       end
 
+      context "with custom transformations using a default value" do
+        before(:each) do
+          InlineSvg.configure do |config|
+            config.add_custom_transformation({attribute: :custom, transform: WorkingCustomTransform, default_value: 'default value'})
+          end
+        end
+
+        after(:each) do
+          InlineSvg.reset_configuration!
+        end
+
+        context "without passing the attribute value" do
+          it "applies custom transformations to the output using the default value" do
+            input_svg = '<svg></svg>'
+
+            allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
+
+            expect(helper.inline_svg('some-file')).to eq "<svg custom=\"default value\"></svg>\n"
+          end
+        end
+
+        context "passing the attribute value" do
+          it "applies custom transformations to the output" do
+            input_svg = '<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 "<svg custom=\"some value\"></svg>\n"
+          end
+        end
+      end
+
     end
     context 'argument polimorphizm' do
       let(:argument) { double('argument') }

data/spec/inline_svg_spec.rb

@@ -48,7 +48,7 @@ describe InlineSvg do
           config.add_custom_transformation(attribute: :my_transform, transform: MyCustomTransform)
         end
 
-        expect(InlineSvg.configuration.custom_transformations).to eq({my_transform: MyCustomTransform})
+        expect(InlineSvg.configuration.custom_transformations).to eq({my_transform: {attribute: :my_transform, transform: MyCustomTransform}})
       end
 
       it "rejects transformations that do not implement .create_with_value" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inline_svg
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - James Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-03 00:00:00.000000000 Z
+date: 2016-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler