pluggable_js 1.0.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8344f65c6acf13c203b313e6057a414f83e49fd
-  data.tar.gz: 6450599c3ab762d0a385abffd81292f6be6a63b0
+  metadata.gz: 9f7dafe469757bf25d292d0b49081de701d62f8d
+  data.tar.gz: 7fad58ce62bc70a5d0541e117673395873681131
 SHA512:
-  metadata.gz: 54a40748b5a52170e0ac9c0f9537c2a7e9812f43f9ee2cc76145b292e3b936fde5881be6f5a8dcdd3a231ad0a1bb07ae2b727ae4cd791d72a7b501562dc07316
-  data.tar.gz: 7fc292f5541052fe50a30b8953607cdedf6459892c5fbe96731af0473a8c493f865411e2efd1a3ea4293c15ca65e04aa94aec281e64d8717e86c0eb00acd3ec6
+  metadata.gz: e1ea81dfe8a2006359d5162d4d8e901ee80af6f6ae3a3ffed85bf2b2660ed6e937bfc8638b38db1972eb9eabd9e25642220e9ee89d70a899fd3bbf905af47d58
+  data.tar.gz: ad1cd94d4e0d88b2bb056db7f071f21781723fee930bee51abc1dd8c8232322d147535205d491588306576febbdb9a20eb69773e7c4eebba9cf47012e1cfe63b

data/CHANGELOG.md

@@ -45,3 +45,7 @@
 ## v1.0.3
 
 * removed unnecessary conditions from pluggable_js controller helper
+
+## v2.0.0
+
+* improved namespace and data passing

data/README.md

@@ -1,40 +1,35 @@
 # PluggableJs
 
-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.
+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.
 
 ## 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)
 
-Next steps are necessary only if you want to use generator for large pieces of js code (see usage):
+### 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
 
 ## Usage
 
+### Basic
+
 Simply define functions in your controller related file (e.g. posts.js.coffee) like so:
 
 ```coffeescript
-window.posts = {}
-posts.index = () ->
+window['posts#index'] = (data) ->
   # your code goes here
-posts.new = () ->
+window['posts#new'] = (data) ->
   # 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 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 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:
+You may pass data to javascript using `pluggable_js` helper in a controller (`pjs` is an alias method). See example below:
 
 ```ruby
 class PostsController < ApplicationController
@@ -54,21 +49,29 @@ 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
-    console.log pluggable_js.array_of_hashes
+window['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
 ```
 
-Note: `pjs` is an alias of `pluggable_js`.
+### 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 `posts.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 `window['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|
@@ -79,3 +82,9 @@ 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).
+
+## 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)

data/features/pluggable_js.feature

@@ -21,4 +21,5 @@ Feature: PluggableJs
   Scenario: New Post
     When I go to new post
     Then I should see 'You wanna piece of me, boy?'
+    And I should see 'Fire it up.'
     And I should not see 'My life for aiur.'

data/lib/pluggable_js/helpers.rb

@@ -1,23 +1,29 @@
 module PluggableJs
   module Helpers
 
-    module ViewHelpers
-      # include file if it exists or pass data and call a function
+    module View
+      # call function and pass data, include file if it exists
       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
-          javascript_tag "
-            #{@js_data_string}
-            jQuery(function() {
-              if (typeof(#{controller}) == 'object' && typeof(#{controller}['#{action}']) == 'function') { 
-                return #{controller}['#{action}']();
-              }
-            });"
-        end
+        ''.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);
+                }
+              });
+            }).call(this);"
+          )
+
+          if File.exist?(Rails.root + "app/assets/javascripts/pluggable/#{controller}/#{action}.js.coffee")
+            content << (javascript_include_tag "pluggable/#{controller}/#{action}")
+          end
+        end.html_safe
+
       end
 
       private
@@ -33,13 +39,10 @@ module PluggableJs
 
     end
 
-    module ControllerHelpers
-      # convert hash passed from a controller's action to js data string
+    module Controller
+      # convert hash passed from controller's action to data string
       def pluggable_js(hash)
-        data_string = hash.map do |key, value|
-          "pluggable_js.#{key} = pjs.#{key} = #{value.to_json};"
-        end.join(' ')
-        @js_data_string = 'window.pluggable_js = window.pjs = {}; ' + data_string
+        @data_string = hash.map { |key, value| "pjs_data.#{key} = #{value.to_json}" }.join('; ')
       end
       alias_method :pjs, :pluggable_js
 

data/lib/pluggable_js/railtie.rb

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

data/lib/pluggable_js/version.rb

@@ -1,3 +1,3 @@
 module PluggableJs
-  VERSION = "1.0.3"
-end
+  VERSION = "2.0.0"
+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{Convention of how to load page specific javascript based on controller and action parameters.}
-  spec.summary       = %q{Pluggable javascript.}
+  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.homepage      = 'https://github.com/peresleguine/pluggable_js'
   spec.license       = 'MIT'
 
@@ -25,7 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'cucumber-rails'
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'capybara-webkit'
-end
+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 ->
-  $('.terran-quotes').text('You wanna piece of me, boy?')
+  $('.terran-quotes').append('<p>Fire it up.</p>')

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

@@ -1,11 +1,13 @@
-window.posts = {}
-posts.index = () ->
-  $('.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, value of pluggable_js.ground_units_quotes
+window['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
+  $('.protoss-quotes').append("<p>#{data.alert.join(' ')}</p>")
+  for key, value of data.ground_units_quotes
     $('.protoss-quotes').append("<p>#{key}: #{value}</p>")
-  for unit in pluggable_js.air_units_quotes
+  for unit in data.air_units_quotes
     for key, value of unit
       $('.protoss-quotes').append("<p>#{key}: #{value}</p>")
+
+window['posts#new'] = (data) ->
+  $('.terran-quotes').append("<p>#{data.marine_quote}</p>")

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

@@ -9,6 +9,7 @@ class PostsController < ApplicationController
   end
 
   def new
+    pjs({marine_quote: 'You wanna piece of me, boy?'})
   end
 
   private

data/test/dummy/config/application.rb

@@ -1,6 +1,7 @@
 require File.expand_path('../boot', __FILE__)
 
-require 'rails/all'
+require 'action_controller/railtie'
+require 'sprockets/railtie'
 
 Bundler.require(*Rails.groups)
 require 'pluggable_js'

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

@@ -13,15 +13,9 @@ Dummy::Application.configure do
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
 
-  # Don't care if the mailer can't send.
-  config.action_mailer.raise_delivery_errors = false
-
   # Print deprecation notices to the Rails logger.
   config.active_support.deprecation = :log
 
-  # Raise an error on page load if there are pending migrations
-  config.active_record.migration_error = :page_load
-
   # Debug mode disables concatenation and preprocessing of assets.
   # This option may cause significant delays in view rendering with a large
   # number of complex assets.

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

@@ -26,11 +26,6 @@ Dummy::Application.configure do
   # Disable request forgery protection in test environment.
   config.action_controller.allow_forgery_protection = false
 
-  # Tell Action Mailer not to deliver emails to the real world.
-  # The :test delivery method accumulates sent emails in the
-  # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
-
   # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluggable_js
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Andrey Peresleguine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-17 00:00:00.000000000 Z
+date: 2013-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
@@ -94,34 +94,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara-webkit
   requirement: !ruby/object:Gem::Requirement
@@ -136,8 +108,8 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Convention of how to load page specific javascript based on controller
-  and action parameters.
+description: A solution for Rails of how to load page specific javascript and pass
+  data.
 email:
 - peresleguine@gmail.com
 executables: []
@@ -185,7 +157,6 @@ files:
 - test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
-- test/dummy/config/database.yml
 - test/dummy/config/environment.rb
 - test/dummy/config/environments/development.rb
 - test/dummy/config/environments/production.rb
@@ -200,9 +171,6 @@ files:
 - 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
 - test/dummy/public/422.html
@@ -231,7 +199,7 @@ rubyforge_project:
 rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: Pluggable javascript.
+summary: Pluggable javascript and data passing for Rails.
 test_files:
 - features/pluggable_js.feature
 - features/step_definitions/pluggable_js_steps.rb
@@ -259,7 +227,6 @@ test_files:
 - test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
-- test/dummy/config/database.yml
 - test/dummy/config/environment.rb
 - test/dummy/config/environments/development.rb
 - test/dummy/config/environments/production.rb
@@ -274,9 +241,6 @@ test_files:
 - 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
 - test/dummy/public/422.html

data/test/dummy/config/database.yml

@@ -1,25 +0,0 @@
-# SQLite version 3.x
-#   gem install sqlite3
-#
-#   Ensure the SQLite 3 gem is defined in your Gemfile
-#   gem 'sqlite3'
-development:
-  adapter: sqlite3
-  database: db/development.sqlite3
-  pool: 5
-  timeout: 5000
-
-# Warning: The database defined as "test" will be erased and
-# re-generated from your development database when you run "rake".
-# Do not set this db to the same as development or production.
-test:
-  adapter: sqlite3
-  database: db/test.sqlite3
-  pool: 5
-  timeout: 5000
-
-production:
-  adapter: sqlite3
-  database: db/production.sqlite3
-  pool: 5
-  timeout: 5000

data/test/dummy/db/schema.rb

@@ -1,16 +0,0 @@
-# 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