pluggable_js 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 042a86301eb3629ddde7da5e4601b20bc1bbf8a2
-  data.tar.gz: ce6aee1cd8a3d65d9c89e9f46a98e6e1f0a545d9
+  metadata.gz: 0e1428335e519b6cd7c4ada68e3509110730777c
+  data.tar.gz: 382b93ad474f9f69ece97e2ea1d1f553fe59c4e3
 SHA512:
-  metadata.gz: 96c4ee114de5a06a5d576dbb5390c6899bef8b43144cb7cd76c51fd718517cada5e68b9d6a8940a10f9593d63b0f5a34817ff5a7844c715c31f560ea23b2c4c1
-  data.tar.gz: 3c1a316e6125e8754cc6789be4a2c1fe68a46631112f9dacdbecde1c8a18ab9e1815ed24944d3f1841dd58585eeebd6e55c23eed968f2f8ae58d74ec7c3ea9a9
+  metadata.gz: fc2209b7ce395bcbfe88f026a8df1be0bf73ee7c1f30196e79047a0b1b0c07bd3094103882d83190b2b2fc42d513ea75c5b4de1e4014bb7f3748aa41a21aa4c3
+  data.tar.gz: 02b55ddb93e3590200a4950fad3e9a275594e9680dc1601376d11af2be7782b0ee4b0be31e4eabbc73a360731e06301fde8ad5437b0267d7ffe532eb7c0a95a2

data/CHANGELOG.md

@@ -67,3 +67,7 @@
 * removed jquery and coffee from core dependency
 * removed unused generator
 * simplified main helper
+
+## v2.2.0
+
+* shared data helper between view and controller

data/README.md

@@ -2,16 +2,18 @@
 
 [![Gem Version](https://badge.fury.io/rb/pluggable_js.svg)](http://badge.fury.io/rb/pluggable_js)
 
-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.
+This gem provides simple functionality of loading page specific javascript and allows to pass data from a controller. It requires only 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 and when DOM is ready.
 
 ## Installation
 
-1. Add `gem 'pluggable_js', '~> 2.1.0'` to Gemfile and run `bundle` command to install it
+1. Add `gem 'pluggable_js', '~> 2.2.0'` to Gemfile and run `bundle` command to install it
 2. Add `<%= javascript_pluggable_tag %>` helper to application layout file above the closing `</body>` tag
 
+The place for the helper is important. Primarily it serves the DOM ready purpose and completely necessary if you decided to use turbolinks.
+
 ## Usage
 
-Simply define functions in your controller related file (e.g. posts.js.coffee) like so:
+Simply define functions in your controller related file (e.g. posts.coffee) like so:
 
 ```coffeescript
 @['posts#index'] = (data) ->
@@ -20,7 +22,7 @@ Simply define functions in your controller related file (e.g. posts.js.coffee) l
   # and here
 ```
 
-You may pass data to javascript using `pluggable_js` helper in a controller (`pjs` is an alias method). See example below:
+You may pass data to javascript function using `pluggable_js` helper in rails controller (`pjs` is an alias method). See example below:
 
 ```ruby
 class PostsController < ApplicationController
@@ -37,18 +39,20 @@ class PostsController < ApplicationController
 end
 ```
 
-Now you can access data in posts.js.coffee:
+If you feel like this logic doesn't belong to a controller, safely move it to a view. Then you can access data in posts.coffee:
 
 ```coffeescript
 @['posts#index'] = (data) ->
-  if data.boolean
-    console.log data.string
-    console.log data.integer
-    console.log data.array
-    console.log data.hash
-    console.log data.array_of_hashes
+  console.log data.string
+  console.log data.integer
+  console.log data.boolean
+  console.log data.array
+  console.log data.hash
+  console.log data.array_of_hashes
 ```
 
+CoffeeScript used here just for the sake of simplicity. You may implement the same with plain JavaScript.
+
 ## 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:
@@ -61,8 +65,6 @@ 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 :set_pluggable_js, only: [:index, :search]` (`before_filter` in Rails < 4).
-
 ## Upgrade
 
 * [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)

data/lib/pluggable_js/helpers.rb

@@ -1,7 +1,16 @@
 module PluggableJs
   module Helpers
 
+    module Shared
+      def pluggable_js(data)
+        @pluggable_js_data = data.to_json
+      end
+      alias_method :pjs, :pluggable_js
+    end
+
     module View
+      include PluggableJs::Helpers::Shared
+
       def javascript_pluggable_tag
         controller = params[:controller]
         action = define_pair_action
@@ -28,10 +37,7 @@ module PluggableJs
     end
 
     module Controller
-      def pluggable_js(data)
-        @pluggable_js_data = data.to_json
-      end
-      alias_method :pjs, :pluggable_js
+      include PluggableJs::Helpers::Shared
     end
 
   end

data/lib/pluggable_js/version.rb

@@ -1,3 +1,3 @@
 module PluggableJs
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

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

@@ -1,6 +1,5 @@
 module PluggableJs
   class PostsController < ApplicationController
-    before_action :set_pluggable_js, only: [:index, :search]
 
     def index
     end
@@ -13,18 +12,5 @@ module PluggableJs
       pjs(marine_quote: 'You wanna piece of me, boy?')
     end
 
-  private
-
-    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
 end

data/test/dummy/app/views/pluggable_js/posts/index.html.erb

@@ -2,3 +2,12 @@
 <div class='terran-quotes'></div>
 
 <%= link_to 'New post', new_pluggable_js_post_path %>
+
+<% 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.'}]
+) %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluggable_js
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Andrey Peresleguine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails