inline_svg 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76c4c056778276bacd69cc27ec4c982566f99f4b
-  data.tar.gz: e3678d7bf16c59dd3922d358265721e2fa05151a
+  metadata.gz: fee50facd0f1019648bd0f7ab4d716c26919c098
+  data.tar.gz: 4987318412fe0646742ceaf185df7a33bf2f1835
 SHA512:
-  metadata.gz: a883fe5008e571a78008f94e8196ba84feb846bd25086bc127573c142a2e5232c90278e7002adbd0609dbf3be9dec25758743acd1f86e98280abec3a8df23f64
-  data.tar.gz: 3fa071d1f1e307cb3bffab9e7144dcf681aa32e5549fb950b350fe55a2eb4bc16438db2eebe508d3fd79b0b7022ade27bcb1b499a47498b9a42da389ff2be9ec
+  metadata.gz: 440f34b97188f0e0733ecc60d31bd436b2b911a708339b759b4729469029a01755498c4ea105eead195867749751049b57b2b6aa064dbc6ded2d23df65f0d79f
+  data.tar.gz: 316936a7b5e273da6ba81e38e6f1f70df6aca4ac73ec8c80fbd3a7658a0e6f13be4ec5e0308c899fbc6b1336a46e3409d5efec7851ceb4b7f0860bd12d172b48

data/CHANGELOG.md

@@ -5,6 +5,17 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased][unreleased]
 Nothing.
 
+## [0.4.0] - 2015-03-22
+### Added
+- A new option: `size` adds width and height attributes to an SVG. Thanks, @2metres.
+
+### Changed
+- Dramatically simplified the TransformPipeline and Transformations code.
+- Added tests for the pipeline and new size transformations.
+
+### Fixed
+- Transformations can no longer be created with a nil value.
+
 ## [0.3.0] - 2015-03-20
 ### Added
 - Use Sprockets to find canonical asset paths (fingerprinted, post asset-pipeline).
@@ -22,6 +33,8 @@ Nothing.
 ### Added
 - Basic Railtie and view helper to inline SVG documents to Rails views.
 
-[unreleased]: https://github.com/jamesmartin/inline_svg/compare/v0.2.0...HEAD
+[unreleased]: https://github.com/jamesmartin/inline_svg/compare/v0.4.0...HEAD
+[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
 [0.1.0]: https://github.com/jamesmartin/inline_svg/compare/v0.0.1...v0.1.0

data/README.md

@@ -32,9 +32,12 @@ Or install it yourself as:
 ```
 inline_svg(file_name, options={})
 ```
+The `file_name` can be a full path to a file, or just the file's basename. The
+actual path of the file on disk is resolved using
+[Sprockets](://github.com/sstephenson/sprockets), which means you can pre-process
+and fingerprint your SVG files like any other Rails asset.
 
-Currently, this little helper only works in the context of a Rails app. Here's
-an example of embedding an SVG document and applying a 'class' attribute in
+Here's an example of embedding an SVG document and applying a 'class' attribute in
 HAML:
 
 ```
@@ -63,6 +66,9 @@ blue:
 
 ## Options
 * `class`: set a CSS class attribute on the SVG
+* `size`: set width and height attributes on the SVG
+  * 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
@@ -71,7 +77,7 @@ blue:
 Example:
 
 ```
-inline_svg("some-document.svg", class: 'some-class', title: 'Some Title', desc:
+inline_svg("some-document.svg", class: 'some-class', size: '30% * 20%', title: 'Some Title', desc:
 'Some interesting description', nocomment: true)
 ```
 
@@ -82,3 +88,8 @@ inline_svg("some-document.svg", class: 'some-class', title: 'Some Title', desc:
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+Please write tests for anything you change, add or fix.
+There is a [basic Rails
+app](http://github.com/jamesmartin/inline_svg_test_app) that demonstrates the
+gem's functionality in use.

data/lib/inline_svg/action_view/helpers.rb

@@ -1,36 +1,17 @@
 require 'action_view/helpers' if defined?(Rails)
 require 'action_view/context' if defined?(Rails)
-require 'nokogiri'
-require 'loofah'
 
 module InlineSvg
   module ActionView
     module Helpers
-      def inline_svg(filename, options={})
+      def inline_svg(filename, transform_params={})
         begin
-          doc = Loofah::HTML::DocumentFragment.parse(AssetFile.named(filename))
+          svg_file = AssetFile.named(filename)
         rescue InlineSvg::AssetFile::FileNotFound
           return "<svg><!-- SVG file not found: '#{filename}' --></svg>".html_safe
         end
 
-        if options[:nocomment].present?
-          doc.scrub!(:strip)
-        end
-
-        svg = doc.at_css 'svg'
-        if options[:class]
-          svg['class'] = options[:class]
-        end
-
-        %i(title desc).each do |child|
-          if options[child].present?
-            node = Nokogiri::XML::Node.new(child.to_s, doc)
-            node.content = options[child]
-            svg.add_child node
-          end
-        end
-
-        doc.to_html.html_safe
+        InlineSvg::TransformPipeline.generate_html_from(svg_file, transform_params).html_safe
       end
     end
   end

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

@@ -0,0 +1,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
+      doc
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module InlineSvg::TransformPipeline::Transformations
+  class Description < Transformation
+    def transform(doc)
+      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
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module InlineSvg::TransformPipeline
+  module Transformations
+    class NoComment < Transformation
+      def transform(doc)
+        doc = Loofah::HTML::DocumentFragment.parse(doc.to_html)
+        doc.scrub!(:strip)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module InlineSvg::TransformPipeline::Transformations
+  class Size < Transformation
+    def transform(doc)
+      doc = Nokogiri::XML::Document.parse(doc.to_html)
+      svg = doc.at_css 'svg'
+      svg['width'] = width_of(self.value)
+      svg['height'] = height_of(self.value)
+      doc
+    end
+
+    def width_of(value)
+      value.split(/\*/).map(&:strip)[0]
+    end
+
+    def height_of(value)
+      value.split(/\*/).map(&:strip)[1] || width_of(value)
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module InlineSvg::TransformPipeline::Transformations
+  class Title < Transformation
+    def transform(doc)
+      doc = Nokogiri::XML::Document.parse(doc.to_html)
+      node = Nokogiri::XML::Node.new('title', doc)
+      node.content = value
+      doc.at_css('svg').add_child(node)
+      doc
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module InlineSvg::TransformPipeline::Transformations
+  class Transformation
+    def self.create_with_value(value)
+      self.new(value)
+    end
+
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+
+    def transform(*)
+      raise "#transform should be implemented by subclasses of Transformation"
+    end
+  end
+
+  class NullTransformation < Transformation
+    def transform(doc)
+      doc
+    end
+  end
+end

data/lib/inline_svg/transform_pipeline/transformations.rb

@@ -0,0 +1,22 @@
+module InlineSvg::TransformPipeline::Transformations
+  def self.all_transformations
+    {nocomment: NoComment, class: ClassAttribute, title: Title, desc: Description, size: Size}
+  end
+
+  def self.lookup(transform_params)
+    without_empty_values(transform_params).map do |key, value|
+      all_transformations.fetch(key, NullTransformation).create_with_value(value)
+    end
+  end
+
+  def self.without_empty_values(params)
+    params.reject {|key, value| value.nil?}
+  end
+end
+
+require 'inline_svg/transform_pipeline/transformations/transformation'
+require 'inline_svg/transform_pipeline/transformations/no_comment'
+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'

data/lib/inline_svg/transform_pipeline.rb

@@ -0,0 +1,14 @@
+module InlineSvg
+  module TransformPipeline
+    def self.generate_html_from(svg_file, transform_params)
+      document = Nokogiri::XML::Document.parse(svg_file)
+      Transformations.lookup(transform_params).reduce(document) do |doc, transformer|
+        transformer.transform(doc)
+      end.to_html
+    end
+  end
+end
+
+require 'nokogiri'
+require 'loofah'
+require 'inline_svg/transform_pipeline/transformations'

data/lib/inline_svg/version.rb

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

data/lib/inline_svg.rb

@@ -1,7 +1,9 @@
 require "inline_svg/version"
 require "inline_svg/action_view/helpers"
-require "inline_svg/finds_asset_paths"
 require "inline_svg/asset_file"
+require "inline_svg/finds_asset_paths"
+require "inline_svg/transform_pipeline"
+
 require "inline_svg/railtie" if defined?(Rails)
 require 'active_support/core_ext'
 require 'nokogiri'

data/spec/helpers/inline_svg_spec.rb

@@ -19,9 +19,9 @@ 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.sub(/\n$/, '')
-  <svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><!-- This is a comment --></svg>
-  SVG
+          example_file = <<-SVG
+<svg xmlns="http://www.w3.org/2000/svg" role="presentation" 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
         end
@@ -29,10 +29,10 @@ describe InlineSvg::ActionView::Helpers do
 
       context "and the 'title' option" do
         it "adds the title node to the SVG output" do
-          input_svg = <<-SVG.sub(/\n$/, '')
+          input_svg = <<-SVG
 <svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"></svg>
 SVG
-          expected_output = <<-SVG.sub(/\n$/, '')
+          expected_output = <<-SVG
 <svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><title>A title</title></svg>
 SVG
           allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
@@ -42,10 +42,10 @@ SVG
 
       context "and the 'desc' option" do
         it "adds the description node to the SVG output" do
-          input_svg = <<-SVG.sub(/\n$/, '')
+          input_svg = <<-SVG
 <svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"></svg>
 SVG
-          expected_output = <<-SVG.sub(/\n$/, '')
+          expected_output = <<-SVG
 <svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><desc>A description</desc></svg>
 SVG
           allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
@@ -55,10 +55,10 @@ SVG
 
       context "and the 'nocomment' option" do
         it "strips comments and other unknown/unsafe nodes from the output" do
-          input_svg = <<-SVG.sub(/\n$/, '')
+          input_svg = <<-SVG
 <svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><!-- This is a comment --></svg>
 SVG
-          expected_output = <<-SVG.sub(/\n$/, '')
+          expected_output = <<-SVG
 <svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"></svg>
 SVG
           allow(InlineSvg::AssetFile).to receive(:named).with('some-file').and_return(input_svg)
@@ -68,10 +68,10 @@ SVG
 
       context "and all options" do
         it "applies all expected transformations to the output" do
-          input_svg = <<-SVG.sub(/\n$/, '')
+          input_svg = <<-SVG
 <svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><!-- This is a comment --></svg>
 SVG
-          expected_output = <<-SVG.sub(/\n$/, '')
+          expected_output = <<-SVG
 <svg xmlns="http://www.w3.org/2000/svg" xml:lang="en"><title>A title</title>
 <desc>A description</desc></svg>
 SVG

data/spec/transformation_pipeline/transformations/size_spec.rb

@@ -0,0 +1,21 @@
+require 'inline_svg/transform_pipeline'
+
+describe InlineSvg::TransformPipeline::Transformations::Size do
+  it "adds width and height attributes to a SVG document" do
+    document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')
+    transformation = InlineSvg::TransformPipeline::Transformations::Size.create_with_value("5% * 5%")
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg width=\"5%\" height=\"5%\">Some document</svg>\n"
+    )
+  end
+
+  it "adds the same width and height value when only passed one attribute" do
+    document = Nokogiri::XML::Document.parse('<svg>Some document</svg>')
+    transformation = InlineSvg::TransformPipeline::Transformations::Size.create_with_value("5%")
+
+    expect(transformation.transform(document).to_html).to eq(
+      "<svg width=\"5%\" height=\"5%\">Some document</svg>\n"
+    )
+  end
+end

data/spec/transformation_pipeline/transformations_spec.rb

@@ -0,0 +1,41 @@
+require 'inline_svg/transform_pipeline'
+
+describe InlineSvg::TransformPipeline::Transformations do
+  context "looking up transformations" do
+    it "returns configured transformations when parameters are supplied" do
+      transformations = InlineSvg::TransformPipeline::Transformations.lookup(
+        nocomment: 'irrelevant',
+        class: 'irrelevant',
+        title: 'irrelevant',
+        desc: 'irrelevant',
+        size: 'irrelevant'
+      )
+
+      expect(transformations.map(&:class)).to match_array([
+        InlineSvg::TransformPipeline::Transformations::NoComment,
+        InlineSvg::TransformPipeline::Transformations::ClassAttribute,
+        InlineSvg::TransformPipeline::Transformations::Title,
+        InlineSvg::TransformPipeline::Transformations::Description,
+        InlineSvg::TransformPipeline::Transformations::Size
+      ])
+    end
+
+    it "returns a benign transformation when asked for an unknown transform" do
+      transformations = InlineSvg::TransformPipeline::Transformations.lookup(
+        not_a_real_transform: 'irrelevant'
+      )
+
+      expect(transformations.map(&:class)).to match_array([
+        InlineSvg::TransformPipeline::Transformations::NullTransformation
+      ])
+    end
+
+    it "does not return a transformation when a value is not supplied" do
+      transformations = InlineSvg::TransformPipeline::Transformations.lookup(
+        title: nil
+      )
+
+      expect(transformations.map(&:class)).to match_array([])
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inline_svg
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - James Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-20 00:00:00.000000000 Z
+date: 2015-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,12 +113,22 @@ files:
 - lib/inline_svg/asset_file.rb
 - lib/inline_svg/finds_asset_paths.rb
 - lib/inline_svg/railtie.rb
+- 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/description.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/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/size_spec.rb
+- spec/transformation_pipeline/transformations_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -149,3 +159,5 @@ test_files:
 - spec/finds_asset_paths_spec.rb
 - spec/helpers/inline_svg_spec.rb
 - spec/inline_svg_spec.rb
+- spec/transformation_pipeline/transformations/size_spec.rb
+- spec/transformation_pipeline/transformations_spec.rb