pluggable_js 0.0.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5562c201846d6f7300763ae176e9419888c3d31d
-  data.tar.gz: 5aa02bbfdaefb4af6476049965a0bd89819a0c66
+  metadata.gz: d7e1dc20d0c0328f1bf75473e5a53c1498cb92ee
+  data.tar.gz: 1ea6d564384dc36b3f4e11a7a870b2217351e2a0
 SHA512:
-  metadata.gz: 3f0c88cbf4c76faca4f8ceab301ae0e75ae25852952295e6a787c4fd0f65030e2ceeecaa3de38499b8f9345e2e6087b2d48f2495e55c9bf9478cd904c0a16a97
-  data.tar.gz: 123d78a1fc300758f3463741e509b88d2d40e9fcb5a4498812ec814cd6c2c8396cdd7f98b04112fd3b8aef2afdb12f1ee24437fcd5fa423aaab5575bb0efc768
+  metadata.gz: a72f01f53602186364f71b60cad17bc562369eeb6ef5b006746462d1200ef9af7c42c566716d3604e9f1189728eb24ee8f1ff9f67f73777e71b315789eff243a
+  data.tar.gz: 26a4568fd34a37e100ddb26e0e2813214a52f92496c6dd71dfe9aa2c9e72be1a0b1ac27846aaef9a96bf59b10224077d00d7f1072e4644377b5f98731d419d56

data/CHANGELOG.md

@@ -29,3 +29,7 @@
 ## v0.0.6
 
 * fixed function call for IE
+
+## v1.0.0
+
+* passing data to javascript functionality

data/README.md

@@ -1,7 +1,7 @@
 
 # PluggableJs
 
-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.
+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.
 
 ## Installation
 
@@ -18,24 +18,54 @@ Next steps are necessary only if you want to use generator for large pieces of j
 Simply define functions in your controller related file (e.g. posts.js.coffee) like so:
 
 ```coffeescript
-window.Post ||= {}
-Post.index = () ->
+window.posts = {}
+posts.index = () ->
   # your code goes here
-Post.new = () ->
+posts.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.:
+Or, in rare cases, if 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 Post index new
+    rails generate pluggable_js posts index new
 
 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
 
+## Passing data
+
+Starting with version 1.0.0 you may pass data to javascript using `pluggable_js` helper in a controller. See example below:
+
+```ruby
+class PostsController < ApplicationController
+  def index
+    pluggable_js({ 
+      string: 'string',
+      integer: 1,
+      boolean: true,
+      array: [1, 2, 3],
+      hash: { a: 1, b: 2, c: 3 }
+    })
+  end
+end
+```
+
+Now you can access data in posts.js.coffee:
+
+```coffeescript
+window.posts = {}
+posts.index = () ->
+  if pluggable_js.boolean
+    console.log pluggable_js.string
+    console.log pluggable_js.integer
+    console.log pluggable_js.array
+    console.log pluggable_js.hash
+```
+
 ## Config
 
-Let's say you've created action `search` that renders `index` template. Most likely we still need to trigger `Post.index()` 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()` function. In such situation you may create `config/initializers/pluggable_js.rb` and use pair actions config:
 
 ```ruby
 PluggableJs.config do |config|
@@ -44,3 +74,9 @@ 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).

data/features/pluggable_js.feature

@@ -1,15 +1,23 @@
 Feature: PluggableJs
-  In order to use some page specific javascript
-  I want to visit different pages and see different working scripts
+  In order to use some page specific javascript and pass some data
+  I want to visit different pages and see appropriate content
 
   @javascript
-  Scenario: Posts List
-    When I go to list of posts
-    Then I should see 'My life for aiur!'
+  Scenario Outline: Posts List
+    When I go to posts '<action>'
+    Then I should see content with '<data_type>'
     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      |
+
   @javascript
   Scenario: New Post
     When I go to new post
     Then I should see 'You wanna piece of me, boy?'
-    And I should not see 'My life for aiur!'
+    And I should not see 'My life for aiur.'

data/features/step_definitions/pluggable_js_steps.rb

@@ -1,7 +1,11 @@
-When(/^I go to list of posts$/) do
+When(/^I go to posts 'index'$/) do
   visit posts_path
 end
 
+When(/^I go to posts 'search'$/) do
+  visit search_posts_path
+end
+
 When(/^I go to new post$/) do
   visit new_post_path
 end
@@ -13,3 +17,25 @@ end
 And(/^I should not see '(.*?)'$/) do |text|
   page.should_not have_content text
 end
+
+Then(/^I should see content with 'string'$/) do
+  page.should have_content 'My life for aiur.'
+end
+
+Then(/^I should see content with 'integer'$/) do
+  page.should have_content 'You have not enough minerals.'
+end
+
+Then(/^I should see content with 'boolean'$/) do
+  page.should have_content 'Base is under attack.'
+end
+
+Then(/^I should see content with 'array'$/) do
+  page.should have_content 'Nuclear launch detected.'
+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.'
+end

data/lib/generators/pluggable_js/USAGE

@@ -2,7 +2,7 @@ Description:
     Creates js files containing function callers based on controller and action parameters.
 
 Example:
-    $ rails generate pluggable_js Post index new
+    $ rails generate pluggable_js Posts index new
 
         create  app/assets/javascripts/pluggable/posts/index.js.coffee
         create  app/assets/javascripts/pluggable/posts/show.js.coffee

data/lib/generators/pluggable_js/pluggable_js_generator.rb

@@ -12,10 +12,6 @@ class PluggableJsGenerator < Rails::Generators::Base
 
   private
 
-  def model_name
-    controller.classify
-  end
-
   def controller_name
     controller.tableize
   end

data/lib/pluggable_js/helpers.rb

@@ -1,33 +1,54 @@
 module PluggableJs
   module Helpers
 
-    # if file exists – include it, else – call function
-    def javascript_pluggable_tag
-      controller = params[:controller]
-      action = define_pair_action
+    module ViewHelpers
+      # include file if it exists or pass data and call a 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
+        if File.exist?(Rails.root + "app/assets/javascripts/pluggable/#{controller}/#{action}.js.coffee")
+          javascript_include_tag "pluggable/#{controller}/#{action}"
+        else
+          javascript_tag "
+            #{@js_data_string}
+            jQuery(function() {
+              if (typeof(#{controller}) == 'object' && typeof(#{controller}['#{action}']) == 'function') { 
+                return #{controller}['#{action}']();
+              }
+            });"
+        end
+      end
+
+      private
 
-        javascript_tag "jQuery(function() { 
-          if (typeof(#{object}) == 'object' && typeof(#{object}['#{action}']) == 'function') { 
-            return #{object}['#{action}']();
-          }
-        });"
+      def define_pair_action
+        action = params[:action]
+        if Config.pair_actions.has_key?(action)
+          Config.pair_actions[action]
+        else
+          action
+        end
       end
-    end
 
-    private
+    end
 
-    def define_pair_action
-      action = params[:action]
-      if Config.pair_actions.has_key?(action)
-        Config.pair_actions[action]
-      else
-        action
+    module ControllerHelpers
+      # convert hash, passed from 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};"
+        end.join(' ')
+        @js_data_string = 'window.pluggable_js = {}; ' + data_string
       end
+      
     end
 
   end

data/lib/pluggable_js/railtie.rb

@@ -1,7 +1,8 @@
 module PluggableJs
   class Railtie < Rails::Railtie
-    initializer "pluggable_js.helpers" do
-      ActionView::Base.send :include, Helpers
+    initializer 'pluggable_js.helpers' do
+      ActionView::Base.send :include, Helpers::ViewHelpers
+      ActionController::Base.send :include, Helpers::ControllerHelpers
     end
   end
 end

data/lib/pluggable_js/version.rb

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

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

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

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

@@ -1,3 +1,8 @@
-window.Post ||= {}
-Post.index = () ->
-  $('.zealot-quote').text('My life for aiur!')
+window.posts = {}
+posts.index = () ->
+  $('.protoss-quotes').append("<p>#{pluggable_js.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>")

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

@@ -1,7 +1,26 @@
 class PostsController < ApplicationController
-  def index 
+  before_action :init_pluggable_js, only: [:index, :search]
+
+  def index
+  end
+
+  def search
+    render :index
   end
 
   def new
   end
+
+  private
+
+  def init_pluggable_js
+    pluggable_js({ 
+      zealot_quote: 'My life for aiur.',
+      minerals_size: 999,
+      base_is_under_attack: true,
+      alert: ['Nuclear', 'launch', 'detected.'],
+      units: { 'Zealots' => 12, 'Dragoons' => 6, 'Archons' => 1 }
+    })
+  end
+
 end

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

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

data/test/dummy/config/environments/production.rb

@@ -77,4 +77,6 @@ Dummy::Application.configure do
 
   # Use default logging formatter so that PID and timestamp are not suppressed.
   config.log_formatter = ::Logger::Formatter.new
+  
+  config.assets.precompile += %w(pluggable/*)
 end

data/test/dummy/config/initializers/pluggable_js.rb

@@ -0,0 +1,3 @@
+PluggableJs.config do |config|
+  config.pair_actions = { 'search' => 'index' }
+end

data/test/dummy/config/routes.rb

@@ -1,3 +1,7 @@
 Dummy::Application.routes.draw do
-  resources :posts, only: [:index, :new]
+  resources :posts, only: [:index, :new] do
+    collection do
+      get  :search
+    end
+  end
 end

data/test/dummy/db/schema.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 0) do
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluggable_js
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrey Peresleguine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-15 00:00:00.000000000 Z
+date: 2013-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
@@ -194,12 +194,14 @@ files:
 - test/dummy/config/initializers/filter_parameter_logging.rb
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/pluggable_js.rb
 - test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/db/development.sqlite3
+- test/dummy/db/schema.rb
 - test/dummy/db/test.sqlite3
 - test/dummy/lib/assets/.keep
 - test/dummy/public/404.html
@@ -266,12 +268,14 @@ test_files:
 - test/dummy/config/initializers/filter_parameter_logging.rb
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/pluggable_js.rb
 - test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/db/development.sqlite3
+- test/dummy/db/schema.rb
 - test/dummy/db/test.sqlite3
 - test/dummy/lib/assets/.keep
 - test/dummy/public/404.html