paloma 0.0.1 → 0.0.2

data/app/views/paloma/_callback_hook.html.erb

@@ -0,0 +1,33 @@
+<% callback_details_id = "#{Time.now.to_i}#{(rand * 1000).ceil}" %>
+
+<div class="callback-details" id="callback-details-<%= callback_details_id %>">
+  <script type="text/javascript">
+    var id = "callback-details-<%= callback_details_id %>",
+      callbacks = [];
+      
+    // Remove any callback details if any 
+    $('.callback-details[id!=" + id + "]').remove(); 
+    
+    
+    // Convert callbacks to javascript variable      
+    <% callbacks.each do |callback| %>
+      callbacks.push({
+        name: '<%= callback[:name] %>', 
+        params: eval($('<div/>').html("(<%= callback[:params].to_json %>)").text())
+      }); 
+    <% end %>
+    
+    
+    // Run Callbacks
+    for (var i = 0, len = callbacks.length; i < len; i++){
+      var callback = callbacks[i],
+        callbackFunction = Paloma.callbacks[callback.name];
+      
+      console.log("Paloma: Fetching [" + callback.name + "]");      
+      if (callback != undefined){
+        console.log("Paloma: Calling [" + callback.name + "]");
+        callbackFunction(callback.params);
+      }
+    }
+  </script>
+</div>

data/lib/paloma.rb

@@ -0,0 +1,14 @@
+module Paloma
+  def self.root
+    @paloma_root ||= File.dirname(__FILE__) + '/../'
+  end
+end
+
+require 'action_controller/railtie'
+require 'rails/generators'
+
+# TODO: Rails version checking
+
+require 'paloma/paloma_generator'
+require 'paloma/action_controller_filters'
+require 'paloma/action_controller_extension'

data/lib/paloma/action_controller_extension.rb

@@ -0,0 +1,52 @@
+module Paloma
+
+  # TODO explain!
+  module ::ActionController::Redirecting
+    alias_method :original_redirect_to, :redirect_to
+  end
+
+  
+
+  module ActionControllerExtension
+    def redirect_js_hook options = {}, response_status = {}
+      add_to_callbacks @__callback__, @__js_params__
+      original_redirect_to options, response_status
+    end      
+    alias_method :redirect_to, :redirect_js_hook
+    
+    
+    #
+    # js_callback false
+    # js_callback :new, :params => {}
+    # js_callback :controller => '', :action => '', :params => {}
+    # js_callback :params => {}
+    #
+    def js_callback options = {}, extras = {}
+      default_callback = "#{controller_name}/#{action_name}"
+      params = {}
+      
+      if options.is_a? Hash
+        params = options[:params]
+        callback = options[:controller].present? && options[:action].present? ? 
+          "#{options[:controller]}/#{options[:action]}" :
+          default_callback
+
+      elsif options.is_a? Symbol
+        params = extras[:params] 
+        callback = "#{controller_name}/#{options}"
+      
+      elsif options.nil? || options.is_a?(TrueClass)
+        callback = default_callback
+      
+      else # false
+        callback = nil
+      end
+      
+      @__callback__ = callback
+      @__js_params__ = params
+    end 
+  end
+  
+
+  ::ActionController::Base.send :include, ActionControllerExtension
+end

data/lib/paloma/action_controller_filters.rb

@@ -0,0 +1,53 @@
+module Paloma
+  module ActionControllerFilters
+    
+    def self.included base
+      base.module_eval do
+        prepend_view_path "#{Paloma.root}/app/views/"
+        before_filter :js_callback
+        after_filter :update_callback, :if => :html_response_from_render?
+      end
+    end
+
+    
+  protected
+    
+    def html_response_from_render?
+      [nil, 'text/html'].include?(response.content_type) && self.status != 302 
+    end
+
+        
+    def update_callback
+      add_to_callbacks @__callback__, @__js_params__
+
+      response_body[0] += view_context.render(
+        :partial => "paloma/callback_hook",
+        :locals => {:callbacks => session[:callbacks]})
+      
+      response.body = response_body[0]
+      clear_callbacks
+    end
+    
+    
+    def add_to_callbacks name, params
+      return true if name.nil?
+      session[:callbacks] ||= []
+      session[:callbacks].push({:name => name, :params => params})
+    end
+    
+    
+    def get_callbacks
+      session[:callbacks]
+    end
+    
+    
+    def clear_callbacks
+      session[:callbacks] = []
+    end
+  
+  end
+  
+  ::ActionController::Base.send :include, ActionControllerFilters
+end
+
+

data/lib/paloma/paloma_generator.rb

@@ -0,0 +1,94 @@
+module Paloma
+  #
+  # Setup:
+  #   rails g paloma:setup
+  #     - Generates the following:
+  #         - 'paloma' folder under app/assets/javascripts/paloma
+  #         - index.js and paloma.js under the 'paloma' folder
+  #
+  #
+  # Usage: 
+  #   rails g paloma:add <controller_name>
+  #     - Generates the following:
+  #         - a folder under app/assets/javascripts/paloma named as <controller_name>
+  #         - callbacks.js inside the folder just made
+  #     - Updates index.js under the 'paloma' folder
+  #         - adds a line in order to require the callbacks to be made under the recently made folder
+  #
+  #
+  #   rails g paloma:add <controller_name>/<action_name>
+  #     - Generates the following:
+  #         - <action_name>.js file inside the <controller_name> folder
+  #
+  #
+  # Generated Files:
+  #  index.js
+  #    - contains code for requiring all callbacks of all folders
+  #    - always updated when new folders and callback.js files are created
+  #
+  #  paloma.js
+  #    - declaration of namespace used in all callbacks
+  #
+  #  <controller_name>/callbacks.js
+  #    - contains code for requiring all callbacks under the same folder <controller_name> 
+  #
+  #  <controller_name>/<action_name>.js
+  #    - actual code to be executed when callback is called
+  #
+    
+  PARENT  = 'app/assets/javascripts/paloma/'
+  INDEX = PARENT + 'index.js'
+  PALOMA = PARENT + 'paloma.js'
+  
+  class SetupGenerator < ::Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    
+    def setup_paloma
+      #index.js on callbacks folder
+      has_index = File.exists? INDEX
+      copy_file 'index.js', INDEX unless has_index  
+      
+      has_paloma = File.exists? PALOMA
+      copy_file 'paloma.js', PALOMA unless has_paloma
+    end
+    
+  end
+  
+  
+  class AddGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+    
+    def create_callback_file
+      file = file_path.split('/')
+      controller = file[0]
+      action = file[1]
+      
+      callbacks = PARENT + "#{controller}/_callbacks.js"
+      templates = "#{Paloma.root}/lib/paloma/templates/"
+      local = PARENT + "#{controller}/_local.js"
+      action_file = PARENT + "#{controller}/#{action}.js"
+      
+      #_callbacks.js per folder(controller)
+      has_callbacks = File.exists? callbacks
+      unless has_callbacks
+        content = File.read(templates + '_callbacks.js').gsub('controller', "#{controller}")
+        File.open(callbacks, 'w'){ |f| f.write(content) }
+        File.open(INDEX, 'a+'){|f| f << "\n//= require ./" + controller + '/_callbacks' }
+      end
+      
+      #_local.js per folder(controller)
+      has_local =File.exists? local
+      unless has_local
+        content = File.read(templates + '_local.js').gsub('controller', "#{controller}")
+        File.open(local, 'w'){ |f| f.write(content) }
+      end
+      
+      #<action>.js on folder(controller) - code for callback
+      has_action = File.exists? action_file
+      unless (action.nil? || has_action)
+        content = File.read(templates + 'action.js').gsub('controller/action', "#{controller}/#{action}")
+        File.open(action_file, 'w'){ |f| f.write(content) }
+      end
+    end    
+  end
+end

data/lib/paloma/templates/_callbacks.js

@@ -0,0 +1,2 @@
+//= require ./controller/_local
+//= require_tree .

data/lib/paloma/templates/_local.js

@@ -0,0 +1,20 @@
+Paloma.controller = {
+
+  /*
+    Put here code which can be used by all callbacks
+      under the controller folder.
+    
+    Example:
+      
+      variableName: value;
+    
+      functionName: function(params){
+        alert('Paloma');
+      };
+      
+    To use the variable and function:
+      Paloma.controller.variableName
+      Paloma.controller.functionName(params);
+  */
+  
+};

data/lib/paloma/templates/action.js

@@ -0,0 +1,5 @@
+Paloma.callbacks['controller/action'] = function(params){
+
+  // alert('Paloma');
+
+};

data/lib/paloma/templates/index.js

@@ -0,0 +1 @@
+//= require ./paloma

data/lib/paloma/templates/paloma.js

@@ -0,0 +1,22 @@
+window.Paloma = {callbacks:{}};
+
+Paloma.g = {
+
+  /*
+    Put here global code that can be used by all callbacks, 
+      regardless which folder they're from.
+    
+    Example:
+      
+      variableName: value;
+    
+      functionName: function(params){
+        alert('Paloma');
+      };
+   
+    To use the variable and function: 
+      Paloma.g.variableName
+      Paloma.g.functionName(params);
+  */
+
+};

data/paloma.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name        = 'paloma'
+  s.version     = '0.0.2'
+  s.date        = '2012-12-17'
+  s.summary     = "Javascript Callback Manager for Rails"
+  s.description = "Javascript Callback Manager for Rails"
+  s.authors     = ["Karl Paragua", "Bia Esmero"]
+  s.email       = 'kb.paragua@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'https://github.com/kbparagua/paloma'
+  
+  s.add_dependency 'jquery-rails'
+  
+  s.add_development_dependency 'rails', ['>= 3.1.0']
+  s.add_development_dependency 'bundler', ['>= 1.0.0']
+  s.add_development_dependency 'rake', ['>= 0']
+  s.add_development_dependency 'sqlite3', ['>= 0']
+  s.add_development_dependency 'rspec', ['>= 0']
+  s.add_development_dependency 'rspec-rails', ['~> 2.0']
+  s.add_development_dependency 'capybara', ['>= 1.0']
+  s.add_development_dependency 'database_cleaner', ['>= 0']
+  s.add_development_dependency 'launchy', ['>= 0']
+end

data/spec/callback_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+feature 'Callbacks' do
+  
+  it 'should execute articles/new callback', :js => true do
+    visit new_article_path  
+    page.has_selector?('#from-articles-new-callback').should == true
+  end
+
+
+  it 'should execute callbacks for articles/create and articles/show', :js => true do
+    visit new_article_path
+    
+    fill_in 'article[title]', :with => 'sexy paloma'
+    fill_in 'article[body]', :with => 'sexy paloma body'
+    click_button 'Save'
+    
+    page.has_selector?('#from-articles-create-callback').should == true
+    page.has_selector?('#from-articles-show-callback').should == true
+  end
+
+
+  it 'should execute "new" callback instead of "create" after failed save', :js => true do
+    visit new_article_path
+    
+    fill_in 'article[body]', :with => 'sexy paloma body'
+    click_button 'Save'
+  
+    page.has_selector?('#from-articles-create-callback').should == false
+    page.has_selector?('#from-articles-new-callback').should == true
+  end
+  
+  
+  it 'should have an access on the passed parameters on js_callback', :js => true do
+    1.upto(30) do |i|
+      Article.create :title => "Sexy Paloma #{i}", :body => "Sexy Body"
+    end
+    
+    visit articles_path
+    page.has_selector?('#article-count-30').should == true
+  end
+  
+  
+  it 'should not execute articles/update callback', :js => true do
+    article = Article.create :title => "Sexy Paloma Baby!", :body => "OMG"
+    
+    visit edit_article_path(article)
+    fill_in 'article[body]', :with => 'Updated Body'
+    click_button 'Save'
+
+    page.has_selector?('#from-articles-update-callback').should == false
+    page.has_selector?('#from-articles-show-callback').should == true
+  end
+  
+  
+  it 'should execute articles/edit callback after failed update', :js => true do
+    article = Article.create :title => 'Sexy Paloma Baby!', :body => 'Yeah'
+    
+    visit edit_article_path(article)
+    fill_in 'article[title]', :with => ''
+    click_button 'Save'
+    
+    page.has_selector?('#from-articles-edit-callback').should == true
+  end
+end

data/spec/sample_app/app/assets/javascripts/application.js

@@ -0,0 +1,4 @@
+//
+//= require jquery.js
+//= require jquery_ujs.js
+//= require paloma

data/spec/sample_app/app/assets/javascripts/paloma/articles/callbacks.js

@@ -0,0 +1 @@
+//= require_tree .

data/spec/sample_app/app/assets/javascripts/paloma/articles/create.js

@@ -0,0 +1,3 @@
+Paloma.callbacks['articles/create'] = function(params){
+  $('body').append($("<div id='from-articles-create-callback'></div>"));
+};

data/spec/sample_app/app/assets/javascripts/paloma/articles/edit.js

@@ -0,0 +1,3 @@
+Paloma.callbacks['articles/edit'] = function(params){
+  $('body').append($("<div id='from-articles-edit-callback'></div>"));
+};

data/spec/sample_app/app/assets/javascripts/paloma/articles/index.js

@@ -0,0 +1,3 @@
+Paloma.callbacks['articles/index'] = function(params){
+  $('body').append($("<div id='article-count-" + params['article_count'] + "'></div>"));
+};

data/spec/sample_app/app/assets/javascripts/paloma/articles/new.js

@@ -0,0 +1,3 @@
+Paloma.callbacks['articles/new'] = function(params){
+  $('body').append($("<div id='from-articles-new-callback'></div>"));
+};

data/spec/sample_app/app/assets/javascripts/paloma/articles/show.js

@@ -0,0 +1,3 @@
+Paloma.callbacks['articles/show'] = function(params){
+  $('body').append($("<div id='from-articles-show-callback'></div>"));
+};

data/spec/sample_app/app/assets/javascripts/paloma/articles/update.js

@@ -0,0 +1,3 @@
+Paloma.callbacks['articles/update'] = function(params){
+  $('body').append($("<div id='from-articles-update-callback'></div>"));
+};