pluggable_js 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f7dafe469757bf25d292d0b49081de701d62f8d
-  data.tar.gz: 7fad58ce62bc70a5d0541e117673395873681131
+  metadata.gz: 1c053d4795af1596c881bb47fea30ce23856cbf7
+  data.tar.gz: ff0bbd8d51e1929d48410a0651e68ed99e1123d3
 SHA512:
-  metadata.gz: e1ea81dfe8a2006359d5162d4d8e901ee80af6f6ae3a3ffed85bf2b2660ed6e937bfc8638b38db1972eb9eabd9e25642220e9ee89d70a899fd3bbf905af47d58
-  data.tar.gz: ad1cd94d4e0d88b2bb056db7f071f21781723fee930bee51abc1dd8c8232322d147535205d491588306576febbdb9a20eb69773e7c4eebba9cf47012e1cfe63b
+  metadata.gz: 0ec2f03e85a3a2e775608410813752b80f139434d1fe934908f620f1cbf1b07911b09d70c3a9e1088b096fa965194c6cdd293b50d1d2299db5b6152a6e430834
+  data.tar.gz: 22fa3a8fabe1c300ac37b5c0c85b259e35b43ca2efc7008c2e5eb4c6e5bc279cf85084b0dea157bc1b7864fd85518dc6e9b470aeda1a011323a19c7396c215fc

data/CHANGELOG.md

@@ -49,3 +49,7 @@
 ## v2.0.0
 
 * improved namespace and data passing
+
+## v2.0.1
+
+* refactored helpers, improved readme

data/README.md

@@ -1,31 +1,20 @@
 # PluggableJs
 
-This gem provides simple functionality of loading page specific javascript and allows to pass data from a controller (for Rails 3 and Rails 4 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 and when DOM is loaded.
+This gem provides simple functionality of loading page specific javascript and allows to pass data from a controller (for Rails 3 and Rails 4 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 and when DOM is ready.
 
 ## Installation
 
-### Basic
-
-* 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 (if you use turbolinks, move helper inside the `body` tag)
-
-### Additional
-
-This steps are necessary only if you want to use generator for large pieces of js code (see [additional usage](https://github.com/peresleguine/pluggable_js#additional-1)):
-
-* 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
+1. Add `gem 'pluggable_js', '~> 2.0.0'` to Gemfile and run `bundle` command to install it
+2. Add `<%= javascript_pluggable_tag %>` helper to application layout file after `<%= javascript_include_tag 'application' %>` line (if you use turbolinks paste it above the closing `</body>` tag)
 
 ## Usage
 
-### Basic
-
 Simply define functions in your controller related file (e.g. posts.js.coffee) like so:
 
 ```coffeescript
-window['posts#index'] = (data) ->
+@['posts#index'] = (data) ->
   # your code goes here
-window['posts#new'] = (data) ->
+@['posts#new'] = (data) ->
   # and here
 ```
 
@@ -34,14 +23,14 @@ You may pass data to javascript using `pluggable_js` helper in a controller (`pj
 ```ruby
 class PostsController < ApplicationController
   def index
-    pluggable_js({ 
+    pluggable_js(
       string: 'string',
       integer: 1,
       boolean: true,
       array: [1, 2, 3],
       hash: { a: 1, b: 2, c: 3 },
       array_of_hashes: [{a: 1}, {b: 2}, {c: 3}]
-    })
+    )
   end
 end
 ```
@@ -49,7 +38,7 @@ end
 Now you can access data in posts.js.coffee:
 
 ```coffeescript
-window['posts#index'] = (data) ->
+@['posts#index'] = (data) ->
   if data.boolean
     console.log data.string
     console.log data.integer
@@ -58,20 +47,9 @@ window['posts#index'] = (data) ->
     console.log data.array_of_hashes
 ```
 
-### Additional
-
-In such cases when you have large piece of code (maybe external lib) that you don't want to define as a function but include on a certain page, choose controller and actions you want to use and run generator, e.g.:
-    
-    rails generate pluggable_js posts index new
-
-It will create two files where you may add your code (don't forget to follow [additional installation steps](https://github.com/peresleguine/pluggable_js#additional)):
-    
-    app/assets/javascripts/pluggable/posts/index.js.coffee
-    app/assets/javascripts/pluggable/posts/new.js.coffee
-
 ## Config
 
-Let's say you've created action `search` that renders `index` template. Most likely we still need to trigger `window['posts#index'](data)` function. In such situation you may create `config/initializers/pluggable_js.rb` and use pair actions config:
+Let's say you've created action `search` that renders `index` template. Most likely we still need to trigger `@['posts#index'](data)` function. In such situation you may create `config/initializers/pluggable_js.rb` and use pair actions config:
 
 ```ruby
 PluggableJs.config do |config|
@@ -81,10 +59,25 @@ end
 
 `{ 'create' => 'new', 'update' => 'edit' }` is a default REST configuration.
 
-If you are passing data, move `pluggable_js` helper into a separate private method and use `before_action :your_private_method, only: [:index, :search]` (`before_filter` in Rails < 4).
+If you are passing data, move `pluggable_js` helper into a separate private method and use `before_action :set_pluggable_js, only: [:index, :search]` (`before_filter` in Rails < 4).
 
 ## Upgrade
 
-* [from v0.0.4 to v0.0.5](https://github.com/peresleguine/pluggable_js/wiki/Upgrade-from-v0.0.4-to-v0.0.5)
 * [from <= v0.0.6 to v1.0.0](https://github.com/peresleguine/pluggable_js/wiki/Upgrade-from-v0.0.6-or-less-to-v1.0.0)
 * [from v1.0 to v2.0](https://github.com/peresleguine/pluggable_js/wiki/Upgrade-from-v1.0-to-v2.0)
+
+## Sublime Text Snippet
+
+Go to `Sublime Text > Preferences > Browse Packages...` and save under `User` directory `pjs.sublime-snippet` with the following content:
+
+```xml
+<snippet>
+  <content><![CDATA[
+@['${0}#'] = (data) ->
+]]></content>
+  <tabTrigger>pjs</tabTrigger>
+  <scope>source.coffee</scope>
+</snippet>
+```
+
+Thereafter `pjs` snippet will be available in coffeescript files.

data/lib/generators/pluggable_js/USAGE

@@ -1,5 +1,5 @@
 Description:
-    Creates js files containing function callers based on controller and action parameters.
+    Creates coffeescript files based on controller and action parameters.
 
 Example:
     $ rails generate pluggable_js Posts index new

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

@@ -1,5 +1,9 @@
 # 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.
 
+# 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
+
 # jQuery ->
 #   # your code goes here

data/lib/pluggable_js/helpers.rb

@@ -2,7 +2,6 @@ module PluggableJs
   module Helpers
 
     module View
-      # call function and pass data, include file if it exists
       def javascript_pluggable_tag
         controller = params[:controller]
         action = define_pair_action
@@ -10,12 +9,12 @@ module PluggableJs
         ''.tap do |content|
           content << (javascript_tag "
             (function() {
-              pjs_data = {}; #{@data_string}
-              jQuery(function() {
-                if (typeof(window['#{controller}##{action}']) == 'function') {
-                  return window['#{controller}##{action}'](pjs_data);
-                }
-              });
+              var function_name = '#{controller}##{action}';
+              if (typeof(this[function_name]) == 'function') {
+                $(function() {
+                  return window[function_name](#{@pluggable_js_data});
+                });
+              }
             }).call(this);"
           )
 
@@ -23,10 +22,9 @@ module PluggableJs
             content << (javascript_include_tag "pluggable/#{controller}/#{action}")
           end
         end.html_safe
-
       end
 
-      private
+    private
 
       def define_pair_action
         action = params[:action]
@@ -40,12 +38,10 @@ module PluggableJs
     end
 
     module Controller
-      # convert hash passed from controller's action to data string
       def pluggable_js(hash)
-        @data_string = hash.map { |key, value| "pjs_data.#{key} = #{value.to_json}" }.join('; ')
+        @pluggable_js_data = hash.to_json
       end
       alias_method :pjs, :pluggable_js
-
     end
 
   end

data/lib/pluggable_js/version.rb

@@ -1,3 +1,3 @@
 module PluggableJs
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/pluggable_js.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = PluggableJs::VERSION
   spec.authors       = ['Andrey Peresleguine']
   spec.email         = ['peresleguine@gmail.com']
-  spec.description   = %q{A solution for Rails of how to load page specific javascript and pass data.}
-  spec.summary       = %q{Pluggable javascript and data passing for Rails.}
+  spec.description   = %q{Page-specific javascript for Rails applications with the ability of passing data.}
+  spec.summary       = %q{Page-specific javascript for Rails.}
   spec.homepage      = 'https://github.com/peresleguine/pluggable_js'
   spec.license       = 'MIT'
 

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

@@ -1,4 +1,4 @@
-window['posts#index'] = (data) ->
+@['posts#index'] = (data) ->
   $('.protoss-quotes').append("<p>#{data.zealot_quote}</p>")
   $('.protoss-quotes').append('<p>You have not enough minerals.</p>' if data.minerals_size < 1000)
   $('.protoss-quotes').append('<p>Base is under attack.</p>') if data.base_is_under_attack
@@ -9,5 +9,5 @@ window['posts#index'] = (data) ->
     for key, value of unit
       $('.protoss-quotes').append("<p>#{key}: #{value}</p>")
 
-window['posts#new'] = (data) ->
+@['posts#new'] = (data) ->
   $('.terran-quotes').append("<p>#{data.marine_quote}</p>")

data/test/dummy/app/controllers/posts_controller.rb

@@ -1,5 +1,5 @@
 class PostsController < ApplicationController
-  before_action :init_pluggable_js, only: [:index, :search]
+  before_action :set_pluggable_js, only: [:index, :search]
 
   def index
   end
@@ -9,20 +9,20 @@ class PostsController < ApplicationController
   end
 
   def new
-    pjs({marine_quote: 'You wanna piece of me, boy?'})
+    pjs(marine_quote: 'You wanna piece of me, boy?')
   end
 
   private
 
-  def init_pluggable_js
-    pluggable_js({ 
+  def set_pluggable_js
+    pluggable_js(
       zealot_quote: 'My life for aiur.',
       minerals_size: 999,
       base_is_under_attack: true,
       alert: ['Nuclear', 'launch', 'detected.'],
       ground_units_quotes: { 'Dragoon' => 'Make use of me.', 'High Templar' => 'It shall be done.', 'Archon' => 'We burn...' },
       air_units_quotes: [{'Scout' => 'Awaiting command.'}, {'Arbiter' => 'We feel your presence.'}, {'Carrier' => 'Affirmative.'}]
-    })
+    )
   end
 
 end

data/test/dummy/app/views/layouts/application.html.erb

@@ -1,15 +1,13 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>Dummy</title>
-  <%= stylesheet_link_tag    "application", media: "all" %>
-  <%= javascript_include_tag "application" %>
-  <%= javascript_pluggable_tag %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
+  <head>
+    <title>Dummy</title>
+    <%= stylesheet_link_tag    "application", media: "all" %>
+    <%= javascript_include_tag "application" %>
+    <%= javascript_pluggable_tag %>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
 </html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluggable_js
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Andrey Peresleguine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-27 00:00:00.000000000 Z
+date: 2014-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
@@ -108,7 +108,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A solution for Rails of how to load page specific javascript and pass
+description: Page-specific javascript for Rails applications with the ability of passing
   data.
 email:
 - peresleguine@gmail.com
@@ -199,7 +199,7 @@ rubyforge_project:
 rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: Pluggable javascript and data passing for Rails.
+summary: Page-specific javascript for Rails.
 test_files:
 - features/pluggable_js.feature
 - features/step_definitions/pluggable_js_steps.rb