ajax 0.1.2 → 0.1.3

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/ajax.rb

@@ -25,7 +25,10 @@ module Ajax
   def self.is_enabled?
     @enabled.nil? ? true : !!@enabled
   end
-
+  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
@@ -35,6 +38,24 @@ module Ajax
     @enabled = !!value
   end
 
+  # Return a boolean indicating whether to enable lazy loading assets.
+  # There are currently issues with some browsers when using this feature.
+  #
+  # Disabled by default.
+  def self.lazy_load_assets?
+    @lazy_load_assets.nil? ? false : !!@lazy_load_assets
+  end
+
+  # Set to false to disable lazy loading assets.  Callbacks will
+  # be executed immediately.
+  #
+  # ActionController and ActionView helpers are still mixed in but
+  # they are effectively disabled, which means your code will still
+  # run.
+  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/helpers/request_helper.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module Ajax
   module Helpers
     module RequestHelper
@@ -15,33 +17,45 @@ module Ajax
       # Hash and/or Array values are merged so you can set multiple values
       def set_header(object, key, value)
         headers = object.is_a?(::ActionController::Response) ? object.headers : object
-        unless headers["Ajax-Info"].is_a?(Hash)
-          headers["Ajax-Info"] = {}
+        
+        info = case headers["Ajax-Info"]
+        when String
+          JSON.parse(headers["Ajax-Info"])
+        when Hash
+          headers["Ajax-Info"]
+        else
+          {}
         end
 
         # Deep merge hashes
-        if headers["Ajax-Info"].has_key?(key.to_s) &&
+        if info.has_key?(key.to_s) &&
             value.is_a?(Hash) &&
-            headers["Ajax-Info"][key.to_s].is_a?(Hash)
-          value = headers["Ajax-Info"][key.to_s].merge(value, &DEEP_MERGE)
+            info[key.to_s].is_a?(Hash)
+          value = info[key.to_s].merge(value, &DEEP_MERGE)
         end
 
         # Concat arrays
-        if headers["Ajax-Info"].has_key?(key.to_s) &&
+        if info.has_key?(key.to_s) &&
             value.is_a?(Array) &&
-            headers["Ajax-Info"][key.to_s].is_a?(Array)
-          value = headers["Ajax-Info"][key.to_s].concat(value)
+            info[key.to_s].is_a?(Array)
+          value = info[key.to_s].concat(value)
         end
       
-        headers["Ajax-Info"][key.to_s] = value
+        info[key.to_s] = value
+        headers["Ajax-Info"] = info.to_json
       end
 
       def get_header(object, key)
         headers = object.is_a?(::ActionController::Request) ? object.headers : object
-        unless headers["Ajax-Info"].is_a?(Hash)
-          headers["Ajax-Info"] = {}
+        info = case headers["Ajax-Info"]
+        when String
+          JSON.parse(headers["Ajax-Info"])
+        when Hash
+          headers["Ajax-Info"]
+        else
+          {}
         end
-        headers['Ajax-Info'][key.to_s]
+        info[key.to_s]
       end
 
       # Set one or more paths that can be accessed directly without the AJAX framework.

data/public/javascripts/ajax.js

@@ -1,3 +1,64 @@
+/**  
+*  Script lazy loader 0.5
+*  Copyright (c) 2008 Bob Matsuoka
+*
+*  This program is free software; you can redistribute it and/or 
+*  modify it under the terms of the GNU General Public License
+*  as published by the Free Software Foundation; either version 2
+*  of the License, or (at your option) any later version.
+*/
+ 
+var LazyLoader = {}; //namespace
+LazyLoader.timer = {};  // contains timers for scripts
+LazyLoader.scripts = [];  // contains called script references
+LazyLoader.load = function(url, callback) {
+  // handle object or path
+  var classname = null;
+  var properties = null;
+  try {
+    // make sure we only load once
+    if (LazyLoader.scripts.indexOf(url) == -1) {
+      // note that we loaded already
+      LazyLoader.scripts.push(url);
+      var script = document.createElement("script");
+      script.src = url;
+      script.type = "text/javascript";
+      $(script).appendTo("head");  // add script tag to head element
+      
+      // was a callback requested
+      if (callback) {    
+        // test for onreadystatechange to trigger callback
+        script.onreadystatechange = function () {         
+          if (script.readyState == 'loaded' || script.readyState == 'complete') {
+            callback();
+          }
+        };
+                                    
+        // test for onload to trigger callback
+        script.onload = function () {  
+          callback();
+          return;
+        };
+        
+        // safari doesn't support either onload or readystate, create a timer
+        // only way to do this in safari
+        if (($.browser.webkit && !navigator.userAgent.match(/Version\/3/)) || $.browser.opera) { // sniff
+          LazyLoader.timer[url] = setInterval(function() {
+            if (/loaded|complete/.test(document.readyState)) {
+              clearInterval(LazyLoader.timer[url]);
+              callback(); // call the callback handler
+            }
+          }, 10);
+        }
+      }
+    } else {
+      if (callback) { callback(); }
+    }
+  } catch (e) {
+    alert(e);
+  }
+}
+
 /**
  * AjaxAssets
  *
@@ -28,22 +89,28 @@ var AjaxAssets = function(array, type) {
     addAsset: function(path) {
       this.push(this.sanitizePath(path));
     },
-    
+
     /**
      * Load and add an asset.  The asset is loaded using the
      * unsanitized path should you need to put something in the
      * query string.
      */
-    loadAsset: function(path) {
+    loadAsset: function(path, callback) {
       console.log('[ajax] loading', type, path);
       this.push(this.sanitizePath(path));
-      this.appendScriptTag(path);
+      if (type == 'css') {
+        this.appendScriptTag(path, callback);
+      } else if ($.browser.msie || $.browser.mozilla) {
+        this.appendScriptTag(path, callback);
+      } else {
+        LazyLoader.load(path, callback);
+      }
     },
 
     /**
      * Return a boolean indicating whether an asset has
      * already been loaded.
-     */    
+     */
     loadedAsset: function(path) {
       path = this.sanitizePath(path);
       for (var i=0; i < this.length; i++) {
@@ -51,47 +118,45 @@ var AjaxAssets = function(array, type) {
           return true;
         }
       }
-      return false;      
+      return false;
     },
 
     /**
      * Remove query strings and otherwise cleanup paths
      * before adding them.
-     */    
+     */
     sanitizePath: function(path) {
       return path.replace(/\?.*/, '');
     },
-    
+
     /**
      * Supports debugging and references the script files as external resources
      * rather than inline.
      *
      * @see http://stackoverflow.com/questions/690781/debugging-scripts-added-via-jquery-getscript-function
-     */  
+     */
     appendScriptTag: function(url, callback) {
       if (type == 'js') {
         var head = document.getElementsByTagName("head")[0];
         var script = document.createElement("script");
         script.src = url;
         script.type = 'text/javascript'
-      
-        { // Handle Script loading
+        head.appendChild(script);
+        // Handle Script loading
+        if (callback) {
            var done = false;
-
-           // Attach handlers for all browsers
            script.onload = script.onreadystatechange = function(){
               if ( !done && (!this.readyState ||
                     this.readyState == "loaded" || this.readyState == "complete") ) {
                  done = true;
                  if (callback)
                     callback();
-
+           
                  // Handle memory leak in IE
                  script.onload = script.onreadystatechange = null;
               }
            };
-        }
-        head.appendChild(script);
+        }       
       } else if (type == 'css') {
         if (url.match(/datauri/)) {
           $(DATA_URI_START + '<link type="text/css" rel="stylesheet" href="'+ url +'">' + DATA_URI_END).appendTo('head');
@@ -102,7 +167,7 @@ var AjaxAssets = function(array, type) {
         }
       }
       return undefined;
-    }  
+    }
   });
 };
 
@@ -114,20 +179,20 @@ var AjaxAssets = function(array, type) {
  *      This must be set if you are using Ajax callbacks in your code,
  *      and you want them to still fire if Ajax is not enabled.
  *
- *    <tt>default_container</tt>  string jQuery selector of the default 
+ *    <tt>default_container</tt>  string jQuery selector of the default
  *      container element to receive content.
  *
  * Callbacks:
  *
  * Callbacks can be specified using Ajax-Info{ callbacks: 'javascript to eval' },
  * or by adding callbacks directly to the Ajax instance:
- * 
+ *
  *    window.ajax.onLoad(function() { doSomething(args); });
  *
  * Order of execution:
  *
  *
- */ 
+ */
 var Ajax = function(options) {
   var self = this;
 
@@ -139,28 +204,32 @@ var Ajax = function(options) {
   self.stylesheets = new AjaxAssets([], 'css');
   self.callbacks = [];
   self.loaded = false;
+  self.lazy_load_assets = false;
   
   // For initial position of the loading icon.  Often the mouse does not
   // move so position it by the link that was clicked.
   self.last_click_coords = undefined;
 
   // Parse options
-  self.options = options;  
+  self.options = options;
   self.default_container = options.default_container;
   if (options.enabled !== undefined) {
     self.enabled = options.enabled;
   }
-
+  if (options.lazy_load_assets !== undefined) {
+    self.lazy_load_assets = options.lazy_load_assets;
+  }
+  
   // Initialize on DOM ready
   $(function() { self.init() });
-        
+
   /**
    * Initializations run on DOM ready.
    *
    * Bind event handlers and setup jQuery Address.
    */
   self.init = function() {
-    
+
     // Configure jQuery Address
     $.address.history(true);
     $.address.change = self.addressChanged;
@@ -168,21 +237,21 @@ var Ajax = function(options) {
     // Insert loading image
     var image = '<img src="/images/loading-icon-small.gif" id="loading-icon-small" alt="Loading..." />'
     $(image).hide().appendTo($('body'));
-    
+
     // Bind a live event to all ajax-enabled links
     $('a[data-deep-link]').live('click', self.linkClicked);
-    
+
     // Initialize the list of javascript assets
     if (self.javascripts === undefined) {
       self.javascripts = new AjaxAssets([], 'js');
-      
+
       $(document).find('script[type=text/javascript][src!=]').each(function() {
         var script = $(this);
         var src = script.attr('src');
-        
+
         // Local scripts only
         if (src.match(/^\//)) {
-          
+
           // Parse parameters passed to the script via the query string.
           // TODO: Untested.  It's difficult for us to use this with Jammit.
           if (src.match(/\Wajax.js\?.+/)) {
@@ -190,7 +259,7 @@ var Ajax = function(options) {
             jQuery.each(params, function(idx, param) {
               param = param.split('=');
               if (param.length == 1) { return true; }
-              
+
               switch(param[0]) {
                 case 'enabled':
                   self.enabled = param[1] == 'false' ? false : true;
@@ -203,33 +272,33 @@ var Ajax = function(options) {
               }
             });
           }
-          
+
           self.javascripts.addAsset(script.attr('src'));
         }
       });
     }
     self.initialized = true;
-    
+
     // Run onInit() callbacks
   };
-  
+
   /**
    * jQuery Address callback triggered when the address changes.
    */
   self.addressChanged = function() {
     if (document.location.pathname != '/') { return false; }
-
-    if (typeof(self.loaded_by_framework) == 'undefined' || self.loaded_by_framework != true) { 
+    if (window.ajax.disable_address_intercept == true) {return false;}
+    if (typeof(self.loaded_by_framework) == 'undefined' || self.loaded_by_framework != true) {
       self.loaded_by_framework = true;
-      return false; 
-    }    
-    
-    self.loadPage({ 
+      return false;
+    }
+
+    self.loadPage({
       url: $.address.value().replace(/\/\//, '/')
     });
     return true;
   };
-  
+
   /**
    * loadPage
    *
@@ -246,7 +315,7 @@ var Ajax = function(options) {
    *  Cookies in the response are automatically set on the document.cookie.
    */
   self.loadPage = function(options) {
-    if (!self.enabled) { 
+    if (!self.enabled) {
       document.location = options.url;
       return true;
     }
@@ -343,16 +412,16 @@ var Ajax = function(options) {
       console.log('Using page title '+data.title);
       $.address.title(data.title);
     }
-    
+
     if (data.tab !== undefined) {
       console.log('Activating tab '+data.tab);
       $(data.tab).trigger('activate');
     }
-    
+
     /**
-     * Load assets
+     * Load stylesheets
     */
-    if (data.assets !== undefined && data.assets.stylesheets !== undefined) {
+    if (self.lazy_load_assets && data.assets && data.assets.stylesheets !== undefined) {
       jQuery.each(jQuery.makeArray(data.assets.stylesheets), function(idx, url) {
         if (self.stylesheets.loadedAsset(url)) {
           console.log('[ajax] skipping css', url);
@@ -362,17 +431,6 @@ var Ajax = function(options) {
         }
       });
     }
-    
-    if (data.assets !== undefined && data.assets.javascripts !== undefined) {
-      jQuery.each(jQuery.makeArray(data.assets.javascripts), function(idx, url) {
-        if (self.javascripts.loadedAsset(url)) {
-          console.log('[ajax] skipping js', url);
-          return true;
-        } else {
-          self.javascripts.loadAsset(url);
-        }
-      });
-    }
 
     /**
      * Insert response
@@ -381,30 +439,49 @@ var Ajax = function(options) {
     console.log('Set data ',data);
     container.data('ajax-info', data)
     container.html(responseText);
-    
+
     /**
-     * Execute callbacks
+     * Include callbacks from Ajax-Info
     */
-    if (data.callbacks !== undefined) {
-      jQuery.each(jQuery.makeArray(data.callbacks), function(idx, callback) {
-        self.executeCallback(callback);
-      });
+    if (data.callbacks) {
+      data.callbacks = jQuery.makeArray(data.callbacks);
+      self.callbacks.concat(data.callbacks);
     }
-    
-    if (self.callbacks.length > 0) {
-      jQuery.each(self.callbacks, function(idx, callback) {
-        self.executeCallback(callback);
+
+    /**
+     * Load javascipts
+    */    
+    if (self.lazy_load_assets && data.assets && data.assets.javascripts !== undefined) {
+      var count = data.assets.javascripts.length;
+      var callback;
+      
+      jQuery.each(jQuery.makeArray(data.assets.javascripts), function(idx, url) {
+        if (self.javascripts.loadedAsset(url)) {
+          console.log('[ajax] skipping js', url);
+          return true;
+        }
+        
+        // Execute callbacks once the last asset has loaded
+        callback = (idx == count - 1) ? undefined : self.executeCallbacks;
+        self.javascripts.loadAsset(url, callback);
       });
-      self.callbacks = [];
+    } else {
+      // Execute callbacks immediately
+      self.executeCallbacks();
     }
-            
+
+    $(document).trigger('ajax.onload');
+    
     /**
-     * Set cookies
+     * Set cookies - browsers don't seem to allow this
     */
-    var cookie = XMLHttpRequest.getResponseHeader('Set-Cookie');
-    if (cookie !== null) {
-      console.log('Setting cookie');
-      document.cookie = cookie;
+    try {
+      var cookie = XMLHttpRequest.getResponseHeader('Set-Cookie');
+      if (cookie !== null) {
+        console.log('Setting cookie');
+        document.cookie = cookie;
+      }
+    } catch(e) {
     }
   };
 
@@ -432,28 +509,33 @@ var Ajax = function(options) {
    */
   self.showLoadingImage = function() {
     var icon = $('#loading-icon-small');
-    
+
     // Follow the mouse pointer
     $(document).bind('mousemove', self.updateImagePosition);
-    
+
     // Display at last click coords initially
     if (self.last_click_coords !== undefined) {
       self.updateImagePosition(self.last_click_coords);
-      
+
     // Center it
     } else {
+      var marginTop  = parseInt(icon.css('marginTop'), 10);
+      var marginLeft = parseInt(icon.css('marginLeft'), 10);
+      marginTop      = isNaN(marginTop)  ? 0 : marginTop;
+      marginLeft     = isNaN(marginLeft) ? 0 : marginLeft;
+      
       icon.css({
-  			position:	  'absolute',
-  			left:		    '50%', 
-  			top:		    '50%', 
-  			zIndex:		  '99',
-				marginTop:	parseInt(icon.css('marginTop'), 10) + jQuery(window).scrollTop(), 
-				marginLeft:	parseInt(icon.css('marginLeft'), 10) + jQuery(window).scrollLeft()
-  		});
-  	}
-    icon.show();    
+        position:   'absolute',
+        left:       '50%',
+        top:        '50%',
+        zIndex:     '99',
+        marginTop:  marginTop  + jQuery(window).scrollTop(),
+        marginLeft: marginLeft + jQuery(window).scrollLeft()
+      });
+    }
+    icon.show();
   };
-  
+
   /**
    * Update the position of the loading icon.
    */
@@ -466,7 +548,7 @@ var Ajax = function(options) {
     });
   };
 
-  
+
   /**
    * onLoad
    *
@@ -478,9 +560,9 @@ var Ajax = function(options) {
    * on DOM ready.
    */
   self.onLoad = function(callback) {
-    if (self.enabled && !self.loaded) {
+    if (self.enabled && (self.lazy_load_assets && !self.loaded)) {
       self.callbacks.push(callback);
-      console.log('[ajax] appending callback', callback);
+      console.log('[ajax] appending callback', self.teaser(callback));
     } else {
       self.executeCallback(callback, true);
     }
@@ -494,14 +576,27 @@ var Ajax = function(options) {
    * @see onLoad
    */
   self.prependOnLoad = function(callback) {
-    if (self.enabled && !self.loaded) {
+    if (self.enabled && (self.lazy_load_assets && !self.loaded)) {
       self.callbacks.unshift(callback);
-      console.log('[ajax] prepending callback', callback);
+      console.log('[ajax] prepending callback', self.teaser(callback));
     } else {
       self.executeCallback(callback, true);
     }
   };
-  
+
+  /**
+   * Execute callbacks
+  */
+  self.executeCallbacks = function() {
+    var callbacks = jQuery.makeArray(self.callbacks);
+    if (callbacks.length > 0) {
+      jQuery.each(callbacks, function(idx, callback) {
+        self.executeCallback(callback);
+      });
+      self.callbacks = [];
+    }
+  };
+
   /**
    * Execute a callback given as a string or function reference.
    *
@@ -513,8 +608,8 @@ var Ajax = function(options) {
       $(function() {
         self.executeCallback(callback);
       })
-    } else { 
-      console.log('[ajax] executing callback', callback);   
+    } else {
+      console.log('[ajax] executing callback', self.teaser(callback));
       try {
         if (jQuery.isFunction(callback)) {
           callback();
@@ -524,6 +619,10 @@ var Ajax = function(options) {
       } catch(e) {
         console.log('[ajax] callback failed with exception', e);
       }
-    }      
-  };  
+    }
+  };
+
+  self.teaser = function(callback) {
+    return new String(callback).slice(0,50);
+  };
 };

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ajax
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Karl Varga
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-20 00:00:00 -07:00
+date: 2010-04-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency