paloma 0.0.1 → 0.0.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+*.gem
+/spec/sample_app/log
+**.orig
+rerun.txt
+pickle-email-*.html

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,148 @@
+PATH
+  remote: .
+  specs:
+    paloma (0.0.2)
+      jquery-rails
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.9)
+      actionpack (= 3.2.9)
+      mail (~> 2.4.4)
+    actionpack (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.9)
+      activesupport (= 3.2.9)
+      builder (~> 3.0.0)
+    activerecord (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.3.2)
+    arel (3.0.2)
+    builder (3.0.4)
+    capybara (2.0.1)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 1.0.0)
+    childprocess (0.3.6)
+      ffi (~> 1.0, >= 1.0.6)
+    database_cleaner (0.9.1)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    ffi (1.2.0)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    jquery-rails (2.1.4)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.7.5)
+    launchy (2.1.2)
+      addressable (~> 2.3)
+    libwebsocket (0.1.7.1)
+      addressable
+      websocket
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.5.0)
+    nokogiri (1.5.5)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.9)
+      actionmailer (= 3.2.9)
+      actionpack (= 3.2.9)
+      activerecord (= 3.2.9)
+      activeresource (= 3.2.9)
+      activesupport (= 3.2.9)
+      bundler (~> 1.0)
+      railties (= 3.2.9)
+    railties (3.2.9)
+      actionpack (= 3.2.9)
+      activesupport (= 3.2.9)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    rspec-rails (2.12.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.27.2)
+      childprocess (>= 0.2.5)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
+      rubyzip
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.35)
+    websocket (1.0.4)
+    xpath (1.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  capybara (>= 1.0)
+  database_cleaner
+  launchy
+  paloma!
+  rails (>= 3.1.0)
+  rake
+  rspec
+  rspec-rails (~> 2.0)
+  sqlite3

data/License

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2012-2013 Karl Paragua, Bia Esmero
+
+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,240 @@
+Paloma
+======
+Paloma provides a sexy way to organize javascript files using Rails' asset pipeline. 
+It adds the capability to execute specific javascript code after rendering the controller's response.
+
+Advantages
+-
+* Javascript files are organized per controller just like app/views folder of Rails.
+* Javascript file per controller's action.
+* The ability to choose what specific javascript code to run on a specific action.
+
+Quick Example
+-
+The javascript callback file `paloma/users/new.js`:
+
+```javascript
+Paloma.callbacks['users/new'] = function(params){
+    // This will only run after executing users/new action
+    alert('Hello New Sexy User');
+};
+```
+ 
+The Rails controller `app/controllers/users_controller.rb`:
+
+```ruby
+def UsersController < ApplicationController
+    def new
+        @user = User.new
+        # No special function to call, the javascript callback will be executed automatically
+    end
+end
+```
+
+That's it! Simply Sexy!
+
+Minimum Requirements
+-
+* jQuery 1.7 or higher
+* Rails 3.1 or higher
+
+
+Install
+-
+Without bundler:
+```
+sudo gem install paloma
+```
+
+With bundler, add this to your Gemfile:
+```
+gem paloma
+```
+
+Setup
+-
+On setup, the `paloma` folder will be generated in `app/assets/javascripts/` containing its required files. Run:
+``` 
+rails g paloma:setup
+```
+
+Directory Structure
+-
+`paloma` folder contains the javascript callbacks.
+
+* paloma
+    * [controllers]
+        * [action].js
+        * [other_action].js
+    * [other_controllers]
+        * [action].js
+        * [other_action].js
+        * [more_action].js
+     
+Generators
+-
+1. Generate a controller folder containing its required files:   
+```
+rails g paloma:add [controllers]
+```
+    **Example:**
+    ```
+    rails g paloma:add users
+    ```
+
+    **Generates:**
+    * /paloma
+        * /users
+
+
+2. Generate a callback file for a controller's action:
+```
+rails g paloma:add [controllers]/[action]
+```
+    **Example:**
+    ```
+    rails g paloma:add users/new
+    ```
+
+    **Generates:**
+    * /paloma
+        * /users
+            * new.js
+
+
+**Note:** You can directly run `rails g paloma:add [controllers]/[action]` even the controller folder is not yet 
+existing on `paloma` folder. It will be created automatically.
+
+
+Advanced Callbacks
+-
+By default Paloma will execute the callback that matches the response's current controller and action if it finds one.
+For instance if the current response is from the `new` action of the `Users` controller, then Paloma will execute the callback
+named `users/new`.
+
+You can manipulate callback behavior by using the `js_callback` command before the `render` or `redirect_to` command in your controllers.
+
+1. Preventing the Callback to execute.
+
+    ```ruby
+    def destroy
+        user = User.find params[:id]
+        user.destroy
+        
+        js_callback false
+    end
+    ```
+    
+    `[controllers]/destroy` callback will not be executed.
+
+2. Using other action's callback from the same controller.
+
+    ```ruby
+    def edit
+        @user = User.find params[:id]
+        js_callback :new
+    end
+    ```
+
+    This will execute `[controller]/new` callback instead of `[controller]/edit`.
+    
+3. Using other action's callback from other controller.
+
+    ```ruby
+    def index
+        @users = User.all
+        js_callback :controller => 'clients', :action => 'index'
+    end
+    ```
+
+    This will execute `clients/index` callback instead of `[controller]/index`.
+
+Passing Parameters
+-
+You can also pass parameters to the callback by passing a `:params` key to `js_callback`. The passed parameters
+will be available on the callback by the `params` object.
+
+**Example:**
+
+`users_controller.rb`
+```ruby
+def destroy
+    user = User.find params[:id]
+    user.destroy
+    
+    js_callback :params => {:user_id => params[:id]}
+end
+```
+
+`/paloma/users/destroy.js`
+```javascript
+Paloma.callbacks['users/destroy'] = function(params){
+    var id = params['user_id'];
+    alert('User ' + id + ' deleted.');
+};
+```
+
+Callback Helpers
+-
+Callback helpers are inside Paloma objects in order to prevent conflicts from different functions and variables.
+
+1. Global
+
+    Helper functions and variables can defined in `paloma/paloma.js` inside the `Paloma.g` object.
+    
+    **Example:**
+    ```javascript
+    Paloma.g = {
+        helper: function(){
+            // do something sexy
+        },
+        
+        helper_variable: 1000
+    };
+    ```
+    
+2. Controller's Scope
+
+    Helper functions that you will only use for a certain controller can be defined in `paloma/[controllers]/_local.js` inside
+    the `Paloma.[controllers]` object.
+    
+    **Example:**
+    ```javascript
+    Paloma.users = {
+        local_helper: function(){
+            // do something sexy
+        },
+        
+        helper_variable: 1
+    };
+    ```
+    
+Callback Chains
+-
+Callback chains are created after a redirect action. The chain will continue to increase its length until a render action is detected.
+
+**Example:**
+
+```ruby
+def first_action
+    redirect_to second_action_path
+end
+
+def second_action
+    redirect_to third_action_path
+end
+
+def third_action
+    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 execute the callbacks for all the 3 actions.
+
+The order of execution will be `[controller]/first_action` first, then `[controller]/second_action`, and finally `[controller]/third_action`.
+
+
+Gotchas
+-
+* Callbacks will not be executed if the response is `js`, `json`, `xml` or any other format except `html`.
+This will not work: `render "something.js.erb"`

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/*_spec.rb']
+end
+
+
+desc "Run tests"
+task :test do
+  puts "Testing..."
+  sh "bundle exec rake spec"
+end