pluggable_js 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6817aa80ad45a4ecc1698a6810bc46c37b60cfd0
-  data.tar.gz: 329eb1d15fb3a57f487322ee15040b113eabe7a4
+  metadata.gz: 72eae7575c4a5d7e5e9f844695c8590ed6c2aac5
+  data.tar.gz: e8b110e7d310a1c60e4819e556a7e9df5054e63e
 SHA512:
-  metadata.gz: ffd735361c98f0a9b6122c9b642efa680011f35349001aed3633267e63115b18e28b6dd649f2315aa05c6502464a08c3981531f2807629e14197f4ce93a21175
-  data.tar.gz: 93473f70466749116f88366280ab4b6793b03c226abd5ae42ccd9819fe2841a716e992b3eb948d31c7b2686cde684087236ece42bbc09e03292380243178ac8a
+  metadata.gz: a4fcc8b5881f6d09c806abc555438b91d83cd5199ba29ed2821d317412ed67bbcb024858bfa377883103eb5c8a80f27f62d628c95e8c543b0dfc72176db3e057
+  data.tar.gz: 50da9bbabcc78c673d66a4380a3ff5f448df812bc695677f33eec36b0c99a22a5ffb81c9d1e488d146574adf30cfa59a91a5641a2a07ce56755a5f68364c7325

data/CHANGELOG.md

@@ -20,4 +20,8 @@
 
 ## v0.0.4
 
-* added necessary folders to gitignore for dummy app
+* added necessary folders to gitignore for dummy app
+
+## v0.0.5
+
+* improved function call, left generator only for large js files

data/README.md

@@ -1,28 +1,21 @@
-# PluggableJs
 
-Sometimes you need to use javascript only in specific pages, but you don't want to change DOM or write code in a view. Maybe you have one container with the same class in different templates, but part of bound logic is needed only in one. Or maybe some javascript causes exceptions in other views.
+# PluggableJs
 
-This gem provides simple functionality of loading javascript only in certain pages based on controller and action parameters. Keep your js code in controller related files as action based functions (still in asset pipeline). It will be triggered only if needed.
+This gem provides simple functionality of loading page specific javascript (for Rails >= 3.1 with asset pipeline enabled). Keep desired js code in controller related files as action based functions. They will be triggered only when matching controller and action parameters.
 
 ## Installation
 
-1. Add `gem 'pluggable_js'` to Gemfile and run `bundle` command to install it
-2. Add `<%= javascript_pluggable_tag %>` to application layout file after `<%= javascript_include_tag 'application' %>` line
-3. Add `pluggable/*` to assets precompile configuration in production.rb (and staging.rb if you have one), e.g.: `config.assets.precompile += %w(pluggable/*)`
-4. Be sure that `pluggable` folder is out of `require_tree` statement in application.js
+* Add `gem 'pluggable_js'` to Gemfile and run `bundle` command to install it
+* Add `<%= javascript_pluggable_tag %>` to application layout file after `<%= javascript_include_tag 'application' %>` line
 
-## Usage
+Next steps are necessary only if you want to use generator for large pieces of js code (see usage):
 
-Choose controller and actions you want to use for pluggable js and run generator, e.g.:
-    
-    rails generate pluggable_js Post index new
+* Add `pluggable/*` to assets precompile configuration in production.rb (and staging.rb if you have one), e.g.: `config.assets.precompile += %w(pluggable/*)`
+* Be sure that `pluggable` folder is out of `require_tree` statement in application.js
 
-It will create two files (just function callers):
-    
-    app/assets/javascripts/pluggable/posts/index.js.coffee
-    app/assets/javascripts/pluggable/posts/new.js.coffee
+## Usage
 
-Now you simply have to define `Post.index` and `Post.new` functions in posts.js.coffee:
+Simply define functions in your controller related file (e.g. posts.js.coffee) like so:
 
 ```coffeescript
 window.Post ||= {}
@@ -31,8 +24,14 @@ Post.index = () ->
 Post.new = () ->
   # and here
 ```
+Or, in rare cases, if you have large piece of code (maybe external lib) that you don't want to define as a function, choose controller and actions you want to use and run generator, e.g.:
+    
+    rails generate pluggable_js Post index new
 
-They will be triggered only when matching controller and action parameters.
+It will create two files where you may add your code (don't forget to follow necessary installation steps):
+    
+    app/assets/javascripts/pluggable/posts/index.js.coffee
+    app/assets/javascripts/pluggable/posts/new.js.coffee
 
 ## Config
 

data/features/support/env.rb

@@ -1,4 +1,6 @@
 require 'bundler'
+require 'coffee_script'
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e

data/lib/generators/pluggable_js/pluggable_js_generator.rb

@@ -6,7 +6,7 @@ class PluggableJsGenerator < Rails::Generators::Base
   def create_pluggable_js_files
     actions.each do |action|
       @action = action
-      template 'function_caller.js.coffee', File.join('app/assets/javascripts/pluggable', controller_name, "#{action}.js.coffee")
+      template 'large_piece_of_code.js.coffee', File.join('app/assets/javascripts/pluggable', controller_name, "#{action}.js.coffee")
     end
   end
 

data/lib/generators/pluggable_js/templates/large_piece_of_code.js.coffee

@@ -0,0 +1,5 @@
+# This file is used only for large piece of js code that you
+# don't want to define as a function in controller related js file.
+
+# jQuery ->
+#   # your code goes here

data/lib/pluggable_js/helpers.rb

@@ -1,12 +1,21 @@
 module PluggableJs
   module Helpers
 
+    # if file exists – include it, else – call function
     def javascript_pluggable_tag
       controller = params[:controller]
       action = define_pair_action
 
       if File.exist?(Rails.root + "app/assets/javascripts/pluggable/#{controller}/#{action}.js.coffee")
         javascript_include_tag "pluggable/#{controller}/#{action}"
+      else
+        object = controller.classify
+
+        javascript_tag "jQuery(function() { 
+          if (typeof(#{object}) == 'object' && typeof(#{object}.#{action}) == 'function') { 
+            return #{object}.#{action}();
+          }
+        });"
       end
     end
 

data/lib/pluggable_js/version.rb

@@ -1,3 +1,3 @@
 module PluggableJs
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/pluggable_js.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = PluggableJs::VERSION
   spec.authors       = ['Andrey Peresleguine']
   spec.email         = ['peresleguine@gmail.com']
-  spec.description   = %q{Convention of how to load javascript only in certain pages based on controller and action parameters.}
+  spec.description   = %q{Convention of how to load page specific javascript based on controller and action parameters.}
   spec.summary       = %q{Pluggable javascript.}
   spec.homepage      = 'https://github.com/peresleguine/pluggable_js'
   spec.license       = 'MIT'

data/test/dummy/app/assets/javascripts/pluggable/posts/new.js.coffee

@@ -1,11 +1,5 @@
-# Define somewhere in your controller related js file (e.g. posts.js.coffee):
-# 
-# window.Post ||= {}
-# Post.new = () ->
-#   # your code goes here
+# This file is used only for large piece of js code that you
+# don't want to define as a function in controller related js file.
 
 jQuery ->
-  # whatever you want will be triggered from here  
-  # only if this filepath matches current 
-  # controller and action parameters  
-  Post.new()
+  $('.marine-quote').text('You wanna piece of me, boy?')

data/test/dummy/app/assets/javascripts/posts.js.coffee

@@ -1,5 +1,3 @@
 window.Post ||= {}
 Post.index = () ->
   $('.zealot-quote').text('My life for aiur!')
-Post.new = () ->
-  $('.marine-quote').text('You wanna piece of me, boy?')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluggable_js
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Andrey Peresleguine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-05 00:00:00.000000000 Z
+date: 2013-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
@@ -136,7 +136,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Convention of how to load javascript only in certain pages based on controller
+description: Convention of how to load page specific javascript based on controller
   and action parameters.
 email:
 - peresleguine@gmail.com
@@ -155,7 +155,7 @@ files:
 - features/support/env.rb
 - lib/generators/pluggable_js/USAGE
 - lib/generators/pluggable_js/pluggable_js_generator.rb
-- lib/generators/pluggable_js/templates/function_caller.js.coffee
+- lib/generators/pluggable_js/templates/large_piece_of_code.js.coffee
 - lib/pluggable_js.rb
 - lib/pluggable_js/config.rb
 - lib/pluggable_js/helpers.rb
@@ -166,7 +166,6 @@ files:
 - test/dummy/Rakefile
 - test/dummy/app/assets/images/.keep
 - test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/javascripts/pluggable/posts/index.js.coffee
 - test/dummy/app/assets/javascripts/pluggable/posts/new.js.coffee
 - test/dummy/app/assets/javascripts/posts.js.coffee
 - test/dummy/app/assets/stylesheets/application.css
@@ -239,7 +238,6 @@ test_files:
 - test/dummy/Rakefile
 - test/dummy/app/assets/images/.keep
 - test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/javascripts/pluggable/posts/index.js.coffee
 - test/dummy/app/assets/javascripts/pluggable/posts/new.js.coffee
 - test/dummy/app/assets/javascripts/posts.js.coffee
 - test/dummy/app/assets/stylesheets/application.css

data/lib/generators/pluggable_js/templates/function_caller.js.coffee

@@ -1,11 +0,0 @@
-# Define somewhere in your controller related js file (e.g. <%= controller_name %>.js.coffee):
-# 
-# window.<%= model_name %> ||= {}
-# <%= model_name %>.<%= @action %> = () ->
-#   # your code goes here
-
-jQuery ->
-  # whatever you want will be triggered from here  
-  # only if this filepath matches current 
-  # controller and action parameters  
-  <%= model_name %>.<%= @action %>()

data/test/dummy/app/assets/javascripts/pluggable/posts/index.js.coffee

@@ -1,11 +0,0 @@
-# Define somewhere in your controller related js file (e.g. posts.js.coffee):
-# 
-# window.Post ||= {}
-# Post.index = () ->
-#   # your code goes here
-
-jQuery ->
-  # whatever you want will be triggered from here  
-  # only if this filepath matches current 
-  # controller and action parameters  
-  Post.index()