ajax 0.1.4 → 0.1.5

data/README.rdoc

@@ -1,12 +1,12 @@
 = Ajax
 
-<b>A Ruby on Rails plugin to augment a traditional Rails application with a completely AJAX frontend, while transparently handling issues important to both the enterprise and end users, such as testing, SEO and browser history.</b>
+<b>Ajax augments a traditional Rails application with a completely AJAX frontend, while transparently handling issues important to both the enterprise and end users. Issues like SEO/Crawlability, browser history, deep-linking and testing.</b>
 
-The Ajax philosophy is that you shouldn't have to develop for AJAX:  Your code shouldn't change; your tests shouldn't change; and the way Google sees your site shouldn't change.
+The Ajax philosophy is that <b>you shouldn't have to develop for AJAX</b>:  Your code shouldn't change; your tests shouldn't change; and the way Google sees your site shouldn't change (ed: this may {change}[]).
 
 The beauty of Ajax is that your Rails application only ever sees traditional requests, so it does not have to be "Ajax aware".
 
-Ajax is being used live in production on altnet.com[http://altnet.com], if you would like to try it out (as of May 1st 2010 or thereabouts).
+As of the end of April, 2010, Ajax is being used live in production on altnet.com[http://altnet.com].  Try it out and create a wicked playlists while you're at it!
 
 == Install
 
@@ -18,7 +18,7 @@ Ajax is being used live in production on altnet.com[http://altnet.com], if you w
 
 2. <tt>bundle install</tt>
 3. <tt>rake ajax:install</tt>
-    
+
 === Rails 2.x.x
 
 <b> As a Gem</b>
@@ -70,10 +70,10 @@ Ajax is being used live in production on altnet.com[http://altnet.com], if you w
         enabled: true,
         lazy_load_assets: false
       });
-   
+
 == Introduction
 
-Ajax handles these common problems:
+=== Features and Support
 
 * SEO/Crawlability/Google Analytics support
 * Browser History
@@ -83,12 +83,13 @@ Ajax handles these common problems:
 * Lazy-loaded Assets
 * Activating Tabs
 * Request Rewriting & Redirecting
+* <b>{Jammit}[http://documentcloud.github.com/jammit/] compatible</b> with {these new helpers}[http://github.com/kjvarga/jammit/commit/27d5f27f4c6d4347c444b5e1a42dbb7c6c85462c].  Also supported are stylesheets with embedded images.
 
-Ajax converts a traditional Rails application to use a completely AJAX frontend.
+<b>Ajax augments a traditional Rails application with a completely AJAX frontend.</b>
 
 What do I mean by "completely AJAX"?  Everyone uses AJAX.  What we mean when we say "completely AJAX" is that the main page is only loaded once.  Every link now loads content via AJAX.
 
-But if we do that, the URL will never change and we will have no history, because that is how browsers determine history.  It turns out the only way to change the URL without causing the browser to issue a new request, is to modify the named anchor - or "hashed" - part of the URL.  
+But if we do that, the URL will never change and we will have no history, because that is how browsers determine history.  It turns out the only way to change the URL without causing the browser to issue a new request, is to modify the named anchor - or "hashed" - part of the URL.
 
 So now your traditional links auto-magically load content via AJAX into a page container and update the browser URL with the new URL.  You have all the benefits of AJAX as well as history and link bookmarkability.
 
@@ -120,17 +121,19 @@ By default the current layout is sent in the <tt>Ajax-Info</tt> header.  This ca
 
 [title]      Sets the page title.
 [tab]        jQuery selector, triggers the <tt>activate</tt> event on matched element(s).
-[container]  jQuery selector, the container to receive the content (default:  <tt>default_container</tt>).
+[container]  jQuery selector, the container to receive the content (default:  <tt>ajax.default_container</tt>).
 [assets]     Hash of JavaScript and CSS assets to load <tt>{ :javascripts => [], :stylesheets => [] }</tt>
 [callbacks]  List of string callbacks to execute after assets have finished loading.
 
 === Robots and External APIS
 
-<b>We detect robots by their User-Agent strings.</b>  If a robot is detected the Ajax handling is bypassed and the robot sees the traditional Rails application.
+<b>We detect robots by their User-Agent strings.</b>  If a robot is detected the Ajax handling is bypassed and the robotsees the traditional Rails application.  The robot will see traditional links and requests for those pages will load traditionally and bypass all Ajax handling.
+
+Check out the {robot User-Agent detection}[http://github.com/kjvarga/ajax/blob/master/lib/ajax/helpers/robot_helper.rb].   If we cannot identify a robot, the robot will receive a redirect on each request for a traditional URL.  Requests for hashed URLs will only render the framework because there will be no JavaScript to trigger loading the inner contents.  It's important that the User-Agent list be kept up-to-date, or some other method of detecting robots is found.  IP address perhaps?
 
-By default any AJAX or non-GET requests pass through unmodified.
+<b>By default any AJAX or non-GET requests pass through unmodified.</b>
 
-If you need to expose external APIs you can do so using a regular expression that is matched against incoming URLs.
+If you need to expose external APIs you can do so using a regular expression that is matched against incoming URLs.  See <b>Documentation->Configuration->Excepted Links</b>.
 
 == Compatibility
 
@@ -145,7 +148,7 @@ The following JavaScript libraries are required and included in the plugin:
 
   * Rails 2.3.4 running Ruby 1.8.7 and Ruby 1.9
   * Rails 2.3.5 running Ruby 1.8.7 and Ruby 1.9
-  
+
 === Browsers:
 
 (See {jQuery address supported browsers}[http://www.asual.com/jquery/address/docs/].)
@@ -170,7 +173,7 @@ It is important to be able to disable the plugin when you don't want it interfer
 <b>Callbacks added directly to the <tt>window.ajax</tt> instance will still be executed, and they will execute immediately.</b>
 
 To disable the plugin in your environment file:
-  
+
   # config/environments/test.rb
   Ajax.enabled = false
 
@@ -225,7 +228,7 @@ Links can be excepted by passing in strings or regular expressions to <tt>Ajax.e
   # config/initializers/ajax.rb
   Ajax.exclude_paths %w[ /login /logout /signup /altnet-pro /my-account/edit /user-session/new ]
   Ajax.exclude_paths [%r[\/my-account\/.*]]
-  
+
 Typically, we except pages that require HTTPS, like signup forms, because including secure forms on an insecure page often triggers a browser warning.
 
 Excepted links when rendered do not contain the <tt>data-deep-link</tt> attribute if they are rendered with the <tt>link_to</tt> (or any other url) helper method.
@@ -241,11 +244,11 @@ You can use <tt>Ajax.get_header</tt> to inspect <tt>Ajax-Info</tt> header values
 In controllers, <tt>ajax_header</tt> uses an <tt>after_filter</tt> to add content to the response.  It therefore accepts passing a block instead of a static value, as well as <tt>:only</tt> and <tt>:except</tt> modifiers, e.g:
 
   # app/controllers/application_controller.rb
-  ajax_header :title { dynamic_page_attribute(:page_title) || "Music @ Altnet" }  
+  ajax_header :title { dynamic_page_attribute(:page_title) || "Music @ Altnet" }
   ajax_header :assets do
     { :stylesheets => [current_controller_stylesheet] }
   end
-  
+
   # app/controllers/browse_controller.rb
   ajax_header :tab, '#header .nav li:contains(Music)', :only => [:music, :artists, :albums, :tracks, :new_releases]
   ajax_header :tab, '#header .nav li:contains(Playlists)',  :only => :playlists
@@ -254,7 +257,7 @@ In controllers, <tt>ajax_header</tt> uses an <tt>after_filter</tt> to add conten
   # app/controllers/activity_controller.rb
   ajax_header :tab, '#header .nav li:contains(Realtime)'
   ajax_header :assets, { :javascripts => javascript_files_for_expansion(:juggernaut_jquery) }
-  
+
 Array and Hash values are merged so you can call <tt>ajax_header</tt> multiple times.  For example, the asset Hash and Array values will be merged.
 
 === In Views
@@ -308,7 +311,7 @@ You can bind callbacks directly to the <tt>window.ajax</tt> object in your view,
     window.ajax.prependOnLoad(function() {
       $(document).trigger('player.init');
     });
-  
+
 In the <tt>onLoad</tt> callback I'm scoping everything to <tt>window</tt> to <b>avoid scoping issues</b> in different browsers.
 
 <b><tt>window.ajax.prependOnLoad</tt><b> adds the callback to the front of the queue.

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.5

data/app/controllers/ajax_controller.rb

@@ -1,3 +1,14 @@
 class AjaxController < ApplicationController
-  unloadable
+  after_filter :clear_return_to
+
+  # Don't return to the framework path, return to root
+  def clear_return_to
+    return unless Ajax.is_enabled?
+    if session[:return_to] =~ %r[#{Ajax.framework_path}]
+      session[:return_to] = session[:return_to].sub(%r[#{Ajax.framework_path}], '/')
+      Rails.logger.info("[ajax] return_to / instead of #{Ajax.framework_path}")
+    end
+  end
+
+  unloadable # needed when installed as a plugin
 end

data/config/initializers/ajax.rb

@@ -5,7 +5,7 @@
 #   Ajax.exclude_paths %w[ /login /logout /signup /user-session/new ]
 #   Ajax.exclude_paths [%r[\/my-account\/.*]]
 
-# If you use a custom <tt>Rack::Ajax.decision_tree</tt>, include your 
+# If you use a custom <tt>Rack::Ajax.decision_tree</tt>, include your
 # parser extensions in the Rack::Ajax::Parser module.
 #
 # The extensions define custom methods that are used in the

data/lib/ajax.rb

@@ -2,9 +2,14 @@ require 'ajax/helpers'
 
 module Ajax
   include Ajax::Helpers
-  
+
   class << self
-    attr_writer :logger
+    attr_writer :logger, :framework_path
+  end
+
+  # Return the full path to the root of the Ajax plugin/gem directory.
+  def self.root
+    @root ||= File.expand_path(File.join(File.dirname(__FILE__), '..'))
   end
 
   # Return a logger instance.
@@ -28,7 +33,7 @@ module Ajax
   class << self
     alias_method :enabled?, :is_enabled?
   end
-  
+
   # Set to false to disable this plugin completely.
   #
   # ActionController and ActionView helpers are still mixed in but
@@ -38,6 +43,13 @@ module Ajax
     @enabled = !!value
   end
 
+  # Return the path to the framework page.
+  #
+  # Default: <tt>/ajax/framework</tt>
+  def self.framework_path
+    @framework_path ||= '/ajax/framework'
+  end
+
   # Return a boolean indicating whether to enable lazy loading assets.
   # There are currently issues with some browsers when using this feature.
   #
@@ -55,7 +67,7 @@ module Ajax
   def self.lazy_load_assets=(value)
     @lazy_load_assets = !!value
   end
-  
+
   # Return a boolean indicating whether the plugin is being mock tested.
   #
   # Mocking forces the environment to be returned after Ajax processing

data/lib/ajax/action_controller.rb

@@ -1,6 +1,6 @@
 module Ajax
   module ActionController
-    def self.included(klass)      
+    def self.included(klass)
       klass.class_eval do
         alias_method_chain :render, :ajax
         alias_method_chain :redirect_to_full_url, :ajax
@@ -62,16 +62,23 @@ module Ajax
       def redirect_to_full_url_with_ajax(url, status)
         return redirect_to_full_url_without_ajax(url, status) unless Ajax.is_enabled?
         raise DoubleRenderError if performed?
-        
+
+        original_url = url
         if url == request.headers["Referer"] && !request.headers['Ajax-Info'].blank?
           url = request.headers['Ajax-Info']['referer']
           Ajax.logger.debug("[ajax] using referer #{url} from Ajax-Info")
         end
 
-        if !Ajax.exclude_path?(url) && !Ajax.is_hashed_url?(url)
-          url = Ajax.hashed_url_from_traditional(url)
-          Ajax.logger.info("[ajax] rewrote redirect to #{url}")
+        if !Ajax.exclude_path?(url)
+          if url =~ %r[#{Ajax.framework_path}]
+            url = url.sub(%r[#{Ajax.framework_path}], '/')
+          end
+
+          if !Ajax.is_hashed_url?(url)
+            url = Ajax.hashed_url_from_traditional(url)
+          end
         end
+        Ajax.logger.info("[ajax] rewrote redirect from #{original_url} to #{url}")
 
         session[:redirected_to] = url
         if request.xhr?
@@ -94,7 +101,7 @@ module Ajax
       #
       def render_with_ajax(options = nil, extra_options = {}, &block)
         return render_without_ajax(options, extra_options, &block) unless Ajax.is_enabled?
-        
+
         original_args = [options, extra_options]
         if request.xhr?
 

data/lib/ajax/helpers.rb

@@ -1,6 +1,6 @@
-require 'ajax/helpers/request_helper'
-require 'ajax/helpers/robot_helper'
-require 'ajax/helpers/url_helper'
+Dir[File.join(File.dirname(__FILE__), 'helpers', '*')].map do |file|
+  require file
+end
 
 module Ajax #:nodoc:
   module Helpers #:nodoc:
@@ -8,8 +8,8 @@ module Ajax #:nodoc:
       klass.class_eval do
         extend RequestHelper
         extend RobotHelper
-        extend UrlHelper   
-      end     
+        extend UrlHelper
+      end
     end
   end
 end

data/lib/ajax/helpers/request_helper.rb

@@ -14,13 +14,22 @@ module Ajax
         end
       end
 
-      # Hash and/or Array values are merged so you can set multiple values
+      # Set the value at <tt>key</tt> in the <tt>Ajax-Info</tt> header
+      # in <tt>object</tt>.
+      #
+      # <tt>object</tt> can be a Hash or instance of <tt>ActionController::Request</tt>
+      # <tt>key</tt> Symbol or String hash key, converted to String
+      # <tt>value</tt> any value that con be converted to JSON
+      #
+      # All Hash and Array values are deep-merged.
+      # Hash keys are converted to Strings.
       def set_header(object, key, value)
         headers = object.is_a?(::ActionController::Response) ? object.headers : object
-        
+        key = key.to_s
+
         info = case headers["Ajax-Info"]
         when String
-          JSON.parse(headers["Ajax-Info"])
+          JSON.parse(headers["Ajax-Info"]) rescue {}
         when Hash
           headers["Ajax-Info"]
         else
@@ -28,34 +37,42 @@ module Ajax
         end
 
         # Deep merge hashes
-        if info.has_key?(key.to_s) &&
+        if info.has_key?(key) &&
             value.is_a?(Hash) &&
-            info[key.to_s].is_a?(Hash)
-          value = info[key.to_s].merge(value, &DEEP_MERGE)
+            info[key].is_a?(Hash)
+          value = value.stringify_keys!
+          value = info[key].merge(value, &DEEP_MERGE)
         end
 
         # Concat arrays
-        if info.has_key?(key.to_s) &&
+        if info.has_key?(key) &&
             value.is_a?(Array) &&
-            info[key.to_s].is_a?(Array)
-          value = info[key.to_s].concat(value)
+            info[key].is_a?(Array)
+          value = info[key].concat(value)
         end
-      
-        info[key.to_s] = value
+
+        info[key] = value
         headers["Ajax-Info"] = info.to_json
       end
 
+      # Return the value at key <tt>key</tt> from the <tt>Ajax-Info</tt> header
+      # in <tt>object</tt>.
+      #
+      # <tt>object</tt> can be a Hash or instance of <tt>ActionController::Request</tt>
+      # <tt>key</tt> Symbol or String hash key, converted to String
       def get_header(object, key)
         headers = object.is_a?(::ActionController::Request) ? object.headers : object
+        key = key.to_s
+
         info = case headers["Ajax-Info"]
         when String
-          JSON.parse(headers["Ajax-Info"])
+          JSON.parse(headers["Ajax-Info"]) rescue {}
         when Hash
           headers["Ajax-Info"]
         else
           {}
         end
-        info[key.to_s]
+        info[key]
       end
 
       # Set one or more paths that can be accessed directly without the AJAX framework.

data/lib/ajax/helpers/robot_helper.rb

@@ -7,6 +7,7 @@ module Ajax
         {:name => 'Gigabot', :user_agent_regex => /\bGigabot\b/i, :sample_agent_string => 'Gigabot'},
         {:name => 'libwww-perl', :user_agent_regex => /\blibwww-perl\b/i, :sample_agent_string => 'libwww-perl'},
         {:name => 'lwp-trivial', :user_agent_regex => /\blwp-trivial\b/i, :sample_agent_string => 'lwp-trivial'},
+        {:name => 'Lynx', :user_agent_regex => /\bLynx\b/i, :sample_agent_string => 'Lynx'},
         {:name => 'MSNBot', :user_agent_regex => /\bmsnbot\b/i, :sample_agent_string => 'msnbot'},
         {:name => 'SiteUptime', :user_agent_regex => /\bSiteUptime\b/i, :sample_agent_string => 'SiteUptime'},
         {:name => 'Slurp', :user_agent_regex => /\bSlurp\b/i, :sample_agent_string => 'Slurp'},
@@ -21,11 +22,11 @@ module Ajax
         end
         nil
       end
-    
+
       # Call with a User Agent string
       def is_robot?(user_agent)
         !!self.robot_for(user_agent)
-      end    
+      end
     end
   end
 end

data/lib/ajax/helpers/task_helper.rb

@@ -0,0 +1,54 @@
+module Ajax
+  module Helpers
+    module TaskHelper
+      INSTALL_FILES = %w[
+        app/controllers/ajax_controller.rb
+        app/views/ajax/framework.html.erb
+        config/initializers/ajax.rb
+        public/javascripts/ajax.js
+        public/javascripts/jquery.address-1.2rc.js
+        public/javascripts/jquery.address-1.2rc.min.js
+        public/javascripts/jquery.json-2.2.min.js
+        public/images/ajax-loading.gif]
+
+      UPDATE_JAVASCRIPT_FILES = %w[
+        public/javascripts/ajax.js]
+
+      def copy_unless_exists(file, from_dir=Ajax.root, to_dir=Rails.root)
+        from_file, to_file = File.join(from_dir, file), File.join(to_dir, file)
+        if File.exist?(to_file)
+          return false
+        else
+          FileUtils.mkdir_p(File.dirname(to_file)) unless File.directory?(File.dirname(to_file))
+          FileUtils.cp(from_file, to_file)
+          return true
+        end
+      rescue Exception => e
+        e
+      end
+
+      def copy_and_overwrite(file, from_dir=Ajax.root, to_dir=Rails.root)
+        from_file, to_file = File.join(from_dir, file), File.join(to_dir, file)
+        FileUtils.mkdir_p(File.dirname(to_file)) unless File.directory?(File.dirname(to_file))
+        FileUtils.cp(from_file, to_file)
+        return true
+      rescue Exception => e
+        e
+      end
+
+      def show_result(file)
+        result = yield file
+        return unless verbose
+
+        case result
+        when Exception
+          puts "skipped: #{file} #{result.message}"
+        when true
+          puts "created: #{file}"
+        else
+          puts "skipped: #{file}"
+        end
+      end
+    end
+  end
+end

data/lib/ajax/helpers/url_helper.rb

@@ -14,7 +14,7 @@ module Ajax
       def is_hashed_url?(url)
         !!(encode_and_parse_url(url).fragment=~ %r[^\/])
       end
-      
+
       # Return a hashed URL using the fragment of <tt>url</tt>
       def hashed_url_from_fragment(url)
         url_host(url) + ('/#/' + (encode_and_parse_url(url).fragment || '')).gsub(/\/\//, '/')
@@ -34,11 +34,11 @@ module Ajax
       end
 
       protected
-      
+
       def encode_and_parse_url(url)
         URI.parse(URI.encode(url).gsub("%23", "#"))
       end
-       
+
       def url_host(url)
         if url.match(/^(\w+\:\/\/[^\/]+)\/?/)
           $1

data/lib/ajax/routes.rb

@@ -1,12 +1,15 @@
+require 'ajax'
+
 module Ajax
   module Routes
     # In your <tt>config/routes.rb</tt> file call:
     #   Ajax::Routes.draw(map)
     # Passing in the routing <tt>map</tt> object.
     #
-    # Adds an <tt>ajax_framework_path</tt> pointing to <tt>/ajax/framework</tt>
+    # Adds an <tt>ajax_framework_path</tt> pointing to <tt>Ajax.framework_path</tt>
+    # which is <tt>/ajax/framework</tt> by default.
     def self.draw(map)
-      map.ajax_framework "/ajax/framework", :controller => 'ajax', :action => 'framework'
+      map.ajax_framework Ajax.framework_path, :controller => 'ajax', :action => 'framework'
     end
   end
 end

data/lib/ajax/spec/extension.rb

@@ -9,16 +9,16 @@ module Ajax
       def disable_ajax
         Ajax.enabled = false
       end
-      
+
       def mock_ajax
         integrate_ajax
         Ajax.mocked = true
       end
-      
+
       def unmock_ajax
         disable_ajax
         Ajax.mocked = false
-      end      
+      end
     end
   end
 end

data/lib/ajax/spec/helpers.rb

@@ -30,9 +30,9 @@ module Ajax
       end
 
       def should_set_ajax_request_header(key, value)
-        @env['Ajax-Info'][key].should == value
+        Ajax.get_header(@env, key).should == value
       end
-            
+
       def should_rewrite_to(url)
         should_be_a_valid_response
 

data/lib/rack-ajax.rb

@@ -5,7 +5,7 @@ require 'json'
 module Rack
   class Ajax
     extend Rack::Ajax::DecisionTree
-    
+
     cattr_accessor :decision_tree
     attr_accessor :user, :request, :params
 
@@ -13,8 +13,9 @@ module Rack
     # This is useful when testing.
     #
     # To integrate Rack::Ajax into your app you should store the decision
-    # tree in a class-attribute <tt>decision_tree</tt>.  This
-    # decision tree will be used unless a block is provided.
+    # tree in a class-attribute <tt>decision_tree</tt>.
+    #
+    # The <tt>default_decision_tree</tt> is used if no other is provided.
     def initialize(app)
       @app = app
       @decision_tree = block_given? ? Proc.new : (self.class.decision_tree || self.class.default_decision_tree)

data/lib/rack-ajax/decision_tree.rb

@@ -1,7 +1,7 @@
 module Rack
   class Ajax
     module DecisionTree
-      
+
       # Decision tree for Rack rewrites and redirects.
       #
       # To use your own decision tree set it on the <tt>Ajax</tt> instance with:
@@ -17,7 +17,7 @@ module Rack
         @@default_decision_tree ||= Proc.new do
           ::Ajax.logger.debug("[ajax] rack session #{@env['rack.session'].inspect}")
           ::Ajax.logger.debug("[ajax] Ajax-Info #{@env['Ajax-Info'].inspect}")
-        
+
           if !::Ajax.exclude_path?(@env['PATH_INFO'] || @env['REQUEST_URI'])
             if ajax_request?
               if hashed_url? # the browser never sends the hashed part
@@ -52,7 +52,7 @@ module Rack
                 end
               end
             end
-          end          
+          end
         end
       end
     end

data/lib/rack-ajax/parser.rb

@@ -40,7 +40,7 @@ module Rack
       # Inspect the headers first - if there are any - so we don't
       # look in the database unneccessarily.
       #
-      # Sets the result in a header {Ajax-Info}[user_is_robot] so we 
+      # Sets the result in a header {Ajax-Info}[user_is_robot] so we
       # don't have to repeat this check in the application.
       def user_is_robot?
         return @user_is_robot if instance_variable_defined?(:@user_is_robot)
@@ -53,7 +53,7 @@ module Rack
         ::Ajax.set_header(@env, :robot, @user_is_robot)
         @user_is_robot
       end
-      
+
       def rewrite_to_traditional_url_from_fragment
         rewrite(::Ajax.traditional_url_from_fragment(@env['REQUEST_URI']))
       end
@@ -73,7 +73,7 @@ module Rack
       end
 
       def rewrite_to_render_ajax_framework
-        rewrite('/ajax/framework')
+        rewrite(::Ajax.framework_path)
       end
 
       private
@@ -106,7 +106,7 @@ module Rack
         headers.reverse_merge!({'Content-Type' => 'text/html'})
         [code, headers, [msg.to_s]]
       end
-      
+
       def rack_response(*args)
         self.class.rack_response(*args)
       end

data/public/javascripts/ajax.js

@@ -172,9 +172,13 @@ var AjaxAssets = function(array, type) {
 };
 
 /**
- * Class Ajax
+ * = Class Ajax
+ *
+ * == Options
+ *
+ * We extend self with the <tt>options</tt> array.  This allows you to set 
+ * any instance variable on the instance.
  *
- * Options:
  *    <tt>enabled</tt>  boolean indicating whether the plugin is enabled.
  *      Callbacks that you set in the Ajax-Info header or directly on
  *      this instance will still be executed.  They will not be queued,
@@ -217,6 +221,9 @@ var AjaxAssets = function(array, type) {
  *
  *    window.ajax.prependOnLoad(function() { doSomething(args); });
  *
+ * We also trigger a global 'ajax.onload' event that you can bind to to execute
+ * a callback on every page load.
+ *
  * KJV 2010-04-22: I've experienced problems with Safari using String callbacks.  YMMV.
  * Browser support for callbacks is patchy at this time so lazy-loading is
  * not recommended.
@@ -226,12 +233,16 @@ var Ajax = function(options) {
   
   /**
    * Options
+   *
+   * Extend self with the options Array.  This allows you to set any instance
+   * variable on the Ajax instance.
    */
   self.options = {
     enabled: true,
     default_container: undefined,
     loaded_by_framework: false,
     show_loading_image: true,
+    disable_next_address_intercept: false,
     loading_image: 'img#ajax-loading',
     loading_image_path: '/images/ajax-loading.gif',
     javascripts: undefined,
@@ -239,7 +250,8 @@ var Ajax = function(options) {
     callbacks: [],
     loaded: false,
     lazy_load_assets: false,
-
+    current_request: undefined,
+    
     // For initial position of the loading icon.  Often the mouse does not
     // move so position it by the link that was clicked.
     last_click_coords: undefined
@@ -307,18 +319,44 @@ var Ajax = function(options) {
 
   /**
    * jQuery Address callback triggered when the address changes.
+   * Loads the current address using AJAX.
+   * 
+   * If the inner content was pre-rendered (as in after a redirect),
+   * then <tt>loaded_by_framwork</tt> should be false.
+   *
+   * jQuery Address will still fire a request when the page loads, 
+   * so we ignore that request if <tt>loaded_by_framwork</tt> is false.
    */
   self.addressChanged = function() {
     if (document.location.pathname != '/') { return false; }
-    if (window.ajax.disable_address_intercept == true) {return false;}
-    if (typeof(self.loaded_by_framework) == 'undefined' || self.loaded_by_framework != true) {
+    if (self.disable_next_address_intercept) {
+      self.disable_next_address_intercept = false;
+      return false;
+    }
+    if (!self.loaded_by_framework) {
       self.loaded_by_framework = true;
       return false;
     }
 
-    self.loadPage({
-      url: $.address.value().replace(/\/\//, '/')
-    });
+    // Ensure that the URL ends with '#' if we are on root. This
+    // will not trigger addressChanged().
+    if (document.location.pathname == '/' 
+      && document.location.href.indexOf('#') == -1) {
+      document.location.href = document.location.href + '#';
+    }
+    
+    // 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.
+    var url = encodeURI($.address.value()).replace(/\/\//, '/');
+    if (url != $.address.value()) {
+      $.address.value(url);
+      return false;
+    } else {    
+      self.loadPage({
+        url: url
+      });
+    }
     return true;
   };
 
@@ -339,22 +377,34 @@ var Ajax = function(options) {
    */
   self.loadPage = function(options) {
     if (!self.enabled) {
-      document.location = options.url;
+      document.location.href = options.url;
       return true;
     }
     self.loaded = false;
     self.showLoadingImage();
 
-    jQuery.ajax({
+    if (self.current_request !== undefined) {
+      try {
+        self.current_request.abort();
+        console.log('[ajax] aborting current request');
+      } catch(e) {
+        console.log('[ajax] abort failed!', e);
+      }
+    }
+    
+    self.current_request = jQuery.ajax({
+      cache: false,
       url: options.url,
       method: options.method || 'GET',
       beforeSend: self.setRequestHeaders,
       success: self.responseHandler,
+      dataType: 'html',
       complete: function(XMLHttpRequest, responseText) {
         // Scroll to the top of the page.
         $(document).scrollTop(0);
         self.hideLoadingImage();
         self.loaded = true;
+        self.current_request = undefined;
       },
       error: function(XMLHttpRequest, textStatus, errorThrown) {
         var responseText = XMLHttpRequest.responseText;
@@ -380,6 +430,15 @@ var Ajax = function(options) {
     XMLHttpRequest.setRequestHeader('AJAX_INFO', $.toJSON(data));
   };
 
+  /**
+   * host
+   *
+   * Return the current host with protocol and with no trailing slash.
+   */
+  self.host = function() {
+    return $.address.baseURL().replace(new RegExp(document.location.pathname), '');  
+  };
+  
   /**
    * linkClicked
    *
@@ -389,10 +448,8 @@ var Ajax = function(options) {
    */
   self.linkClicked = function(event) {
     if (document.location.pathname != '/') {
-      var url = $.address.baseURL().replace(new RegExp(document.location.pathname), '')
-      url += '/#/' + $(this).attr('data-deep-link');
-      url.replace(/\/\//, '/');
-      document.location = url;
+      var url = ('/#/' + $(this).attr('data-deep-link')).replace(/\/\//, '/');
+      document.location.href = url;
     } else {
       self.last_click_coords = { pageX: event.pageX, pageY: event.pageY };
       $.address.value($(this).attr('data-deep-link'));
@@ -412,7 +469,10 @@ var Ajax = function(options) {
     var container = data.container === undefined ? $(self.default_container) : $(data.container);
 
     // Redirect?  Let the JS execute.  It will set the new window location.
-    if (responseText && responseText.match(/try\s{\swindow\.location\.href/)) { return true; }
+    if (responseText && responseText.match(/try\s{\swindow\.location\.href/)) {
+      jQuery.globalEval(responseText);
+      return true;
+    }
 
     /**
      * Extract the body

data/rails/install.rb

@@ -1,23 +1,5 @@
-AJAX_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+require 'ajax'
+require 'rake'
 
-%w[
-  app/controllers/ajax_controller.rb
-  app/views/ajax/framework.html.erb   
-  config/initializers/ajax.rb   
-  public/javascripts/ajax.js
-  public/javascripts/jquery.address-1.2rc.js
-  public/javascripts/jquery.address-1.2rc.min.js
-  public/javascripts/jquery.json-2.2.min.js
-  public/images/ajax-loading.gif
-].each do |file|
-  if File.exist?(File.join(Rails.root, file))
-    puts "skipped: #{file} exists!"
-  else
-    begin
-      FileUtils.cp(File.join(AJAX_ROOT, file), File.join(Rails.root, file))
-      puts "created: #{file}"
-    rescue Exception => e
-      puts "skipped: #{file} #{e.message}"
-    end
-  end
-end
+load(File.join(Ajax.root, 'tasks', 'ajax_tasks.rake'))
+Rake::Task['ajax:install'].invoke

data/spec/ajax/ajax_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+context Ajax do
+  context "framework path" do
+    it "should be /ajax/framework by default" do
+      Ajax.framework_path.should_not be_nil
+      Ajax.framework_path.should == '/ajax/framework'
+    end
+
+    it "should be able to be changed" do
+      Ajax.framework_path = '/my/path'
+      Ajax.framework_path.should == '/my/path'
+    end
+  end
+
+  it "should have a root method" do
+    Ajax.root.should == File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+  end
+end

data/spec/ajax/helpers_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require 'spec_helper'
 
 context 'Ajax::UrlHelpers' do
@@ -20,7 +21,7 @@ context 'Ajax::UrlHelpers' do
       Ajax.hashed_url_from_traditional('/beyoncé').should == '/#/beyonc%C3%A9'
       Ajax.hashed_url_from_traditional('/red hot').should == '/#/red%20hot'
     end
-    
+
     DOMAINS.each do |domain|
       it "should work for domain #{domain}" do
         Ajax.hashed_url_from_traditional("http://#{domain}/playlists").should == "http://#{domain}/#/playlists"
@@ -33,7 +34,7 @@ context 'Ajax::UrlHelpers' do
       Ajax.hashed_url_from_fragment('/Beyonce#/Akon').should == '/#/Akon'
       Ajax.hashed_url_from_fragment('/Beyonce#Akon').should == '/#/Akon'
     end
-    
+
     it "should handle special characters" do
       Ajax.hashed_url_from_fragment('/#/beyoncé').should == '/#/beyonc%C3%A9'
       Ajax.hashed_url_from_fragment('/#/red hot').should == '/#/red%20hot'
@@ -66,7 +67,7 @@ context 'Ajax::UrlHelpers' do
     it "should support full URLs" do
       Ajax.is_hashed_url?('http://musicsocial.com.local/#/playlists').should be(true)
     end
-    
+
     it "should support special characters" do
       Ajax.is_hashed_url?('http://musicsocial.com.local/#/beyoncé').should be(true)
     end
@@ -106,7 +107,7 @@ context 'Ajax::UrlHelpers' do
       Ajax.traditional_url_from_fragment('/Beyonce#/beyoncé').should == '/beyonc%C3%A9'
       Ajax.traditional_url_from_fragment('/#/red hot').should == '/red%20hot'
     end
-    
+
     it "should handle special characters" do
       Ajax.traditional_url_from_fragment('/Beyonce#/Akon').should == '/Akon'
     end

data/spec/ajax/request_helper_spec.rb

@@ -8,26 +8,45 @@ describe 'Ajax::Helpers::RequestHelpers' do
       @headers = {}
     end
 
+    it "should store headers as JSON" do
+      set_header @headers, :tab, '#main .home_tab'
+      get_header(@headers, :tab).should == '#main .home_tab'
+    end
+
+    it "should not fail on bad JSON" do
+      @headers['Ajax-Info'] = 'invalid JSON!'
+      get_header(@headers, :layout).should be_nil
+
+      set_header(@headers, :layout, '')
+      get_header(@headers, :layout).should == ''
+    end
+
     it "should add headers" do
       set_header @headers, :tab, '#main .home_tab'
-      @headers['Ajax-Info']['tab'].should == '#main .home_tab'
+      get_header(@headers, :tab).should == '#main .home_tab'
     end
 
     it "should add assets" do
       set_header @headers, :assets, { :key => ['value'] }
-      @headers['Ajax-Info']['assets'].should == { :key => ['value'] }
+      get_header(@headers, :assets).should == { 'key' => ['value'] }
     end
 
     it "should merge hashes" do
-      set_header @headers, :assets, { :key => ['value1'] }
-      set_header @headers, :assets, { :key => ['value2'] }
-      @headers['Ajax-Info']['assets'].should == { :key => ['value1', 'value2'] }
+      set_header @headers, :assets, { :key1 => 'value1' }
+      set_header @headers, :assets, { :key2 => 'value2' }
+      get_header(@headers, :assets).should == { 'key1' => 'value1', 'key2' => 'value2' }
     end
-    
+
     it "should concat arrays" do
       set_header @headers, :callbacks, ['one']
       set_header @headers, :callbacks, ['two']
-      @headers['Ajax-Info']['callbacks'].should == ['one', 'two']
-    end    
+      get_header(@headers, :callbacks).should == ['one', 'two']
+    end
+
+    it "should deep merge" do
+      set_header @headers, :assets, { :key => ['value1'] }
+      set_header @headers, :assets, { :key => ['value2'] }
+      get_header(@headers, :assets).should == { 'key' => ['value1', 'value2'] }
+    end
   end
 end

data/spec/ajax/tasks_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'fileutils'
+
+# Dummy Rails.root to tmp/
+TMP_DIR = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'tmp'))
+Rails = Class.new do
+  def self.root
+    TMP_DIR
+  end
+end
+
+def verbose # silence the tasks
+  false
+end
+
+require 'rake'
+load(File.join(Ajax.root, 'tasks', 'ajax_tasks.rake'))
+
+context 'task' do
+  before :each do
+    FileUtils.rm_r(TMP_DIR) if File.exists?(TMP_DIR)
+    FileUtils.mkdir(TMP_DIR)
+  end
+
+  it "rails root should be tmp/" do
+    Rails.root.should == TMP_DIR
+  end
+
+  context 'install' do
+    it "should install files" do
+      Rake::Task['ajax:install'].invoke
+      INSTALL_FILES.each do |file|
+        file_should_exist(File.join(Rails.root, file))
+      end
+    end
+  end
+
+  context 'update' do
+    context 'javascript' do
+      it "should update files" do
+        Rake::Task['ajax:update:javascript'].invoke
+        UPDATE_JAVASCRIPT_FILES.each do |file|
+          file_should_exist(File.join(Rails.root, file))
+        end
+      end
+    end
+  end
+end

data/spec/integration/ajax_spec.rb

@@ -17,26 +17,26 @@ context 'Rack::Ajax' do
   after :all do
     unmock_ajax
   end
-  
+
   context "XMLHttpRequest" do
     context "hashed url" do
       it "should rewrite GET request" do
         xhr(:get, '/?query1#/Beyonce?query2')
         should_rewrite_to('/Beyonce?query2')
       end
-  
+
       it "should not modify POST" do
         xhr(:post, '/#/user_session/new?param1=1&param2=2')
         should_not_modify_request
       end
     end
-  
+
     context "traditional url" do
       it "should not be modified" do
         xhr(:get, '/Beyonce')
         should_not_modify_request
       end
-  
+
       it "should not be modified" do
         xhr(:post, '/user_session/new?param1=1&param2=2')
         should_not_modify_request
@@ -49,7 +49,7 @@ context 'Rack::Ajax' do
       get('/')
       should_not_modify_request
     end
-    
+
     it "should not be modified" do
       get('/?query_string')
       should_not_modify_request
@@ -65,17 +65,17 @@ context 'Rack::Ajax' do
     before :each do
       @user = login_robot_user
     end
-  
+
     it "should not modify request for root" do
       get('/')
       should_not_modify_request
     end
-  
+
     it "should not modify traditional requests" do
       get('/Beyonce')
       should_not_modify_request
     end
-  
+
     context "request hashed" do
       context "non-root url" do
         it "should not modify the request" do
@@ -83,7 +83,7 @@ context 'Rack::Ajax' do
           should_not_modify_request
         end
       end
-  
+
       context "root url" do
         it "should rewrite to traditional url" do
           get('/#/Beyonce?query2')
@@ -92,18 +92,18 @@ context 'Rack::Ajax' do
       end
     end
   end
-  
+
   context "regular user" do
     it "should not modify request for root" do
       get('/')
       should_not_modify_request
     end
-  
+
     it "should ignore query string on root url" do
       get('/?query1#/Beyonce?query2')
       should_rewrite_to('/Beyonce?query2')
     end
-  
+
     context "request hashed" do
       context "non-root url" do
         it "should redirect to hashed part at root" do
@@ -111,7 +111,7 @@ context 'Rack::Ajax' do
           should_redirect_to('/#/Beyonce?query2')
         end
       end
-  
+
       context "root url" do
         it "should rewrite to traditional url" do
           get('/#/Beyonce?query2')
@@ -119,7 +119,7 @@ context 'Rack::Ajax' do
         end
       end
     end
-  
+
     context "request traditional url" do
       it "should not be modified" do
         get('/')
@@ -129,12 +129,12 @@ context 'Rack::Ajax' do
         get('/?query_string')
         should_not_modify_request
       end
-  
+
       it "should redirect GET request" do
         get('/Beyonce')
         should_redirect_to('/#/Beyonce')
       end
-  
+
       it "should not modify non-GET request" do
         %w[post put delete].each do |method|
           send(method, '/')

data/spec/rack-ajax/parser_spec.rb

@@ -22,11 +22,11 @@ describe Rack::Ajax::Parser, :type => :integration do
     end
     should_set_ajax_request_header('robot', true)
   end
-  
+
   it "should recognize regular users" do
     call_rack('/', { 'HTTP_USER_AGENT' => 'Safari' }) do
       rack_response(user_is_robot?)
-    end      
+    end
     should_set_ajax_request_header('robot', false)
   end
 

data/spec/spec_helper.rb

@@ -7,12 +7,18 @@ require 'ajax/spec/extension'
 require 'ruby-debug'
 
 # Rails dependencies
+gem 'actionpack', '2.3.5'
 require 'action_controller'
 require 'active_support/core_ext'
 
 $: << File.join(File.dirname(__FILE__), '..', 'lib')
 require File.join(File.dirname(__FILE__), '..', 'rails', 'init')
 
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
 Spec::Runner.configure do |config|
   include Ajax::Spec::Extension
+  config.include(FileMacros)
 end

data/spec/support/file_macros.rb

@@ -0,0 +1,28 @@
+module FileMacros
+  module ExampleMethods
+
+    def files_should_be_identical(first, second)
+      identical_files?(first, second).should be(true)
+    end
+
+    def files_should_not_be_identical(first, second)
+      identical_files?(first, second).should be(false)
+    end
+
+    def (file)
+      File.exists?(file).should be(true)
+    end
+
+    def file_should_not_exist(file)
+      File.exists?(file).should be(false)
+    end
+
+    def identical_files?(first, second)
+      open(second, 'r').read.should == open(first, 'r').read
+    end
+  end
+
+  def self.included(receiver)
+    receiver.send :include, ExampleMethods
+  end
+end

data/tasks/ajax_tasks.rake

@@ -1,15 +1,28 @@
 require 'ajax'
 
+include Ajax::Helpers::TaskHelper
+
 namespace :ajax do
-  desc "Install required Ajax files."
+  desc "Install required Ajax files.  Existing files will not be overwritten."
   task :install do
-    load(File.join(File.dirname(__FILE__), '..', 'rails', 'install.rb'))
+    INSTALL_FILES.map do |file|
+      show_result(file) { |file| copy_unless_exists(file) }
+    end
   end
 
   namespace :install do
-    desc "Install Ajax integration spec tests into spec/integration."
+    desc "Copy Ajax integration spec tests into spec/integration."
     task :specs do
       puts "Coming soon..."
     end
   end
+
+  namespace :update do
+    desc "Overwrite public/javascripts/ajax.js with the latest version."
+    task :javascript do
+      UPDATE_JAVASCRIPT_FILES.map do |file|
+        show_result(file) { |file| copy_and_overwrite(file) }
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: ajax
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Karl Varga
@@ -9,19 +14,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-22 00:00:00 -07:00
+date: 2010-04-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id001
 description: Augment a traditional Rails application with a completely AJAX frontend, while transparently handling issues important to both the enterprise and end users, such as testing, SEO and browser history.
 email: kjvarga@gmail.com
 executables: []
@@ -44,6 +51,7 @@ files:
 - lib/ajax/helpers.rb
 - lib/ajax/helpers/request_helper.rb
 - lib/ajax/helpers/robot_helper.rb
+- lib/ajax/helpers/task_helper.rb
 - lib/ajax/helpers/url_helper.rb
 - lib/ajax/railtie.rb
 - lib/ajax/routes.rb
@@ -66,12 +74,15 @@ files:
 - rails/init.rb
 - rails/install.rb
 - rails/uninstall.rb
+- spec/ajax/ajax_spec.rb
 - spec/ajax/helpers_spec.rb
 - spec/ajax/request_helper_spec.rb
+- spec/ajax/tasks_spec.rb
 - spec/integration/ajax_spec.rb
 - spec/rack-ajax/parser_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/support/file_macros.rb
 - tasks/ajax_tasks.rake
 has_rdoc: true
 homepage: http://github.com/kjvarga/ajax
@@ -86,18 +97,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A framework to augment a traditional Rails application with a completely AJAX frontend.