savagery 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afdcbfb98ed3b794c4770fa6debd24e3889ef4f0
-  data.tar.gz: a2084e5ff63b8c3b47daadb49360ec38e971baf5
+  metadata.gz: ee09c3c070917055eb7b817030e15f46f53d09a8
+  data.tar.gz: 8d68da05a447d63420b5bfe84df9f15c05063a38
 SHA512:
-  metadata.gz: fb6e7e68739b3ff491d523a0c8b0e319d3e41f2d4f379d02aa5d5c26c572dd3bb7399623b79ba8fcc2dbbd69da2f3fe94888bfe8ffa6c395587c33c7d82a3a47
-  data.tar.gz: d251faf0413e8129fd49dfd2bc802a756750e31bee1508e81dce42f13ff2ada7d4a66dfdf0433ede059bb408f5f74aca365810c1e3c0a7352d7762049210ad11
+  metadata.gz: 768b230c5568792fb1158e3c352149a26af9a07909a200a502d1f6310c10ceb21a8a59f9768a62b6aed0f51ead5ddb43e50f2b0fb95bc741f3216000718a0ede
+  data.tar.gz: 31b6973438164b642ec7a724e3c3a687a6c3e19ee88c9d34ac12929f47d170a9d7af5b57e081e17321f865e873aed44aa012cdbda1d0f07c4193a16804a88e33

data/README.md

@@ -12,23 +12,40 @@ gem "savagery"
 
 ## Usage
 
-Give savagery the name of a directory in app/assets/images to sprite:
+Given the following directory structure:
 
-```ruby
-# app/views/layouts/application.html.erb
-<%= svg_sprite_include "svgs" %>
+```
+app/assets/images/
+└── dogs
+    ├── chihuahua.svg
+    ├── golden.svg
+    └── lab.svg
 ```
 
-And then any images within that directory will be available later on in the view:
+Use the `svg_sprite_use` helper in your view:
 
 ```ruby
 # app/views/dogs/show.html.erb
-<%= svg_sprite_use "svgs/chihuahua" %>
+<%= svg_sprite_use "dogs/chihuahua" %>
 ```
 
+And Savagery will do all the hard work of spriting and embedding. A new .svg
+sprite file will appear in the images directory, named after the directory
+containing the sprites:
+
+```
+app/assets/images/
+├── dogs
+│   ├── chilhuahua.svg
+│   ├── golden.svg
+│   └── lab.svg
+└── dogs.svg
+```
+
+Make sure you check this file into version control.
+
 ## TODO
 
-* remove necessity of `svg_sprite_include`
 * add handlebars helpers for ember apps
 
 ## Contributing

data/lib/savagery/helpers.rb

@@ -1,17 +1,28 @@
+require "set"
+
 module Savagery
   module Helpers
     def svg_sprite_include path
+      return raw("") if svg_sprites_included.include?(path)
       sprite_file_path = Savagery.sprite!("app/assets/images/#{path}")
+      svg_sprites_included.add path
       raw File.read(sprite_file_path)
     end
 
     def svg_sprite_use name, options={}
+      dirname = File.dirname(name)
+      sprite = svg_sprite_include(dirname)
+
       basename = File.basename(name)
       options[:class] ||= basename
-      content_tag :svg, options do
+      sprite + content_tag(:svg, options) do
         content_tag :use, nil, "xlink:href" => "##{basename}"
       end
     end
+
+    def svg_sprites_included
+      @svg_sprites_included ||= Set.new
+    end
   end
 end
 

data/lib/savagery/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: savagery
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Micah Geisel