inline_svg 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4632d27f08baae878205e66ba52684fbd266dafa
-  data.tar.gz: c4f1086d39318016ca1143f1cf43df3797f3f59d
+  metadata.gz: 41039ec47d5e43fa34eaf787648e970efbf07c01
+  data.tar.gz: 026d0ba494b8d333dee2c4fa1d73e1544c40a972
 SHA512:
-  metadata.gz: 3a0319168f2a259c4c681e346f44d37fe83cd0cac6bcbcead70c4e89bb52e266a89ddbf891d1f2d6e27b6660f2bb3e7e37cfa98a5bfdf8f8003e66a44fe13797
-  data.tar.gz: e258223c987a278b449a4a8b1eeecdbc93a5e4ca71090756b3cdd2eb82b1a959f2c82a1f9330de8c6d875de72826683f09685b7efb65c7ce901344f8b37e02c1
+  metadata.gz: 361e754da8e05922c1575bee23500fc40d12675f06a925e35f64db3d9ce3716e2e2719509a710b1f0b3dbbeff2a7c3f8dbd1a4675eda5f72a2848b7aa2ede62b
+  data.tar.gz: ed37e6ad6598811999e617f6919e759c2eb455d3e91be2e07bcb578c44d8a27a1a104b0087be35b2f57c0f83b022b8698fbfe2f93d06e93b2ddb99692a55b085

data/README.md

@@ -1,6 +1,12 @@
-# InlineSvg
+# Inline Svg
 
-TODO: Write a gem description
+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 helper method (`inline_svg`) that reads an SVG document from a Rails
+image directory, applies a CSS class attribute to the root of the document and
+then embeds it into a view.
 
 ## Installation
 
@@ -18,11 +24,53 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+inline_svg(file_name, options={})
+```
+
+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
+HAML:
+
+```
+ !!! 5 
+  %html
+    %head
+      %title Embedded SVG Documents
+    %body
+      %h1 Embedded SVG Documents
+      %div
+        = inline_svg "some-document.svg", class: 'some-class'
+```
+
+Here's some CSS to target the SVG, resize it and turn it an attractive shade of
+blue:
+
+```
+.some-class {
+  display: block;
+  margin: 0 auto;
+  fill: #3498db;
+  width: 5em;
+  height: 5em;
+}
+```
+
+## Options
+* `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
+
+Example:
+
+```
+inline_svg("some-document.svg", class: 'some-class', title: 'Some Title', desc:
+'Some interesting description')
+```
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/inline_svg/fork )
+1. Fork it ( [http://github.com/<my-github-username>/inline_svg/fork](http://github.com/<my-github-username>/inline_svg/fork) )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/inline_svg.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "activesupport"
 
-  spec.add_runtime_dependency "nokogiri", "~> 1.6"
+  spec.add_runtime_dependency "nokogiri", "~> 1.6", '~> 1.6'
 end

data/lib/inline_svg/action_view/helpers.rb

@@ -1,5 +1,6 @@
-require 'action_view/helpers'
-require 'action_view/context'
+require 'action_view/helpers' if defined?(Rails)
+require 'action_view/context' if defined?(Rails)
+require 'nokogiri'
 
 module InlineSvg
   module ActionView
@@ -8,9 +9,19 @@ module InlineSvg
         file = File.read(Rails.root.join('app', 'assets', 'images', filename))
         doc = Nokogiri::HTML::DocumentFragment.parse file
         svg = doc.at_css 'svg'
-        if options[:class].present?
+        if options[:class]
           svg['class'] = options[:class]
         end
+        if options[:title].present?
+          title = Nokogiri::XML::Node.new("title", doc)
+          title.content = options[:title]
+          svg.add_child title
+        end
+        if options[:desc].present?
+          desc = Nokogiri::XML::Node.new("desc", doc)
+          desc.content = options[:desc]
+          svg.add_child desc
+        end
         doc.to_html.html_safe
       end
     end

data/lib/inline_svg/version.rb

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

data/spec/files/example.svg

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

data/spec/helpers/inline_svg_spec.rb

@@ -0,0 +1,53 @@
+require 'inline_svg'
+require 'nokogiri'
+require 'active_support/core_ext'
+
+describe InlineSvg::ActionView::Helpers do
+
+  before(:each) do
+    # Mock Rails
+    unless defined?(::Rails)
+      @mocked_rails_class = true
+      class ::Rails
+      end
+    end
+    # Allow mock Rails to give a path to our SVG
+    path_mocker = double("path_mocker")
+    allow(path_mocker).to receive(:join) { 'spec/files/example.svg' }
+    allow(Rails).to receive(:root) { path_mocker }
+  end
+
+  let(:mock_helper) { ( Class.new { include InlineSvg::ActionView::Helpers } ).new }
+
+  describe "#inline_svg" do
+    
+    context 'when passed a SVG file' do
+      
+      subject { mock_helper.inline_svg( 'mocked_path' ) }
+      let(:example_svg) {
+<<-SVG.sub(/\n$/, '')
+<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"></svg>
+SVG
+      }
+      
+      it { is_expected.to eql example_svg }
+      
+      context 'and additional options' do
+      
+        subject { mock_helper.inline_svg( 'mocked_path', title: 'A title', desc: 'A desc' ) }
+        let(:example_svg) {
+<<-SVG.sub(/\n$/, '')
+<svg xmlns="http://www.w3.org/2000/svg" role="presentation" xml:lang="en"><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

metadata

@@ -1,55 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: inline_svg
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - James Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-21 00:00:00.000000000 Z
+date: 2014-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 description: Get an SVG into your view and then style it with CSS.
@@ -59,7 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -69,6 +97,8 @@ files:
 - lib/inline_svg/action_view/helpers.rb
 - lib/inline_svg/railtie.rb
 - lib/inline_svg/version.rb
+- spec/files/example.svg
+- spec/helpers/inline_svg_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -79,12 +109,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -93,4 +123,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Embeds an SVG document, inline.
-test_files: []
+test_files:
+- spec/files/example.svg
+- spec/helpers/inline_svg_spec.rb