sproutcore 1.4.5 → 1.5.0.pre.3

data/lib/frameworks/sproutcore/frameworks/foundation/system/request.js

@@ -68,7 +68,7 @@ SC.Request = SC.Object.extend(SC.Copyable, SC.Freezable,
     this.header('X-Requested-With', 'XMLHttpRequest');
     //TODO: we need to have the SC version in a SC variable.
     //For now I'm harcoding the variable.
-    this.header('X-SproutCore-Version', '1.4');
+    this.header('X-SproutCore-Version', SC.VERSION);
   },
   
   /**
@@ -116,8 +116,8 @@ SC.Request = SC.Object.extend(SC.Copyable, SC.Freezable,
     and not necessarily when SC.Request#send is invoked.  If this timeout is
     reached before a response is received, the equivalent of
     SC.Request.manager#cancel() will be invoked on the SC.Response instance
-    and the didTimeout() callback will be called.
-    
+    and the didReceive() callback will be called.
+
     An exception will be thrown if you try to invoke send() on a request that
     has both a timeout and isAsyncronous set to NO.
     
@@ -186,22 +186,12 @@ SC.Request = SC.Object.extend(SC.Copyable, SC.Freezable,
     notified.  You can do any standard processing on the request at this 
     point.  If you don't want to allow notifications to continue, call
     response.cancel()
-    
+
     @param {SC.Response} response reponse
     @returns {void}
   */
   didReceive: function(request, response) {},
   
-  /**
-    Invoked when a request times out before a response has been received, as
-    determined by the 'timeout' property.  Note that if a request times out,
-    neither willReceive() nor didReceive() will be called.
-
-    @param {SC.Response} response the response
-    @returns {void}
-  */
-  didTimeout: function(request, response) {},
-  
   // ..........................................................
   // HELPER METHODS
   // 
@@ -281,18 +271,28 @@ SC.Request = SC.Object.extend(SC.Copyable, SC.Freezable,
   /**
     Converts the current request to be asynchronous.
 
-    @property {Boolean} flag YES to make asynchronous, NO or undefined
+    @param {Boolean} flag YES to make asynchronous, NO or undefined
     @returns {SC.Request} receiver
   */
   async: function(flag) {
     if (flag === undefined) flag = YES;
     return this.set('isAsynchronous', flag);
   },
-  
+
+  /**
+    Sets the maximum amount of time the request will wait for a response.
+
+    @param {Number} timeout The timeout in milliseconds.
+    @returns {SC.Request} receiver
+  */
+  timeoutAfter: function(timeout) {
+    return this.set('timeout', timeout);
+  },
+
   /**
     Converts the current request to use JSON.
     
-    @property {Boolean} flag YES to make JSON, NO or undefined
+    @param {Boolean} flag YES to make JSON, NO or undefined
     @returns {SC.Request} receiver
   */
   json: function(flag) {
@@ -304,7 +304,7 @@ SC.Request = SC.Object.extend(SC.Copyable, SC.Freezable,
   /**
     Converts the current request to use XML.
     
-    @property {Boolean} flag YES to make XML, NO or undefined
+    @param {Boolean} flag YES to make XML, NO or undefined
     @returns {SC.Request} recevier
   */
   xml: function(flag) {
@@ -366,7 +366,7 @@ SC.Request = SC.Object.extend(SC.Copyable, SC.Freezable,
     Configures a callback to execute when a request completes.  You must pass
     at least a target and action/method to this and optionally a status code.
     You may also pass additional parameters which will be passed along to your
-    callback.
+    callback. If your callback handled the notification, it should return YES.
     
     h2. Scoping With Status Codes
     
@@ -463,11 +463,8 @@ SC.Request.mixin(/** @scope SC.Request */ {
     if(body) req.set('body', body) ;
     return req ;
   }
-  
 });
 
-
-
 /**
   The request manager coordinates all of the active XHR requests.  It will
   only allow a certain number of requests to be active at a time; queuing 

data/lib/frameworks/sproutcore/frameworks/foundation/system/response.js

@@ -238,36 +238,35 @@ SC.Response = SC.Object.extend(
     @returns {SC.Response} receiver
   */
   receive: function(callback, context) {
-    // If we timed out, we should ignore this response.
     if (!this.get('timedOut')) {
       // If we had a timeout timer scheduled, invalidate it now.
       var timer = this.get('timeoutTimer');
       if (timer) timer.invalidate();
       this.set('timedOut', NO);
-    
-      var req = this.get('request');
-      var source = req ? req.get('source') : null;
-    
-      SC.run(function() {
-        // invoke the source, giving a chance to fixup the reponse or (more 
-        // likely) cancel the request.
-        if (source && source.willReceive) source.willReceive(req, this);
-
-        // invoke the callback.  note if the response was cancelled or not
-        callback.call(context, !this.get('isCancelled'));
-
-        // if we weren't cancelled, then give the source first crack at handling
-        // the response.  if the source doesn't want listeners to be notified,
-        // it will cancel the response.
-        if (!this.get('isCancelled') && source && source.didReceive) {
-          source.didReceive(req, this);
-        }
-
-        // notify listeners if we weren't cancelled.
-        if (!this.get('isCancelled')) this.notify();
-      }, this);
     }
-    
+
+    var req = this.get('request');
+    var source = req ? req.get('source') : null;
+
+    SC.run(function() {
+      // invoke the source, giving a chance to fixup the response or (more
+      // likely) cancel the request.
+      if (source && source.willReceive) source.willReceive(req, this);
+
+      // invoke the callback.  note if the response was cancelled or not
+      callback.call(context, !this.get('isCancelled'));
+
+      // if we weren't cancelled, then give the source first crack at handling
+      // the response.  if the source doesn't want listeners to be notified,
+      // it will cancel the response.
+      if (!this.get('isCancelled') && source && source.didReceive) {
+        source.didReceive(req, this);
+      }
+
+      // notify listeners if we weren't cancelled.
+      if (!this.get('isCancelled')) this.notify();
+    }, this);
+
     // no matter what, remove from inflight queue
     SC.Request.manager.transportDidClose(this) ;
     return this;
@@ -294,21 +293,25 @@ SC.Response = SC.Object.extend(
     if (this.get('timedOut') === null) {
       this.set('timedOut', YES);
       this.cancelTransport();
-      SC.Request.manager.transportDidClose(this);
-      
-      // Set our value to an error.
-      var error = SC.$error("HTTP Request timed out", "Request", 408) ;
-      error.set("errorValue", this) ;
-      this.set('isError', YES);
-      this.set('errorObject', error);
-      
-      // Invoke the didTimeout callback.
-      var req = this.get('request');
-      var source = req ? req.get('source') : null;
-      if (!this.get('isCancelled') && source && source.didTimeout) {
-        source.didTimeout(req, this);
-      }
+
+      // Invokes any relevant callbacks and notifies registered listeners, if
+      // any. In the event of a timeout, we set the status to 0 since we
+      // didn't actually get a response from the server.
+      this.receive(function(proceed) {
+        if (!proceed) return;
+
+        // Set our value to an error.
+        var error = SC.$error("HTTP Request timed out", "Request", 0) ;
+        error.set("errorValue", this) ;
+        this.set('isError', YES);
+        this.set('errorObject', error);
+        this.set('status', 0);
+      }, this);
+
+      return YES;
     }
+
+    return NO;
   },
   
   /**
@@ -316,7 +319,6 @@ SC.Response = SC.Object.extend(
   */
   cancelTransport: function() {},
   
-  
   /** @private
     Will notify each listener.
   */
@@ -419,28 +421,12 @@ SC.XHRResponse = SC.Response.extend({
     if (rawRequest) rawRequest.abort();
     this.set('rawRequest', null);
   },
-  
+
   invokeTransport: function() {
-    
     var rawRequest, transport, handleReadyStateChange, async, headers;
     
-    // Get an XHR object
-    function tryThese() {
-      for (var i=0; i < arguments.length; i++) {
-        try {
-          var item = arguments[i]() ;
-          return item ;
-        } catch (e) {}
-      }
-      return NO;
-    }
-    
-    rawRequest = tryThese(
-      function() { return new XMLHttpRequest(); },
-      function() { return new ActiveXObject('Msxml2.XMLHTTP'); },
-      function() { return new ActiveXObject('Microsoft.XMLHTTP'); }
-    );
-    
+    rawRequest = this.createRequest();
+
     // save it 
     this.set('rawRequest', rawRequest);
     
@@ -479,6 +465,33 @@ SC.XHRResponse = SC.Response.extend({
     return rawRequest ;
   },
   
+  /**
+    Creates the correct XMLHttpRequest object for this browser.
+
+    You can override this if you need to, for example, create an XHR on a
+    different domain name from an iframe.
+
+    @returns {XMLHttpRequest|ActiveXObject}
+  */
+  createRequest: function() {
+    // Get an XHR object
+    function tryThese() {
+      for (var i=0; i < arguments.length; i++) {
+        try {
+          var item = arguments[i]() ;
+          return item ;
+        } catch (e) {}
+      }
+      return NO;
+    }
+
+    return tryThese(
+      function() { return new XMLHttpRequest(); },
+      function() { return new ActiveXObject('Msxml2.XMLHTTP'); },
+      function() { return new ActiveXObject('Microsoft.XMLHTTP'); }
+    );
+  },
+
   /**  @private
   
     Called by the XHR when it responds with some final results.
@@ -491,9 +504,8 @@ SC.XHRResponse = SC.Response.extend({
         readyState = rawRequest.readyState,
         error, status, msg;
 
-    if (readyState === 4) {
+    if (readyState === 4 && !this.get('timedOut')) {
       this.receive(function(proceed) {
-
         if (!proceed) return ; // skip receiving...
       
         // collect the status and decide if we're in an error state or not
@@ -523,7 +535,7 @@ SC.XHRResponse = SC.Response.extend({
       }, this);
 
       // Avoid memory leaks
-      if (!SC.browser.msie) {
+      if (!SC.browser.msie && !SC.browser.opera) {
         SC.Event.remove(rawRequest, 'readystatechange', this, this.finishRequest);	  
       } else {
         rawRequest.onreadystatechange = null;

data/lib/frameworks/sproutcore/frameworks/foundation/system/routes.js

@@ -5,8 +5,6 @@
 // License:   Licensed under MIT license (see license.js)
 // ==========================================================================
 
-require('system/platform');
-
 /**
   SC.routes manages the browser location. You can change the hash part of the
   current location. The following code
@@ -40,12 +38,76 @@ require('system/platform');
   and earlier, which do not modify the history stack when the location hash
   changes.
   
-  @since SproutCore 1.1
+  SC.routes also supports HTML5 history, which uses a '/' instead of a '#'
+  in the URLs, so that all your website's URLs are consistent.
 */
 SC.routes = SC.Object.create({
+  
+  /**
+    Set this property to YES if you want to use HTML5 history, if available on
+    the browser, instead of the location hash.
+    
+    HTML 5 history uses the history.pushState method and the window's popstate
+    event.
+    
+    By default it is NO, so your URLs will look like:
+    {{{
+      http://domain.tld/my_app#notes/edit/4
+    }}}
     
+    If set to YES and the browser supports pushState(), your URLs will look
+    like:
+    {{{
+      http://domain.tld/my_app/notes/edit/4
+    }}}
+    
+    You will also need to make sure that baseURI is properly configured, as
+    well as your server so that your routes are properly pointing to your
+    SproutCore application.
+    
+    @see http://dev.w3.org/html5/spec/history.html#the-history-interface
+    @property
+    @type {Boolean}
+  */
+  wantsHistory: NO,
+  
+  /**
+    A read-only boolean indicating whether or not HTML5 history is used. Based
+    on the value of wantsHistory and the browser's support for pushState.
+    
+    @see wantsHistory
+    @property
+    @type {Boolean}
+  */
+  usesHistory: null,
+  
+  /**
+    The base URI used to resolve routes (which are relative URLs). Only used
+    when usesHistory is equal to YES.
+    
+    The build tools automatically configure this value if you have the
+    html5_history option activated in the Buildfile:
+    {{{
+      config :my_app, :html5_history => true
+    }}}
+    
+    Alternatively, it uses by default the value of the href attribute of the
+    <base> tag of the HTML document. For example:
+    {{{
+      <base href="http://domain.tld/my_app">
+    }}}
+    
+    The value can also be customized before or during the exectution of the
+    main() method.
+    
+    @see http://www.w3.org/TR/html5/semantics.html#the-base-element
+    @property
+    @type {String}
+  */
+  baseURI: document.baseURI,
+  
   /** @private
-    A boolean value indicating whether or the ping method has been called
+    A boolean value indicating whether or not the ping method has been called
     to setup the SC.routes.
   
     @property
@@ -53,7 +115,6 @@ SC.routes = SC.Object.create({
   */
   _didSetup: NO,
   
-  
   /** @private
     Internal representation of the current location hash.
   
@@ -168,7 +229,7 @@ SC.routes = SC.Object.create({
     @type {String}
   */
   location: function(key, value) {
-    var crumbs;
+    var crumbs, encodedValue;
     
     if (value !== undefined) {
       if (value === null) {
@@ -180,13 +241,22 @@ SC.routes = SC.Object.create({
         value = crumbs.route + crumbs.params;
       }
       
-      if(!SC.empty(value) || (this._location && this._location !== value)) {
-        window.location.hash = encodeURI(value);
+      if (!SC.empty(value) || (this._location && this._location !== value)) {
+        encodedValue = encodeURI(value);
+        
+        if (this.usesHistory) {
+          if (encodedValue.length > 0) {
+            encodedValue = '/' + encodedValue;
+          }
+          window.history.pushState(null, null, this.get('baseURI') + encodedValue);
+        } else {
+          window.location.hash = encodedValue;
+        }
       }
-      this._location = value;
       
-      return this;
+      this._location = value;
     }
+    
     return this._location;
   }.property(),
   
@@ -203,19 +273,29 @@ SC.routes = SC.Object.create({
     if (!this._didSetup) {
       this._didSetup = YES;
       
-      if (SC.platform.supportsHashChange) {
-        this.hashChange();
-        SC.Event.add(window, 'hashchange', this, this.hashChange);
-      
+      if (this.get('wantsHistory') && SC.platform.supportsHistory) {
+        this.usesHistory = YES;
+        
+        this.popState();
+        SC.Event.add(window, 'popstate', this, this.popState);
+        
       } else {
-        // we don't use a SC.Timer because we don't want
-        // a run loop to be triggered at each ping
-        that = this;
-        this._invokeHashChange = function() {
-          that.hashChange();
-          setTimeout(that._invokeHashChange, 100);
-        };
-        this._invokeHashChange();
+        this.usesHistory = NO;
+        
+        if (SC.platform.supportsHashChange) {
+          this.hashChange();
+          SC.Event.add(window, 'hashchange', this, this.hashChange);
+      
+        } else {
+          // we don't use a SC.Timer because we don't want
+          // a run loop to be triggered at each ping
+          that = this;
+          this._invokeHashChange = function() {
+            that.hashChange();
+            setTimeout(that._invokeHashChange, 100);
+          };
+          this._invokeHashChange();
+        }
       }
     }
   },
@@ -227,7 +307,9 @@ SC.routes = SC.Object.create({
   hashChange: function(event) {
     var loc = window.location.hash;
     
+    // Remove the '#' prefix
     loc = (loc && loc.length > 0) ? loc.slice(1, loc.length) : '';
+    
     if (!SC.browser.isMozilla) {
       // because of bug https://bugzilla.mozilla.org/show_bug.cgi?id=483304
       loc = decodeURI(loc);
@@ -235,11 +317,28 @@ SC.routes = SC.Object.create({
     
     if (this.get('location') !== loc) {
       SC.run(function() {
-        this.set('location', loc);        
+        this.set('location', loc);
       }, this);
     }
   },
   
+  popState: function(event) {
+    var base = this.get('baseURI'),
+        loc = document.location.href;
+    
+    if (loc.slice(0, base.length) === base) {
+      
+      // Remove the base prefix and the extra '/'
+      loc = loc.slice(base.length + 1, loc.length);
+      
+      if (this.get('location') !== loc) {
+        SC.run(function() {
+          this.set('location', loc);
+        }, this);
+      }
+    }
+  },
+  
   /**
     Adds a route handler. Routes have the following format:
       - 'users/show/5' is a static route and only matches this exact string,