pluggable_js 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6817aa80ad45a4ecc1698a6810bc46c37b60cfd0
+  data.tar.gz: 329eb1d15fb3a57f487322ee15040b113eabe7a4
+SHA512:
+  metadata.gz: ffd735361c98f0a9b6122c9b642efa680011f35349001aed3633267e63115b18e28b6dd649f2315aa05c6502464a08c3981531f2807629e14197f4ce93a21175
+  data.tar.gz: 93473f70466749116f88366280ab4b6793b03c226abd5ae42ccd9819fe2841a716e992b3eb948d31c7b2686cde684087236ece42bbc09e03292380243178ac8a

data/.gitignore

@@ -0,0 +1,22 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-gemset
+.ruby-version
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/dummy/tmp
+test/dummy/log
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+## v0.0.1.rc
+
+* initial release
+
+## v0.0.1.rc2
+
+* extended readme
+
+## v0.0.1
+
+* added tests
+
+## v0.0.2
+
+* edited dependencies
+
+## v0.0.3
+
+* edited rails as >= 3.1 dependency
+
+## v0.0.4
+
+* added necessary folders to gitignore for dummy app

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluggable_js.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Andrey Peresleguine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# PluggableJs
+
+Sometimes you need to use javascript only in specific pages, but you don't want to change DOM or write code in a view. Maybe you have one container with the same class in different templates, but part of bound logic is needed only in one. Or maybe some javascript causes exceptions in other views.
+
+This gem provides simple functionality of loading javascript only in certain pages based on controller and action parameters. Keep your js code in controller related files as action based functions (still in asset pipeline). It will be triggered only if needed.
+
+## Installation
+
+1. Add `gem 'pluggable_js'` to Gemfile and run `bundle` command to install it
+2. Add `<%= javascript_pluggable_tag %>` to application layout file after `<%= javascript_include_tag 'application' %>` line
+3. Add `pluggable/*` to assets precompile configuration in production.rb (and staging.rb if you have one), e.g.: `config.assets.precompile += %w(pluggable/*)`
+4. Be sure that `pluggable` folder is out of `require_tree` statement in application.js
+
+## Usage
+
+Choose controller and actions you want to use for pluggable js and run generator, e.g.:
+    
+    rails generate pluggable_js Post index new
+
+It will create two files (just function callers):
+    
+    app/assets/javascripts/pluggable/posts/index.js.coffee
+    app/assets/javascripts/pluggable/posts/new.js.coffee
+
+Now you simply have to define `Post.index` and `Post.new` functions in posts.js.coffee:
+
+```coffeescript
+window.Post ||= {}
+Post.index = () ->
+  # your code goes here
+Post.new = () ->
+  # and here
+```
+
+They will be triggered only when matching controller and action parameters.
+
+## 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:
+
+```ruby
+PluggableJs.config do |config|
+  config.pair_actions = { 'search' => 'index' }
+end
+```
+
+`{ 'create' => 'new', 'update' => 'edit' }` is a default REST configuration.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/features/pluggable_js.feature

@@ -0,0 +1,15 @@
+Feature: PluggableJs
+  In order to use some page specific javascript
+  I want to visit different pages and see different working scripts
+
+  @javascript
+  Scenario: Posts List
+    When I go to list of posts
+    Then I should see 'My life for aiur!'
+    And I should not see 'You wanna piece of me, boy?'
+
+  @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!'

data/features/step_definitions/pluggable_js_steps.rb

@@ -0,0 +1,15 @@
+When(/^I go to list of posts$/) do
+  visit posts_path
+end
+
+When(/^I go to new post$/) do
+  visit new_post_path
+end
+
+Then(/^I should see '(.*?)'$/) do |text|
+  page.should have_content text
+end
+
+And(/^I should not see '(.*?)'$/) do |text|
+  page.should_not have_content text
+end

data/features/support/env.rb

@@ -0,0 +1,19 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'rspec/expectations'
+
+ENV["RAILS_ENV"] ||= "test"
+require File.expand_path("../../../test/dummy/config/environment.rb",  __FILE__)
+ENV["RAILS_ROOT"] ||= File.dirname(__FILE__) + "../../../test/dummy"
+require 'cucumber/rails'
+
+require 'capybara-webkit'
+Capybara.javascript_driver = :webkit

data/lib/generators/pluggable_js/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Creates js files containing function callers based on controller and action parameters.
+
+Example:
+    $ rails generate pluggable_js Post 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

@@ -0,0 +1,23 @@
+class PluggableJsGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  argument :controller, type: :string
+  argument :actions, type: :array, default: [], banner: 'action action'
+
+  def create_pluggable_js_files
+    actions.each do |action|
+      @action = action
+      template 'function_caller.js.coffee', File.join('app/assets/javascripts/pluggable', controller_name, "#{action}.js.coffee")
+    end
+  end
+
+  private
+
+  def model_name
+    controller.classify
+  end
+
+  def controller_name
+    controller.tableize
+  end
+  
+end

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

@@ -0,0 +1,11 @@
+# Define somewhere in your controller related js file (e.g. <%= controller_name %>.js.coffee):
+# 
+# window.<%= model_name %> ||= {}
+# <%= model_name %>.<%= @action %> = () ->
+#   # your code goes here
+
+jQuery ->
+  # whatever you want will be triggered from here  
+  # only if this filepath matches current 
+  # controller and action parameters  
+  <%= model_name %>.<%= @action %>()

data/lib/pluggable_js/config.rb

@@ -0,0 +1,16 @@
+module PluggableJs
+  module Config
+    DEFAULT_PAIR_ACTIONS = { 'create' => 'new', 'update' => 'edit' }
+
+    class << self
+      def pair_actions=(hash = {})
+        @pair_actions = DEFAULT_PAIR_ACTIONS.merge hash
+      end
+
+      def pair_actions
+        @pair_actions ||= DEFAULT_PAIR_ACTIONS
+      end
+    end
+
+  end
+end

data/lib/pluggable_js/helpers.rb

@@ -0,0 +1,25 @@
+module PluggableJs
+  module Helpers
+
+    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}"
+      end
+    end
+
+    private
+
+    def define_pair_action
+      action = params[:action]
+      if Config.pair_actions.has_key?(action)
+        Config.pair_actions[action]
+      else
+        action
+      end
+    end
+
+  end
+end

data/lib/pluggable_js/railtie.rb

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

data/lib/pluggable_js/version.rb

@@ -0,0 +1,3 @@
+module PluggableJs
+  VERSION = "0.0.4"
+end

data/lib/pluggable_js.rb

@@ -0,0 +1,10 @@
+require 'pluggable_js/version'
+require 'pluggable_js/helpers'
+require 'pluggable_js/config'
+require 'pluggable_js/railtie' if defined?(Rails)
+
+module PluggableJs
+  def self.config(&block)
+    block.call(Config)
+  end
+end

data/pluggable_js.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pluggable_js/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pluggable_js'
+  spec.version       = PluggableJs::VERSION
+  spec.authors       = ['Andrey Peresleguine']
+  spec.email         = ['peresleguine@gmail.com']
+  spec.description   = %q{Convention of how to load javascript only in certain pages based on controller and action parameters.}
+  spec.summary       = %q{Pluggable javascript.}
+  spec.homepage      = 'https://github.com/peresleguine/pluggable_js'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'coffee-rails'
+  spec.add_dependency 'jquery-rails'
+  spec.add_dependency 'rails', '>= 3.1'
+
+  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

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require_directory

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

@@ -0,0 +1,11 @@
+# Define somewhere in your controller related js file (e.g. posts.js.coffee):
+# 
+# window.Post ||= {}
+# Post.index = () ->
+#   # your code goes here
+
+jQuery ->
+  # whatever you want will be triggered from here  
+  # only if this filepath matches current 
+  # controller and action parameters  
+  Post.index()

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

@@ -0,0 +1,11 @@
+# Define somewhere in your controller related js file (e.g. posts.js.coffee):
+# 
+# window.Post ||= {}
+# Post.new = () ->
+#   # your code goes here
+
+jQuery ->
+  # whatever you want will be triggered from here  
+  # only if this filepath matches current 
+  # controller and action parameters  
+  Post.new()

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

@@ -0,0 +1,5 @@
+window.Post ||= {}
+Post.index = () ->
+  $('.zealot-quote').text('My life for aiur!')
+Post.new = () ->
+  $('.marine-quote').text('You wanna piece of me, boy?')

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

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

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

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

@@ -0,0 +1,7 @@
+class PostsController < ApplicationController
+  def index 
+  end
+
+  def new
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

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

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

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

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

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

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

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require 'pluggable_js'
+require 'jquery-rails'
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# 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/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

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

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  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.
+  config.assets.debug = true
+end