paloma 3.0.2 → 4.0.0

data/lib/paloma/controller.rb

@@ -0,0 +1,38 @@
+module Paloma
+  class Controller
+
+    attr_accessor :resource, :action, :params
+
+
+
+    def initialize
+      self.clear_request
+    end
+
+
+    def clear_request
+      self.resource = nil
+      self.action = nil
+      self.params = {}
+
+      true
+    end
+
+
+    def request
+      {:resource => self.resource, :action => self.action, :params => self.params}
+    end
+
+
+    def has_request?
+      self.resource.present? && self.action.present?
+    end
+
+
+    def has_no_request?
+      !self.has_request?
+    end
+
+
+  end
+end

data/lib/paloma/utilities.rb

@@ -0,0 +1,23 @@
+module Paloma
+  class Utilities
+
+    def self.get_resource controller_path
+      controller_path.split('/').map(&:titleize).join('/').gsub(' ', '')
+    end
+
+
+    def self.interpret_route route_string = nil
+      raise 'Empty route cannot be interpreted' if route_string.blank?
+
+      parts = route_string.split '#'
+
+      resource = parts.first
+      resource = resource.blank? ? nil : resource
+
+      action = parts.length != 1 ? parts.last : nil
+
+      {:resource => resource, :action => action}
+    end
+
+  end
+end

data/paloma.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'paloma'
-  s.version     = '3.0.2'
+  s.version     = '4.0.0'
   s.summary     = "Provides an easy way to execute page-specific javascript for Rails."
   s.description = "Page-specific javascript for Rails done right"
   s.authors     = ['Karl Paragua']

data/test_app/app/assets/javascripts/application.js

@@ -16,78 +16,31 @@
 //= require_tree .
 
 
-// Will be manipulated by Paloma controllers.
-window.called = [];
-
-
-
-
-
-//
-//
-// Routes
-//
-//
-var router = Paloma.router;
-
-router.resource('Foo', {controller: 'MyFoo'});
-router.redirect('Foo#new', {to: 'AnotherFoo#build'});
-
-
-
 
 //
 //
 // Controllers
 //
 //
-var Main = Paloma.controller('Main');
-
-Main.prototype.index = function(){
-  window.called.push('Main#index');
-};
 
+var Main = Paloma.controller('Main');
+Main.prototype.index = function(){};
+Main.prototype.otherAction = function(){};
+Main.prototype.prevent = function(){};
+Main.prototype.basic_params = function(){};
 
 
-var MyFoo = Paloma.controller('MyFoo');
-
-MyFoo.prototype.index = function(){
-  window.called.push('MyFoo#index');
-};
-
-
-MyFoo.prototype.show = function(){
-  window.called.push('MyFoo#show');
-  window.parameter = this.params.parameter;
-};
-
-
-MyFoo.prototype.edit = function(){
-  window.called.push('MyFoo#edit');
-};
-
-
-
-var AnotherFoo = Paloma.controller('AnotherFoo');
-
-AnotherFoo.prototype.build = function(){
-  window.called.push('AnotherFoo#build');
-};
-
-
-
-var Bar = Paloma.controller('Admin/Bar');
-
-Bar.prototype.show = function(){
-  window.called.push('Admin/Bar#show');
-};
-
+var OtherMain = Paloma.controller('OtherMain');
+OtherMain.prototype.show = function(){};
+OtherMain.prototype.otherAction = function(){};
 
 
 
+var Foos = Paloma.controller('Admin/Foos');
+Foos.prototype.index = function(){};
+Foos.prototype.otherAction = function(){};
 
-var MultipleNames = Paloma.controller('MultipleNames');
 
-MultipleNames.prototype.index = function(){
-  window.called.push('MultipleNames#index')
-};
+var NotFoos = Paloma.controller('NotAdmin/Foos');
+NotFoos.prototype.show = function(){};
+NotFoos.prototype.otherAction = function(){};

data/test_app/app/controllers/admin/foos_controller.rb

@@ -0,0 +1,29 @@
+class Admin::FoosController < ApplicationController
+
+  # Default behavior
+  def index
+    render :inline => 'Admin/Foos#index', :layout => 'application'
+  end
+
+
+  # Override controller
+  def show
+    js 'NotAdmin/Foos', :x => 99
+    render :inline => 'Admin/Foos#show', :layout => 'application'
+  end
+
+
+  # Override action
+  def new
+    js '#otherAction', :x => 99
+    render :inline => 'Admin/Foos#new', :layout => 'application'
+  end
+
+
+  # Override controller/action
+  def edit
+    js 'NotAdmin/Foos#otherAction', :x => 99
+    render :inline => 'Admin/Foos#edit', :layout => 'application'
+  end
+
+end

data/test_app/app/controllers/main_controller.rb

@@ -1,10 +1,52 @@
 class MainController < ApplicationController
 
+  # Default behavior
   def index
     render :inline => 'Main#index', :layout => 'application'
   end
 
 
+  # Override controller
+  def show
+    js 'OtherMain', :x => 1
+    render :inline => 'Main#show', :layout => 'application'
+  end
+
+
+  # Override action
+  def new
+    js :otherAction, :x => 1
+    render :inline => 'Main#new', :layout => 'application'
+  end
+
+
+  # Override controller/action
+  def edit
+    js 'OtherMain#otherAction', :x => 1
+    render :inline => 'Main#edit', :layout => 'application'
+  end
+
+
+  # Stop paloma from execution
+  def prevent
+    js false
+    render :inline => 'Main#prevent', :layout => 'application'
+  end
+
+
+  def basic_params
+    js :x => 1, :y => 2
+    render :inline => 'Main#basic_params', :layout => 'application'
+  end
+
+
+
+
+
+  #
+  # Non-HTML response
+  #
+
   def json_response
     render :json => {:x => 1}
   end

data/test_app/config/routes.rb

@@ -5,7 +5,9 @@ TestApp::Application.routes.draw do
   root :to => 'main#index'
 
   resources :main, :controller => 'Main' do
-    member do
+    collection do
+      get :prevent
+      get :basic_params
       get :json_response
       get :js_response
       get :xml_response
@@ -13,12 +15,8 @@ TestApp::Application.routes.draw do
     end
   end
 
-  resources :foo, :controller => 'Foo'
 
   namespace :admin do
-    resources :bar, :controller => 'Bar'
+    resources :foos
   end
-
-
-  resources :multiple_names
 end

data/test_app/spec/integration/advanced_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+#
+#
+# All examples are using namespaces
+#
+#
+
+feature 'executing Paloma controller', :js => true do
+
+
+  context 'default behavior' do
+    it 'executes the same namespace/controller/action' do
+      visit admin_foos_path
+
+      expect(request).to eq({
+        'controller' => 'Admin/Foos',
+        'action' => 'index',
+        'params' => {}})
+    end
+  end
+
+
+  context 'override default controller' do
+    it 'executes the specified controller' do
+      visit admin_foo_path(1)
+
+      expect(request).to eq({
+        'controller' => 'NotAdmin/Foos',
+        'action' => 'show',
+        'params' => {'x' => 99}})
+    end
+  end
+
+
+  context 'override default action' do
+    it 'executes the specified action' do
+      visit new_admin_foo_path
+
+      expect(request).to eq({
+        'controller' => 'Admin/Foos',
+        'action' => 'otherAction',
+        'params' => {'x' => 99}})
+    end
+  end
+
+
+  context 'override default controller/action' do
+    it 'executes the specified controller/action' do
+      visit edit_admin_foo_path(1)
+
+      expect(request).to eq({
+        'controller' => 'NotAdmin/Foos',
+        'action' => 'otherAction',
+        'params' => {'x' => 99}})
+    end
+  end
+
+
+end

data/test_app/spec/integration/basic_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+#
+#
+# All examples are not using namespaces.
+#
+#
+
+feature 'executing Paloma controller', :js => true do
+
+  #
+  #
+  # Basic
+  # All except for basic_params and index action will pass :x => 1 parameter
+  #
+  #
+
+  context 'default behavior' do
+    it 'executes the same controller/action' do
+      visit main_index_path
+
+      expect(request).to eq({
+        'controller' => 'Main',
+        'action' => 'index',
+        'params' => {}})
+    end
+  end
+
+
+  context 'override default controller' do
+    it 'executes the specified controller' do
+      visit main_path(1)
+
+      expect(request).to eq({
+        'controller' => 'OtherMain',
+        'action' => 'show',
+        'params' => {'x' => 1}})
+    end
+  end
+
+
+  context 'override default action' do
+    it 'executes the specified action' do
+      visit new_main_path
+
+      expect(request).to eq({
+        'controller' => 'Main',
+        'action' => 'otherAction',
+        'params' => {'x' => 1}})
+    end
+  end
+
+
+  context 'override default controller/action' do
+    it 'executes the specified controller/action' do
+      visit edit_main_path(1)
+
+      expect(request).to eq({
+        'controller' => 'OtherMain',
+        'action' => 'otherAction',
+        'params' => {'x' => 1}})
+    end
+  end
+
+
+  context 'parameter passed' do
+    it 'passes the parameter' do
+      visit basic_params_main_index_path
+
+      expect(request['params']).to eq({'x' => 1, 'y' => 2})
+    end
+  end
+
+
+
+
+
+  #
+  #
+  # Prevent Paloma
+  #
+  #
+
+  shared_examples 'no paloma' do
+    it 'does not add paloma hook' do
+      expect(page.has_selector?('.js-paloma-hook')).to be_false
+    end
+  end
+
+
+  context 'js(false)' do
+    before { visit prevent_main_index_path }
+
+    include_examples 'no paloma'
+
+    it 'prevents execution of Paloma controller' do
+      expect(request).to be_nil
+    end
+  end
+
+  context 'json response' do
+    before { visit json_response_main_index_path }
+    include_examples 'no paloma'
+  end
+
+  context 'js response' do
+    before { visit js_response_main_index_path }
+    include_examples 'no paloma'
+  end
+
+  context 'xml response' do
+    before { visit xml_response_main_index_path }
+    include_examples 'no paloma'
+  end
+
+  context 'file response' do
+    before { visit file_response_main_index_path }
+    include_examples 'no paloma'
+  end
+
+
+end