inline_svg 0.6.4 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20cf938dedae16a9b3f2282f60666911ea31918d
-  data.tar.gz: 3e85ceba1e9306512ce5b6c8bf5e362449da05fb
+  metadata.gz: 0c003e0cd953e58b743df9c836748124cac54bab
+  data.tar.gz: 58b09ffa5695e837d113957adeb339db0f0484dc
 SHA512:
-  metadata.gz: 913ca48724b6e124be585023a910568f7f7d850521f0e8294832160b84cd7c6e063b51cd5ddc097a22c92078c32f2f29be48c81ef0b300ff37f07fecd54c1ea6
-  data.tar.gz: ee22b302999f9bd020af932b4615a061cf3c8a14bb0a5bb5091f6f44edeb2f6fbd11e90fb82dba031d0161fe5e97a0fd368b6ed559246c0fd1b4e30fffe677be
+  metadata.gz: ba4074f8ae922fc6ef08a0e9ecbe66e334350e21be1374b6f72b20a9093f73652540cf248bc5392e41678233580135bf1609dab4a6e2ded08ae1b4f7c72b6541
+  data.tar.gz: ec749c7628ad273fb5605e70abe309aa74be1dec9c307ae1656de02d34294d81fd8a6244bd24293b03a17fff3558ec3a8c33706c22e5c7e3b9f2b25cd7169bb1

data/CHANGELOG.md

@@ -5,11 +5,16 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased][unreleased]
 - Nothing.
 
+## [0.7.0] - 2016-05-03
+### Added
+- Aria attributes transform (aria-labelledby / role etc.) Addresses issue
+  [#28](https://github.com/jamesmartin/inline_svg/issues/28)
+
 ## [0.6.4] - 2016-04-23
 ### Fixed
 - Don't duplicate the `title` element. Addresses issue
-  [#31](https://github.com/jamesmartin/inline_svg/issues/31).
-- Make the `title` element the first child node of the SVG document.
+  [#31](https://github.com/jamesmartin/inline_svg/issues/31)
+- Make the `title` element the first child node of the SVG document
 
 ## [0.6.3] - 2016-04-19
 ### Added
@@ -80,7 +85,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.6.4...HEAD
+[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
 [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

@@ -81,12 +81,13 @@ key                     | description
 `desc`                  | add a \<desc\> node inside the top level of the SVG document
 `nocomment`             | remove comment tags (and other unsafe/unknown tags) from svg (uses the [Loofah](https://github.com/flavorjones/loofah) gem)
 `preserve_aspect_ratio` | adds a `preserveAspectRatio` attribute to the SVG
+`aria`                  | adds common accessibility attributes to the SVG (see [PR #34](https://github.com/jamesmartin/inline_svg/pull/34#issue-152062674) for details)
 
 Example:
 
 ```ruby
 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, preserve_aspect_ratio: 'xMaxYMax meet')
+'Some description', nocomment: true, preserve_aspect_ratio: 'xMaxYMax meet', aria: true)
 ```
 
 ## Custom Transformations

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

@@ -0,0 +1,23 @@
+module InlineSvg::TransformPipeline::Transformations
+  class AriaAttributes < Transformation
+    def transform(doc)
+      doc = Nokogiri::XML::Document.parse(doc.to_html)
+      svg = doc.at_css("svg")
+
+      # Add role
+      svg["role"] = "img"
+
+      # Build aria-labelledby string
+      aria_elements = []
+      doc.search("svg title").each { |_| aria_elements << "title" }
+      doc.search("svg desc").each { |_| aria_elements << "desc" }
+      aria_elements.uniq!
+
+      if aria_elements.any?
+        svg["aria-labelledby"] = aria_elements.join(" ")
+      end
+
+      doc
+    end
+  end
+end

data/lib/inline_svg/transform_pipeline/transformations.rb

@@ -10,7 +10,8 @@ module InlineSvg::TransformPipeline::Transformations
       width: Width,
       id: IdAttribute,
       data: DataAttributes,
-      preserve_aspect_ratio: PreserveAspectRatio
+      preserve_aspect_ratio: PreserveAspectRatio,
+      aria: AriaAttributes
     }
   end
 
@@ -44,3 +45,4 @@ require 'inline_svg/transform_pipeline/transformations/width'
 require 'inline_svg/transform_pipeline/transformations/id_attribute'
 require 'inline_svg/transform_pipeline/transformations/data_attributes'
 require 'inline_svg/transform_pipeline/transformations/preserve_aspect_ratio'
+require 'inline_svg/transform_pipeline/transformations/aria_attributes'

data/lib/inline_svg/version.rb

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

data/spec/transformation_pipeline/aria_attributes_spec.rb

@@ -0,0 +1,41 @@
+require 'inline_svg/transform_pipeline'
+
+describe InlineSvg::TransformPipeline::Transformations::AriaAttributes do
+  it "adds a role attribute to the SVG document" do
+    document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')
+    transformation = InlineSvg::TransformPipeline::Transformations::AriaAttributes.create_with_value({})
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg role=\"img\">Some document</svg>\n"
+    )
+  end
+
+  context "aria-labelledby attribute" do
+    it "adds 'title' when a title element is present" do
+      document = Nokogiri::XML::Document.parse('<svg><title>Some title</title>Some document</svg>')
+      transformation = InlineSvg::TransformPipeline::Transformations::AriaAttributes.create_with_value({})
+
+      expect(transformation.transform(document).to_html).to eq(
+        "<svg role=\"img\" aria-labelledby=\"title\"><title>Some title</title>Some document</svg>\n"
+      )
+    end
+
+    it "adds 'desc' when a description element is present" do
+      document = Nokogiri::XML::Document.parse('<svg><desc>Some description</desc>Some document</svg>')
+      transformation = InlineSvg::TransformPipeline::Transformations::AriaAttributes.create_with_value({})
+
+      expect(transformation.transform(document).to_html).to eq(
+        "<svg role=\"img\" aria-labelledby=\"desc\"><desc>Some description</desc>Some document</svg>\n"
+      )
+    end
+
+    it "adds both 'desc' and 'title' when title and description elements are present" do
+      document = Nokogiri::XML::Document.parse('<svg><title>Some title</title><desc>Some description</desc>Some document</svg>')
+      transformation = InlineSvg::TransformPipeline::Transformations::AriaAttributes.create_with_value({})
+
+      expect(transformation.transform(document).to_html).to eq(
+        "<svg role=\"img\" aria-labelledby=\"title desc\"><title>Some title</title>\n<desc>Some description</desc>Some document</svg>\n"
+      )
+    end
+  end
+end

data/spec/transformation_pipeline/transformations_spec.rb

@@ -21,6 +21,7 @@ describe InlineSvg::TransformPipeline::Transformations do
         id: 'irrelevant',
         data: 'irrelevant',
         preserve_aspect_ratio: 'irrelevant',
+        aria: 'irrelevant',
       )
 
       expect(transformations.map(&:class)).to match_array([
@@ -33,7 +34,8 @@ describe InlineSvg::TransformPipeline::Transformations do
         InlineSvg::TransformPipeline::Transformations::Width,
         InlineSvg::TransformPipeline::Transformations::IdAttribute,
         InlineSvg::TransformPipeline::Transformations::DataAttributes,
-        InlineSvg::TransformPipeline::Transformations::PreserveAspectRatio
+        InlineSvg::TransformPipeline::Transformations::PreserveAspectRatio,
+        InlineSvg::TransformPipeline::Transformations::AriaAttributes
       ])
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inline_svg
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.7.0
 platform: ruby
 authors:
 - James Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2016-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,6 +131,7 @@ files:
 - lib/inline_svg/static_asset_finder.rb
 - lib/inline_svg/transform_pipeline.rb
 - lib/inline_svg/transform_pipeline/transformations.rb
+- lib/inline_svg/transform_pipeline/transformations/aria_attributes.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
@@ -149,6 +150,7 @@ files:
 - spec/helpers/inline_svg_spec.rb
 - spec/inline_svg_spec.rb
 - spec/io_resource_spec.rb
+- spec/transformation_pipeline/aria_attributes_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
@@ -188,6 +190,7 @@ test_files:
 - spec/helpers/inline_svg_spec.rb
 - spec/inline_svg_spec.rb
 - spec/io_resource_spec.rb
+- spec/transformation_pipeline/aria_attributes_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