sproutcore 0.9.14 → 0.9.15

data/frameworks/sproutcore/mixins/observable.js

@@ -73,82 +73,55 @@
   This will call the 'targetAction' method on the targetObject to be called
   whenever the value of the propertyKey changes.
   
-
-*/
-SC.Observable = {
-
-  /**  
-    Manually add a new binding to an object.  This is the same as doing
-    the more familiar propertyBinding: 'property.path' approach.
-  */
-  bind: function(toKey, fromPropertyPath) {
-    
-    var r = SC.idt.active ;
-    
-    var binding ;
-    var props = { to: [this, toKey] } ;
-
-    // for strings try to do default relay
-    var pathType = $type(fromPropertyPath) ;
-    if (pathType == T_STRING || pathType == T_ARRAY) {
-      binding = this[toKey + 'BindingDefault'] || SC.Binding.From;
-      binding = binding(fromPropertyPath) ;
-    } else binding = fromPropertyPath ;
-
-    // check the 'from' value of the relay. if it starts w/
-    // '.' || '*' then convert to a local tuple.
-    var relayFrom = binding.prototype.from ;
-    if ($type(relayFrom) == T_STRING) switch(relayFrom.slice(0,1)) {
-      case '*':
-      case '.':
-        relayFrom = [this,relayFrom.slice(1,relayFrom.length)];
-    }        
-
-    if(r) bt = new Date().getTime();
-
-    binding = binding.create(props, { from: relayFrom }) ;
-    this.bindings.push(binding) ;
-
-    if (r) SC.idt.b1_t += (new Date().getTime()) - bt ;
-    
-    return binding ;
-  },
   
-  /**  
-    didChangeFor makes it easy for you to verify that you haven't seen any
-    changed values.  You need to use this if your method observes multiple
-    properties.  To use this, call it like this:
+  h2. Implementing Manual Change Notifications
   
-    if (this.didChangeFor('render','height','width')) {
-       // DO SOMETHING HERE IF CHANGED.
-    }
-  */  
-  didChangeFor: function(context) {    
-    var keys = $A(arguments) ;
-    context = keys.shift() ;
-    
-    var ret = false ;
-    if (!this._didChangeCache) this._didChangeCache = {} ;
-    if (!this._didChangeRevisionCache) this._didChangeRevisionCache = {};
+  Sometimes you may want to control the rate at which notifications for 
+  a property are delivered, for example by checking first to make sure 
+  that the value has changed.
+  
+  To do this, you need to implement a computed property for the property 
+  you want to change and override automaticallyNotifiesObserversFor().
+  
+  The example below will only notify if the "balance" property value actually
+  changes:
+  
+  {{{
     
-    var seen = this._didChangeCache[context] || {} ;
-    var seenRevisions = this._didChangeRevisionCache[context] || {} ;
-    var loc = keys.length ;
-    var rev = this._kvo().revision ;
+    automaticallyNotifiesObserversFor: function(key) {
+      return (key === 'balance') ? NO : sc_super() ;
+    },
     
-    while(--loc >= 0) {
-      var key = keys[loc] ;
-      if (seenRevisions[key] != rev) {
-        var val = this.get(key) ;
-        if (seen[key] !== val) ret = true ;
-        seen[key] = val ;
+    balance: function(key, value) {
+      var balance = this._balance ;
+      if ((value !== undefined) && (balance !== value)) {
+        this.propertyWillChange(key) ;
+        balance = this._balance = value ;
+        this.propertyDidChange(key) ;
       }
-      seenRevisions[key] = rev ;
+      return balance ;
     }
     
-    this._didChangeCache[context] = seen ;
-    this._didChangeRevisionCache[context] = seenRevisions ;
-    return ret ;
+  }}}
+
+*/
+SC.Observable = {
+
+  /**
+    Determines whether observers should be automatically notified of changes
+    to a key.
+    
+    If you are manually implementing change notifications for a property, you
+    can override this method to return NO for properties you do not want the
+    observing system to automatically notify for.
+    
+    The default implementation always returns YES.
+    
+    @param key {String} the key that is changing
+    @returns {Boolean} YES if automatic notification should occur.
+  */
+  automaticallyNotifiesObserversFor: function(key) { 
+    return YES;
   },
 
   // ..........................................
@@ -196,7 +169,7 @@ SC.Observable = {
     var ret = this[key] ;
     if (ret === undefined) {
       return this.unknownProperty(key) ;
-    } else if (ret && (ret instanceof Function) && ret.isProperty) {
+    } else if (ret && ret.isProperty) {
       return ret.call(this,key) ;
     } else return ret ;
   },
@@ -251,20 +224,107 @@ SC.Observable = {
   set: function(key, value) {
     var func = this[key] ;
     var ret = value ;
-
-    this.propertyWillChange(key) ;
-
+    var notify = this.automaticallyNotifiesObserversFor(key) ;
+    
+    if (notify) this.propertyWillChange(key) ;
+    
     // set the value.
-    if (func && (func instanceof Function) && (func.isProperty)) {
+    if (func && func.isProperty) {
       ret = func.call(this,key,value) ;
     } else if (func === undefined) {
       ret = this.unknownProperty(key,value) ;
     } else ret = this[key] = value ;
-
+    
     // post out notifications.
-    this.propertyDidChange(key, ret) ;
+    if (notify) this.propertyDidChange(key, ret) ;
     return this ;
-  },  
+  },
+
+  // ..........................................
+  // OBSERVERS
+  // 
+
+  
+
+  // ..........................................
+  // BINDINGS
+  // 
+    
+  /**  
+    Manually add a new binding to an object.  This is the same as doing
+    the more familiar propertyBinding: 'property.path' approach.
+  */
+  bind: function(toKey, fromPropertyPath) {
+    
+    var r = SC.idt.active ;
+    
+    var binding ;
+    var props = { to: [this, toKey] } ;
+
+    // for strings try to do default relay
+    var pathType = $type(fromPropertyPath) ;
+    if (pathType == T_STRING || pathType == T_ARRAY) {
+      binding = this[toKey + 'BindingDefault'] || SC.Binding.From;
+      binding = binding(fromPropertyPath) ;
+    } else binding = fromPropertyPath ;
+
+    // check the 'from' value of the relay. if it starts w/
+    // '.' || '*' then convert to a local tuple.
+    var relayFrom = binding.prototype.from ;
+    if ($type(relayFrom) == T_STRING) switch(relayFrom.slice(0,1)) {
+      case '*':
+      case '.':
+        relayFrom = [this,relayFrom.slice(1,relayFrom.length)];
+    }        
+
+    if(r) bt = new Date().getTime();
+
+    binding = binding.create(props, { from: relayFrom }) ;
+    this.bindings.push(binding) ;
+
+    if (r) SC.idt.b1_t += (new Date().getTime()) - bt ;
+    
+    return binding ;
+  },
+  
+  /**  
+    didChangeFor makes it easy for you to verify that you haven't seen any
+    changed values.  You need to use this if your method observes multiple
+    properties.  To use this, call it like this:
+  
+    if (this.didChangeFor('render','height','width')) {
+       // DO SOMETHING HERE IF CHANGED.
+    }
+  */  
+  didChangeFor: function(context) {    
+    var keys = SC.$A(arguments) ;
+    context = keys.shift() ;
+    
+    var ret = false ;
+    if (!this._didChangeCache) this._didChangeCache = {} ;
+    if (!this._didChangeRevisionCache) this._didChangeRevisionCache = {};
+    
+    var seen = this._didChangeCache[context] || {} ;
+    var seenRevisions = this._didChangeRevisionCache[context] || {} ;
+    var loc = keys.length ;
+    var rev = this._kvo().revision ;
+    
+    while(--loc >= 0) {
+      var key = keys[loc] ;
+      if (seenRevisions[key] != rev) {
+        var val = this.get(key) ;
+        if (seen[key] !== val) ret = true ;
+        seen[key] = val ;
+      }
+      seenRevisions[key] = rev ;
+    }
+    
+    this._didChangeCache[context] = seen ;
+    this._didChangeRevisionCache[context] = seenRevisions ;
+    return ret ;
+  },
+
+
 
   /**
     Sets the property only if the passed value is different from the
@@ -314,7 +374,7 @@ SC.Observable = {
     @returns {Array} Values of property keys.
   */
   getEach: function() {
-    var keys = $A(arguments).flatten() ;
+    var keys = SC.$A(arguments).flatten() ;
     var ret = [];
     for(var idx=0; idx<keys.length;idx++) {
       ret[ret.length] = this.getPath(keys[idx]);
@@ -543,6 +603,13 @@ SC.Observable = {
 
     // otherwise, bind as a normal property
     } else {      
+      
+      // if you add an observer beginning with '@', then we might need to 
+      // create or register the property...
+      if (this.reducedProperty && (key.charAt(0) === '@')) {
+        this.reducedProperty(key, undefined) ; // create if needed...
+      }
+      
       var observers = kvo.observers[key] = (kvo.observers[key] || []) ;
       var found = false; var loc = observers.length;
       while(!found && --loc >= 0) found = (observers[loc] == func) ;
@@ -586,7 +653,7 @@ SC.Observable = {
     @param propertyNames one or more property names
   */
   logProperty: function() {
-    var props = $A(arguments) ;
+    var props = SC.$A(arguments) ;
     for(var idx=0;idx<props.length; idx++) {
       var prop = props[idx] ;
       console.log('%@:%@: '.fmt(this._guid, prop), this.get(prop)) ;
@@ -626,7 +693,7 @@ SC.Observable = {
     change.
   */  
   registerDependentKey: function(key) {
-    var keys = $A(arguments) ;
+    var keys = SC.$A(arguments) ;
     var dependent = keys.shift() ;
     var kvo = this._kvo() ;
     for(var loc=0;loc<keys.length;loc++) {
@@ -743,11 +810,13 @@ SC.Observable = {
     
 } ;
 
+SC.mixin(Array.prototype, SC.Observable) ;
+
 // ........................................................................
 // FUNCTION ENHANCEMENTS
 //
 // Enhance function.
-Object.extend(Function.prototype,
+SC.mixin(Function.prototype,
 /** @scope Function.prototype */ {
   
   /**
@@ -858,14 +927,14 @@ Object.extend(Function.prototype,
     @returns {Function} the declared function instance
   */
   property: function() {
-    this.dependentKeys = $A(arguments) ; 
+    this.dependentKeys = SC.$A(arguments) ; 
     this.isProperty = true; return this; 
   },
   
   // Declare that a function should observe an object at the named path.  Note
   // that the path is used only to construct the observation one time.
   observes: function(propertyPaths) { 
-    this.propertyPaths = $A(arguments); 
+    this.propertyPaths = SC.$A(arguments); 
     return this;
   },
   
@@ -893,7 +962,7 @@ Object.extend(Function.prototype,
     if (interval === undefined) interval = 1 ;
     var f = this;
     if (arguments.length > 2) {
-      var args =$A(arguments).slice(2,arguments.length);
+      var args =SC.$A(arguments).slice(2,arguments.length);
       args.unshift(target);
       f = f.bind.apply(f, args) ;
     }

data/frameworks/sproutcore/mixins/selection_support.js

@@ -143,6 +143,18 @@ SC.SelectionSupport = {
 
     @type bool
   */
-  allowsEmptySelection: true
+  allowsEmptySelection: true,
+  
+  /**
+    YES if the receiver currently has a non-zero selection.
+    
+    @property
+    @type {Boolean}
+  */
+  hasSelection: function() {
+    var sel = this.get('selection') ;
+    return sel && (sel.get('length') > 0) ;
+  }.property('selection')
+    
 };
 

data/frameworks/sproutcore/models/record.js

@@ -92,9 +92,10 @@ SC.Record = SC.Object.extend(
   //
 
   /**
-    Set this URL to point to the type of resource this record is.  Put a
-    '%@' where you expect the primaryKey to be inserted to identify the
-    record.
+    Set this URL to point to the type of resource this record is. 
+    
+    If you are using SC.Server, then put a '%@' where you expect the 
+    primaryKey to be inserted to identify the record.
     
     @field
     @type {String}
@@ -111,6 +112,33 @@ SC.Record = SC.Object.extend(
   */
   dataSource: SC.Store,
 
+  /**
+    The URL where this record can be refreshed. Usually you would send the value
+    for this URL from the server in response to requests from Sproutcore.
+    
+    @field
+    @type {String}
+  */
+  refreshURL: null,
+
+  /**
+    The URL where this record can be updated. Usually you would send the value
+    for this URL from the server in response to requests from Sproutcore.
+    
+    @field
+    @type {String}
+  */
+  updateURL: null,
+
+  /**
+    The URL where this record can be destroyed. Usually you would send the value
+    for this URL from the server in response to requests from Sproutcore.
+    
+    @field
+    @type {String}
+  */
+  destroyURL: null,
+
 
   init: function()
   {
@@ -146,7 +174,7 @@ SC.Record = SC.Object.extend(
     to support server changes.  Note that this is used to support both the
     create and update components of CRUD.
   */
-  commit: function() {
+  commit: function() {  
     // no longer a new record once changes have been committed.
     if (this.get('newRecord')) {
       this.dataSource.createRecords([this]) ;
@@ -183,18 +211,18 @@ SC.Record = SC.Object.extend(
     @returns {value} the value of the key, or null if it doesn't exist
   **/
   readAttribute: function(key) {
-  	if (!this._cachedAttributes) this._cachedAttributes = {} ;
-  	var ret = this._cachedAttributes[key] ;
-  	if (ret === undefined) {
-			var attr = this._attributes ;
-			ret = (attr) ? attr[key] : undefined ;
-			if (ret !== undefined) {
-				var recordType = this._getRecordType(key+'Type') ;
-				ret = this._propertyFromAttribute(ret, recordType) ;
-			}
-			this._cachedAttributes[key] = ret ;
-  	}
-  	return (ret === undefined) ? null : ret;
+    if (!this._cachedAttributes) this._cachedAttributes = {} ;
+    var ret = this._cachedAttributes[key] ;
+    if (ret === undefined) {
+      var attr = this._attributes ;
+      ret = (attr) ? attr[key] : undefined ;
+      if (ret !== undefined) {
+        var recordType = this._getRecordType(key+'Type') ;
+        ret = this._propertyFromAttribute(ret, recordType) ;
+      }
+      this._cachedAttributes[key] = ret ;
+    }
+    return (ret === undefined) ? null : ret;
   },
 
   /**
@@ -210,9 +238,17 @@ SC.Record = SC.Object.extend(
     if (!this._attributes) this._attributes = {} ;
     this._attributes[key] = ret ;
     if (this._cachedAttributes) delete this._cachedAttributes[key];  // clear cache.
+    this.recordDidChange() ;
+    return value ;  
+  },
+  
+  /**
+    You can invoke this method anytime you need to make the record as dirty
+    and needing a commit to the server.
+  */
+  recordDidChange: function() {
     this.incrementProperty('changeCount') ;
     if (SC.Store) SC.Store.recordDidChange(this) ;
-    return value ;  
   },
   
   /**
@@ -313,10 +349,15 @@ SC.Record = SC.Object.extend(
   
   _propertyFromAttribute: function(value,recordType) {
     if (value && value instanceof Array) {
-      var that = this;
-      return value.map(function(v) { 
-        return that._propertyFromAttribute(v,recordType); 
-      }) ;
+      var max = value.get('length') ;
+      var ret = new Array(max) ; 
+      for(var idx=0;idx<max;idx++) {
+        var v = value.objectAt(idx) ; 
+        ret[idx] = this._propertyFromAttribute(v, recordType) ; 
+      }
+      ret.ownerRecord = this ;
+      return ret ;
+      
     } else {
       var typeConverter = this._pickTypeConverter(recordType) ;
       if (typeConverter) return typeConverter(value,'in') ;
@@ -462,6 +503,7 @@ SC.Record = SC.Object.extend(
     if (recValue && recValue.primaryKey) recValue = recValue.get(recValue.primaryKey) ;
     var stringify = (value instanceof RegExp);
     if (stringify)  {
+      if (recValue == null) return false ;
       return recValue.toString().match(value) ;
     } else {
        return recValue==value ;
@@ -624,17 +666,20 @@ SC.Record = SC.Object.extend(
 }) ;
 
 // Class Methods
-SC.Record.mixin({
+SC.Record.mixin(
+/** @static SC.Record */ {
 
   // Constants for sorting
   SORT_BEFORE: -1, SORT_AFTER: 1, SORT_SAME: 0,
 
-  // Used to find the first object matching the specified conditions.  You can pass
-  // in either a simple guid or one or more hashes of conditions.
+  /** 
+    Used to find the first object matching the specified conditions.  You can 
+    pass in either a simple guid or one or more hashes of conditions.
+  */
   find: function(guid) {
     var args ;
     if (typeof(guid) == 'object') {
-      args = $A(arguments) ;
+      args = SC.$A(arguments) ;
       args.push(this) ;
       var ret = SC.Store.findRecords.apply(SC.Store,args) ;
       return (ret && ret.length > 0) ? ret[0] : null ;
@@ -654,7 +699,7 @@ SC.Record.mixin({
   // Same as find except returns all records matching the passed conditions.
   findAll: function(filter) {
     if (!filter) filter = {} ;
-    args = $A(arguments) ; args.push(this) ; // add type
+    args = SC.$A(arguments) ; args.push(this) ; // add type
     return SC.Store.findRecords.apply(SC.Store,args) ;  
   },
   
@@ -723,9 +768,11 @@ SC.Record.mixin({
     SC.Store.addRecord(rec) ;
     return rec; 
   }
-  
+    
 }) ;
 
+SC.Record.newObject = SC.Record.newRecord; // clone method
+
 // Built in Type Converters.  You can also use an SC.Record.
 SC.Record.Date = function(value,direction) {
   if (direction == 'out') {

data/frameworks/sproutcore/models/store.js

@@ -61,6 +61,9 @@ SC.Store = SC.Object.create(
       var pkValue = data[rt.primaryKey()] ;      
       var rec = store.getRecordFor(pkValue,rt,true) ;
       rec.dataSource = dataSource ;
+      if (data.refreshURL) rec.refreshURL = data.refreshURL;
+      if (data.updateURL) rec.updateURL = data.updateURL;
+      if (data.destroyURL) rec.destroyURL = data.destroyURL;
       rec.updateAttributes(data, isLoaded, isLoaded) ;
       if (rec.needsAddToStore) store.addRecord(rec) ;
       ret.push(rec) ;
@@ -177,7 +180,7 @@ SC.Store = SC.Object.create(
     recordType.  It will AND the results of each condition hash.
   */  
   findRecords: function() {
-    var allConditions = $A(arguments) ;
+    var allConditions = SC.$A(arguments) ;
     var recordType = allConditions.pop() ;
     var guid = recordType._storeKey() ;
 
@@ -195,8 +198,9 @@ SC.Store = SC.Object.create(
       }
       records = ret ;
     }
-    
-    return records ;
+
+    // clone records...
+    return SC.$A(records) ;
   },
   
   // private method used by Record and Store. Returns null if the record does not exist.

data/frameworks/sproutcore/server/rails_server.js

@@ -0,0 +1,82 @@
+// ========================================================================
+// SproutCore
+// copyright 2006-2008 Sprout Systems, Inc.
+// ========================================================================
+
+require('core') ;
+
+/**
+  @class
+
+  This server extends SC.RestServer and leverages Rails feature to protect
+  your controller actions from CSRF attacks by using the authenticity token
+  from rails in requests from SproutCore. For more information about this
+  feature from Rails see the documentation in rails for module
+  ActionController::RequestForgeryProtection.
+
+  To use this server create it like for example:
+
+  {{{
+    Contacts = SC.Object.create({
+      server: SC.RailsServer.create({ prefix: ['Contacts'] })
+    }) ;
+  }}}
+
+  In order for SproutCore to send the authenticity token in the body of 
+  requests there is one prerequisite: you must initialize the SproutCore app 
+  by setting the following two variables:
+
+  | SC.RAILS_AUTH_TOKEN_NAME  | Should be set to the name of the authenticity token |
+  | SC.AUTH_TOKEN | Should be set to the value of the authenticity token |
+
+  Following is a description of how this can be achieved. Stick the following 
+  code in one of your controllers:
+
+  {{{
+    # Passes the authenticity token for use in javascript
+    def auth_token
+      respond_to do |wants|
+        wants.js do
+          if protect_against_forgery?
+            render :text => "var SC = SC || {};  
+              SC.RAILS_AUTH_TOKEN_NAME = '#{request_forgery_protection_token}';
+              SC.RAILS_AUTH_TOKEN = '#{form_authenticity_token}';"
+          end
+        end
+      end
+    end
+  }}}
+
+  And make it accessible via your rails routes.rb file, for example:
+
+  {{{
+    map.connect 'auth-token.js', :controller => 'application', :action => 'auth_token'
+  }}}
+
+  Copy-and-paste the default index template of SproutCore into your own
+  client app. Refer to your new default index template by modifying the
+  :layout option in your sc-config file. Lastly, within this default
+  index template add a line to call auth-token.js on your rails server.
+  For example:
+
+  {{{
+    <script src="/sc/auth-token.js" type="text/javascript"></script>
+  }}}
+
+
+  @extends SC.RestServer
+  @author Lawrence Pit
+  @copyright 2006-2008, Sprout Systems, Inc. and contributors.
+  @since SproutCore 1.0
+*/
+SC.RailsServer = SC.RestServer.extend({
+
+  urlFor: function(resource, action, ids, params, method) {
+    if (method != 'get' && SC.RAILS_AUTH_TOKEN_NAME) {
+      params[SC.RAILS_AUTH_TOKEN_NAME] = SC.RAILS_AUTH_TOKEN;
+    }
+
+    return sc_super();
+  }
+
+}) ;