ajax 1.1.5 → 1.1.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ./
   specs:
-    ajax (1.1.4)
+    ajax (1.1.6)
       json
       rack
 

data/README.rdoc

@@ -10,6 +10,7 @@ As of May 2010 Ajax is being used live in production on kazaa.com[http://www.kaz
 
 == Changelog
 
+* v1.1.6: Fix redirect_to to handle Rails 3 resourceful redirects
 * v1.1.5: Fix inclusion of +controller+ and +layout+ in <tt>Ajax-Info</tt> response header.  Improve RSpec 1.* integration
 * v1.1.4: Fix RSpec 2 integration
 * v1.1.3: Guard against possible nil values for the redirect_to url and the referrers
@@ -17,33 +18,29 @@ As of May 2010 Ajax is being used live in production on kazaa.com[http://www.kaz
 * v1.1.1: Backwards compatibility fix for Rails < 3
 * <b>v1.1.0: Rails 3 supported!</b>
 
-== Install
+== Install for Rails
 
-=== Rails 3
+After getting the Gem installed, take a look at <b>Getting Started</b> for more information about setting up your application for Ajax.
 
-1. Add the gem to your <tt>Gemspec</tt>
+=== Rails 3
 
-     gem 'ajax'
+Add the gem to your <tt>Gemspec</tt>:
 
-2. <tt>bundle</tt>
-3. <tt>rake ajax:install</tt>
-4. Run <tt>rake routes</tt> to verify that the <tt>/ajax/framework</tt> path is being routed correctly.  The route will automatically be added to your application but if you have catch-all routes they will take precedence, so if that is the case, you can add the route to <tt>config/routes.rb</tt> manually like so:
+   gem 'ajax'
 
-    YourAppName::Application.routes.draw do
-      Ajax::Routes.draw(self)
-    end
+Then run +bundle+.
 
-=== Rails 2
+=== Rails 2 Gem
 
-<b> As a Gem</b>
+1. Follow the Rails 3 install if you are using a <tt>Gemfile</tt>.
 
-1. Add the gem as a dependency in your <tt>config/environment.rb</tt>
+   If you are not using a <tt>Gemfile</tt> add the gem to your <tt>config/environment.rb</tt> configuration block with:
 
      config.gem 'ajax'
 
-2. <tt>rake gems:install</tt>
+   Then run <tt>rake gems:install</tt>.
 
-3. Add to your <tt>Rakefile</tt>
+2. Include the gem's Rake tasks in your <tt>Rakefile</tt>:
 
      begin
        require 'ajax/tasks'
@@ -51,72 +48,105 @@ As of May 2010 Ajax is being used live in production on kazaa.com[http://www.kaz
        puts "Warning, couldn't load gem tasks: #{e.message}! Skipping..."
      end
 
-4. <tt>rake ajax:install</tt> to install required files.  This command is safe to run multiple times.  It will skip existing files.
+3. Add a route for the framework path to your <tt>config/routes.rb</tt>:
+
+     ActionController::Routing::Routes.draw do |map|
+       Ajax::Routes.draw(map)
+     end
+
+=== Rails 2 Plugin
+
+Run <tt>script/plugin install http://github.com/kjvarga/ajax.git</tt> from your application's root directory.
+
+== Getting Started
+
+1. First run <tt>rake -T ajax</tt> to see the Rake tasks provided and to verify that the gem and its Rake tasks are being included properly.
+
+
+2. Run <tt>rake ajax:install</tt> to install required asset files into various application directories.  The output from running the command will list the files that are created.
+
+3. Run <tt>rake routes</tt> to verify that the <tt>/ajax/framework</tt> path is being routed correctly.  It should route to <tt>AjaxController#framework</tt>.
+
+   The route will automatically be added to your application if you are running Rails 3 or Ajax is installed as a plugin.  If you are running Rails 2 you must add it to your routes file yourself.
+
+   If you have catch-all routes they may take precedence, so if that is the case you will have to add it to the top of your <tt>config/routes.rb</tt> to ensure it comes first.
 
-4. Add a route for the framework path to your <tt>config/routes.rb</tt>
+   <b>Rails 2</b>:
 
     ActionController::Routing::Routes.draw do |map|
       Ajax::Routes.draw(map)
     end
 
-5. Run <tt>rake routes</tt> to verify that the <tt>/ajax/framework</tt> path is being routed correctly.
+   <b>Rails 3</b>:
 
-<b> As a Plugin</b>
+    YourAppName::Application.routes.draw do
+      Ajax::Routes.draw(self)
+    end
 
-1.  ./script/plugin install http://github.com/kjvarga/ajax.git
-2.  Run <tt>rake routes</tt> to verify that the <tt>/ajax/framework</tt> path is being routed correctly.
+5. Include the JavaScript files in your application layout file:
 
-=== Rake Tasks
+     # app/views/layouts/application.html.erb
+     <%= javascript_include_tag 'jquery', 'jquery.json-2.2.min', 'jquery.address-1.3', 'ajax', 'application' %>
 
-  $ rake -T ajax
-  rake ajax:install            # Install required Ajax files.
-  rake ajax:install:specs      # Copy Ajax integration spec into spec/integration/ajax_spec.rb.
-  rake ajax:update:javascript  # Overwrite public/javascripts/ajax.js with the latest version.
+   While you are in this file, add a container element that will be the default container to receive content loaded via the Ajax framework.  Usually this is the main body of the page below the header.  For example:
 
-  $ rake ajax:install
-  created: app/controllers/ajax_controller.rb
-  created: app/views/ajax/framework.html.erb
-  created: config/initializers/ajax.rb
-  created: public/javascripts/ajax.js
-  created: public/javascripts/jquery.address-1.3.js
-  created: public/javascripts/jquery.address-1.3.min.js
-  created: public/javascripts/jquery.json-2.2.min.js
-  created: public/images/ajax-loading.gif
+     # app/views/layouts/application.html.erb
+     <div id="main">
+       <%= yield %>
+     </div>
 
-  $ rake ajax:install:specs
-  already exists: spec/integration/ajax_spec.rb
 
-  $ rake ajax:update:javascript
-  created: public/javascripts/ajax.js
+   NOTE: jQuery is NOT provided for you by the install.  You will need to download it to your <tt>public/javascripts</tt> directory yourself.
 
-== Getting Started
+6. Instantiate an instance of the Ajax JavaScript class in your <tt>application.js</tt>.  This object will handle clicks on links, communication with the server and provide methods that you can use for custom behaviour.
 
-1. Include the JavaScript assets in your <tt>app/views/layouts/application.html.erb</tt> file.  For example:
+   An example of creating the Ajax instance:
 
-    <%= javascript_include_tag 'jquery', 'jquery.address-1.3', 'ajax', 'application' %>
+      // public/javascripts/application.js
+      if (typeof(Ajax) != 'undefined') {
+        window.ajax = new Ajax({
+          default_container: '#main',  // jQuery selector of your container element
+          enabled: true,               // Enable/disable the plugin
+          lazy_load_assets: false      // YMMV
+        });
+      }
 
-1. Ajax looks for a layout to use for an Ajax request in <tt>app/views/layouts/ajax/</tt>.  It looks for a layout with the same name as the default Rails layout for that action.  So copy your existing layouts into <tt>layouts/ajax/</tt> and get them ready for Ajax by removing any excess HTML, leaving just the content that will be inserted into the container.
+   Make sure you set your <b>default_container</b> correctly.  The selector you use must match the container element you added in <tt>app/views/layouts/application.html.erb</tt> in the previous step.
 
-   Your main layout should contain a container element to receive page content.  Typically this would be a container below your page header.  If you don't have a static header, you can make the whole BODY element the container.
+7. Ajax should now be installed and configured and ready to handle requests.  Start your Rails server, open your favorite browser and load the home page.  Using the browser's developer tools take a look at the console.  You should not see any JavaScript errors.
 
-   Here is an {example of converting our <tt>layouts/application.html.haml</tt> to <tt>layouts/ajax/application.html.haml</tt>}[http://gist.github.com/373133/5a80a63ef69a883ed3c5630b68330b1036ad01ec].
+   If everything is working correctly when you load the root url <tt>/</tt> the URL should change to <tt>/#</tt> and you should see some output in the console like:
 
-2. Instantiate an instance of the Ajax class in <tt>public/javascripts/application.js</tt>.  For example:
+    [ajax] loadPage /
+    GET http://localhost:3000/?_=1304973841796
+    [ajax] in response handler! status: 200
+    [ajax] extracted body [6..1828] chars
+    [ajax] using container #main
+    [ajax] got ajax-info Object {}
 
-    // public/javascripts/application.js
-    if (typeof(Ajax) != 'undefined') {
-      window.ajax = new Ajax({
-        default_container: '#main',  // jQuery selector of your container element
-        enabled: true,               // Enable/disable the plugin
-        lazy_load_assets: false      // YMMV
-      });
-    }
+   In the server logs your should see two requests.  One is a normal GET request for <tt>/</tt> which should be processed by <tt>AjaxController#framework</tt> and another which is an AJAX GET request also for <tt>/</tt> which is handled by whatever you have set your application's root path handler to.
 
-3. Add a <tt>data-deep-link</tt> attribute to links that you want to load using the Ajax framework.  A jQuery live event automatically intercepts all clicks on links with this attribute and loads their content using the framework.
+   Congratulations on getting everything setup and working!  Now you can start customizing your setup further and adding new functionality.
 
-   By default all links that use the Rails link helpers will include this attribute, so you won't need to do anything.  When a link with this attribute is clicked, content is requested using AJAX and goes through the Ajax framework.  Rails receives a request for content at the <tt>data-deep-link</tt> location.  The content is rendered using the default layout for the action but from the <tt>app/views/layouts/ajax</tt> directory.  The rendered content is received client-side and special Ajax headers are processed.  The content is then inserted into the specified container, or the <tt>default_container</tt> defined in your Ajax JS class above.
+8. At this point it is a good idea to include the Ajax integration specs in your application to ensure that Ajax is properly integrated going forward.  If you are running RSpec 1 or 2 this is as simple as running:
 
-4. To submit forms using the Ajax framework, or to manually request content using various request methods, you can call <tt>window.ajax.loadPage</tt>, passing in options like _url_, _method_ and _data_.
+     rake ajax:install:specs
+
+   This adds <tt>spec/integration/ajax_spec.rb</tt> to your specs.  Run your specs and verify that they are all passing.
+
+== Next Steps
+
+1. Ajax looks for a layout to use for an Ajax-handled request in <tt>app/views/layouts/ajax/</tt>.  It looks for a layout with the same name as the  Rails layout that is configured for that action.  So copy your existing layouts into <tt>layouts/ajax/</tt> and get them ready by removing all the excess HTML, like the HEAD section and the BODY element.  You want to leave just the HTML content that will be inserted into your container element.
+
+   Here is an {example of converting our <tt>layouts/application.html.haml</tt> to <tt>layouts/ajax/application.html.haml</tt>}[http://gist.github.com/373133/5a80a63ef69a883ed3c5630b68330b1036ad01ec].
+
+2. Add a <tt>data-deep-link</tt> attribute to links that you want to load using the Ajax framework.  A jQuery live event automatically intercepts all clicks on links with this attribute and loads their content using the framework.
+
+   By default all links that use the Rails link helpers will include this attribute, so you won't need to do anything.
+
+   When a link with this attribute is clicked, content is requested using AJAX and goes through the Ajax framework.  Rails receives a request for content at the <tt>data-deep-link</tt> location.  The content is rendered using the default layout for the action but from the <tt>app/views/layouts/ajax</tt> directory.  The rendered content is received client-side and special Ajax headers are processed.  The content is then inserted into the specified container, or the <tt>default_container</tt> defined in your Ajax JS class above.
+
+4. To submit forms using the Ajax framework, or to manually request content using various request methods, you can call <tt>window.ajax.loadPage</tt>, passing in options like +url, +method+ and +data+.
 
    For example to handle form submissions with Ajax, you could use code like the following:
 
@@ -136,6 +166,23 @@ As of May 2010 Ajax is being used live in production on kazaa.com[http://www.kaz
       # app/views/layouts/ajax/two_column.html.haml
       ajax_header :container, '#twocolumns'
 
+   Ajax provides helper methods for you to use.  In your controllers you can call <tt>ajax_header</tt> and <tt>ajax_layout</tt> to add configuration for the whole controller or on a per-action basis:
+
+   For example:
+      # app/controllers/application_controller.rb
+      ApplciationController < ActionController::Base
+        ajax_header :tab, "#app-tab"
+
+        def maintenance
+          ajax_layout :maintenance
+          render
+        end
+      end
+
+   In your views you only have access to <tt>ajax_header</tt>.
+
+   Lots of other useful methods are provided by the <tt>Ajax<tt> module.  Take a look at the documentation for more information.
+
 6. Specify tabs that should be activated on a per-action, per-controller or dynamic basis using the <tt>ajax_header :tab, '<jquery css selector>'</tt> helper method.  The element(s) that match the selector will have their _activate_ event triggered, so you will need to setup an event handler.
 
    For example:
@@ -248,6 +295,39 @@ The following JavaScript libraries are required and included in the plugin:
 
 Please browse the {API documentation at rDoc.info}[http://rdoc.info/projects/kjvarga/ajax]
 
+=== Rake Tasks
+
+Here are the rake tasks provided and sample output from running them.
+
+To see the tasks provided:
+
+  $ rake -T ajax
+  rake ajax:install            # Install required Ajax files.
+  rake ajax:install:specs      # Copy Ajax integration spec into spec/integration/ajax_spec.rb.
+  rake ajax:update:javascript  # Overwrite public/javascripts/ajax.js with the latest version.
+
+The install task:
+
+  $ rake ajax:install
+  created: app/controllers/ajax_controller.rb
+  created: app/views/ajax/framework.html.erb
+  created: config/initializers/ajax.rb
+  created: public/javascripts/ajax.js
+  created: public/javascripts/jquery.address-1.3.js
+  created: public/javascripts/jquery.address-1.3.min.js
+  created: public/javascripts/jquery.json-2.2.min.js
+  created: public/images/ajax-loading.gif
+
+Copy an integration RSpec into your <tt>spec/</tt> directory:
+
+  $ rake ajax:install:specs
+  already exists: spec/integration/ajax_spec.rb
+
+Update the <tt>ajax.js</tt> javascript file:
+
+  $ rake ajax:update:javascript
+  created: public/javascripts/ajax.js
+
 == Configuration
 
 It is important to be able to disable the plugin when you don't want it interfering, like when you are testing.  You will also want to ensure that your site's JavaScript still works when the plugin is disabled.
@@ -485,7 +565,7 @@ not have been integrated.  In this case you can force re-integration by calling:
 
   Ajax::RSpec.setup
 
-* See <tt>Ajax::RSpec::Helpers</tt> and <tt>Ajax::RSpec::Extension</tt> {in the rdocs}[http://rdoc.info/projects/kjvarga/ajax]
+See <tt>Ajax::RSpec::Helpers</tt> and <tt>Ajax::RSpec::Extension</tt> {in the rdocs}[http://rdoc.info/projects/kjvarga/ajax]
 
 == Contributions
 

data/VERSION

@@ -1 +1 @@
-1.1.5
+1.1.6

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

@@ -0,0 +1 @@
+<%= yield %>

data/lib/ajax/action_controller.rb

@@ -67,7 +67,7 @@ module Ajax
       #
       # This method only applies to Rails < 3
       def redirect_to_full_url_with_ajax(url, status)
-        if !_ajax_redirect(url, status)
+        if !_ajax_redirect(url)
           redirect_to_full_url_without_ajax(url, status)
         end
       end
@@ -114,8 +114,9 @@ module Ajax
     module Rails3
       # Rails 3 hook.  Rails < 3 is handled using redirect_to_full_url.  See
       # those docs for info.
-      def redirect_to(url={}, status={})
-        if !_ajax_redirect(url, status)
+      def redirect_to(options = {}, response_status = {})
+        url = _compute_redirect_to_location(options)
+        if !_ajax_redirect(url)
           super
         end
       end
@@ -155,7 +156,7 @@ module Ajax
     # Perform special processing on the response if we need to.
     # Return true if an Ajax "redirect" was performed, and false
     # otherwise.
-    def _ajax_redirect(url, status)
+    def _ajax_redirect(url)
       return false if url.nil? || !Ajax.is_enabled?
       special_redirect = false
       original_url = url

data/lib/ajax/helpers/task_helper.rb

@@ -2,14 +2,16 @@ module Ajax
   module Helpers
     module TaskHelper
       INSTALL_FILES = %w[
+        app/views/layouts/ajax/application.html.erb
         app/controllers/ajax_controller.rb
         app/views/ajax/framework.html.erb
         config/initializers/ajax.rb
+        public/images/ajax-loading.gif
         public/javascripts/ajax.js
         public/javascripts/jquery.address-1.3.js
         public/javascripts/jquery.address-1.3.min.js
         public/javascripts/jquery.json-2.2.min.js
-        public/images/ajax-loading.gif]
+      ]
 
       UPDATE_JAVASCRIPT_FILES = %w[
         public/javascripts/ajax.js]

data/lib/ajax/rspec/extension.rb

@@ -1,23 +1,23 @@
 module Ajax
   module RSpec
     module Extension
+      # Enable and unmock
       def integrate_ajax
         Ajax.enabled = true
+        Ajax.mocked = false
       end
 
+      # Disable
       def disable_ajax
         Ajax.enabled = false
       end
+      alias_method :unmock_ajax, :disable_ajax
 
+      # Enable and mock
       def mock_ajax
-        integrate_ajax
+        Ajax.enabled = true
         Ajax.mocked = true
       end
-
-      def unmock_ajax
-        disable_ajax
-        Ajax.mocked = false
-      end
     end
   end
-end
+end

data/public/javascripts/ajax.js

@@ -338,7 +338,7 @@ var Ajax = function(options) {
   self.addressChanged = function() {
     if (document.location.pathname != '/') { return false; }
     if (self.disable_next_address_intercept) {
-      console.log('skipping address intercept & resetting disable_next_address_intercept');
+      console.log('[ajax] skipping address intercept & resetting disable_next_address_intercept');
       self.disable_next_address_intercept = false;
       return false;
     }
@@ -357,14 +357,14 @@ var Ajax = function(options) {
     // Clean up the URL before making the request.  If the URL changes
     // as a result of this, update it, which will trigger this
     // callback again.
-    console.log('cleaning up the url');
+    //console.log('cleaning up the url');
     var url = ($.address.value()).replace(/\/\//, '/');
     if (url != $.address.value()) {
-      console.log('reloading because encoded uri ' + url + ' differs from current uri ' + $.address.value());
+      console.log('[ajax] reloading because encoded uri ' + url + ' differs from current uri ' + $.address.value());
       $.address.value(url);
       return false;
     } else {
-      console.log('going ahead with load');
+      //console.log('going ahead with load');
       self.loadPage({
         url: url
       });
@@ -501,13 +501,13 @@ var Ajax = function(options) {
     }
     if (document.location.pathname != '/') {
       var url = ('/#/' + ajax_url).replace(/\/\//, '/');
-      console.log('linkClicked 1: going to ' + url);
+      //console.log('linkClicked 1: going to ' + url);
       document.location.href = url;
     } else {
       self.last_click_coords = { pageX: event.pageX, pageY: event.pageY };
       encoded_url = ajax.safeURL(ajax_url);
-      console.log('linkClicked 2: going to ' + ajax_url);
-      console.log('untouched url is ' + ajax_url + ', encoded is ' + encoded_url);
+      //console.log('linkClicked 2: going to ' + ajax_url);
+      //console.log('untouched url is ' + ajax_url + ', encoded is ' + encoded_url);
       if ($.browser.msie) {
         $.address.value(encoded_url);
       }
@@ -537,15 +537,15 @@ var Ajax = function(options) {
   self.responseHandler = function(responseText, textStatus, XMLHttpRequest) {
 
     self.last_request_object = XMLHttpRequest;
-    console.log("[AJAX] in response handler! status: " + self.last_request_object.status);
+    console.log("[ajax] in response handler! status: " + self.last_request_object.status);
     if(self.last_request_object.status == 0) {
-      console.log("[AJAX] aborting response handler! ");
+      console.log("[ajax] aborting response handler! ");
       return;
     }
     var data = self.processResponseHeaders(XMLHttpRequest);
 
     if (data.soft_redirect !== undefined) {
-      console.log('**** data.soft_redirect is ' + data.soft_redirect);
+      console.log('[ajax] issuing soft redirect to ' + data.soft_redirect);
       $.address.value(data.soft_redirect);
       return;
     };
@@ -561,7 +561,7 @@ var Ajax = function(options) {
       start += responseText.match(/<\s*body[^>]*>/)[0].length;
       var end   = responseText.search(/<\s*\/\s*body\s*\>/);
 
-      console.log('Extracting body ['+start+'..'+end+'] chars');
+      console.log('[ajax] extracted body ['+start+'..'+end+'] chars');
       responseText = responseText.substr(start, end - start);
 
       var body = $(responseText);
@@ -576,14 +576,14 @@ var Ajax = function(options) {
     //  assets   - load assets
     //  callbacks - execute one or an array of callbacks
     if (data.title !== undefined) {
-      console.log('Using page title '+data.title);
+      console.log('[ajax] set page title '+data.title);
       // commenting this out until we fix ' char bug, removing % chars from page titles for now
       // $.address.title(encodeURIComponent(data.title));
       $.address.title(data.title);
     }
 
     if (data.tab !== undefined) {
-      console.log('Activating tab '+data.tab);
+      console.log('[ajax] activated tab '+data.tab);
       $(data.tab).trigger('activate');
     }
 
@@ -605,8 +605,8 @@ var Ajax = function(options) {
     /**
      * Insert response
     */
-    console.log('Using container ',container.selector);
-    console.log('Set data ',data);
+    console.log('[ajax] using container ', container.selector);
+    console.log('[ajax] got ajax-info ', data);
     container.data('ajax-info', data);
     container.html(responseText);
 
@@ -649,7 +649,7 @@ var Ajax = function(options) {
     try {
       var cookie = XMLHttpRequest.getResponseHeader('Set-Cookie');
       if (cookie !== null) {
-        console.log('Setting cookie');
+        console.log('[ajax] attempting to set cookie');
         document.cookie = cookie;
       }
     } catch(e) {
@@ -666,7 +666,7 @@ var Ajax = function(options) {
     if (data !== null) {
       try { data = jQuery.parseJSON(data); }
       catch(e) {
-        console.log('Failed to parse Ajax-Info header as JSON!', data);
+        console.log('[ajax] failed to parse Ajax-Info header as JSON!', data);
       }
     }
     if (data === null || data === undefined) {
@@ -683,7 +683,7 @@ var Ajax = function(options) {
   self.hideLoadingImage = function() {
     // check if a new request has already started
     if (self.current_request && self.current_request.status == 0) {
-      console.log("[AJAX] aborting hideLoadingImage.. ");
+      console.log("[ajax] aborting hideLoadingImage.. ");
       return;
     }
     if (!self.show_loading_image) { return; }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ajax
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 1
   - 1
-  - 5
-  version: 1.1.5
+  - 6
+  version: 1.1.6
 platform: ruby
 authors: 
 - Karl Varga
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-08 00:00:00 -07:00
+date: 2011-05-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -77,6 +77,7 @@ files:
 - VERSION
 - app/controllers/ajax_controller.rb
 - app/views/ajax/framework.html.erb
+- app/views/layouts/ajax/application.html.erb
 - config/initializers/ajax.rb
 - init.rb
 - lib/ajax.rb
@@ -93,7 +94,6 @@ files:
 - lib/ajax/rspec.rb
 - lib/ajax/rspec/extension.rb
 - lib/ajax/rspec/helpers.rb
-- lib/ajax/rspec/integration.rb
 - lib/ajax/tasks.rb
 - lib/rack-ajax.rb
 - lib/rack-ajax/decision_tree.rb