pluggable_js 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7e1dc20d0c0328f1bf75473e5a53c1498cb92ee
-  data.tar.gz: 1ea6d564384dc36b3f4e11a7a870b2217351e2a0
+  metadata.gz: d8344f65c6acf13c203b313e6057a414f83e49fd
+  data.tar.gz: 6450599c3ab762d0a385abffd81292f6be6a63b0
 SHA512:
-  metadata.gz: a72f01f53602186364f71b60cad17bc562369eeb6ef5b006746462d1200ef9af7c42c566716d3604e9f1189728eb24ee8f1ff9f67f73777e71b315789eff243a
-  data.tar.gz: 26a4568fd34a37e100ddb26e0e2813214a52f92496c6dd71dfe9aa2c9e72be1a0b1ac27846aaef9a96bf59b10224077d00d7f1072e4644377b5f98731d419d56
+  metadata.gz: 54a40748b5a52170e0ac9c0f9537c2a7e9812f43f9ee2cc76145b292e3b936fde5881be6f5a8dcdd3a231ad0a1bb07ae2b727ae4cd791d72a7b501562dc07316
+  data.tar.gz: 7fc292f5541052fe50a30b8953607cdedf6459892c5fbe96731af0473a8c493f865411e2efd1a3ea4293c15ca65e04aa94aec281e64d8717e86c0eb00acd3ec6

data/CHANGELOG.md

@@ -33,3 +33,15 @@
 ## v1.0.0
 
 * passing data to javascript functionality
+
+## v1.0.1
+
+* array of hashes support
+
+## v1.0.2
+
+* array conversion for js and pjs as alias method.
+
+## v1.0.3
+
+* removed unnecessary conditions from pluggable_js controller helper

data/README.md

@@ -1,12 +1,11 @@
-
 # PluggableJs
 
-This gem provides simple functionality of loading page specific javascript and passing data (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 and when DOM is loaded.
+This gem provides simple functionality of loading page specific javascript and passing data from a controller (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 and when DOM is loaded.
 
 ## Installation
 
 * 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
+* Add `<%= javascript_pluggable_tag %>` to application layout file after `<%= javascript_include_tag 'application' %>` line (if you use turbolinks, move helper inside the `body` tag)
 
 Next steps are necessary only if you want to use generator for large pieces of js code (see usage):
 
@@ -45,7 +44,8 @@ class PostsController < ApplicationController
       integer: 1,
       boolean: true,
       array: [1, 2, 3],
-      hash: { a: 1, b: 2, c: 3 }
+      hash: { a: 1, b: 2, c: 3 },
+      array_of_hashes: [{a: 1}, {b: 2}, {c: 3}]
     })
   end
 end
@@ -61,8 +61,11 @@ posts.index = () ->
     console.log pluggable_js.integer
     console.log pluggable_js.array
     console.log pluggable_js.hash
+    console.log pluggable_js.array_of_hashes
 ```
 
+Note: `pjs` is an alias of `pluggable_js`.
+
 ## Config
 
 Let's say you've created action `search` that renders `index` template. Most likely we still need to trigger `posts.index()` function. In such situation you may create `config/initializers/pluggable_js.rb` and use pair actions config:
@@ -75,8 +78,4 @@ end
 
 `{ 'create' => 'new', 'update' => 'edit' }` is a default REST configuration.
 
-If you 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).
-
-## Upgrade
-
-If you are upgrading from version `<= 0.0.6` to `1.0.0`, all you have to do is rename old construction `window.Post` to new `window.posts` (see usage).
+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).

data/features/pluggable_js.feature

@@ -9,12 +9,13 @@ Feature: PluggableJs
     And I should not see 'You wanna piece of me, boy?'
 
   Examples:
-    | action | data_type |
-    | index  | string    |
-    | search | integer   |
-    | index  | boolean   |
-    | search | array     |
-    | index  | hash      |
+    | action | data_type       |
+    | index  | string          |
+    | search | integer         |
+    | index  | boolean         |
+    | search | array           |
+    | index  | hash            |
+    | search | array_of_hashes |
 
   @javascript
   Scenario: New Post

data/features/step_definitions/pluggable_js_steps.rb

@@ -35,7 +35,13 @@ Then(/^I should see content with 'array'$/) do
 end
 
 Then(/^I should see content with 'hash'$/) do
-  page.should have_content 'Zealots: 12.'
-  page.should have_content 'Dragoons: 6.'
-  page.should have_content 'Archons: 1.'
+  page.should have_content 'Dragoon: Make use of me.'
+  page.should have_content 'High Templar: It shall be done.'
+  page.should have_content 'Archon: We burn...'
+end
+
+Then(/^I should see content with 'array_of_hashes'$/) do
+  page.should have_content 'Scout: Awaiting command.'
+  page.should have_content 'Arbiter: We feel your presence.'
+  page.should have_content 'Carrier: Affirmative.'
 end

data/lib/pluggable_js/helpers.rb

@@ -34,21 +34,15 @@ module PluggableJs
     end
 
     module ControllerHelpers
-      # convert hash, passed from controller's action, to js data string
+      # convert hash passed from a controller's action to js data string
       def pluggable_js(hash)
         data_string = hash.map do |key, value|
-          value = if value.is_a?(String)
-            "'#{value}'"
-          elsif value.is_a?(Hash)
-            value.to_json
-          else
-            value
-          end
-          "pluggable_js.#{key} = #{value};"
+          "pluggable_js.#{key} = pjs.#{key} = #{value.to_json};"
         end.join(' ')
-        @js_data_string = 'window.pluggable_js = {}; ' + data_string
+        @js_data_string = 'window.pluggable_js = window.pjs = {}; ' + data_string
       end
-      
+      alias_method :pjs, :pluggable_js
+
     end
 
   end

data/lib/pluggable_js/version.rb

@@ -1,3 +1,3 @@
 module PluggableJs
-  VERSION = "1.0.0"
+  VERSION = "1.0.3"
 end

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

@@ -2,4 +2,4 @@
 # don't want to define as a function in controller related js file.
 
 jQuery ->
-  $('.marine-quote').text('You wanna piece of me, boy?')
+  $('.terran-quotes').text('You wanna piece of me, boy?')

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

@@ -1,8 +1,11 @@
 window.posts = {}
 posts.index = () ->
-  $('.protoss-quotes').append("<p>#{pluggable_js.zealot_quote}</p>")
+  $('.protoss-quotes').append("<p>#{pjs.zealot_quote}</p>")
   $('.protoss-quotes').append('<p>You have not enough minerals.</p>' if pluggable_js.minerals_size < 1000)
   $('.protoss-quotes').append('<p>Base is under attack.</p>') if pluggable_js.base_is_under_attack
   $('.protoss-quotes').append("<p>#{pluggable_js.alert.join(' ')}</p>")
-  for key of pluggable_js.units
-    $('.protoss-quotes').append("<p>#{key}: #{pluggable_js.units[key]}.</p>")
+  for key, value of pluggable_js.ground_units_quotes
+    $('.protoss-quotes').append("<p>#{key}: #{value}</p>")
+  for unit in pluggable_js.air_units_quotes
+    for key, value of unit
+      $('.protoss-quotes').append("<p>#{key}: #{value}</p>")

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

@@ -19,7 +19,8 @@ class PostsController < ApplicationController
       minerals_size: 999,
       base_is_under_attack: true,
       alert: ['Nuclear', 'launch', 'detected.'],
-      units: { 'Zealots' => 12, 'Dragoons' => 6, 'Archons' => 1 }
+      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
 

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

@@ -2,8 +2,8 @@
 <html>
 <head>
   <title>Dummy</title>
-  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
-  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= stylesheet_link_tag    "application", media: "all" %>
+  <%= javascript_include_tag "application" %>
   <%= javascript_pluggable_tag %>
   <%= csrf_meta_tags %>
 </head>

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

@@ -1,2 +1,2 @@
 <div class='protoss-quotes'></div>
-<div class='marine-quote'></div>
+<div class='terran-quotes'></div>

data/test/dummy/app/views/posts/new.html.erb

@@ -1,2 +1,2 @@
-<div class='zealot-quote'></div>
-<div class='marine-quote'></div>
+<div class='protoss-quotes'></div>
+<div class='terran-quotes'></div>

data/test/dummy/config/routes.rb

@@ -1,4 +1,5 @@
 Dummy::Application.routes.draw do
+  root 'posts#index'
   resources :posts, only: [:index, :new] do
     collection do
       get  :search

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluggable_js
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Andrey Peresleguine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-04 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
@@ -228,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Pluggable javascript.