inline_svg 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41039ec47d5e43fa34eaf787648e970efbf07c01
-  data.tar.gz: 026d0ba494b8d333dee2c4fa1d73e1544c40a972
+  metadata.gz: 529e4c1b0bd2b16b4684a2cd241bdb707cd14e74
+  data.tar.gz: 86d782dd377e342b750e245001cbd50bba50dc71
 SHA512:
-  metadata.gz: 361e754da8e05922c1575bee23500fc40d12675f06a925e35f64db3d9ce3716e2e2719509a710b1f0b3dbbeff2a7c3f8dbd1a4675eda5f72a2848b7aa2ede62b
-  data.tar.gz: ed37e6ad6598811999e617f6919e759c2eb455d3e91be2e07bcb578c44d8a27a1a104b0087be35b2f57c0f83b022b8698fbfe2f93d06e93b2ddb99692a55b085
+  metadata.gz: 46dba646464d60a3df6cc59f27767a58ef482faee661a15bd93841f5c32aeb405a30b77fc0dc53bf3f12e74ab12edb2dac9b0bc3c35505388432701010263dec
+  data.tar.gz: 9ee8d699f27cd417bcdef5c42fc0036b7797d5fb5394c38fa7cfca576f1a16b3e3ee950f4cb082015d184ea0eebfedd26fd0c373777989e8e414b94326b9ad62

data/README.md

@@ -60,12 +60,14 @@ blue:
 * `class`: set a CSS class attribute on the SVG
 * `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)
 
 Example:
 
 ```
 inline_svg("some-document.svg", class: 'some-class', title: 'Some Title', desc:
-'Some interesting description')
+'Some interesting description', nocomment: true)
 ```
 
 ## Contributing

data/inline_svg.gemspec

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

data/lib/inline_svg/action_view/helpers.rb

@@ -1,6 +1,7 @@
 require 'action_view/helpers' if defined?(Rails)
 require 'action_view/context' if defined?(Rails)
 require 'nokogiri'
+require 'loofah'
 
 module InlineSvg
   module ActionView
@@ -8,6 +9,12 @@ module InlineSvg
       def inline_svg(filename, options={})
         file = File.read(Rails.root.join('app', 'assets', 'images', filename))
         doc = Nokogiri::HTML::DocumentFragment.parse file
+
+        # remove comments from svg file
+        if options[:nocomment].present?
+          doc = Loofah.fragment(doc.to_s).scrub!(:strip)
+        end
+
         svg = doc.at_css 'svg'
         if options[:class]
           svg['class'] = options[:class]

data/lib/inline_svg/version.rb

@@ -1,3 +1,3 @@
 module InlineSvg
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/files/example.svg

@@ -1,3 +1,3 @@
 <svg xmlns="http://www.w3.org/2000/svg"
      xml:lang="en"
-     role="presentation"></svg>
+     role="presentation"><!-- This is a comment --></svg>

data/spec/helpers/inline_svg_spec.rb

@@ -23,31 +23,41 @@ describe InlineSvg::ActionView::Helpers do
     
     context 'when passed a SVG file' do
       
-      subject { mock_helper.inline_svg( 'mocked_path' ) }
+      subject { mock_helper.inline_svg( 'mocked_path' ).strip }
       let(:example_svg) {
 <<-SVG.sub(/\n$/, '')
-<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"></svg>
+<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><!-- This is a comment --></svg>
 SVG
       }
       
       it { is_expected.to eql example_svg }
       
-      context 'and additional options' do
+      context 'and title and description options' do
       
-        subject { mock_helper.inline_svg( 'mocked_path', title: 'A title', desc: 'A desc' ) }
+        subject { mock_helper.inline_svg( 'mocked_path', title: 'A title', desc: 'A desc' ).strip }
         let(:example_svg) {
 <<-SVG.sub(/\n$/, '')
-<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><title>A title</title>
+<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><!-- This is a comment --><title>A title</title>
 <desc>A desc</desc></svg>
 SVG
         }
         
         it { is_expected.to eql example_svg }
       
-      end # 'and additional options'
-    
-    end # 'when passed a SVG file'
-    
-  end #inline_svg
-  
-end # describe InlineSvg::ActionView::Helpers
+      end
+
+      context 'and the "nocomment" option' do
+
+        subject { mock_helper.inline_svg( 'mocked_path', nocomment: true).strip }
+        let(:example_svg) {
+<<-SVG.sub(/\n$/, '')
+<svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"></svg>
+SVG
+        }
+
+        it { is_expected.to eql example_svg }
+
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inline_svg
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2014-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ 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