insulate 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbe2d92b6c766255e90d035284549593959080e6
-  data.tar.gz: 2852c5808d05dd62f40d6708edd8a5490f4bbe4e
+  metadata.gz: 0d894f3bf475a3f7006194f98a406f5665ae68ba
+  data.tar.gz: 9857f4e9ca4471c9eb036a9ebda89e07ea164baa
 SHA512:
-  metadata.gz: b338487196650c8b3fdd6a8ca537344462924f6b31eb8cc93080b1fca42e42e86fbe0f15e28ebdc0e816c3c6cb40d204fcf70f94e9239e0e5e0f1556ffc37377
-  data.tar.gz: d53aa244809c3ff42f3f0d74a17725646e90185a168c95e15bb6af906b44814c81b7fc4f14de3c2008fe12e19097aee4ffb8771532da265001a4ad0a3e820e75
+  metadata.gz: 30b517d55aa2f29cd2deb2839d130b3056641b9e91fc504a81f94cab40dc9063f769df97c38d01a8b2e2e00bb209266430ca2ae7a81c39c54a04103e34ca242e
+  data.tar.gz: 6764530b185b19424830c9120e70b60e079f54948cbda5d99a51dcd9d321153942ff065cb306b7590912d271a13c19df484933890afee0b823a0f92f6eda8bce

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in insulate.gemspec
 gemspec

data/README.md

@@ -1,29 +1,48 @@
 # Insulate
 
-TODO: Write a gem description
+*"Page-specific JavaScript".*
+
+Easily partition your JavaScript code based on controller actions. Works great with Rails' asset pipeline default configuration (i.e. all JavaScript concatenated into one huge application.js file).
+
+This gem is a fork of [Paloma](https://github.com/kbparagua/paloma), an excellent and much more comprehensive page-specific JavaScript solution. What does it do differently? Basically, I've just removed a lot of the shiny features and fluff in order to provide something that is extremely simple, compact, and *just works*. Think of it as Paloma Lite.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'insulate'
+```ruby
+gem 'insulate'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle install
+```
 
-Or install it yourself as:
+Lastly, add the following line to the application.js manifest after `//= require jquery` and before `//= require_tree .`:
 
-    $ gem install insulate
+```
+//= require insulate
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+It's all very simple. For every controller action that you want to hook into, just add a callback function to a global `Insulate` object. The key must be a string in the format `controller#action`.
+
+CoffeeScript example:
+
+```coffeescript
+Insulate['users#new'] = ->
+  alert 'Create a new user!'
+```
+
+JavaScript example:
 
-## Contributing
+```javascript
+Insulate['users#edit'] = function() {
+  alert('Edit an existing user!');
+};
+```
 
-1. Fork it
-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`)
-5. Create new Pull Request
+Any callback function you define this way will be executed on jQuery's `$(document).ready()` event (hence why jQuery is a dependency of this gem).

data/app/views/insulate/_callback.html.erb

@@ -0,0 +1,10 @@
+<script type="text/javascript">
+  (function(){
+    $(document).ready(function(){
+      var callback = Insulate['<%= controller %>#<%= action %>'];
+      if (callback != undefined){
+        callback();
+      }
+    });
+  })();
+</script>

data/insulate.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "jquery-rails"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

data/lib/insulate/action_controller_filters.rb

@@ -0,0 +1,33 @@
+module Insulate
+  module ActionControllerFilters
+    def self.included base
+      base.module_eval do
+        prepend_view_path "#{Insulate.root}/app/views/"
+        after_filter :inject_callback_script, :if => :html_response_from_render?
+      end
+    end
+
+    protected
+
+    def html_response_from_render?
+      [nil, 'text/html'].include?(response.content_type) && self.status != 302
+    end
+
+    def inject_callback_script
+      callback_script = view_context.render(
+        :partial => 'insulate/callback',
+        :locals => { :controller => controller_path, :action => action_name })
+
+      body_closing_tag_index = response_body[0].rindex('</body>')
+      if body_closing_tag_index.present?
+        # Insert callback_script just before </body> tag
+        response_body[0].insert body_closing_tag_index, callback_script
+      else
+        # Append callback_script in the response body
+        response_body[0].concat callback_script
+      end
+    end
+  end
+
+  ::ActionController::Base.send :include, ActionControllerFilters
+end

data/lib/insulate/rails/engine.rb

@@ -0,0 +1,8 @@
+# Define a "dummy" engine in order to make vendor/assets/javascripts/insulate.js available to the app
+
+module Insulate
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/insulate/version.rb

@@ -1,3 +1,3 @@
 module Insulate
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/lib/insulate.rb

@@ -1,5 +1,9 @@
-require "insulate/version"
-
 module Insulate
-  # Your code goes here...
+  def self.root
+    @insulate_root ||= "#{File.dirname(__FILE__)}/../"
+  end
 end
+
+require 'insulate/version'
+require 'insulate/action_controller_filters'
+require 'insulate/rails/engine'

data/vendor/assets/javascripts/insulate.js

@@ -0,0 +1,3 @@
+(function(){
+  window.Insulate = {};
+})();

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: insulate
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Luke Horvat
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2013-07-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -50,9 +64,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/views/insulate/_callback.html.erb
 - insulate.gemspec
 - lib/insulate.rb
+- lib/insulate/action_controller_filters.rb
+- lib/insulate/rails/engine.rb
 - lib/insulate/version.rb
+- vendor/assets/javascripts/insulate.js
 homepage: https://github.com/lukehorvat/insulate
 licenses:
 - MIT