rails-ajax 0.3.3.20140307 → 1.0.0.20140320

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 345f911093db6d23b6d8c8f2e0d2322b47478b0f
-  data.tar.gz: b02ae050e13d6b26329ff12f4867f93f09ed9cdb
+  metadata.gz: d174e764d5f6b7b2c49ade21b0b53419a38656fb
+  data.tar.gz: eace139aa4e7b220466a5cc8fb7f6fde0e6461bd
 SHA512:
-  metadata.gz: 6020a12c030f49b312ee8058cd07328a49052f666d674267554a5373fd4f1d43ec9081a98e99879a43a6c31c1c8307f738c04c59486a8852cd62773122d77883
-  data.tar.gz: b647df1ac778c31bcfd107725ec9e305a59732e875ee1423ae8302051e1450a01d0c8354d83842c903f2f47cf3a1c379ab8492e505163d690bd35ba3c4c038d9
+  metadata.gz: 24f0d39e6f272df7336e5803cc413c52d4a8ee3308c4517f2274e3b33f9d1707bc6e696bf9b18163c4fe1f9cbd1bcdf4eb0dd4e60ff108a51dfb6d5397621d22
+  data.tar.gz: fc12a427b0b6ce796085125a1f7fe84277a1637ce14f921c0eac80c24305edbd3ffd411f246cb7196f17a1c2ea44a7e8cf040a2c5ece289a1987f791840d11fc

data/AUTHORS.rdoc

@@ -8,6 +8,7 @@
 * 0.3.1.20131223
 * 0.3.2.20131227
 * 0.3.3.20140307
+* 1.0.0.20140320
 
 = LoveIsGrief (https://github.com/LoveIsGrief)
 

data/ChangeLog

@@ -1,5 +1,21 @@
 = Rails-Ajax Release History
 
+== 1.0.0.20140320 (Beta)
+
+! Compatibility break !
+The way to test if RailsAjax is enabled changes from:
+RailsAjax.config.Enabled
+to:
+RailsAjax.config.enabled?
+Unless you specifically used this method, this only impacts the generated config file app/assets/javascripts/RailsAjax-Config.js.erb.
+
+* Added support for Rails button_to helper.
+* Handled the case when servers return an empty content.
+* Update page when a 4xx status gets to rails-ajax.
+* Now compatible with Devise.
+* Complete code review.
+* Adapted Travis configuration to take database into account.
+
 == 0.3.3.20140307 (Beta)
 
 * Adapted tests environment to Travis

data/Gemfile

@@ -15,22 +15,3 @@ gem "jquery-rails"
 
 # To use debugger
 # gem 'debugger'
-
-group :test do
-
-  # Rails itself
-  gem 'rails'
-
-  # RSpec
-  gem 'rspec'
-  gem 'rspec-rails'
-
-  # Cucumber
-  gem 'cucumber-rails', :require => false
-  gem 'sqlite3'
-  gem 'database_cleaner'
-
-  # Capybara-webkit
-  gem 'capybara-webkit'
-
-end

data/Gemfile.lock

@@ -6,116 +6,44 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (0.6.1)
-      actionpack (>= 0.9.5)
-    actionpack (4.0.3)
-      activesupport (= 4.0.3)
+    actionpack (4.0.4)
+      activesupport (= 4.0.4)
       builder (~> 3.1.0)
       erubis (~> 2.7.0)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    activemodel (4.0.3)
-      activesupport (= 4.0.3)
-      builder (~> 3.1.0)
-    activerecord (4.0.3)
-      activemodel (= 4.0.3)
-      activerecord-deprecated_finders (~> 1.0.2)
-      activesupport (= 4.0.3)
-      arel (~> 4.0.0)
-    activerecord-deprecated_finders (1.0.3)
-    activesupport (4.0.3)
-      i18n (~> 0.6, >= 0.6.4)
+    activesupport (4.0.4)
+      i18n (~> 0.6, >= 0.6.9)
       minitest (~> 4.2)
       multi_json (~> 1.3)
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
-    arel (4.0.2)
-    atomic (1.1.15)
+    atomic (1.1.16)
     builder (3.1.4)
-    capybara (2.2.1)
-      mime-types (>= 1.16)
-      nokogiri (>= 1.3.3)
-      rack (>= 1.0.0)
-      rack-test (>= 0.5.4)
-      xpath (~> 2.0)
-    capybara-webkit (1.1.0)
-      capybara (~> 2.0, >= 2.0.2)
-      json
-    cucumber (1.3.11)
-      builder (>= 2.1.2)
-      diff-lcs (>= 1.1.3)
-      gherkin (~> 2.12)
-      multi_json (>= 1.7.5, < 2.0)
-      multi_test (>= 0.0.2)
-    cucumber-rails (1.3.0)
-      capybara (>= 1.1.2)
-      cucumber (>= 1.1.8)
-      nokogiri (>= 1.5.0)
-    database_cleaner (1.2.0)
-    diff-lcs (1.2.5)
     erubis (2.7.0)
-    gherkin (2.12.2)
-      multi_json (~> 1.3)
     i18n (0.6.9)
     jquery-rails (3.1.0)
       railties (>= 3.0, < 5.0)
       thor (>= 0.14, < 2.0)
-    json (1.8.1)
-    mime-types (2.1)
-    mini_portile (0.5.2)
     minitest (4.7.5)
     multi_json (1.9.0)
-    multi_test (0.0.3)
-    nokogiri (1.6.1)
-      mini_portile (~> 0.5.0)
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
-    rails (0.9.5)
-      actionmailer (>= 0.6.1)
-      actionpack (>= 1.4.0)
-      activerecord (>= 1.6.0)
-      rake (>= 0.4.15)
-    railties (4.0.3)
-      actionpack (= 4.0.3)
-      activesupport (= 4.0.3)
+    railties (4.0.4)
+      actionpack (= 4.0.4)
+      activesupport (= 4.0.4)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.1.1)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    rspec-rails (2.14.1)
-      actionpack (>= 3.0)
-      activemodel (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    sqlite3 (1.3.9)
     thor (0.18.1)
-    thread_safe (0.2.0)
+    thread_safe (0.3.0)
       atomic (>= 1.1.7, < 2)
-    tzinfo (0.3.38)
-    xpath (2.0.0)
-      nokogiri (~> 1.3)
+    tzinfo (0.3.39)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  capybara-webkit
-  cucumber-rails
-  database_cleaner
   jquery-rails
-  rails
   rails-ajax!
-  rspec
-  rspec-rails
-  sqlite3

data/ReleaseInfo

@@ -2,7 +2,7 @@
 # This file has been generated by RubyPackager during a delivery.
 # More info about RubyPackager: http://rubypackager.sourceforge.net
 {
-  :version => '0.3.3.20140307',
+  :version => '1.0.0.20140320',
   :tags => [ 'Beta' ],
   :dev_status => 'Beta'
 }

data/assets/javascripts/jquery.rails-ajax.js.erb

@@ -1,9 +1,4 @@
-//--
-// Copyright (c) 2012 Muriel Salvan (muriel@x-aeon.com)
-// Licensed under the terms specified in LICENSE file. No warranty is provided.
-//++
-
-<% if (RailsAjax.config.Enabled) %>
+<% if (RailsAjax.config.enabled?) %>
 
 //=========================================
 // Browser detection code (removed from jQuery >=1.9):
@@ -47,8 +42,6 @@ if ( browser.chrome ) {
 jQuery.browser = browser;
 //===========================================
 
-
-
 // Encapsulate everything in a nice namespace
 var railsAjax = {
 
@@ -61,7 +54,8 @@ var railsAjax = {
       jQuery(window).bind('statechange', function() {
         try {
           var lState = History.getState();
-          <%= 'alert(\'[RailsAjax] History statechange triggered #\' + lState.data.id + \' via \' + lState.data.type + \' to \' + lState.url.replace(lRootURL, \'/\') + \' (anchor: \' + lState.data.anchor + \')\');' if (RailsAjax.config.DebugAlerts) %>
+          <%= 'alert(\'[RailsAjax] History statechange triggered #\' + lState.data.id + \' via \' + lState.data.type + \' to \' + lState.url.replace(lRootURL, \'/\') + \' (anchor: \' + lState.data.anchor + \', dataType: \' + lState.data.dataType + \')\');' if (RailsAjax.config.debug_alerts?) %>
+          // console.log('[RailsAjax] History statechange triggered ' + lState.data.type + ' to ' + lState.url.replace(lRootURL, '/') + ' (anchor: ' + lState.data.anchor + ', dataType: ' + lState.data.dataType + ')');
           jQuery.ajax({
             // TODO (History.js): Remove the anchor attribute when History.js handles anchors correctly.
             anchor: lState.data.anchor,
@@ -75,21 +69,26 @@ var railsAjax = {
             // And the callbacks
             // TODO (History.js): Remove the beforeSend callback when anchors will be handled correctly by History.js
             beforeSend: function(ioXHR, iSettings) {
+              // console.log('[RailsAjax] Before sending request');
               // Remember the anchor used
               ioXHR.anchor = iSettings.anchor;
             },
             success: function(iData, iStatus, iXHR) {
+              // console.log('[RailsAjax] Response returned success');
               railsAjax.ajaxSuccess(iXHR, iData);
             },
             error: function(iXHR, iStatus, iError) {
+              // console.log('[RailsAjax] Response returned error');
               railsAjax.ajaxError(iXHR, iError);
             }
           });
         } catch (iError) {
+          // console.log('[RailsAjax] Exception in statechange callback: ' + iError.name + ' - ' + iError.message);
           alert('[RailsAjax] Exception in statechange callback: ' + iError.name + ' - ' + iError.message);
         }
       });
     } catch (iError) {
+      // console.log('[RailsAjax] Exception during railsAjax initialization: ' + iError.name + ' - ' + iError.message);
       alert('[RailsAjax] Exception during railsAjax initialization: ' + iError.name + ' - ' + iError.message);
     }
   },
@@ -100,13 +99,13 @@ var railsAjax = {
   // * *iCSSSelector* (_String_): CSS selector of elements needing attachment
   attachAjaxToElements: function(iCSSSelector) {
     try {
-      <%= 'alert(\'[RailsAjax] Attach Ajax bindings to elements \' + iCSSSelector + \' (\' + jQuery(iCSSSelector).length + \' elements)\');' if (RailsAjax.config.DebugAlerts) %>
+      <%= 'alert(\'[RailsAjax] Attach Ajax bindings to elements \' + iCSSSelector + \' (\' + jQuery(iCSSSelector).length + \' elements)\');' if (RailsAjax.config.debug_alerts?) %>
       jQuery(document)
         .delegate(iCSSSelector, 'ajax:beforeSend', function(iEvent, ioXHR, iSettings) {
           try {
             var lThis = jQuery(this);
             var lURL = ((lThis.is('a')) ? lThis.attr('href') : lThis.attr('action'));
-            <%= 'alert(\'[RailsAjax] Ajax before send. URL=\' + lURL + \' Method=\' + iSettings.type + \' Data=\' + iSettings.data);' if (RailsAjax.config.DebugAlerts) %>
+            <%= 'alert(\'[RailsAjax] Ajax before send. URL=\' + lURL + \' Method=\' + iSettings.type + \' Data=\' + iSettings.data);' if (RailsAjax.config.debug_alerts?) %>
             var lContinue = true;
             if (railsAjax.beforeSend != undefined) {
               try {
@@ -115,7 +114,7 @@ var railsAjax = {
                 alert('[RailsAjax] Exception in user callback railsAjax.beforeSend: ' + iUserError.name + ' - ' + iUserError.message);
               }
             }
-            <%= 'alert(\'[RailsAjax] Continue on the Ajax load ? \' + lContinue);' if (RailsAjax.config.DebugAlerts) %>
+            <%= 'alert(\'[RailsAjax] Continue on the Ajax load ? \' + lContinue);' if (RailsAjax.config.debug_alerts?) %>
             if (lContinue) {
               railsAjax.pushNewState(lURL,
                 {
@@ -144,45 +143,16 @@ var railsAjax = {
   //
   // Parameters::
   // * *iXHR* (_Object_): The XHR object responsible for the Ajax call
-  // * *iData* (_String_): The received data
+  // * *iData* (_String_): The received data (can be undefined for empty contents)
   ajaxSuccess: function(iXHR, iData) {
     try {
-      <%= 'alert(\'[RailsAjax] Ajax success. Loading data: \' + iData);' if (RailsAjax.config.DebugAlerts) %>
-
-      // 1. Change the window's title if needed
-      if ('page_title' in iData) {
-        document.title = iData.page_title;
-      }
-
-      // 2. Replace HTML data, and execute scripts in the same time
-      jQuery.each(iData.div_contents, function(iCSSSelector, iContent) {
-        // This replaces HTML content and also executes scripts (even document.ready ones)
-        jQuery(iCSSSelector).html(iContent);
-      });
-
-      // 3. Scroll to anchor if needed
-      if (iXHR.anchor) {
-        railsAjax.scrollToAnchor(iXHR.anchor);
-      }
+      <%= 'alert(\'[RailsAjax] Ajax success. Loading data: \' + iData);' if (RailsAjax.config.debug_alerts?) %>
 
-      // 4. For Firefox only, workaround a bug by setting the Favicon
-      if (jQuery.browser.mozilla) {
-        railsAjax.setFavicon();
-      }
-
-      // 5. Execute scripts that were added
-      if ('js_to_execute' in iData) {
-        jQuery.each(iData.js_to_execute, function(iIdx, iJS) {
-          <%= 'alert(\'[RailsAjax] Execute script #\' + iIdx + \':\\n\' + iJS);' if (RailsAjax.config.DebugAlerts) %>
-          try {
-            eval(iJS);
-          } catch (iError) {
-            alert('[RailsAjax] Exception while executing Ajax script: ' + iError.name + ' - ' + iError.message + '\nScript:\n' + iJS);
-          }
-        });
+      if (iData != undefined) {
+        railsAjax.updatePage(iXHR, iData);
       }
 
-      // 6. Call user callbacks
+      // Call user callbacks
       if (railsAjax.success != undefined) {
         try {
           railsAjax.success(iXHR, iData);
@@ -198,8 +168,9 @@ var railsAjax = {
         }
       }
 
-      // 7. Handle redirects
-      if ('redirect_to' in iData) {
+      // Handle redirects
+      if ((iData != undefined) &&
+          ('redirect_to' in iData)) {
         railsAjax.pushNewState(iData.redirect_to, {}, true);
       }
 
@@ -214,6 +185,15 @@ var railsAjax = {
   // * *iXHR* (_Object_): The xhr object
   // * *iError* (_Object_): The error
   ajaxError: function(iXHR, iError) {
+
+    // If the error is a 4xx one, and handled by rails-ajax (using a JSON object), still update the page.
+    if ((iXHR.status >= 400) &&
+        (iXHR.status < 500) &&
+        (iXHR.responseJSON != undefined)) {
+      railsAjax.updatePage(iXHR, iXHR.responseJSON);
+    }
+
+    // Call user callbacks
     if (railsAjax.error != undefined) {
       try {
         railsAjax.error(iXHR, iError);
@@ -228,10 +208,57 @@ var railsAjax = {
         alert('[RailsAjax] Exception in user callback railsAjax.complete: ' + iUserError.name + ' - ' + iUserError.message);
       }
     }
+
+  },
+
+  // Update the page with a given data returned by rails-ajax
+  //
+  // Parameters::
+  // * *iXHR* (_Object_): The XHR object responsible for the Ajax call
+  // * *iData* (_String_): The received data
+  updatePage: function(iXHR, iData) {
+    try {
+
+      // 1. Change the window's title if needed
+      if ('page_title' in iData) {
+        document.title = iData.page_title;
+      }
+
+      // 2. Replace HTML data, and execute scripts in the same time
+      jQuery.each(iData.div_contents, function(iCSSSelector, iContent) {
+        // This replaces HTML content and also executes scripts (even document.ready ones)
+        jQuery(iCSSSelector).html(iContent);
+      });
+
+      // 3. Scroll to anchor if needed
+      if (iXHR.anchor) {
+        railsAjax.scrollToAnchor(iXHR.anchor);
+      }
+
+      // 4. For Firefox only, workaround a bug by setting the Favicon
+      if (jQuery.browser.mozilla) {
+        railsAjax.setFavicon();
+      }
+
+      // 5. Execute scripts that were added
+      if ('js_to_execute' in iData) {
+        jQuery.each(iData.js_to_execute, function(iIdx, iJS) {
+          <%= 'alert(\'[RailsAjax] Execute script #\' + iIdx + \':\\n\' + iJS);' if (RailsAjax.config.debug_alerts?) %>
+          try {
+            eval(iJS);
+          } catch (iError) {
+            alert('[RailsAjax] Exception while executing Ajax script: ' + iError.name + ' - ' + iError.message + '\nScript:\n' + iJS);
+          }
+        });
+      }
+
+    } catch (iError) {
+      alert('[RailsAjax] Exception while updating page: ' + iError.name + ' - ' + iError.message);
+    }
   },
 
   // Used to identify states in debugging logs
-  <%= 'gStateID: 0,' if (RailsAjax.config.DebugAlerts) %>
+  <%= 'gStateID: 0,' if (RailsAjax.config.debug_alerts?) %>
 
   // Push a new History state
   //
@@ -248,7 +275,7 @@ var railsAjax = {
       var lState = jQuery.extend(
         {
           // Used to identify states in debugging logs
-          <%= 'id: railsAjax.gStateID,' if (RailsAjax.config.DebugAlerts) %>
+          <%= 'id: railsAjax.gStateID,' if (RailsAjax.config.debug_alerts?) %>
           anchor: lSplittedURL[1]
         },
         iData
@@ -258,7 +285,7 @@ var railsAjax = {
       } else {
         History.pushState(lState, null, lSplittedURL[0]);
       }
-      <%= 'railsAjax.gStateID = railsAjax.gStateID + 1;' if (RailsAjax.config.DebugAlerts) %>
+      <%= 'railsAjax.gStateID = railsAjax.gStateID + 1;' if (RailsAjax.config.debug_alerts?) %>
     } catch (iError) {
       alert('[RailsAjax] Exception in pushNewState: ' + iError.name + ' - ' + iError.message);
     }

data/gen/app/assets/javascripts/RailsAjax-Config.js.erb

@@ -1,4 +1,4 @@
-<% if (RailsAjax.config.Enabled) %>
+<% if (RailsAjax.config.enabled?) %>
 
 // Define callbacks used with asynchronous Ajax answers:
 // railsAjax.beforeSend => railsAjax.success/railsAjax.error => railsAjax.complete

data/gen/config/initializers/rails-ajax-config.rb

@@ -1,5 +1,5 @@
 # RailsAjax configuration
-RailsAjax::configure do
+RailsAjax.configure do
 
   # Enable or disable RailsAjax.
   # If disabled, RailsAjax methods will be useless, and corresponding JavaScript will be removed.

data/lib/rails-ajax.rb

@@ -1,8 +1,3 @@
-#--
-# Copyright (c) 2012 Muriel Salvan (Muriel@X-Aeon.com)
-# Licensed under the terms specified in LICENSE file. No warranty is provided.
-#++
-
 module RailsAjax
 
   # Give the root directory of the RailsAjax installation

data/lib/rails-ajax/action_controller/base.rb

@@ -1,9 +1,3 @@
-#--
-# Copyright (c) 2012 Muriel Salvan (Muriel@X-Aeon.com)
-# Licensed under the terms specified in LICENSE file. No warranty is provided.
-#++
-
-# Alias standard methods, and add new ones to adapt them to AJAX calls
 module ActionController
 
   class Base

data/lib/rails-ajax/action_view/base.rb

@@ -1,8 +1,3 @@
-#--
-# Copyright (c) 2012 Muriel Salvan (Muriel@X-Aeon.com)
-# Licensed under the terms specified in LICENSE file. No warranty is provided.
-#++
-
 module ActionView
 
   class Base

data/lib/rails-ajax/configuration.rb

@@ -1,8 +1,3 @@
-#--
-# Copyright (c) 2012 Muriel Salvan (Muriel@X-Aeon.com)
-# Licensed under the terms specified in LICENSE file. No warranty is provided.
-#++
-
 module RailsAjax
 
   # Class used to configure and store the configuration of RailsAjax
@@ -10,63 +5,65 @@ module RailsAjax
 
     # Indicate if RailsAjax is enabled
     #
-    # _Boolean_
-    attr_reader :Enabled
-
-    # The main container
-    #
-    # _String_
-    attr_reader :MainContainer
-
-    # The flash containers
-    #
-    # <em>map< Symbol, String ></em>
-    attr_reader :FlashContainers
+    # Return::
+    # * _Boolean_: Is rails-ajax enabled?
+    def enabled?
+      return @enabled
+    end
 
     # Debug alerts ?
     #
-    # _Boolean_
-    attr_reader :DebugAlerts
+    # Return::
+    # * _Boolean_: Do we switch on debug alerts?
+    def debug_alerts?
+      return @debug_alerts
+    end
 
     # Constructor
     def initialize
       # Set default values here
-      @Enabled = true
-      @MainContainer = 'body'
-      @FlashContainers = {}
-      @DebugAlerts = false
+      @enabled = true
+      @main_container = 'body'
+      @flash_containers = {}
+      @debug_alerts = false
     end
 
     # Do we activate RailsAjax ?
     #
     # Parameters::
-    # * *iSwitch* (_Boolean_): Do we activate RailsAjax ?
-    def enable(iSwitch)
-      @Enabled = iSwitch
+    # * *switch* (_Boolean_): Do we activate RailsAjax ?
+    def enable(switch)
+      @enabled = switch
     end
 
-    # Define the main container
+    # Define the main container if provided, and return it
     #
     # Parameters::
-    # * *iSelector* (_String_): Selector used to identify the container
-    def main_container(iSelector)
-      @MainContainer = iSelector
+    # * *selector* (_String_): Selector used to identify the container [optional = nil]
+    # Return::
+    # * _String_: The CSS selector of the main container
+    def main_container(selector = nil)
+      @main_container = selector if (selector != nil)
+      return @main_container
     end
 
-    # Define the flash containers
+    # Define the flash containers (add them to already present ones) if provided, and return them
     #
     # Parameters::
-    # * *iMapSelectors* (<em>map<Symbol,String></em>): The map of selectors, per flash message type (:alert, :notice...)
-    def flash_containers(iMapSelectors)
-      @FlashContainers.merge!(iMapSelectors)
+    # * *selectors_map* (<em>map<Symbol,String></em>): The map of selectors, per flash message type (:alert, :notice...)
+    # Return::
+    # * <em>map<Symbol,String></em>: The map of selectors [optional = nil]
+    def flash_containers(selectors_map = nil)
+      @flash_containers.merge!(selectors_map) if (selectors_map != nil)
+      return @flash_containers
     end
 
     # Do we activate debugging alerts ?
     #
     # Parameters::
-    # * *iSwitch* (_Boolean_): Do we activate debugging alerts ?
-    def debug_alerts(iSwitch)
-      @DebugAlerts = iSwitch
+    # * *switch* (_Boolean_): Do we activate debugging alerts ?
+    def debug_alerts(switch)
+      @debug_alerts = switch
     end
 
   end

data/lib/rails-ajax/controller.rb

@@ -1,8 +1,3 @@
-#--
-# Copyright (c) 2012 Muriel Salvan (Muriel@X-Aeon.com)
-# Licensed under the terms specified in LICENSE file. No warranty is provided.
-#++
-
 module RailsAjax
 
   # Module defining new methods that will be part of every controller
@@ -10,75 +5,60 @@ module RailsAjax
 
     # Render
     # Adapt to AJAX calls, by returning the following JSON object that will be interpreted by client side JavaScript.
-    def render(*iArgs, &iBlock)
-      if (RailsAjax.config.Enabled)
-        lArgs = _normalize_args(*iArgs, &iBlock)
+    def render(*options, &block)
+      if (RailsAjax.config.enabled?)
+        args = _normalize_args(*options, &block)
         if ((request.xhr?) and
-            (!lArgs.has_key?(:partial)) and
-            (!lArgs.has_key?(:layout)) and
-            (!lArgs.has_key?(:json)) and
+            (!args.has_key?(:partial)) and
+            (!args.has_key?(:layout)) and
+            (!args.has_key?(:json)) and
             (params['format'] != 'json') and
             (self.content_type != 'application/json'))
-          logger.debug "[RailsAjax] render: iArgs=#{iArgs.inspect} iBlock?#{iBlock != nil} flash=#{flash.inspect} | Normalized arguments: #{lArgs.inspect}"
+          logger.debug "[RailsAjax] render: options=#{options.inspect} block?#{block != nil} flash=#{flash.inspect} | Normalized arguments: #{args.inspect}"
 
           # If we have a redirection, use redirect_to
-          if (lArgs[:location] == nil)
+          if (args[:location] == nil)
             # Complete arguments if needed
             # We don't want a special layout for Ajax requests: this was asked using AJAX for a page to be displayed in the main content
-            lArgs[:layout] = false
+            args[:layout] = false
             # Render
-            lMainPage = nil
-            if (iBlock == nil)
-              lMainPage = render_to_string(lArgs)
-            else
-              lMainPage = render_to_string(lArgs) do
-                iBlock.call
-              end
-            end
+            main_content = render_to_string(args, &block)
 
             # Send JSON result
             # Use 'application/json'
             self.content_type = 'application/json'
             self.response_body = get_json_response(
-              :css_to_refresh => {
-                RailsAjax::config.MainContainer => lMainPage
+              :elements_to_refresh => {
+                RailsAjax.config.main_container => main_content
               }
             ).to_json
-          elsif (lArgs[:status] == nil)
-            redirect_to lArgs[:location]
+          elsif (args[:status] == nil)
+            redirect_to args[:location]
           else
-            redirect_to lArgs[:location], lArgs[:status]
+            redirect_to args[:location], args[:status]
           end
 
-        elsif (iBlock == nil)
-          super(*iArgs)
         else
-          super(*iArgs) do
-            iBlock.call
-          end
+          super(*options, &block)
         end
-      elsif (iBlock == nil)
-        super(*iArgs)
       else
-        super(*iArgs) do
-          iBlock.call
-        end
+        super(*options, &block)
       end
 
     end
 
     # Render a redirection
     # Adapt to AJAX calls
-    def redirect_to(iOptions = {}, iResponseStatus = {})
-      if (RailsAjax.config.Enabled and request.xhr?)
-        logger.debug "[RailsAjax] redirect_to: iOptions=#{iOptions.inspect} iResponseStatus=#{iResponseStatus.inspect}"
+    def redirect_to(options = {}, response_status = {})
+      if (RailsAjax.config.enabled? and request.xhr?)
+        logger.debug "[RailsAjax] redirect_to: options=#{options.inspect} response_status=#{response_status.inspect}"
         # Use 'application/json'
         self.content_type = 'application/json'
         self.response_body = get_json_response(
-          :redirect_to => url_for(iOptions)
+          :redirect_to => url_for(options)
         ).to_json
       else
-        super(iOptions, iResponseStatus)
+        super(options, response_status)
       end
     end
 
@@ -87,15 +67,13 @@ module RailsAjax
     # Mark given DOM elements (selected using a CSS selector) to be refreshed with a partial's content
     #
     # Parameters::
-    # * *iCSSSelector* (_String_): The CSS selector to be used to refresh elements
-    # * *iPartialName* (_String_): Name of the partial to be used to refresh these elements
-    def refresh_dom_with_partial(iCSSSelector, iPartialName)
-      if RailsAjax.config.Enabled
-        logger.debug "[RailsAjax] Mark partial #{iPartialName} to be refreshed in #{iCSSSelector}"
-        if (defined?(@PartialsToRefresh) == nil)
-          @PartialsToRefresh = {}
-        end
-        @PartialsToRefresh[iCSSSelector] = iPartialName
+    # * *css_selector* (_String_): The CSS selector to be used to refresh elements
+    # * *partial_name* (_String_): Name of the partial to be used to refresh these elements
+    def refresh_dom_with_partial(css_selector, partial_name)
+      if RailsAjax.config.enabled?
+        logger.debug "[RailsAjax] Mark partial #{partial_name} to be refreshed in #{css_selector}"
+        @partials_to_refresh = {} if (defined?(@partials_to_refresh) == nil)
+        @partials_to_refresh[css_selector] = partial_name
       end
     end
 
@@ -103,14 +81,12 @@ module RailsAjax
     # This is used to execute special Ajax handling that is not needed in case the same request is made without Ajax
     #
     # Parameters::
-    # * *iJS* (_String_): Javascript to be executed
-    def execute_javascript(iJS)
-      if RailsAjax.config.Enabled
-        logger.debug "[RailsAjax] Add javascript to be executed: #{iJS[0..255]}"
-        if (defined?(@JSToExecute) == nil)
-          @JSToExecute = []
-        end
-        @JSToExecute << iJS
+    # * *js_code* (_String_): Javascript to be executed
+    def execute_javascript(js_code)
+      if RailsAjax.config.enabled?
+        logger.debug "[RailsAjax] Add javascript to be executed: #{js_code[0..255]}"
+        @js_to_execute = [] if (defined?(@js_to_execute) == nil)
+        @js_to_execute << js_code
       end
     end
 
@@ -118,7 +94,8 @@ module RailsAjax
 
     # Get the JSON object that will be sent to an Ajax request.
     # Include the partials marked to be refreshed.
-    # Include Javascripts to be executed
+    # Include Javascripts to be executed.
+    # Include Flash messages.
     # Structure of the JSON object:
     # * *:div_contents* (<em>map<String,String></em>): The content of DOM elements to be replaced, indexed by CSS selector.
     # * *:page_title* (_String_): The new page title
@@ -126,28 +103,28 @@ module RailsAjax
     # * *:js_to_execute* (<em>list<String></em>): Javascripts to be executed
     #
     # Parameters::
-    # * *iOptions* (<em>map<Symbol,Object></em>): Options [optional = {}]
-    #   * *:css_to_refresh* (<em>map<String,String></em>): List of CSS to be refreshed, along with their HTML code [optional = {}]
+    # * *options* (<em>map<Symbol,Object></em>): Options [optional = {}]
+    #   * *:elements_to_refresh* (<em>map<String,String></em>): List of elements to be refreshed (HTML code), indexed by their CSS selector [optional = {}]
     #   * *:redirect_to* (_String_): URL to redirect to [optional = nil]
     # Return::
     # * <em>map<Object,Object></em>: The corresponding JSON data
-    def get_json_response(iOptions = {})
-      rJSON = {}
+    def get_json_response(options = {})
+      json_result = {}
 
-      lDivContents = iOptions[:css_to_refresh] || {}
-      if (defined?(@PartialsToRefresh) != nil)
-        @PartialsToRefresh.each do |iCSSSelector, iPartialName|
-          lDivContents[iCSSSelector] = render_to_string(:partial => iPartialName)
+      elements_contents = options[:elements_to_refresh] || {}
+      if (defined?(@partials_to_refresh) != nil)
+        @partials_to_refresh.each do |css_selector, partial_name|
+          elements_contents[css_selector] = render_to_string(:partial => partial_name)
         end
       end
-      RailsAjax::config.FlashContainers.each do |iSymFlashType, iSelector|
-        lDivContents[iSelector] = flash[iSymFlashType]
+      RailsAjax.config.flash_containers.each do |flash_type, css_selector|
+        elements_contents[css_selector] = flash[flash_type]
       end
-      rJSON[:js_to_execute] = @JSToExecute if (defined?(@JSToExecute) != nil)
-      rJSON[:div_contents] = lDivContents
-      rJSON[:redirect_to] = iOptions[:redirect_to] if (iOptions[:redirect_to] != nil)
+      json_result[:js_to_execute] = @js_to_execute if (defined?(@js_to_execute) != nil)
+      json_result[:div_contents] = elements_contents
+      json_result[:redirect_to] = options[:redirect_to] if (options[:redirect_to] != nil)
 
-      return rJSON
+      return json_result
     end
 
   end

data/lib/rails-ajax/form_tag_helper.rb

@@ -1,8 +1,3 @@
-#--
-# Copyright (c) 2012 Muriel Salvan (Muriel@X-Aeon.com)
-# Licensed under the terms specified in LICENSE file. No warranty is provided.
-#++
-
 module RailsAjax
 
   # Module defining methods to include in ActionView::Helpers::FormTagHelper
@@ -10,22 +5,8 @@ module RailsAjax
 
     # Replaces form_tag with an Ajax updated version
     def form_tag(url_for_options = {}, options = {}, &block)
-      if (RailsAjax.config.Enabled and
-          RailsAjax::rails_ajaxifiable?(options))
-        if block_given?
-          return super(url_for_options, options.merge({ :remote => true, :'data-rails-ajax-remote' => true })) do
-            block.call
-          end
-        else
-          return super(url_for_options, options.merge({ :remote => true, :'data-rails-ajax-remote' => true }))
-        end
-      elsif block_given?
-        return super(url_for_options, options) do
-          block.call
-        end
-      else
-        return super(url_for_options, options)
-      end
+      options.merge!({ :remote => true, :'data-rails-ajax-remote' => true }) if (RailsAjax.config.enabled? and RailsAjax.rails_ajaxifiable?(options))
+      return super(url_for_options, options, &block)
     end
 
   end

data/lib/rails-ajax/rails-ajax.rb

@@ -1,40 +1,35 @@
-#--
-# Copyright (c) 2012 Muriel Salvan (Muriel@X-Aeon.com)
-# Licensed under the terms specified in LICENSE file. No warranty is provided.
-#++
-
 module RailsAjax
 
   # The configuration
   #   <em>RailsAjax::Configuration</em>
-  @@Configuration = RailsAjax::Configuration.new
+  @configuration = RailsAjax::Configuration.new
 
   # Give access to the configuration
   #
   # Return::
   # * <em>RailsAjax::Configuration</em>: The RailsAjax configuration
   def self.config
-    return @@Configuration
+    return @configuration
   end
 
   # Configure RailsAjax
   #
   # Parameters::
-  # * *iProcConfig* (_CodeBlock_): Block called that will contain all configuration directives
-  def self.configure(&iProcConfig)
-    @@Configuration.instance_eval(&iProcConfig)
+  # * *config_block* (_CodeBlock_): Block called that will contain all configuration directives
+  def self.configure(&config_block)
+    @configuration.instance_eval(&config_block)
   end
 
   # Find if we use rails-ajax for a given set of options applicable to a link
   #
   # Parameters::
-  # * *iOptions* (<em>map<Symbol,Object></em>): The options provided to a link (used in link_to or form_tag)
+  # * *options* (<em>map<Symbol,Object></em>): The options provided to a link (used in link_to or form_tag)
   # Result::
   # * _Boolean_: Would this link be handled by rails-ajax?
-  def self.rails_ajaxifiable?(iOptions)
-    return ((iOptions[:use_rails_ajax] != false) and # User has not removed rails-ajax voluntarily
-            (iOptions[:target] == nil) and # Open in the same window and
-            (!iOptions.has_key?(:remote))) # User has not specified Ajax call itself
+  def self.rails_ajaxifiable?(options)
+    return ((options[:use_rails_ajax] != false) and # User has not removed rails-ajax voluntarily
+            (options[:target] == nil) and # Open in the same window and
+            (!options.has_key?(:remote))) # User has not specified Ajax call itself
   end
 
 end

data/lib/rails-ajax/railtie.rb

@@ -1,8 +1,3 @@
-#--
-# Copyright (c) 2012 Muriel Salvan (Muriel@X-Aeon.com)
-# Licensed under the terms specified in LICENSE file. No warranty is provided.
-#++
-
 module RailsAjax
 
   # Class defining how Rails-Ajax is plugged into Rails
@@ -13,7 +8,7 @@ module RailsAjax
       load "#{RailsAjax.root}/tasks/rails-ajax_tasks.rake"
     end
 
-    initializer :'rails-ajax.initialize' do |ioApp|
+    initializer :'rails-ajax.initialize' do |app|
       # Require all files
       require 'rails-ajax/configuration'
       require 'rails-ajax/rails-ajax'
@@ -23,7 +18,7 @@ module RailsAjax
       require 'rails-ajax/action_controller/base'
       require 'rails-ajax/action_view/base'
       # Add a new assets path for javascript
-      ioApp.config.assets.paths << "#{RailsAjax.root}/assets/javascripts"
+      app.config.assets.paths << "#{RailsAjax.root}/assets/javascripts"
     end
 
   end

data/lib/rails-ajax/url_helper.rb

@@ -1,8 +1,3 @@
-#--
-# Copyright (c) 2012 Muriel Salvan (Muriel@X-Aeon.com)
-# Licensed under the terms specified in LICENSE file. No warranty is provided.
-#++
-
 module RailsAjax
 
   # Module defining methods to include in ActionView::Helpers::FormHelper
@@ -12,19 +7,27 @@ module RailsAjax
     def link_to(name = nil, options = nil, html_options = nil, &block)
       options, html_options = name, options if block_given?
       html_options ||= {}
-      if (RailsAjax.config.Enabled and
-          RailsAjax::rails_ajaxifiable?(html_options))
-        html_options.merge!({ :remote => true, :'data-rails-ajax-remote' => true })
+      html_options.merge!({ :remote => true, :'data-rails-ajax-remote' => true }) if (RailsAjax.config.enabled? and RailsAjax.rails_ajaxifiable?(html_options))
+      if block_given?
+        return super(options, html_options, &block)
+      else
+        return super(name, options, html_options)
       end
+    end
+
+    # Adapt button_to method to handle Ajax queries automatically
+    def button_to(name = nil, options = nil, html_options = nil, &block)
+      html_options, options = options, name if block_given?
+      html_options ||= {}
+      html_options.merge!({ :remote => true, :form => {:'data-rails-ajax-remote' => true} }) if (RailsAjax.config.enabled? and RailsAjax.rails_ajaxifiable?(html_options))
       if block_given?
-        return super(options, html_options) do
-          block.call
-        end
+        return super(options, html_options, &block)
       else
         return super(name, options, html_options)
       end
     end
 
+
   end
 
 end

data/tasks/rails-ajax_tasks.rake

@@ -1,22 +1,17 @@
-#--
-# Copyright (c) 2012 Muriel Salvan (Muriel@X-Aeon.com)
-# Licensed under the terms specified in LICENSE file. No warranty is provided.
-#++
-
 namespace :'rails-ajax' do
 
   # Copy a file if it does not exist from RailsAjax root path /gen to Rails root path
   #
   # Parameters::
-  # * *iFileName* (_String_): The file name
-  def copy_file_unless_exists(iFileName)
-    lDstFileName = File.join(Rails.root, iFileName)
-    if (File.exist?(lDstFileName))
-      puts "File #{lDstFileName} already exists. Will not overwrite."
+  # * *file_name* (_String_): The file name
+  def copy_file_unless_exists(file_name)
+    dest_file_name = File.join(Rails.root, file_name)
+    if (File.exist?(dest_file_name))
+      puts "File #{dest_file_name} already exists. Will not overwrite."
     else
-      puts "Creating file #{lDstFileName}."
-      FileUtils.mkdir_p(File.dirname(lDstFileName))
-      FileUtils.cp(File.join("#{RailsAjax.root}/gen", iFileName), lDstFileName)
+      puts "Creating file #{dest_file_name}."
+      FileUtils.mkdir_p(File.dirname(dest_file_name))
+      FileUtils.cp("#{RailsAjax.root}/gen/#{file_name}", dest_file_name)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-ajax
 version: !ruby/object:Gem::Version
-  version: 0.3.3.20140307
+  version: 1.0.0.20140320
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-07 00:00:00.000000000 Z
+date: 2014-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails