paloma 3.0.0 → 3.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmNlOWQ5NmY4NDIyMmNkNzllNDlmMTNjZDEyZWYzODBhMTU2YzAxYg==
+  data.tar.gz: !binary |-
+    OGI2NDc5ODAzM2YyNmVjMWIyMTUyZGJjN2Y3OTVkYTM0YzM4MGYwMg==
+SHA512:
+  metadata.gz: !binary |-
+    ZmI5NTFiZmU1ZTQ0ZTI2NTUyZTcxM2NlMDZkOTAyMDQzM2IzZWM1NDNhMzdm
+    MzRlYmZmMGU1OGQ4NTk1Y2Y2N2FhNGY3NjlmZTk3OTQ5ZThiMDhiNmEzOWIy
+    Yzk2MDU1YjAzYmJhNzZlNTM0MDQ5ZTIwMThkOWM1YWIzZjBjNGQ=
+  data.tar.gz: !binary |-
+    Y2QzMjUwZGMwNTNlYTQ3YTU3NWVlYTM1ODBjZmY5MjQyNGM2NjY0NDVlN2U0
+    MGMwOGJiMTQwOTc2MmYyYzQxNmUwMWQ5YjNjNjgyZjFiMDU3NGYzYWFiYzJm
+    NDUxODBkOWI0ZTQ5ZTA1NDNhZWNiMDNjNzcxNjdlYmU0YWM2Y2Y=

data/Changelog.md

@@ -1,4 +1,10 @@
 # Changelog
 
+## Version 3.0.1
+* Bug Fix: Can't handle Rails controller with Multi-word name.
+* Bug Fix: Paloma Engine is halting when a warning is encountered.
+* Don't create Paloma request if rendering js, json, xml, or file.
+
+
 ## Version 3.0.0
-* Rewrite Initial Release
+* Rewrite Initial Release

data/README.md

@@ -1,14 +1,24 @@
 # Paloma
 
+**This README is for Paloma 3 only. 
+For version 2 README please go [here](https://github.com/kbparagua/paloma/blob/2.0/README.md).**
+
 
 ## What's New?
-Paloma (version 3) is almost a complete rewrite of the old version.
+Paloma 3 is almost a complete rewrite of the old version.
+
+It is now simpler and more flexible. The old callback thingy paradigm is replaced by a `Router` and `Controller` layer for better abstraction. Generators are also removed, so programmers need not to follow specific directory structure, unlike in the old versions.
+
+Previously, there are generators that create Paloma files, and these files are written in vanilla javascript. Because of that there are some users who are requesting for coffeescript setup. Now since there are no generated files programmers can write their code either by using vanilla javascript or **coffeescript**. Yay!
+
+### Controller and Router
+The new paradigm is patterned after Rails Controller and Routes, so it is easier to grasp than the old callback paradigm. Basically, you have a Paloma Controller that is responsible for processing requests made from Rails Controller. While the Router is responsible for telling what Paloma Controller handles what Rails Controller, or what Paloma Controller's action handles what Rails Controller's action. 
+
 
-It is now simpler and it also gives more flexibility to the developers. Simplicity and flexibility are achieved by replacing the old callback thingy paradigm by a combination of `Router` and `Controller` components.
+### How about Model and View?
 
-All the generator shits are also gone. So developers need not to follow specific folder structure or file name. And since there's no generated files or whatsoever, you can now code in vanilla javascript or **coffescript**! Yay!
+It is tempting to convert Paloma 3 to a full-blown MVC or MVP (or whatever) framework. But I've decided to keep it simple and just provide a Controller component as way to execute a specific javascript code per Rails Controller action and give developers freedom on how to handle each action. So you can still have your own Model and View components and just use them in your Paloma Controllers, since a controller is just a middle-man.
 
-**Basically, Paloma now provides a Controller for your javascript!**
 
 ## Advantages
 * Choose what specific javascript code to run per page.
@@ -22,7 +32,7 @@ Paloma controller.
 ```javascript
 var UsersController = Paloma.controller('Users');
 
-// Executes when Rails User#new is rendered.
+// Executes when Rails User#new is executed.
 UsersController.prototype.new = function(){
    alert('Hello Sexy User!' );
 };
@@ -33,6 +43,7 @@ The Rails controller `app/controllers/users_controller.rb`:
 ```ruby
 def UsersController < ApplicationController
     def new
+      # a Paloma request will automatically be created.
       @user = User.new
     end
 end
@@ -40,87 +51,45 @@ end
 
 That's it! Simply Sexy!
 
-Minimum Requirements
--
+## Minimum Requirements
 * jQuery 1.7 or higher
 * Rails 3.1 or higher
 
 
 ## Install
 
-Without bundler:
-```
-sudo gem install paloma
-```
+* Without bundler: `sudo gem install paloma`.
+* With bundler, add this to your Gemfile: `gem 'paloma'`
+* Require `paloma` in your `application.js`: `//= require paloma`
 
-With bundler, add this to your Gemfile:
-```
-gem 'paloma'
-```
 
+## Controllers
 
-Require `paloma` in your `application.js`:
-```
-//= require paloma
-```
-
-
-## Router
-
-Router is responsible for mapping Rails controller/action to its equivalent Paloma controller/action.
+Controllers are just classes that handle requests made by Rails Controllers. Each Rails Controller's action will be mapped to a specific Paloma Controller's action.
 
-By default all Rails controller/action will be mapped with a Paloma controller/action with the same resource name (controller name without the `Controller` suffix).
 
-Example:
-* Response from `UsersController#new` will be mapped to `Users` Paloma controller and execute its `new` method.
+### Creating a Controller
 
-### Changing Controller
-
-If you want to use a different Paloma Controller for a specific Rails controller, you can do the following:
-
-```javascript
-// Instead of mapping Rails UsersController to Paloma Users
-// it will be mapped to AdminUsers.
-Paloma.router.resource('Users', {controller: 'AdminUsers'});
-```
-
-### Redirecting
-
-You can also redirect an action if you want it to be handled by a different method.
+A Controller constructor is created or accessed, if it already exists, using `Paloma.controller()` method.
 
 ```javascript
-// Instead of executing Paloma's `Users#new` it will execute
-// `Registrations#signUp`.
-Paloma.router.redirect('Users#new', {to: 'Registrations#signUp');
-```
-
-## Controller
-
-Controller handles responses from Rails. A new controller instance is created by Paloma for every Rails controller/action that is executed.
-
-### Creating Controller
-
-A Controller is created or accessed (if already existing) using:
-
-```javascript
-Paloma.controller('ControllerName');
+var ArticlesController = Paloma.controller('Articles');
 ``` 
 
-It returns the constructor of your controller. It is just a normal constructor so you can do your OOP stuff.
+It will return the constructor function of your controller.
 
 
-### Creating actions
-
-Add instance methods to you Controller constructor to handle actions.
+### Handling Actions
 
+Every time a request to Paloma is made (A Rails Controller action is executed), an instance of a Paloma controller is created and a method responsible for the request will be invoked.
+ 
 ```javascript
-var ArticlesController = Paloma.controller('ArticlesController');
+var ArticlesController = Paloma.controller('Articles');
 
 ArticlesController.prototype.new = function(){
   // Handle new articles
 };
 
-
 ArticlesController.prototype.edit = function(){
   // Handle edit articles
 };
@@ -128,7 +97,7 @@ ArticlesController.prototype.edit = function(){
 
 ## Passing Parameters
 
-You can also pass parameters to Paloma by calling `js` before render in your Rails controller. You can access the parameters on your Paloma controller using `this.params` object.
+You can also pass parameters to a Paloma Controller by calling `js` **before** render in your Rails controller. You can access the parameters on your Paloma Controller using `this.params` object.
 
 **Example:**
 
@@ -145,7 +114,6 @@ end
 Paloma controller.
 
 ```javascript
-
 var UsersController = Paloma.controller('Users');
 
 UsersController.prototype.destroy = function(){
@@ -153,9 +121,9 @@ UsersController.prototype.destroy = function(){
 };
 ```
 
-## Preventing Paloma
+## Preventing Paloma Execution
 
-If you want to prevent Paloma from executing in a certain Rails controller action you can do it by passing `false` to `js` command.
+If you want to Paloma not to execute in a specific Rails Controller action you need to pass `false` as the Paloma parameter.
 
 ```ruby
 def edit
@@ -166,26 +134,59 @@ end
 
 ## Execution Chains
 
-Chains are created after a redirect action. The chain will continue to increase its length until a render action is detected.
+A Paloma request is created every time a Rails Controller action is executed. All requests will be recorded until a render action is triggered, and all Paloma requests will be processed following FIFO (First In, First Out) method.
 
 **Example:**
 
 ```ruby
 def first_action
+    # Paloma request will be created
     redirect_to second_action_path
 end
 
 def second_action
+    # Paloma request will be created
     redirect_to third_action_path
 end
 
 def third_action
+    # Paloma request will be created
     render :template => 'third_action_view'
 end
 ```
 
-A request for `first_action` will lead to 2 redirects until it reaches the `third_action` and renders a result on the browser. When the `third_action` renders its response, Paloma will process all the request starting from `first_action` up to `third_action`.
+When the `third_action` renders its response, Paloma will process all the request starting from `first_action` up to `third_action`. So, Paloma Controller actions responsible for those 3 Rails actions will be executed.
+
+## Router
+
+Router is responsible for mapping Rails Controller/action to its equivalent Paloma Controller/action.
+
+By default all Rails Controller will be mapped with a Paloma Controller with the same resource name (controller name without the `Controller` suffix).
+
+Example:
+* Requests from `UsersController#new` will be mapped to Paloma Controller named `Users` with its `new` method.
+
+If you have no problem with the default behavior, you don't need to write Router stuff in your code.
+
+### Changing Controller
+
+If you want to use a different Paloma Controller for a specific Rails Controller, you can do the following:
+
+```javascript
+// Instead of mapping Rails UsersController to Paloma Users Controller
+// it will be mapped to AdminUsers.
+Paloma.router.resource('Users', {controller: 'AdminUsers'});
+```
+
+### Redirecting
+
+You can also redirect an action if you want it to be handled by a different method.
 
+```javascript
+// Instead of executing Paloma's `Users#new` it will execute
+// `Registrations#signUp`.
+Paloma.router.redirect('Users#new', {to: 'Registrations#signUp');
+```
 
 ## Gotchas
 
@@ -196,7 +197,7 @@ For example: `render "something.js.erb"`
 
 ## Where to put code?
 
-Again, Paloma is now flexible and doesn't force developers to follow specific folder structure.
-You have the freedom to create controllers and routes anywhere in your javascript code. 
+Again, Paloma is now flexible and doesn't force developers to follow specific directory structure.
+You have the freedom to create controllers and routes anywhere in your application.
 
-Personally, I prefer having a `routes.js` file to contain all the route declaration, and a javascript file for each controller.
+Personally, I prefer having a `routes.js` file to contain all the route declarations, and a javascript file for each controller.

data/lib/paloma/action_controller_extension.rb

@@ -35,7 +35,7 @@ module Paloma
       # Keeps track of what Rails controller/action is executed.
       #
       def track_paloma_request
-        resource = controller_path.split('/').map(&:titleize).join('/')
+        resource = controller_path.split('/').map(&:classify).join('/')
 
         paloma_request = {:resource => resource,
                           :action => self.action_name}
@@ -81,6 +81,18 @@ module Paloma
       not_redirect = self.status != 302
       [nil, 'text/html'].include?(response.content_type) && not_redirect
     end
+
+
+    #
+    # Make sure not to execute paloma on the following response type
+    #
+    def render options = nil, extra_options = {}, &block
+      [:json, :js, :xml, :file].each do |format|
+        js false if options.has_key?(format)
+      end if options.is_a?(Hash)
+
+      super
+    end
   end
 
 

data/paloma.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'paloma'
-  s.version     = '3.0.0'
+  s.version     = '3.0.1'
   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']
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'jquery-rails'
 
-  s.add_development_dependency 'rails', ['>= 3.2.0']
+  s.add_development_dependency 'rails', ['~> 3.2.0']
   s.add_development_dependency 'rake', ['>= 0']
   s.add_development_dependency 'rspec', ['>= 0']
   s.add_development_dependency 'rspec-rails', ['~> 2.0']

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

@@ -80,4 +80,14 @@ var Bar = Paloma.controller('Admin/Bar');
 
 Bar.prototype.show = function(){
   window.called.push('Admin/Bar#show');
-};
+};
+
+
+
+
+
+var MultipleName = Paloma.controller('MultipleName');
+
+MultipleName.prototype.index = function(){
+  window.called.push('MultipleName#index')
+};

data/test_app/app/assets/stylesheets/multiple_names.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test_app/app/controllers/main_controller.rb

@@ -4,4 +4,24 @@ class MainController < ApplicationController
     render :inline => 'Main#index', :layout => 'application'
   end
 
+
+  def json_response
+    render :json => {:x => 1}
+  end
+
+
+  def js_response
+    render :js => 'alert(1);'
+  end
+
+
+  def xml_response
+    render :xml => '<xml></xml>'
+  end
+
+
+  def file_response
+    render :file => "#{Rails.root}/Gemfile"
+  end
+
 end

data/test_app/app/controllers/multiple_names_controller.rb

@@ -0,0 +1,7 @@
+class MultipleNamesController < ApplicationController
+
+  def index
+    render :inline => 'MultipleName#index', :layout => 'application'
+  end
+
+end

data/test_app/app/helpers/multiple_names_helper.rb

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

data/test_app/config/routes.rb

@@ -4,11 +4,21 @@ TestApp::Application.routes.draw do
 
   root :to => 'main#index'
 
-  resources :main, :controller => 'Main'
+  resources :main, :controller => 'Main' do
+    member do
+      get :json_response
+      get :js_response
+      get :xml_response
+      get :file_response
+    end
+  end
+
   resources :foo, :controller => 'Foo'
 
   namespace :admin do
     resources :bar, :controller => 'Bar'
   end
 
+
+  resources :multiple_names
 end

data/test_app/spec/integration/main_spec.rb

@@ -56,6 +56,53 @@ feature 'executing Paloma controller', :js => true do
       end
     end
 
+
+    context 'when requests from a controller with multiple name' do
+      it 'executes the corresponding Paloma action' do
+        visit multiple_names_path
+
+        called = page.evaluate_script 'window.called.pop()'
+
+        expect(called).to eq 'MultipleName#index'
+      end
+    end
+
+
+    #
+    # [TODO]
+    # Create proper test for the following:
+    #
+
+    context 'when rendering json' do
+      it 'does not execute Paloma' do
+        visit json_response_main_path 1
+        page.should_not have_selector '.js-paloma-hook'
+      end
+    end
+
+
+    context 'when rendering js' do
+      it 'does not execute Paloma' do
+        visit js_response_main_path 1
+        page.should_not have_selector '.js-paloma-hook'
+      end
+    end
+
+
+    context 'when rendering xml' do
+      it 'does not execute Paloma' do
+        visit xml_response_main_path 1
+        page.should_not have_selector '.js-paloma-hook'
+      end
+    end
+
+
+    context 'when rendering a file' do
+      it 'does not execute Paloma' do
+        visit file_response_main_path 1
+        page.should_not have_selector '.js-paloma-hook'
+      end
+    end
   end
 
-end
+end

data/vendor/assets/javascripts/paloma/engine.js

@@ -29,18 +29,22 @@
       var Controller = this.factory.get(controllerName);
 
       if (!Controller){
-        return console.warn('Paloma: undefined controller -> ' + controllerName);
+        console.warn('Paloma: undefined controller -> ' + controllerName);
+        continue;
       }
 
       var controller = new Controller(request.params);
 
       if (!controller[action]){
-        return console.warn('Paloma: undefined action <' + action +
-                            '> for <' + controllerName + '> controller');
+        console.warn('Paloma: undefined action <' + action +
+          '> for <' + controllerName + '> controller');
+        continue;
       }
 
       controller[action]();
     }
+
+    this.restart();
   };
 
 
@@ -58,4 +62,4 @@
 
   Paloma.Engine = Engine;
 
-})(window.Paloma);
+})(window.Paloma);

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: paloma
 version: !ruby/object:Gem::Version
-  version: 3.0.0
-  prerelease: 
+  version: 3.0.1
 platform: ruby
 authors:
 - Karl Paragua
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-12 00:00:00.000000000 Z
+date: 2013-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,23 +27,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -110,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: jasmine-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -148,20 +133,21 @@ files:
 - test_app/app/assets/images/rails.png
 - test_app/app/assets/javascripts/admin/bar.js
 - test_app/app/assets/javascripts/application.js
-- test_app/app/assets/javascripts/foo.js
-- test_app/app/assets/javascripts/main.js
 - test_app/app/assets/stylesheets/admin/bar.css
 - test_app/app/assets/stylesheets/application.css
 - test_app/app/assets/stylesheets/foo.css
 - test_app/app/assets/stylesheets/main.css
+- test_app/app/assets/stylesheets/multiple_names.css
 - test_app/app/controllers/admin/bar_controller.rb
 - test_app/app/controllers/application_controller.rb
 - test_app/app/controllers/foo_controller.rb
 - test_app/app/controllers/main_controller.rb
+- test_app/app/controllers/multiple_names_controller.rb
 - test_app/app/helpers/admin/bar_helper.rb
 - test_app/app/helpers/application_helper.rb
 - test_app/app/helpers/foo_helper.rb
 - test_app/app/helpers/main_helper.rb
+- test_app/app/helpers/multiple_names_helper.rb
 - test_app/app/mailers/.gitkeep
 - test_app/app/models/.gitkeep
 - test_app/app/views/layouts/application.html.erb
@@ -214,26 +200,25 @@ files:
 - vendor/assets/javascripts/paloma/router.js
 homepage: https://github.com/kbparagua/paloma
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.1.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Provides an easy way to execute page-specific javascript for Rails.
 test_files: []

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

@@ -1,2 +0,0 @@
-// Place all the behaviors and hooks related to the matching controller here.
-// All this logic will automatically be available in application.js.

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

@@ -1,2 +0,0 @@
-// Place all the behaviors and hooks related to the matching controller here.
-// All this logic will automatically be available in application.js.