paloma 2.0.6 → 3.0.0

data/TODO.md

@@ -1,13 +1 @@
-TODO
-=
-
-Features
--
-* Filters (before, after, around, global)
-* Setup for coffescript (although I hate coffescript)
-* A way to manually trigger callbacks with parameters
-
-Dev
--
-* Documentation
-* Enough comments on source code
+# TODO

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

@@ -0,0 +1,31 @@
+<% id = "#{Time.now.to_i}#{(rand * 1000).ceil}" %>
+
+<div class="js-paloma-hook" data-id="<%= id %>">
+  <script type="text/javascript">
+    (function(){
+
+      // Do not continue if Paloma not found.
+      if (window['Paloma'] === undefined && window['console'] !== undefined){
+        console.warn("Paloma not found. Require it in your application.js.");
+        return true;
+      }
+
+      // Remove any callback details if any
+      $('.js-paloma-hook[data-id!=' + <%= id %> + ']').remove();
+
+      var requests = <%= requests.to_json.html_safe %>;
+
+      for (var i = 0, len = requests.length; i < len; i++){
+        var request = requests[i];
+
+        Paloma.engine.request(request['resource'],
+                              request['action'],
+                              request['params']);
+      }
+
+
+      $(document).ready(function(){ Paloma.engine.start(); });
+
+    })();
+  </script>
+</div>

data/lib/paloma.rb

@@ -1,35 +1,11 @@
 module Paloma
-  mattr_accessor :destination, :templates
-  
   def self.root
     @paloma_root ||= "#{File.dirname(__FILE__)}/../"
   end
-  
-  
-  def self.index_js
-    @index_js ||= "#{Paloma.destination}/index.js"
-  end
-  
-  
-  def self.destination
-    @destination ||= 'app/assets/javascripts/paloma'
-  end
-  
-  
-  def self.templates
-    @templates ||= "#{Paloma.root}/app/templates"
-  end
-  
 end
 
-require 'action_controller/railtie'
-require 'rails/generators'
-
 # TODO: Rails version checking
 
-require 'paloma/generators/add_generator'
-require 'paloma/generators/setup_generator'
-require 'paloma/action_controller_filters'
+require 'action_controller/railtie'
 require 'paloma/action_controller_extension'
-require 'paloma/rails/controller_generator'
 require 'paloma/rails/engine'

data/lib/paloma/action_controller_extension.rb

@@ -1,51 +1,85 @@
 module Paloma
 
-  # TODO explain!
-  module ::ActionController::Flash
-    alias_method :original_redirect_to, :redirect_to
-  end
 
+  module ActionControllerExtension
 
+    def self.included base
+      base.send :include, InstanceMethods
 
-  module ActionControllerExtension
-    def redirect_js_hook options = {}, response_status_and_flash = {}
-      add_to_callbacks @__paloma_callback__
-      original_redirect_to options, response_status_and_flash
+      base.module_eval do
+        prepend_view_path "#{Paloma.root}/app/views/"
+
+        before_filter :track_paloma_request
+        after_filter :append_paloma_hook, :if => :html_is_rendered?
+      end
     end
-    alias_method :redirect_to, :redirect_js_hook
-
-
-    #
-    # js false
-    # js :new, :params => {}
-    # js :controller => '', :action => '', :params => {}
-    # js :params => {}
-    #
-    def js options = {}, extras = {}
-      callback = {:controller => controller_path, :action => action_name}
-      params = {}
-
-      if options.is_a? Hash
-        params = options[:params]
-        callback = options[:controller].present? && options[:action].present? ?
-          {:controller => options[:controller], :action => options[:action]} :
-          callback
-
-      elsif options.is_a? Symbol
-        params = extras[:params]
-        callback[:action] = options
-
-      elsif options.is_a? FalseClass
-        callback = nil
+
+
+
+
+
+    module InstanceMethods
+
+      #
+      # Use on controllers to pass variables to Paloma controller.
+      #
+      def js params = {}
+        return session[:paloma_requests].pop if !params
+        session[:paloma_requests].last[:params] = params
+      end
+
+
+      #
+      # Executed every time a controller action is executed.
+      #
+      # Keeps track of what Rails controller/action is executed.
+      #
+      def track_paloma_request
+        resource = controller_path.split('/').map(&:titleize).join('/')
+
+        paloma_request = {:resource => resource,
+                          :action => self.action_name}
+
+        session[:paloma_requests] ||= []
+        session[:paloma_requests].push paloma_request
       end
 
-      params ||= {}
 
-      # Include request details
-      params[:controller_path] = controller_path
-      params[:action] = action_name
+      #
+      # Before rendering html reponses,
+      # this is exectued to append Paloma's html hook to the response.
+      #
+      # The html hook contains the javascript code that
+      # will execute the tracked Paloma requests.
+      #
+      def append_paloma_hook
+        return true if session[:paloma_requests].empty?
+
+        hook = view_context.render(
+                  :partial => 'paloma/hook',
+                  :locals => {:requests => session[:paloma_requests]})
+
+        before_body_end_index = response_body[0].rindex('</body>')
+
+        # Append the hook after the body tag if it is present.
+        if before_body_end_index.present?
+          before_body = response_body[0][0, before_body_end_index].html_safe
+          after_body = response_body[0][before_body_end_index..-1].html_safe
+
+          response.body = before_body + hook + after_body
+        else
+          # If body tag is not present, append hook in the response body
+          response.body += hook
+        end
+
+        session[:paloma_requests] = nil
+      end
+    end
+
 
-      @__paloma_callback__ = callback.present? ? callback.merge({:params => params}) : nil
+    def html_is_rendered?
+      not_redirect = self.status != 302
+      [nil, 'text/html'].include?(response.content_type) && not_redirect
     end
   end
 

data/paloma.gemspec

@@ -1,19 +1,19 @@
 Gem::Specification.new do |s|
   s.name        = 'paloma'
-  s.version     = '2.0.6'
+  s.version     = '3.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", "Bia Esmero"]
+  s.authors     = ['Karl Paragua']
   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 'rails', ['>= 3.2.0']
   s.add_development_dependency 'rake', ['>= 0']
   s.add_development_dependency 'rspec', ['>= 0']
   s.add_development_dependency 'rspec-rails', ['~> 2.0']
-  s.add_development_dependency 'generator_spec', ['~> 0.8.7']
-  s.add_development_dependency 'capybara', ['>= 1.0']
+  s.add_development_dependency 'capybara', ['~> 1.0']
+  s.add_development_dependency 'jasmine-rails', ['~> 0.4.5']
 end

data/{spec/test_app → test_app}/Gemfile

@@ -1,5 +1,4 @@
 source 'https://rubygems.org'
 
 gem 'selenium-webdriver'
-
-gemspec :path => '../../'
+gemspec :path => '../'

data/{spec/test_app → test_app}/Rakefile

@@ -3,14 +3,9 @@
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
 require File.expand_path('../config/application', __FILE__)
-require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new('spec:generators') do |spec|
-  spec.pattern = FileList['spec/generators/*_spec.rb']
-end
-
-RSpec::Core::RakeTask.new('spec:javascripts') do |spec|
-  spec.pattern = FileList['spec/javascripts/*_spec.rb']
+if ['development', 'test'].include?(Rails.env)
+  require 'rspec/core/rake_task'
 end
 
 TestApp::Application.load_tasks

data/test_app/app/assets/javascripts/admin/bar.js

@@ -0,0 +1,2 @@
+// 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/application.js

@@ -0,0 +1,83 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require paloma
+//= 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 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');
+};

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

@@ -0,0 +1,2 @@
+// 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

@@ -0,0 +1,2 @@
+// 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/stylesheets/admin/bar.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/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test_app/app/assets/stylesheets/foo.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/assets/stylesheets/main.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/admin/bar_controller.rb

@@ -0,0 +1,7 @@
+class Admin::BarController < ApplicationController
+
+  def show
+    render :inline => 'Admin/Bar#show', :layout => 'application'
+  end
+
+end

data/test_app/app/controllers/foo_controller.rb

@@ -0,0 +1,19 @@
+class FooController < ApplicationController
+
+  def index
+    redirect_to main_index_path
+  end
+
+
+  def show
+    js :parameter => 'Parameter From Paloma'
+    render :inline => '<h1>Foo#show</h1>', :layout => 'application'
+  end
+
+
+  def edit
+    js false
+    render :inline => 'Foo#edit', :layout => 'application'
+  end
+
+end

data/test_app/app/controllers/main_controller.rb

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

data/test_app/app/helpers/admin/bar_helper.rb

@@ -0,0 +1,2 @@
+module Admin::BarHelper
+end

data/test_app/app/helpers/application_helper.rb

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