js_hooks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cef0ed4b6e0af39af7ad94682ff3a511e204da13
+  data.tar.gz: ecead09416b0e5b8e50d091503f93dba21426e30
+SHA512:
+  metadata.gz: 144ed7796be9b670e2480b96b47cfde3ee783298b21c17cade786f77c2b7ba85bb9734553514d9292796db695fc26abb6b922df67a7caf0449f8893afdd73634
+  data.tar.gz: 2d08b477408ec0469e0f50360b46bc0c97e3f0577d7c7e81337e368078b2642e09b11ef1d5c25e85daadb2edf00f4c5dd8727861b53eae5bcec660c77c3bd3ad

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+js_hooks

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p353

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2014 Francisco R. Santos
+
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# Jshooks
+Usually, there are tons of JavaScript hooks in an application, some used in all pages, but many used only in a single
+group of pages, or even in only a single page. This gems invokes those hooks only when needed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'js_hooks'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install js_hooks
+
+### Rails 3.1 or greater
+Include the módule in your controller:
+
+    class MyController < ApplicationController
+      act_as_js_hookable
+    end
+
+Add the js_hooks.js file to `app/assets/javascripts/application.js`:
+
+    //= require js_hooks
+
+And add the helper to your views:
+
+    <%= javascript_hooks_tag %>
+
+## Usage
+You can define hook by defining a ``init`` method inside an plain object and calling ``JsHooks.registerHook`` inside
+a closure before the body close tag in your templates. For each hook added, the init method is called in the
+``documentReady`` event:
+
+    (function() {
+      'use strict';
+
+      window.JsHooks.registerHook('Users', {
+        init: function() {
+          // Set my hooks
+          $('#id').on('click', function() {
+            // do something
+          });
+        }
+      });
+    })()
+
+This ``init`` function will be called automatically whenever the ``UsersController`` is used.
+
+By default, the gem invokes the hooks related to the current controller, but hooks can be added if they are not named
+after the current controller. For example, in your view, add:
+
+    <%= add_js_hook( :users, :clients ) %>
+      --> Users.init(); Clients.init()
+
+By default, the ``init`` function is called for each hook. However, a suffix can be added to the ``init`` method to refine
+the initialization process:
+
+    <%= add_js_hook( :users, :clients, users: 'action' ) %>
+      --> Users.init(); Clients.init(); Users.initAction();
+
+    <%= add_js_hook( :clients, users: ['', 'action1', 'action2'] ) %>
+      --> Clients.init(); Users.init(); Users.initAction1(); Users.initAction2();
+
+Three hooks are added by default: one with 'application' as name, one with the controller as name and one last
+with the controller as name and template as suffix.
+
+So, by default, the following methods will be called if they exist:
+
+    GET /users/1 --> Application.init(); Users.init(); Users.initShow()
+
+## Contributing
+
+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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/js_hooks.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'js_hooks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'js_hooks'
+  spec.version       = Jshooks::VERSION
+  spec.authors       = ['Francisco R. Santos']
+  spec.email         = ['frsantos@aspgems.com']
+  spec.description   = %q{Manages JavaScript hooks for Rails controllers and views}
+  spec.summary       = %q{Manages JavaScript hooks for Rails controllers and views}
+  spec.homepage      = 'https://github.com/aspgems/js_hooks'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rails', '~> 4.0.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/js_hooks/controller.rb

@@ -0,0 +1,80 @@
+require 'abstract_controller/helpers'
+
+module JsHooks
+  module Controller
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def act_as_js_hookable(options = {})
+        before_filter :add_default_js_hooks if :add_default_js_hooks?
+
+        include JsHooks::Controller::LocalInstanceMethods
+
+        helper_method :js_hooks, :add_js_hook
+      end
+    end
+
+    module LocalInstanceMethods
+      # Javascript on demand hooks
+      def js_hooks
+        @js_hooks ||= {}
+      end
+
+      # Add javascript components to execute inside a document ready jquery closure before the body close tag in your
+      # templates. For each hook added, an object with the same name is searched and the init method is called.
+      # A suffix can be used with the init method to refine the initialization process:
+      #
+      #     add_js_hook( :users, :clients )
+      #       --> Users.init(); Clients.init()
+      #
+      #     add_js_hook( :users, :clients, users: 'action' )
+      #       --> Users.init(); Clients.init(); Users.initAction();
+      #
+      #     add_js_hook( :clients, users: ['', 'action1', 'action2'] )
+      #       --> Clients.init(); Users.init(); Users.initAction1(); Users.initAction2();
+      #
+      # Three hooks are added by default: one with 'application' as name, one with the controller as name and one last
+      # with the controller as name and template as suffix.
+      # So, by default, the following methods will be called if they exist:
+      #
+      #     GET /users/1 --> Application.init(); Users.init(); Users.initShow()
+      def add_js_hook(*args)
+        opts = args.extract_options!
+
+        # Default init method
+        args.each do |hook|
+          hook = hook.to_s.camelize
+          js_hooks[hook] ||= []
+          js_hooks[hook] = (js_hooks[hook] + [true]).uniq
+        end
+
+        # Suffix init method
+        opts.each_pair do |hook, methods|
+          hook = hook.to_s.camelize
+          js_hooks[hook] ||= []
+          if methods
+            js_hooks[hook] = (js_hooks[hook] + [methods].flatten.map! { |m| m.to_s.camelize.presence || true }).uniq
+          else
+            js_hooks.delete(hook)
+          end
+        end
+      end
+
+      private
+      def add_default_js_hooks
+        add_js_hook :application
+        add_js_hook controller_name
+      end
+
+      # Add template as suffix to the controller hook: GET users/1 -> Users.initShow()
+      def render_to_body(options = {})
+        add_js_hook controller_name => options[:template].to_s.camelize if options[:template] && add_default_js_hooks?
+        super
+      end
+
+      def add_default_js_hooks?
+        request.format.html?
+      end
+    end
+  end
+end

data/lib/js_hooks/helpers.rb

@@ -0,0 +1,12 @@
+module JsHooks
+  module Helpers
+    # Build the javascript code need to initialize the components js_hooks
+    def javascript_hooks_tag
+      javascript_tag <<-JS
+        window.JsHooks = window.JsHooks || {};
+        window.JsHooks.namespace = '.#{Rails.application.class.to_s.split('::').first}';
+        window.JsHooks.hooks     = #{js_hooks.to_json};
+      JS
+    end
+  end
+end

data/lib/js_hooks/railtie.rb

@@ -0,0 +1,19 @@
+module JsHooks
+  class Railtie < Rails::Railtie
+    initializer 'js_hooks.initialize' do
+      ActiveSupport.on_load :action_controller do
+        require 'js_hooks/controller'
+        include JsHooks::Controller
+      end
+
+      ActiveSupport.on_load :action_view do
+        require 'js_hooks/helpers'
+        include JsHooks::Helpers
+      end
+    end
+  end
+
+  # Needed for assets pipeline
+  class Engine < Rails::Engine
+  end
+end

data/lib/js_hooks/version.rb

@@ -0,0 +1,3 @@
+module Jshooks
+  VERSION = '0.0.1'
+end

data/lib/js_hooks.rb

@@ -0,0 +1,5 @@
+require 'js_hooks/version'
+require 'js_hooks/railtie'
+
+module Jshooks
+end

data/vendor/assets/javascripts/js_hooks.js

@@ -0,0 +1,59 @@
+/*jshint nonew:true, jquery:true, curly:true, noarg:true, forin:true, noempty:true, eqeqeq:true, strict:true, undef:true, bitwise:true, browser:true */
+
+(function () {
+  'use strict';
+
+  function registerHook(hookClass, hooks) {
+    window.JsHooks[hookClass] = hooks;
+
+  }
+
+  function initHooks() {
+    var jsHooks = window.JsHooks;
+
+    // Remove all events added by the previous turbolinks page
+    if(jsHooks.namespace) {
+      $(document).off(jsHooks.namespace);
+    }
+
+    var hooks = jsHooks.hooks;
+    for (var hookClass in hooks) {
+      if(hooks.hasOwnProperty(hookClass)) {
+        var hook = jsHooks[hookClass];
+        if (!hook) {
+          continue;
+        }
+
+        var methods = hooks[hookClass];
+        if (!$.isArray(methods)) {
+          methods = ['']; // invoke the default .init() method
+        }
+
+        for (var i = 0; i < methods.length; i++) {
+          var method = methods[i];
+          if (method === true) {
+            method = '';
+          } else if (method === false) {
+            continue;
+          }
+          method = 'init' + method;
+
+          if ($.isFunction(hook[method])) {
+            // if(console && console.debug) console.debug('Calling ' + hookClass + '.' + method + '();');
+            hook[method]();
+          }
+        }
+      }
+    }
+  }
+
+  // Set initializer only once
+  if (!window.JsHooks || !window.JsHooks.initialized) {
+    $(document).ready(initHooks).on('page:load', initHooks);
+  }
+
+  window.JsHooks = window.JsHooks || {};
+  window.JsHooks.initialized = true;
+  window.JsHooks.registerHook = registerHook;
+})();
+

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: js_hooks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Francisco R. Santos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Manages JavaScript hooks for Rails controllers and views
+email:
+- frsantos@aspgems.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- js_hooks.gemspec
+- lib/js_hooks.rb
+- lib/js_hooks/controller.rb
+- lib/js_hooks/helpers.rb
+- lib/js_hooks/railtie.rb
+- lib/js_hooks/version.rb
+- vendor/assets/javascripts/js_hooks.js
+homepage: https://github.com/aspgems/js_hooks
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Manages JavaScript hooks for Rails controllers and views
+test_files: []