inline_svg 0.12.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0491a6e65ea3cac66dc9612b22a0a7a2715bb668
-  data.tar.gz: 31d0110574f801a1f3cc77916decb92edc997513
+  metadata.gz: 7004d185bef2b924f18a066874654c38df4def32
+  data.tar.gz: b88ad5893b28740772c3561c2ec10b49f16354e8
 SHA512:
-  metadata.gz: b58b3ca89ab12aba85a60e6073e835aa335b1d7a8e6e6af9218a63c0342eadc4cdd2d905b08a88b9c53d0535c65b8706a48f3d29e0113b8e989d8708d4c70286
-  data.tar.gz: dd349c539a96ebeaf27dc71bcdc1c9cd7da6a4d54e07911272a5bf4896c28587a0d56c61e49eea6689e71917b020595b595982da27ea00a73ac75aa3ef70cf15
+  metadata.gz: d2cd936da88bd368aa88e7da0ef68791523c3c386d746e094c7e8f3df4b8b9dd3dc2293529d10ee80a42273a82f45ae69c356d55c2ada0ead4c59fcdfe64ed33
+  data.tar.gz: efdcb9cdbd557a06a0b689563b469df1fb1d7e8d78b62cc7cad97f70e26fb6f0c2d72f624ae7b36301a45298326ee043c401cc34b8e3bded752a886a14d62def

data/CHANGELOG.md

@@ -5,6 +5,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased][unreleased]
 - Nothing
 
+## [1.0.0] - 2017-04-7
+### Added
+- Remove dependency on `Loofah` while maintaining basic `nocomment` transform
+
 ## [0.12.1] - 2017-03-24
 ### Added
 - Relax dependency on `Nokogiri` to allow users to upgrade to v1.7x, preventing
@@ -136,7 +140,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.12.1...HEAD
+[unreleased]: https://github.com/jamesmartin/inline_svg/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/jamesmartin/inline_svg/compare/v0.12.1...v1.0.0
 [0.12.1]: https://github.com/jamesmartin/inline_svg/compare/v0.12.0...v0.12.1
 [0.12.0]: https://github.com/jamesmartin/inline_svg/compare/v0.11.1...v0.12.0
 [0.11.1]: https://github.com/jamesmartin/inline_svg/compare/v0.11.0...v0.11.1

data/README.md

@@ -4,13 +4,11 @@ Styling a SVG document with CSS for use on the web is most reliably achieved by
 [adding classes to the document and
 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
+This gem adds a 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 3](http://weblog.rubyonrails.org/2010/8/29/rails-3-0-it-s-done/) (from [v0.12.0](https://github.com/jamesmartin/inline_svg/releases/tag/v0.12.0)), [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/) (from [v0.10.0](https://github.com/jamesmartin/inline_svg/releases/tag/v0.10.0)).
 
-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.).
-
 ## Changelog
 
 This project adheres to [Semantic Versioning](http://semver.org). All notable changes are documented in the
@@ -76,10 +74,10 @@ key                     | description
 `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 <br/> Can also be set using `height` and/or `width` attributes, which take precedence over `size` <br/> Supplied as "{Width} * {Height}" or "{Number}", so "30px*45px" becomes `width="30px"` and `height="45px"`, and "50%" becomes `width="50%"` and `height="50%"`
+`size`                  | set width and height attributes on the SVG <br/> Can also be set using `height` and/or `width` attributes, which take precedence over `size` <br/> 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
 `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)
+`nocomment`             | remove comment tags from the SVG document
 `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)
 

data/inline_svg.gemspec

@@ -26,5 +26,4 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "activesupport", ">= 3.0"
   spec.add_runtime_dependency "nokogiri", ">= 1.6"
-  spec.add_runtime_dependency "loofah", ">= 2.0"
 end

data/lib/inline_svg/transform_pipeline.rb

@@ -10,6 +10,5 @@ module InlineSvg
 end
 
 require 'nokogiri'
-require 'loofah'
 require 'inline_svg/id_generator'
 require 'inline_svg/transform_pipeline/transformations'

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

@@ -2,8 +2,11 @@ module InlineSvg::TransformPipeline
   module Transformations
     class NoComment < Transformation
       def transform(doc)
-        doc = Loofah::HTML::DocumentFragment.parse(doc.to_html)
-        doc.scrub!(:strip)
+        doc = Nokogiri::XML::Document.parse(doc.to_html)
+        doc.xpath("//comment()").each do |comment|
+          comment.remove
+        end
+        doc
       end
     end
   end

data/lib/inline_svg/version.rb

@@ -1,3 +1,3 @@
 module InlineSvg
-  VERSION = "0.12.1"
+  VERSION = "1.0.0"
 end

data/spec/helpers/inline_svg_spec.rb

@@ -41,7 +41,7 @@ describe InlineSvg::ActionView::Helpers do
       context "and no options" do
         it "returns a html safe version of the file's contents" do
           example_file = <<-SVG
-<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><!-- This is a comment --></svg>
+<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"><!-- This is a comment --></svg>
 SVG
           allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(example_file)
           expect(helper.inline_svg('some-file')).to eq example_file
@@ -77,7 +77,7 @@ SVG
       context "and the 'nocomment' option" do
         it "strips comments and other unknown/unsafe nodes from the output" do
           input_svg = <<-SVG
-<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><!-- This is a comment --></svg>
+<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"><!-- This is a comment --></svg>
 SVG
           expected_output = <<-SVG
 <svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"></svg>
@@ -90,11 +90,10 @@ SVG
       context "and all options" do
         it "applies all expected transformations to the output" do
           input_svg = <<-SVG
-<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><!-- This is a comment --></svg>
+<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"><!-- This is a comment --></svg>
 SVG
           expected_output = <<-SVG
-<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"><title>A title</title>
-<desc>A description</desc></svg>
+<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"><title>A title</title><desc>A description</desc></svg>
 SVG
           allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
           expect(helper.inline_svg('some-file', title: 'A title', desc: 'A description', nocomment: true)).to eq expected_output

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inline_svg
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 1.0.0
 platform: ruby
 authors:
 - James Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-23 00:00:00.000000000 Z
+date: 2017-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,20 +108,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: loofah
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
 description: Get an SVG into your view and then style it with CSS.
 email:
 - inline_svg@jmrtn.com