paloma 4.1.2 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb171dd2c32755bd619029e3e93a859f8888f666
-  data.tar.gz: 9184bb4268f33cdc3f8581426f3a48e7a6acd95d
+  metadata.gz: b10b31f63c970076c4afe47277ce5f90a3c6fccd
+  data.tar.gz: 0f63a749171a49ed7b88c4bedc9f66b559a5bdf7
 SHA512:
-  metadata.gz: 8c5d9ae6c6f97388e55d0f625733f2b145c4653612e6ee09eb8c2ce5760531c8ad212457f4c942320706ab9e3c27dbdd45bf370d728844c3e6249a6685713d48
-  data.tar.gz: be6d27412b201fcecd6af8ca6ab8d18eb5889524aff9f7402d30571c715726f61030a83efd1ffd49a3d93a171ba78d72d4734bf1a23f5f4bb027815edd9d553b
+  metadata.gz: df5a36190acab372138dab88ed9e41a864c8f05e460a5be02e905f06f675d89b4b303ba3ca28ee9ddf4738f8937ad8286f855312cb2338e8a4f287db17eef786
+  data.tar.gz: cfc151c6dbc4afc174dd6e5b4288476094bbb762a311c24744a008868c447a51d6e11a653058a5105862b3a7d76522ade0eb7e05399092955edd473da27e5a2c

data/.gitignore

@@ -1,6 +1,5 @@
 Gemfile.lock
 *.gem
 /tmp/*
-/spec/tmp/
-/spec/test_app/tmp
-/spec/test_app/spec/tmp/*
+/test_app/tmp/*
+/test_app/spec/tmp/*

data/Changelog.md

@@ -1,3 +1,6 @@
+## 4.2.0
+* https://github.com/kbparagua/paloma/pull/75 - Explicitly insert hook in view.
+
 ## 4.1.2
 * https://github.com/kbparagua/paloma/issues/73 - Fix `js false` issue.
 

data/DEVELOPMENT.md

@@ -4,9 +4,10 @@
 
 1. Go to `test_app`
 1. Comment out `turbolinks.js` on `applciation.js`
-1. Run `rake spec:javascript`.
-1. Run `rake spec:units`.
-1. Run `rake spec:integration`.
+1. Run `bundle exec rails s`.
+1. Open your browser and visit [http://localhost:3000/specs](http://localhost:3000/specs).
+1. Run `bundle exec rake spec:units`.
+1. Run `bundle exec rake spec:integration`.
 
 ## TODO
 

data/README.md

@@ -1,35 +1,16 @@
-# Paloma
-
-**This README is for Paloma 4 only.**
-
-**For version 3 README please go [here](https://github.com/kbparagua/paloma/blob/3.0/README.md).**
-
-**For version 2 README please go [here](https://github.com/kbparagua/paloma/blob/2.0/README.md).**
-
-
-## Paloma 4, why so sudden?
-The last major version (v3) of Paloma introduced a major paradigm shift, and it took me a while to realize that some of the major changes introduced are not really that good and needed to be removed.
-
-
-## What's new?
-*(compared to version 2)*
-It is now simpler and more flexible. The old callback thingy paradigm is replaced by a `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!
+**Important**
+- `master` branch contains the bleeding edge development code.
+- check `branches` or `tags` for the latest stable release or specific versions.
 
-### Controller
-The new paradigm is patterned after Rails Controller, so it is easier to grasp than the old callback paradigm. Basically, you have a Paloma Controller counterpart for every Rails Controller.
-
-
-### How about Model and View?
-
-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.
+# Paloma
 
+Page-specific javascript for Rails done right.
 
 ## Advantages
 * Choose what specific javascript code to run per page.
 * Easily make ruby variables available on your javascript files.
-
+* Can be written using vanilla javascript, coffeescript, and anything that compiles to js.
+* Easy to understand (*because it is patterned after Rails' controller module*).
 
 ## Quick Example
 
@@ -64,10 +45,23 @@ That's it! Simply Sexy!
 
 ## Install
 
-* Without bundler: `sudo gem install paloma`.
-* With bundler, add this to your Gemfile: `gem 'paloma'`
-* Require `paloma` in your `application.js`: `//= require paloma`
+1. Without bundler: `sudo gem install paloma`.
+1. With bundler, add this to your Gemfile: `gem 'paloma'`
+1. Require `paloma` in your `application.js`: `//= require paloma`
+1. In your layouts insert Paloma hook.
 
+   `application.html.erb`
+   ```html
+   <html>
+      <head>
+      </head>
+      
+      <body>
+         <%= yield %>
+         <%= insert_paloma_hook %>
+      </body>
+   </html>
+   ```
 
 ## Controllers
 
@@ -276,6 +270,28 @@ class UsersController < ApplicationController
 end
 ```
 
+## Hook
+
+`insert_paloma_hook` is a helper method that you can use in your views to insert Paloma's HTML hook.
+Inside this HTML hook is where the magic happens. This is the reason why Paloma can magically know what Javascript controller/action to execute. To further understand how Paloma works, you can inspect the HTML hook, by checking the generated HTML (*inspect element*) and locate the `div` element that has the class `js-paloma-hook`.
+
+Ideally, you just need to call `insert_paloma_hook` in your layouts, since the layout will always be included in every rendered view. But if you are rendering a view without a layout, make sure to call `insert_paloma_hook` in that view.
+
+
+## AJAX
+
+1. Make sure that the AJAX response contains the html hook. (use `insert_paloma_hook`)
+2. Execute the hook and start Paloma's engine on complete/success.
+
+   ```js
+   $.get('http://example.com', function(response){
+      $('#result').html(response);
+      
+      // Execute Paloma hook and start the engine.
+      Paloma.executeHook();
+      Palama.engine.start();
+   });
+   ```
 
 ## Turbolinks Support
 
@@ -308,14 +324,7 @@ $(document).on('page:load', function(){
 
 ## Gotchas
 
-* Paloma  will execute on all `render` calls, except for calls with the following formats: `js`, `json`, `xml`, and `file`.
-
-   Example:
-   
-   ```ruby
-   render :json => {:x => 1}  # Paloma will not execute`
-   render :partial => '/path/to/partial'  # Paloma will execute
-   ```
+* Make sure that the rendered view has the paloma hook (*use `insert_paloma_hook`*) for Paloma to execute. 
 
 * It will cause conflicts if you have a controller and a module that has the same name.
 
@@ -334,3 +343,11 @@ Again, Paloma is now flexible and doesn't force developers to follow specific di
 You have the freedom to create controllers anywhere in your application.
 
 Personally, I prefer having a javascript file for each controller.
+
+
+## Contribute
+
+1. Fork.
+2. Do awesome things.
+3. Submit Pull-Request to `master` branch.
+4. Add short summary of changes on your PR.

data/lib/paloma/action_controller_extension.rb

@@ -12,7 +12,7 @@ module Paloma
         prepend_view_path "#{Paloma.root}/app/views/"
 
         before_filter :track_paloma_request
-        after_filter :append_paloma_hook, :if => :not_redirect?
+        helper_method :insert_paloma_hook
       end
     end
 
@@ -107,61 +107,26 @@ module Paloma
 
 
       #
-      # Before rendering html reponses,
-      # this is exectued to append Paloma's html hook to the response.
+      # Call in your view to insert Paloma's html hook.
       #
       # The html hook contains the javascript code that
       # will execute the tracked Paloma requests.
       #
-      def append_paloma_hook
+      def insert_paloma_hook
         return true if self.paloma.has_no_request?
-       
-        # Render the partial if it is present, otherwise do nothing. 
-        begin
-          hook = view_context.render(
-                   :partial => 'paloma/hook',
-                   :locals => {:request => self.paloma.request})
-        rescue ActionView::MissingTemplate
-          return true
-        end
-
-        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
+        hook = view_context.render(
+                 :partial => 'paloma/hook',
+                 :locals => {:request => self.paloma.request})
 
         self.paloma.clear_request
+        hook
       end
     end
 
 
-    def not_redirect?
-      self.status != 302
-    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|
-        if options.has_key?(format)
-          self.paloma.clear_request
-          break
-        end
-      end if options.is_a?(Hash)
-
-      super
-    end
-
 
   protected
 

data/paloma.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'paloma'
-  s.version     = '4.1.2'
+  s.version     = '4.2.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

@@ -52,3 +52,16 @@ Foos.prototype.otherAction = function(){};
 var NotFoos = Paloma.controller('NotAdmin/Foos');
 NotFoos.prototype.show = function(){};
 NotFoos.prototype.otherAction = function(){};
+
+
+$(document).ready(function(){
+  $('#js-ajax-link').on('click', function(e){
+    e.preventDefault();
+
+    $.get($(this).prop('href'), function(response){
+      $('#js-ajax-response').html(response);
+      Paloma.executeHook();
+      Paloma.engine.start();
+    });
+  });
+});

data/test_app/app/controllers/main_controller.rb

@@ -40,6 +40,11 @@ class MainController < ApplicationController
   end
 
 
+  def ajax
+    render :ajax, :layout => false
+  end
+
+
 
 
 
@@ -63,7 +68,7 @@ class MainController < ApplicationController
 
 
   def file_response
-    render :file => "#{Rails.root}/Gemfile"
+    render :file => "#{Rails.root}/Gemfile", :layout => false
   end
 
 end

data/test_app/app/views/layouts/application.html.erb

@@ -19,12 +19,17 @@
     <li><%= link_to 'Main#basic_params', basic_params_main_index_path %></li>
     <li><%= link_to 'Main#xml_response', xml_response_main_index_path %></li>
     <li><%= link_to 'Main#file_response', file_response_main_index_path %></li>
+    <li><%= link_to 'Main#ajax', ajax_main_index_path, :id => 'js-ajax-link' %></li>
   </ul>
 </div>
 
 <hr/>
 
+<div id='js-ajax-response'>
+</div>
+
 <%= yield %>
+<%= insert_paloma_hook %>
 
 </body>
 </html>

data/test_app/app/views/main/ajax.html.erb

@@ -0,0 +1,2 @@
+<h1>Main#AJAX</h1>
+<%= insert_paloma_hook %>

data/test_app/config/routes.rb

@@ -12,6 +12,7 @@ TestApp::Application.routes.draw do
       get :js_response
       get :xml_response
       get :file_response
+      get :ajax
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paloma
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.2.0
 platform: ruby
 authors:
 - Karl Paragua
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-24 00:00:00.000000000 Z
+date: 2015-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jquery-rails
@@ -180,6 +180,7 @@ files:
 - test_app/app/mailers/.gitkeep
 - test_app/app/models/.gitkeep
 - test_app/app/views/layouts/application.html.erb
+- test_app/app/views/main/ajax.html.erb
 - test_app/config.ru
 - test_app/config/application.rb
 - test_app/config/boot.rb
@@ -212,15 +213,6 @@ files:
 - test_app/spec/javascripts/router_spec.js
 - test_app/spec/javascripts/support/jasmine.yml
 - test_app/spec/spec_helper.rb
-- test_app/spec/tmp/assets/jasmine-boot.js
-- test_app/spec/tmp/assets/jasmine-console-reporter.js
-- test_app/spec/tmp/assets/jasmine-console-shims.js
-- test_app/spec/tmp/assets/jasmine-html.js
-- test_app/spec/tmp/assets/jasmine-specs.js
-- test_app/spec/tmp/assets/jasmine.css
-- test_app/spec/tmp/assets/jasmine.js
-- test_app/spec/tmp/assets/json2.js
-- test_app/spec/tmp/runner.html
 - test_app/spec/units/controller_spec.rb
 - test_app/spec/units/utilities_spec.rb
 - test_app/test/fixtures/.gitkeep

data/test_app/spec/tmp/assets/jasmine-boot.js

@@ -1,27 +0,0 @@
-var jsApiReporter;
-(function() {
-  var jasmineEnv = jasmine.getEnv();
-
-  jsApiReporter = new jasmine.JsApiReporter();
-  jasmineEnv.addReporter(jsApiReporter);
-
-  var htmlReporter = new jasmine.HtmlReporter();
-  jasmineEnv.addReporter(htmlReporter);
-  jasmineEnv.specFilter = function(spec) {
-    return htmlReporter.specFilter(spec);
-  };
-
-  if (jasmine.ConsoleReporter) {
-    jasmineEnv.addReporter(new jasmine.ConsoleReporter());
-  }
-
-  function execJasmine() {
-    jasmineEnv.execute();
-  }
-
-  if (window.addEventListener) { // W3C
-    window.addEventListener('load', execJasmine, false);
-  } else if (window.attachEvent) { // MSIE
-    window.attachEvent('onload', execJasmine);
-  }
-})();

data/test_app/spec/tmp/assets/jasmine-console-reporter.js

@@ -1,111 +0,0 @@
-/**
- Jasmine Reporter that outputs test results to the browser console.
- Useful for running in a headless environment such as PhantomJs, ZombieJs etc.
-
- Usage:
- // From your html file that loads jasmine:
- jasmine.getEnv().addReporter(new jasmine.ConsoleReporter());
- jasmine.getEnv().execute();
-*/
-
-
-(function(jasmine, console) {
-  if (!jasmine) {
-    throw "jasmine library isn't loaded!";
-  }
-
-  var ANSI = {}
-  ANSI.color_map = {
-      "green" : 32,
-      "red"   : 31
-  }
-
-  ANSI.colorize_text = function(text, color) {
-    var color_code = this.color_map[color];
-    return "\033[" + color_code + "m" + text + "\033[0m";
-  }
-
-  var ConsoleReporter = function() {
-    if (!console || !console.log) { throw "console isn't present!"; }
-    this.status = this.statuses.stopped;
-  };
-
-  var proto = ConsoleReporter.prototype;
-  proto.statuses = {
-    stopped : "stopped",
-    running : "running",
-    fail    : "fail",
-    success : "success"
-  };
-
-  proto.reportRunnerStarting = function(runner) {
-    this.status = this.statuses.running;
-    this.start_time = (new Date()).getTime();
-    this.executed_specs = 0;
-    this.passed_specs = 0;
-    this.log("Starting...");
-  };
-
-  proto.reportRunnerResults = function(runner) {
-    var failed = this.executed_specs - this.passed_specs;
-    var spec_str = this.executed_specs + (this.executed_specs === 1 ? " spec, " : " specs, ");
-    var fail_str = failed + (failed === 1 ? " failure in " : " failures in ");
-    var color = (failed > 0)? "red" : "green";
-    var dur = (new Date()).getTime() - this.start_time;
-
-    this.log("");
-    this.log("Finished");
-    this.log("-----------------");
-    this.log(spec_str + fail_str + (dur/1000) + "s.", color);
-
-    this.status = (failed > 0)? this.statuses.fail : this.statuses.success;
-
-    /* Print something that signals that testing is over so that headless browsers
-       like PhantomJs know when to terminate. */
-    this.log("");
-    this.log("ConsoleReporter finished");
-  };
-
-
-  proto.reportSpecStarting = function(spec) {
-    this.executed_specs++;
-  };
-
-  proto.reportSpecResults = function(spec) {
-    if (spec.results().skipped) {
-      return;
-    }
-    if (spec.results().passed()) {
-      this.passed_specs++;
-      return;
-    }
-
-    var resultText = spec.suite.description + " : " + spec.description;
-    this.log(resultText, "red");
-
-    var items = spec.results().getItems()
-    for (var i = 0; i < items.length; i++) {
-      var item = items[i];
-      var output = '  ' + item.message;
-      this.log(output, "red");
-    }
-  };
-
-  proto.reportSuiteResults = function(suite) {
-    if (suite.parentSuite) { return; }
-    var results = suite.results();
-    if (results.totalCount === 0) {
-      return;
-    }
-    var failed = results.totalCount - results.passedCount;
-    var color = (failed > 0)? "red" : "green";
-    this.log(suite.description + ": " + results.passedCount + " of " + results.totalCount + " passed.", color);
-  };
-
-  proto.log = function(str, color) {
-    var text = (color != undefined)? ANSI.colorize_text(str, color) : str;
-    console.log(text)
-  };
-
-  jasmine.ConsoleReporter = ConsoleReporter;
-})(jasmine, console);