savagery 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee09c3c070917055eb7b817030e15f46f53d09a8
-  data.tar.gz: 8d68da05a447d63420b5bfe84df9f15c05063a38
+  metadata.gz: af5e8dab154d57467a364bb5a2e6aa37d8b2f1f4
+  data.tar.gz: 253378ce924305f255292635211261ff4eaeb880
 SHA512:
-  metadata.gz: 768b230c5568792fb1158e3c352149a26af9a07909a200a502d1f6310c10ceb21a8a59f9768a62b6aed0f51ead5ddb43e50f2b0fb95bc741f3216000718a0ede
-  data.tar.gz: 31b6973438164b642ec7a724e3c3a687a6c3e19ee88c9d34ac12929f47d170a9d7af5b57e081e17321f865e873aed44aa012cdbda1d0f07c4193a16804a88e33
+  metadata.gz: 942fe2cc63dd8ad97578544be840c577dcb7b3e06f4a82a7b6a411e86e0ffe76f8c88b4920e377ed0f701fe18c73bcf7105eef8890b86cf44a0c447de9c4ad4c
+  data.tar.gz: fc59d5f61595b1cd5a40430a169e86b203ca01c0a643ddb959a93092e15c97a3c4db51804547b5eb2ae30e740fc2d5fa82f5332031d049a1b186772a7207d569

data/README.md

@@ -1,6 +1,6 @@
 # Savagery
 
-Ruthlessly sprite SVGs in your Rails app.
+Ruthlessly sprite SVGs in your Rails app. Includes Ember helpers, too!
 
 ## Installation
 
@@ -15,28 +15,36 @@ gem "savagery"
 Given the following directory structure:
 
 ```
-app/assets/images/
+app/assets/svgs/
 └── dogs
     ├── chihuahua.svg
     ├── golden.svg
     └── lab.svg
 ```
 
-Use the `svg_sprite_use` helper in your view:
+Rails: Use the `svg_sprite_use` helper in your view:
 
 ```ruby
 # app/views/dogs/show.html.erb
 <%= svg_sprite_use "dogs/chihuahua" %>
 ```
 
+Ember: Require `savagery/ember` anywhere, then use the 'svg-sprite-use` helper in your template:
+
+```javascript
+// app/assets/javascripts/templates/application.hbs
+//= require savagery/ember
+{{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
+sprite file will appear in the `app/assets/svgs` directory, named after the directory
 containing the sprites:
 
 ```
-app/assets/images/
+app/assets/svgs/
 ├── dogs
-│   ├── chilhuahua.svg
+│   ├── chihuahua.svg
 │   ├── golden.svg
 │   └── lab.svg
 └── dogs.svg
@@ -44,10 +52,6 @@ app/assets/images/
 
 Make sure you check this file into version control.
 
-## TODO
-
-* add handlebars helpers for ember apps
-
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/savagery/fork )

data/app/assets/javascripts/savagery/ember.js

@@ -0,0 +1,29 @@
+Savagery = {
+  svgSpriteInclude: function(name) {
+    if(this._svgSpritesIncluded[name]) { return; }
+    this._svgSpritesIncluded[name] = true
+
+    $.get("/assets/" + name + ".svg", function(data) {
+      $("body").prepend(data);
+    }, "text");
+  },
+
+  svgSpriteUse: function(basename, cssClass) {
+    cssClass = cssClass || basename;
+    return '<svg class="' + cssClass + '"><use xlink:href="#' + basename + '"></use></svg>';
+  },
+
+  _svgSpritesIncluded: {}
+};
+
+Ember.Handlebars.helper("svg-sprite-use", function(name, options) {
+  var names = name.split("/");
+  var dirname = names[0];
+  var basename = names[1];
+  Savagery.svgSpriteInclude(dirname);
+
+  var cssClass = options.hash["class"];
+  var html = Savagery.svgSpriteUse(basename, cssClass);
+  return new Ember.Handlebars.SafeString(html);
+});
+

data/lib/savagery/engine.rb

@@ -1,10 +1,16 @@
 require "rails"
 require "savagery/helpers"
+require "savagery/middleware"
 
 module Savagery
   class Engine < Rails::Engine
-    initializer "include helpers" do |app|
+    initializer "savagery.helpers" do |app|
       ApplicationController.helper(Helpers)
     end
+
+    initializer "savagery.middleware" do |app|
+      app.config.middleware.use Middleware
+    end
   end
 end
+

data/lib/savagery/helpers.rb

@@ -4,9 +4,10 @@ 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)
+
+      sprite_file = "app/assets/svgs/#{path}.svg"
+      raw File.read(sprite_file)
     end
 
     def svg_sprite_use name, options={}

data/lib/savagery/middleware.rb

@@ -0,0 +1,18 @@
+module Savagery
+  class Middleware < Struct.new(:app)
+    def call *args
+      sprite!
+      app.call *args
+    end
+
+    private
+
+    def sprite!
+      paths = Dir.glob("app/assets/svgs/*/").map(&:chop)
+      paths.each do |path|
+        Spriter.new(path).sprite!
+      end
+    end
+  end
+end
+

data/lib/savagery/spriter.rb

@@ -10,7 +10,6 @@ module Savagery
 
     def sprite!
       File.write sprite_path, sprite
-      sprite_path
     end
 
     private
@@ -20,7 +19,7 @@ module Savagery
     end
 
     def sprite
-      "<svg><defs>\n\n#{symbols.join("\n")}\n</defs></svg>\n"
+      %(<svg style="display: none"><defs>\n\n#{symbols.join("\n")}\n</defs></svg>\n)
     end
 
     def symbols

data/lib/savagery/version.rb

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

data/spec/support/svgs.svg

@@ -1,4 +1,4 @@
-<svg><defs>
+<svg style="display: none"><defs>
 
 <symbol id="callout1">
 <g opacity="0.6">

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: savagery
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Micah Geisel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,9 +78,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/assets/javascripts/savagery/ember.js
 - lib/savagery.rb
 - lib/savagery/engine.rb
 - lib/savagery/helpers.rb
+- lib/savagery/middleware.rb
 - lib/savagery/spriter.rb
 - lib/savagery/spriter/image.rb
 - lib/savagery/version.rb