jcontroller 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bfcee10ac94a9114e9d0ece81aa09c870564af1
-  data.tar.gz: 504a7afa731f155ac463574b2f9d56b832115e7c
+  metadata.gz: 0dc0dec2d86a61f9e4f6d4a0c1522ad298ba5252
+  data.tar.gz: feda08b748ad215642d79e191635e4f92b4c6cb2
 SHA512:
-  metadata.gz: aec42bf2c4cab2d34187deac8853fabc2515b746fc61fd72d520b24f2b103636b3f7266e9feeaa30f7e51718cdf0b1756eb2d9061bf1c8441f2c07261b98af48
-  data.tar.gz: 9707c39a865653f525571dffd36ca34ea5ba3715add9f5d8704311a342fd50a35e33596bf365c9a5aaf33958814f8c4b9664d91d55f4fa45484f8af0900ef1ec
+  metadata.gz: 44b2653eba12e626f017460ae7287f2e1e3340cd07b631763e43cd99730c6689bb1951b510fa7e422796d07d3456f64642b030cec80c9a06de23a11a019781c9
+  data.tar.gz: ee1bce67790d5a99b7cfae9870daf6985f85885635b810e9f0a493c68115df10cb337fa055946aac14539d532dc16b175ad86964d96fb772ecc83ff1241843da

data/README.md

@@ -1,29 +1,164 @@
-# Jcontroller
+# Jcontroller [![Gem Version](https://badge.fury.io/rb/jcontroller.png)](http://badge.fury.io/rb/jcontroller) [![Build Status](https://travis-ci.org/s12chung/jcontroller.png?branch=master)](https://travis-ci.org/s12chung/jcontroller?branch=master) [![Code Climate](https://codeclimate.com/github/s12chung/jcontroller.png)](https://codeclimate.com/github/s12chung/jcontroller)
+Rails controller based javascript to keep your javascript outside of your views.
 
-TODO: Write a gem description
+Based off [Paul Irish's DOM-based Routing](http://www.paulirish.com/2009/markup-based-unobtrusive-comprehensive-dom-ready-execution/)
+(or Garber-Irish Implementation). __Works with turbolinks__
 
-## Installation
-
-Add this line to your application's Gemfile:
+## How it works
+```javascript
+Jcontroller.create('users', {
+    html: {
+        // executes whenever users#index with html format is executed
+        index: function() {}
+    }
+});
+```
+No other code is needed.
 
-    gem 'jcontroller'
+## Installation
+Add `gem 'dom_routes'` to your application's `Gemfile` and run the `bundle` command, then add this to your `app/assets/javascripts/application.js`
 
-And then execute:
+    //= require dom_routes
+    
+## Controllers
+### Namespaces
+Jcontroller creation and finding are based off the controller path.
+```javascript
+// for Admin::UsersController
+Jcontroller.create('admin/users', {});
+```
+### Filters
+Jcontrollers can be created with before and after filters like so:
+```javascript
+Jcontroller.create('users', {
+    html: {
+        // executes for all html format responses for UsersController, before the specific action
+        before: function() {}
+        // executes whenever users#index with html format is executed
+        index: function() {}
+        // executes for all html format responses for UsersController, after the specific action
+        after: function() {}
+    }
+});
+```
+### Inheritance
+By default, jcontrollers inherit from the `application` jcontroller and will execute it if it exists, such as:
+```javascript
+Jcontroller.create('application', {
+    html: {
+        before: function() {}
+        index: function() {}
+        after: function() {}
+    }
+});
+```
+So with the jcontrollers above the order of execution is:
+- `application.before`
+- `users.before`
+- `application.index`
+- `users.index`
+- `application.after`
+- `users.after`
 
-    $ bundle
+You can also set your own inhertance chain:
+```javascript
+Jcontroller.create('users', { 
+    parent_path: 'users_base',
+    ...
+});
+```
+## Parameters
+### Access
+Parameters are accessed from `this.params`:
+```javascript
+Jcontroller.create('users', {
+    html: {
+        index: function() {
+            console.log(this.params);
+        }
+    }
+});
+```
+The request state (controller_path, action_name, jcontroller, etc.) are also given in `this.state`.
 
-Or install it yourself as:
+### Manual
+Use the `js` method with the `params` option.
+```ruby
+class UsersController < ApplicationController
+    def show
+        @user = User.find(params[:id])
+        js { :params => { :id => @user.id } }
+    end
+end
+```
+### From view template
+You can also create parameters using a JSON DSL (such as [jbuilder](https://github.com/rails/jbuilder/)) by creating a template named `<action_name>_params.js.<DSL suffix>`:
+```ruby
+# app/views/users/show_params.js.jbuilder
+json.id @user.id
+```
 
-    $ gem install jcontroller
+## Controlling javascript execution
+### Stop
+Stop all execution of all filters and methods for the action:
+```ruby
+class UsersController < ApplicationController
+    def index
+        js false
+    end
+end
+```
+### Different jcontroller
+Execute a different jcontroller:
+```ruby
+class UsersController < ApplicationController
+    def index
+        # same as "users#index.html", parameters and options are optional
+        js "users/show.html", { :params => { ... } }
+    end
+end
+```
 
-## Usage
+### HTML view
+Execute all filters and actions related to a action:
+```erb
+<!-- same as "users#index.html", parameters and options are optional -->
+<%= execute_jaction "users/show.html", { :params => { ... } } %>
+```
 
-TODO: Write usage instructions here
+### Manually filter in Javascript
+You can use the given state to stop execution of functions:
+```javascript
+Jcontroller.create('application', {
+    html: {
+        before: function() {
+            if (this.state.action_name === 'destroy') { }
+        }
+    }
+});
+```
+### Redirect
+You can execute all filters and functions of the current action before the redirected action using:
+```ruby
+class UsersController < ApplicationController
+    def index
+        js { :redirect => true }
+        redirect_to user_path(User.first)
+    end
+end
+```
+So `users/index.html` will be executed before `users/show.html`.
 
-## Contributing
+## Ajax
+You can optionally execute jcontrollers for ajax instead of writing javascript in views by turning it in `config/application.rb`:
+```ruby
+Jcontroller.ajax = true
+```
+Jcontrollers will automatically execute with parameters given by the template with a JSON DSL:
+```ruby
+# app/views/users/show.js.jbuilder
+json.id @user.id
+```
 
-1. Fork it ( http://github.com/<my-github-username>/jcontroller/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+## Credits
+Extracted out of [Placemark](https://www.placemarkhq.com/). Originally called [dom_routes](https://github.com/s12chung/dom_routes). An alternative is [paloma](https://github.com/kbparagua/paloma).

data/app/assets/javascripts/jcontroller.js

@@ -6,9 +6,7 @@ var Jcontroller = {
             $.extend({
                     parent_path: controller_path === this.application_controller_path ? undefined : "application",
                     parent: function() {
-                        if (Jcontroller.blank(this.parent_cache)) {
-                            this.parent_cache =  Jcontroller.find(this.parent_path);
-                        }
+                        if (Jcontroller.blank(this.parent_cache)) { this.parent_cache =  Jcontroller.find(this.parent_path); }
                         return this.parent_cache;
                     },
 
@@ -16,7 +14,7 @@ var Jcontroller = {
                         var dup = $.extend({}, this, state.jaction);
                         dup.state = state;
                         dup.params = params;
-                        if (Jcontroller.present(dup.parent())) dup.parent_cache = dup.parent().dup(state, params);
+                        if (Jcontroller.present(dup.parent())) { dup.parent_cache = dup.parent().dup(state, params); }
                         return dup;
                     },
 
@@ -36,7 +34,7 @@ var Jcontroller = {
                         if (Jcontroller.present(this.parent())) this.parent().execute_pre_order_filter(filter);
                     },
                     execute_filter: function(filter) {
-                        if ($.isFunction(filter)) $.proxy(filter, this)();
+                        if ($.isFunction(filter)) { $.proxy(filter, this)(); }
                     }
                 },
                 definition
@@ -45,9 +43,7 @@ var Jcontroller = {
     },
     execute_jaction: function(state, params) {
         var controller = this.find(state.jaction.controller_path);
-        if (this.present(controller)) {
-            controller.dup(state, params).execute_action();
-        }
+        if (this.present(controller)) { controller.dup(state, params).execute_action(); }
     },
 
     blank: function(o) { return typeof o === "undefined" || o === null; },
@@ -59,14 +55,14 @@ var Jcontroller = {
     get_or_create: function(namespace_string) {
         var current_namepace = window;
         $.each(namespace_string.split('/'), function(index, level) {
-            if (Jcontroller.blank(current_namepace[level])) current_namepace[level] = {};
+            if (Jcontroller.blank(current_namepace[level])) { current_namepace[level] = {}; }
             current_namepace = current_namepace[level];
         });
 
         return current_namepace;
     },
     find: function(controller_path) {
-        if (this.blank(controller_path)) return undefined;
+        if (this.blank(controller_path)) { return undefined; }
         var namespace_string = this.controllers_path + controller_path;
 
         var current_namepace = window;

data/jcontroller.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'rails', '>= 3.2'
+  spec.add_dependency 'rails', '>= 4.0'
   spec.add_dependency 'request_store'
 
   spec.add_development_dependency "bundler"

data/lib/jcontroller/filter.rb

@@ -30,7 +30,7 @@ module Jcontroller
           else
             response.body += jactions
           end
-        else
+        elsif Jcontroller.ajax
           response.body = execute_jaction({ :params => response.body })
         end
       end

data/lib/jcontroller/version.rb

@@ -1,3 +1,3 @@
 module Jcontroller
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/jcontroller.rb

@@ -9,4 +9,7 @@ require 'jcontroller/view_helpers'
 require 'jcontroller/engine'
 
 module Jcontroller
+  class << self
+    attr_accessor :ajax
+  end
 end

data/spec/fake_app/app/controllers.rb

@@ -3,14 +3,19 @@ class ApplicationController < ActionController::Base
 end
 
 class UsersController < ApplicationController
-  DEFAULT_ACTIONS = %w[state no_action manually_execute parameters_template]
+  DEFAULT_ACTIONS = %w[state no_action manually_execute]
   (%w[index] + DEFAULT_ACTIONS).each do |action|
     class_eval <<-END
       def #{action};end
     END
   end
 
+  def parameters_template
+    @parameter_string = "parameter template"
+  end
+
   def stopped
+    Jcontroller.ajax = !params[:ajax_off]
     js false
   end
   def redirect

data/spec/fake_app/app/views/users/parameters_template_params.js.jbuilder

@@ -1 +1 @@
-json.s "parameter template"
+json.s @parameter_string

data/spec/fake_app/routes.rb

@@ -4,6 +4,7 @@ FakeApp::Application.routes.draw do
       UsersController::DEFAULT_ACTIONS.each do |action|
         get action
       end
+      get :parameters_template
       get :stopped
       get :redirect
       get :redirect_simple

data/spec/features/jcontroller_spec.rb

@@ -27,6 +27,12 @@ feature 'invoke correct filter', :js => true do
     end
   end
 
+  def test_no_elements
+    within @test_append_selector do
+      all('div').size.should == 0
+    end
+  end
+
   it "should pass the state of the request" do
     visit state_users_path
     find(@test_append_selector).text.should == {
@@ -68,9 +74,7 @@ feature 'invoke correct filter', :js => true do
 
   scenario "when stopped" do
     visit stopped_users_path
-    within @test_append_selector do
-      all('div').size.should == 0
-    end
+    test_no_elements
   end
   scenario "when redirected" do
     visit redirect_users_path
@@ -102,6 +106,13 @@ feature 'invoke correct filter', :js => true do
   end
 
   context "with ajax" do
+    scenario "ajax off" do
+      visit stopped_users_path(ajax_off: true)
+      click_link "ajax link"
+      wait_for_ajax
+      test_no_elements
+    end
+
     scenario "basic controller" do
       visit stopped_users_path
       click_link "ajax link"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jcontroller
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Steve Chung
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement