inline_svg 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fee50facd0f1019648bd0f7ab4d716c26919c098
-  data.tar.gz: 4987318412fe0646742ceaf185df7a33bf2f1835
+  metadata.gz: 6eda36369f830ee60216241e8152c2a92be18f4f
+  data.tar.gz: 4a2c84a1379d7341aa74623b132b5d36ee68ea90
 SHA512:
-  metadata.gz: 440f34b97188f0e0733ecc60d31bd436b2b911a708339b759b4729469029a01755498c4ea105eead195867749751049b57b2b6aa064dbc6ded2d23df65f0d79f
-  data.tar.gz: 316936a7b5e273da6ba81e38e6f1f70df6aca4ac73ec8c80fbd3a7658a0e6f13be4ec5e0308c899fbc6b1336a46e3409d5efec7851ceb4b7f0860bd12d172b48
+  metadata.gz: 7c9c902e2ae6574cab4ab8a3bf69edb5a69232c190112ae645f9a1f402edf5bcb434c2b149620af12290dd1bcdb285c259d815c3220a92f0b2b8c7e753a163a7
+  data.tar.gz: a593f1d06649736a8772efd8b38f51ce476be53b62f252dbe45a1ccf35e46a0266fd3d693bd0b8b45284218697cc84a779562c00a3b1355ba1fb6151f4183652

data/CHANGELOG.md

@@ -5,6 +5,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased][unreleased]
 Nothing.
 
+## [0.5.0] - 2015-03-29
+### Added
+- A new option: `id` adds an id attribute to the SVG.
+- A new option: `data` adds data attributes to the SVG.
+
+### Changed
+- New options: `height` and `width` override `size` and can be set independently.
+
 ## [0.4.0] - 2015-03-22
 ### Added
 - A new option: `size` adds width and height attributes to an SVG. Thanks, @2metres.
@@ -33,7 +41,8 @@ Nothing.
 ### Added
 - Basic Railtie and view helper to inline SVG documents to Rails views.
 
-[unreleased]: https://github.com/jamesmartin/inline_svg/compare/v0.4.0...HEAD
+[unreleased]: https://github.com/jamesmartin/inline_svg/compare/v0.5.0...HEAD
+[0.5.0]: https://github.com/jamesmartin/inline_svg/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/jamesmartin/inline_svg/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/jamesmartin/inline_svg/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/jamesmartin/inline_svg/compare/v0.1.0...v0.2.0

data/README.md

@@ -65,8 +65,12 @@ blue:
 ```
 
 ## Options
+* `id`: set a ID attribute on the SVG
 * `class`: set a CSS class attribute on the SVG
+* `data`: add data attributes to the SVG (supply as a hash)
 * `size`: set width and height attributes on the SVG
+  * Can also be set using `height` and/or `width` attributes, which take
+    precedence over `size`
   * Supplied as "{Width} * {Height}" or "{Number}", so "30px*45px" becomes `width="30px"`
     and `height="45px"`, and "50%" becomes `width="50%"` and `height="50%"`
 * `title`: add a \<title\> node inside the top level of the SVG document
@@ -77,8 +81,8 @@ blue:
 Example:
 
 ```
-inline_svg("some-document.svg", class: 'some-class', size: '30% * 20%', title: 'Some Title', desc:
-'Some interesting description', nocomment: true)
+inline_svg("some-document.svg", id: 'some-id', class: 'some-class', data: {some: "value"}, size: '30% * 20%', title: 'Some Title', desc:
+'Some description', nocomment: true)
 ```
 
 ## Contributing

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

@@ -0,0 +1,16 @@
+module InlineSvg::TransformPipeline::Transformations
+  class DataAttributes < Transformation
+    def transform(doc)
+      doc = Nokogiri::XML::Document.parse(doc.to_html)
+      svg = doc.at_css 'svg'
+      with_valid_hash_from(self.value).each_pair do |name, data|
+        svg["data-#{name}"] = data
+      end
+      doc
+    end
+
+    def with_valid_hash_from(hash)
+      Hash.try_convert(hash) || {}
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module InlineSvg::TransformPipeline::Transformations
+  class Height < Transformation
+    def transform(doc)
+      doc = Nokogiri::XML::Document.parse(doc.to_html)
+      svg = doc.at_css 'svg'
+      svg['height'] = self.value
+      doc
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module InlineSvg::TransformPipeline::Transformations
+  class IdAttribute < Transformation
+    def transform(doc)
+      doc = Nokogiri::XML::Document.parse(doc.to_html)
+      svg = doc.at_css 'svg'
+      svg['id'] = self.value
+      doc
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module InlineSvg::TransformPipeline::Transformations
+  class Width < Transformation
+    def transform(doc)
+      doc = Nokogiri::XML::Document.parse(doc.to_html)
+      svg = doc.at_css 'svg'
+      svg['width'] = self.value
+      doc
+    end
+  end
+end

data/lib/inline_svg/transform_pipeline/transformations.rb

@@ -1,6 +1,16 @@
 module InlineSvg::TransformPipeline::Transformations
   def self.all_transformations
-    {nocomment: NoComment, class: ClassAttribute, title: Title, desc: Description, size: Size}
+    {
+      nocomment: NoComment,
+      class: ClassAttribute,
+      title: Title,
+      desc: Description,
+      size: Size,
+      height: Height,
+      width: Width,
+      id: IdAttribute,
+      data: DataAttributes
+    }
   end
 
   def self.lookup(transform_params)
@@ -20,3 +30,7 @@ require 'inline_svg/transform_pipeline/transformations/class_attribute'
 require 'inline_svg/transform_pipeline/transformations/title'
 require 'inline_svg/transform_pipeline/transformations/description'
 require 'inline_svg/transform_pipeline/transformations/size'
+require 'inline_svg/transform_pipeline/transformations/height'
+require 'inline_svg/transform_pipeline/transformations/width'
+require 'inline_svg/transform_pipeline/transformations/id_attribute'
+require 'inline_svg/transform_pipeline/transformations/data_attributes'

data/lib/inline_svg/version.rb

@@ -1,3 +1,3 @@
 module InlineSvg
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/transformation_pipeline/transformations/data_attributes_spec.rb

@@ -0,0 +1,36 @@
+require 'inline_svg/transform_pipeline'
+
+describe InlineSvg::TransformPipeline::Transformations::DataAttributes do
+  it "adds a data attribute to a SVG document" do
+    document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')
+    transformation = InlineSvg::TransformPipeline::Transformations::DataAttributes.create_with_value({some: "value"})
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg data-some=\"value\">Some document</svg>\n"
+    )
+  end
+
+  context "when multiple data attributes are supplied" do
+    it "adds data attributes to the SVG for each supplied value" do
+      document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')
+      transformation = InlineSvg::TransformPipeline::Transformations::DataAttributes.
+        create_with_value({some: "value", other: "thing"})
+
+      expect(transformation.transform(document).to_html).to eq(
+        "<svg data-some=\"value\" data-other=\"thing\">Some document</svg>\n"
+      )
+    end
+  end
+
+  context "when a non-hash is supplied" do
+    it "does not update the SVG document" do
+      document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')
+      transformation = InlineSvg::TransformPipeline::Transformations::DataAttributes.
+        create_with_value("some non-hash")
+
+      expect(transformation.transform(document).to_html).to eq(
+        "<svg>Some document</svg>\n"
+      )
+    end
+  end
+end

data/spec/transformation_pipeline/transformations/height_spec.rb

@@ -0,0 +1,12 @@
+require 'inline_svg/transform_pipeline'
+
+describe InlineSvg::TransformPipeline::Transformations::Height do
+  it "adds height attribute to a SVG document" do
+    document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')
+    transformation = InlineSvg::TransformPipeline::Transformations::Height.create_with_value("5%")
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg height=\"5%\">Some document</svg>\n"
+    )
+  end
+end

data/spec/transformation_pipeline/transformations/id_attribute_spec.rb

@@ -0,0 +1,12 @@
+require 'inline_svg/transform_pipeline'
+
+describe InlineSvg::TransformPipeline::Transformations::IdAttribute do
+  it "adds an id attribute to a SVG document" do
+    document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')
+    transformation = InlineSvg::TransformPipeline::Transformations::IdAttribute.create_with_value("some-id")
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg id=\"some-id\">Some document</svg>\n"
+    )
+  end
+end

data/spec/transformation_pipeline/transformations/width_spec.rb

@@ -0,0 +1,12 @@
+require 'inline_svg/transform_pipeline'
+
+describe InlineSvg::TransformPipeline::Transformations::Width do
+  it "adds width attribute to a SVG document" do
+    document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')
+    transformation = InlineSvg::TransformPipeline::Transformations::Width.create_with_value("5%")
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg width=\"5%\">Some document</svg>\n"
+    )
+  end
+end

data/spec/transformation_pipeline/transformations_spec.rb

@@ -8,7 +8,11 @@ describe InlineSvg::TransformPipeline::Transformations do
         class: 'irrelevant',
         title: 'irrelevant',
         desc: 'irrelevant',
-        size: 'irrelevant'
+        size: 'irrelevant',
+        height: 'irrelevant',
+        width: 'irrelevant',
+        id: 'irrelevant',
+        data: 'irrelevant'
       )
 
       expect(transformations.map(&:class)).to match_array([
@@ -16,7 +20,11 @@ describe InlineSvg::TransformPipeline::Transformations do
         InlineSvg::TransformPipeline::Transformations::ClassAttribute,
         InlineSvg::TransformPipeline::Transformations::Title,
         InlineSvg::TransformPipeline::Transformations::Description,
-        InlineSvg::TransformPipeline::Transformations::Size
+        InlineSvg::TransformPipeline::Transformations::Size,
+        InlineSvg::TransformPipeline::Transformations::Height,
+        InlineSvg::TransformPipeline::Transformations::Width,
+        InlineSvg::TransformPipeline::Transformations::IdAttribute,
+        InlineSvg::TransformPipeline::Transformations::DataAttributes
       ])
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inline_svg
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - James Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-22 00:00:00.000000000 Z
+date: 2015-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,18 +116,26 @@ files:
 - lib/inline_svg/transform_pipeline.rb
 - lib/inline_svg/transform_pipeline/transformations.rb
 - lib/inline_svg/transform_pipeline/transformations/class_attribute.rb
+- lib/inline_svg/transform_pipeline/transformations/data_attributes.rb
 - lib/inline_svg/transform_pipeline/transformations/description.rb
+- lib/inline_svg/transform_pipeline/transformations/height.rb
+- lib/inline_svg/transform_pipeline/transformations/id_attribute.rb
 - lib/inline_svg/transform_pipeline/transformations/no_comment.rb
 - lib/inline_svg/transform_pipeline/transformations/size.rb
 - lib/inline_svg/transform_pipeline/transformations/title.rb
 - lib/inline_svg/transform_pipeline/transformations/transformation.rb
+- lib/inline_svg/transform_pipeline/transformations/width.rb
 - lib/inline_svg/version.rb
 - spec/asset_file_spec.rb
 - spec/files/example.svg
 - spec/finds_asset_paths_spec.rb
 - spec/helpers/inline_svg_spec.rb
 - spec/inline_svg_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
 - spec/transformation_pipeline/transformations/size_spec.rb
+- spec/transformation_pipeline/transformations/width_spec.rb
 - spec/transformation_pipeline/transformations_spec.rb
 homepage: ''
 licenses:
@@ -159,5 +167,9 @@ test_files:
 - spec/finds_asset_paths_spec.rb
 - spec/helpers/inline_svg_spec.rb
 - spec/inline_svg_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
 - spec/transformation_pipeline/transformations/size_spec.rb
+- spec/transformation_pipeline/transformations/width_spec.rb
 - spec/transformation_pipeline/transformations_spec.rb