inline_svg 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8cc9c7834d90be148c6dab54da0583e310c6be7
-  data.tar.gz: 7d56a72f24be4e162b998b49b8494ec5abf004b6
+  metadata.gz: 7fb6e64ae5311883892613c4a6b3eebf128961b6
+  data.tar.gz: 40f3eb0a9198ff40838f3df4fe93937a3ef1dd9c
 SHA512:
-  metadata.gz: d2b1f8ecb2a936f8e1a8297b3766c0f11dac1318aca92f9f1ac6a43790fa268cd78aaf10b841ca2890e2493c3f27b7caaf32d8671a8df14cf4e114ca953a6c1f
-  data.tar.gz: 5b90cc6cb9531ea88ad2c0326156453c9ef335949311c5288a8a9f75098a2bdb2e9ce784598cbaca17e64acccafe763a99ffe121439abdc9c135f68e10c6a88e
+  metadata.gz: 2a6d3430898827a14e0b34dfe018efe8f99991dd7362f758e63973e75d577d7cb6116ee8cb981a1534dfd7283fd170e9bbef36ad13325f7fc482423c86de0314
+  data.tar.gz: 126adaf50a5d41ea9225c3497cf2df7ee20c231caf33f653773ddc03d8cb5b2c32bf51248ac5bbd1cff9e19ca494422cccfadf7136530d08826b71e74d9cc17b

data/CHANGELOG.md

@@ -5,6 +5,16 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased][unreleased]
 - Nothing
 
+## [0.11.0] - 2016-07-24
+### Added
+- Priority ordering for transformations
+
+### Fixed
+- Prevent duplicate desc elements being created
+  [#46](https://github.com/jamesmartin/inline_svg/issues/46)
+- Prevent class attributes being replaced
+  [#44](https://github.com/jamesmartin/inline_svg/issues/44)
+
 ## [0.10.0] - 2016-07-24
 ### Added
 - Rails 5 support [#43](https://github.com/jamesmartin/inline_svg/pull/43)
@@ -107,7 +117,8 @@ 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.10.0...HEAD
+[unreleased]: https://github.com/jamesmartin/inline_svg/compare/v0.11.0...HEAD
+[0.11.0]: https://github.com/jamesmartin/inline_svg/compare/v0.10.0...v0.11.0
 [0.10.0]: https://github.com/jamesmartin/inline_svg/compare/v0.9.1...v0.10.0
 [0.9.1]: https://github.com/jamesmartin/inline_svg/compare/v0.9.0...v0.9.1
 [0.9.0]: https://github.com/jamesmartin/inline_svg/compare/v0.8.0...v0.9.0

data/README.md

@@ -7,7 +7,7 @@ embedding](http://css-tricks.com/using-svg/) it inline in the HTML.
 This gem is a little Rails helper method (`inline_svg`) that reads an SVG document (via Sprockets, so works with the Rails Asset Pipeline), applies a CSS class attribute to the root of the document and
 then embeds it into a view.
 
-Inline SVG supports [Rails version 4.0.4](http://weblog.rubyonrails.org/2014/3/14/Rails-4-0-4-has-been-released/) and newer.
+Inline SVG (from [v0.10.0](https://github.com/jamesmartin/inline_svg/releases/tag/v0.10.0)) supports both [Rails 4](http://weblog.rubyonrails.org/2013/6/25/Rails-4-0-final/) and [Rails 5](http://weblog.rubyonrails.org/2016/6/30/Rails-5-0-final/).
 
 Want to embed SVGs with Javascript? You might like [RemoteSvg](https://github.com/jamesmartin/remote-svg), which features similar transforms but can also load SVGs from remote URLs (like S3 etc.).
 
@@ -188,6 +188,21 @@ And
 <svg custom="some value">...</svg>
 ```
 
+Passing a `priority` option with your custom transformation allows you to
+control the order that transformations are applied to the SVG document:
+
+```ruby
+InlineSvg.configure do |config|
+  config.add_custom_transformation(attribute: :custom_one, transform: MyCustomTransform, priority: 1)
+  config.add_custom_transformation(attribute: :custom_two, transform: MyOtherCustomTransform, priority: 2)
+end
+```
+
+Transforms are applied in ascending order (lowest number first).
+
+***Note***: Custom transformations are always applied *after* all built-in
+transformations, regardless of priority.
+
 ## Contributing
 
 1. Fork it ( [http://github.com/jamesmartin/inline_svg/fork](http://github.com/jamesmartin/inline_svg/fork) )

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version:  2.2.2

data/inline_svg.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "rspec_junit_formatter", "0.2.2"
+  spec.add_development_dependency "pry"
 
   spec.add_runtime_dependency "activesupport", ">= 4.0"
   spec.add_runtime_dependency "nokogiri", "~> 1.6", '~> 1.6'

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

@@ -2,8 +2,10 @@ module InlineSvg::TransformPipeline::Transformations
   class ClassAttribute < Transformation
     def transform(doc)
       doc = Nokogiri::XML::Document.parse(doc.to_html)
-      svg = doc.at_css 'svg'
-      svg['class'] = value
+      svg = doc.at_css "svg"
+      classes = (svg["class"] || "").split(" ")
+      classes << value
+      svg["class"] = classes.join(" ")
       doc
     end
   end

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

@@ -4,7 +4,8 @@ module InlineSvg::TransformPipeline::Transformations
       doc = Nokogiri::XML::Document.parse(doc.to_html)
       node = Nokogiri::XML::Node.new('desc', doc)
       node.content = value
-      doc.at_css('svg').add_child(node)
+      doc.search('svg desc').each { |node| node.remove }
+      doc.at_css('svg').prepend_child(node)
       doc
     end
   end

data/lib/inline_svg/transform_pipeline/transformations.rb

@@ -1,33 +1,55 @@
 module InlineSvg::TransformPipeline::Transformations
+  # Transformations are run in priority order, lowest number first:
   def self.built_in_transformations
     {
-      nocomment: { transform: NoComment },
+      id: { transform: IdAttribute, priority: 1 },
+      desc: { transform: Description, priority: 2 },
+      title: { transform: Title, priority: 3 },
+      aria: { transform: AriaAttributes },
       class: { transform: ClassAttribute },
-      title: { transform: Title },
-      desc: { transform: Description },
-      size: { transform: Size },
-      height: { transform: Height },
-      width: { transform: Width },
-      id: { transform: IdAttribute },
       data: { transform: DataAttributes },
+      height: { transform: Height },
+      nocomment: { transform: NoComment },
       preserve_aspect_ratio: { transform: PreserveAspectRatio },
-      aria: { transform: AriaAttributes }
+      size: { transform: Size },
+      width: { transform: Width },
     }
   end
 
   def self.custom_transformations
-    InlineSvg.configuration.custom_transformations
+    magnify_priorities(InlineSvg.configuration.custom_transformations)
+  end
+
+  def self.magnify_priorities(transforms)
+    transforms.inject({}) do |output, (name, definition)|
+      priority = definition.fetch(:priority, built_in_transformations.size)
+
+      output[name] = definition.merge( { priority: magnify(priority) } )
+      output
+    end
+  end
+
+  def self.magnify(priority=0)
+    (priority + 1) * built_in_transformations.size
   end
 
   def self.all_transformations
-    built_in_transformations.merge(custom_transformations)
+    in_priority_order(built_in_transformations.merge(custom_transformations))
   end
 
   def self.lookup(transform_params)
-    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
+    all_transformations.map { |name, definition|
+      value = params_with_defaults(transform_params)[name]
+      definition.fetch(:transform, no_transform).create_with_value(value) if value
+    }.compact
+  end
+
+  def self.in_priority_order(transforms)
+    transforms.sort_by { |_, options| options.fetch(:priority, transforms.size) }
+  end
+
+  def self.params_with_defaults(params)
+    without_empty_values(all_default_values.merge(params))
   end
 
   def self.without_empty_values(params)
@@ -39,7 +61,7 @@ module InlineSvg::TransformPipeline::Transformations
       .values
       .select {|opt| opt[:default_value] != nil}
       .map {|opt| [opt[:attribute], opt[:default_value]]}
-      .inject({}) {|hash, array| hash.merge!(array[0] => array[1])}
+      .inject({}) {|options, attrs| options.merge!(attrs[0] => attrs[1])}
   end
 
   def self.no_transform

data/lib/inline_svg/version.rb

@@ -1,3 +1,3 @@
 module InlineSvg
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

data/spec/transformation_pipeline/transformations/class_attribute_spec.rb

@@ -0,0 +1,21 @@
+require "inline_svg/transform_pipeline"
+
+describe InlineSvg::TransformPipeline::Transformations::ClassAttribute do
+  it "adds a class attribute to a SVG document" do
+    document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')
+    transformation = InlineSvg::TransformPipeline::Transformations::ClassAttribute.create_with_value("some-class")
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg class=\"some-class\">Some document</svg>\n"
+    )
+  end
+
+  it "preserves existing class attributes on a SVG document" do
+    document = Nokogiri::XML::Document.parse('<svg class="existing things">Some document</svg>')
+    transformation = InlineSvg::TransformPipeline::Transformations::ClassAttribute.create_with_value("some-class")
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg class=\"existing things some-class\">Some document</svg>\n"
+    )
+  end
+end

data/spec/transformation_pipeline/transformations/description_spec.rb

@@ -0,0 +1,30 @@
+require 'inline_svg/transform_pipeline'
+
+describe InlineSvg::TransformPipeline::Transformations::Description do
+  it "adds a desc element to the SVG document" do
+    document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')
+    transformation = InlineSvg::TransformPipeline::Transformations::Description.create_with_value("Some Description")
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg><desc>Some Description</desc>Some document</svg>\n"
+    )
+  end
+
+  it "overwrites the content of an existing description element" do
+    document = Nokogiri::XML::Document.parse('<svg><desc>My Description</desc>Some document</svg>')
+    transformation = InlineSvg::TransformPipeline::Transformations::Description.create_with_value("Some Description")
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg><desc>Some Description</desc>Some document</svg>\n"
+    )
+  end
+
+  it "handles empty SVG documents" do
+    document = Nokogiri::XML::Document.parse('<svg></svg>')
+    transformation = InlineSvg::TransformPipeline::Transformations::Description.create_with_value("Some Description")
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg><desc>Some Description</desc></svg>\n"
+    )
+  end
+end

data/spec/transformation_pipeline/transformations_spec.rb

@@ -7,6 +7,8 @@ class ACustomTransform < InlineSvg::CustomTransformation
   end
 end
 
+class ASecondCustomTransform < ACustomTransform; end
+
 describe InlineSvg::TransformPipeline::Transformations do
   context "looking up transformations" do
     it "returns built-in transformations when parameters are supplied" do
@@ -39,16 +41,40 @@ describe InlineSvg::TransformPipeline::Transformations do
       ])
     end
 
-    it "returns a benign transformation when asked for an unknown transform" do
+    it "returns transformations in priority order" do
+      built_ins = {
+        desc:   { transform: InlineSvg::TransformPipeline::Transformations::Description, priority: 1 },
+        size:   { transform: InlineSvg::TransformPipeline::Transformations::Size },
+        title:  { transform: InlineSvg::TransformPipeline::Transformations::Title, priority: 2 }
+      }
+
+      allow(InlineSvg::TransformPipeline::Transformations).to \
+        receive(:built_in_transformations).and_return(built_ins)
+
       transformations = InlineSvg::TransformPipeline::Transformations.lookup(
-        not_a_real_transform: 'irrelevant'
+        {
+          desc: "irrelevant",
+          size: "irrelevant",
+          title: "irrelevant",
+        }
       )
 
-      expect(transformations.map(&:class)).to match_array([
-        InlineSvg::TransformPipeline::Transformations::NullTransformation
+      # Use `eq` here because we care about order
+      expect(transformations.map(&:class)).to eq([
+        InlineSvg::TransformPipeline::Transformations::Description,
+        InlineSvg::TransformPipeline::Transformations::Title,
+        InlineSvg::TransformPipeline::Transformations::Size,
       ])
     end
 
+    it "returns no transformations when asked for an unknown transform" do
+      transformations = InlineSvg::TransformPipeline::Transformations.lookup(
+        not_a_real_transform: 'irrelevant'
+      )
+
+      expect(transformations.map(&:class)).to match_array([])
+    end
+
     it "does not return a transformation when a value is not supplied" do
       transformations = InlineSvg::TransformPipeline::Transformations.lookup(
         title: nil
@@ -61,7 +87,8 @@ describe InlineSvg::TransformPipeline::Transformations do
   context "custom transformations" do
     before(:each) do
       InlineSvg.configure do |config|
-        config.add_custom_transformation({transform: ACustomTransform, attribute: :my_transform})
+        config.add_custom_transformation({transform: ACustomTransform, attribute: :my_transform, priority: 2})
+        config.add_custom_transformation({transform: ASecondCustomTransform, attribute: :my_other_transform, priority: 1})
       end
     end
 
@@ -76,6 +103,33 @@ describe InlineSvg::TransformPipeline::Transformations do
 
       expect(transformations.map(&:class)).to match_array([ACustomTransform])
     end
+
+    it "returns configured custom transformations in priority order" do
+      transformations = InlineSvg::TransformPipeline::Transformations.lookup(
+        my_transform: :irrelevant,
+        my_other_transform: :irrelevant
+      )
+
+      # Use `eq` here because we care about order:
+      expect(transformations.map(&:class)).to eq([ASecondCustomTransform, ACustomTransform])
+    end
+
+    it "always prioritizes built-in transforms before custom transforms" do
+      transformations = InlineSvg::TransformPipeline::Transformations.lookup(
+        my_transform: :irrelevant,
+        my_other_transform: :irrelevant,
+        desc: "irrelevant"
+      )
+
+      # Use `eq` here because we care about order:
+      expect(transformations.map(&:class)).to eq(
+        [
+          InlineSvg::TransformPipeline::Transformations::Description,
+          ASecondCustomTransform,
+          ACustomTransform
+        ]
+      )
+    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inline_svg
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - James Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-24 00:00:00.000000000 Z
+date: 2016-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -121,6 +135,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- circle.yml
 - inline_svg.gemspec
 - lib/inline_svg.rb
 - lib/inline_svg/action_view/helpers.rb
@@ -153,7 +168,9 @@ files:
 - spec/inline_svg_spec.rb
 - spec/io_resource_spec.rb
 - spec/transformation_pipeline/transformations/aria_attributes_spec.rb
+- spec/transformation_pipeline/transformations/class_attribute_spec.rb
 - spec/transformation_pipeline/transformations/data_attributes_spec.rb
+- spec/transformation_pipeline/transformations/description_spec.rb
 - spec/transformation_pipeline/transformations/height_spec.rb
 - spec/transformation_pipeline/transformations/id_attribute_spec.rb
 - spec/transformation_pipeline/transformations/preserve_aspect_ratio_spec.rb
@@ -194,7 +211,9 @@ test_files:
 - spec/inline_svg_spec.rb
 - spec/io_resource_spec.rb
 - spec/transformation_pipeline/transformations/aria_attributes_spec.rb
+- spec/transformation_pipeline/transformations/class_attribute_spec.rb
 - spec/transformation_pipeline/transformations/data_attributes_spec.rb
+- spec/transformation_pipeline/transformations/description_spec.rb
 - spec/transformation_pipeline/transformations/height_spec.rb
 - spec/transformation_pipeline/transformations/id_attribute_spec.rb
 - spec/transformation_pipeline/transformations/preserve_aspect_ratio_spec.rb