sproutit-sproutcore 1.0.0.20090416161445 → 1.0.0.20090720093355

data/frameworks/sproutcore/frameworks/runtime/system/set.js

@@ -5,8 +5,20 @@
 // License:   Licened under MIT license (see license.js)
 // ==========================================================================
 
-require('mixins/enumerable') ;
-require('mixins/observable') ;
+sc_require('mixins/enumerable') ;
+sc_require('mixins/observable') ;
+sc_require('mixins/freezable');
+sc_require('mixins/copyable');
+
+// IMPORTANT NOTE:  This file actually defines two classes: 
+// SC.Set is a fully observable set class documented below. 
+// SC._CoreSet is just like SC.Set but is not observable.  This is required
+// because SC.Observable is built on using sets and requires sets without 
+// observability.
+//
+// We use pointer swizzling below to swap around the actual definitions so 
+// that the documentation will turn out right.  (The docs should only 
+// define SC.Set - not SC._CoreSet)
 
 /**
   @class 
@@ -24,10 +36,10 @@ require('mixins/observable') ;
 
   h1. Creating a Set
 
-  You can create a set like you would most objects using SC.Set.create() or
-  new SC.Set().  Most new sets you create will be empty, but you can also
-  initialize the set with some content by passing an array or other enumerable
-  of objects to the constructor.
+  You can create a set like you would most objects using SC.Set.create().  
+  Most new sets you create will be empty, but you can also initialize the set 
+  with some content by passing an array or other enumerable of objects to the 
+  constructor.
 
   Finally, you can pass in an existing set and the set will be copied.  You
   can also create a copy of a set by calling SC.Set#clone().
@@ -73,26 +85,57 @@ require('mixins/observable') ;
   object's _guid but if you implement the hash() method on the object, it will
   use the return value from that method instead.
 
-  @extends Object
   @extends SC.Enumerable 
   @extends SC.Observable
-  @since SproutCore 0.9.15
+  @extends SC.Copyable
+  @extends SC.Freezable
+
+  @since SproutCore 1.0
 */
-SC.Set = function(items) {
-  this.initObservable();
-  if (items && items.length > 0) {
-    var idx = items.get ? items.get('length') : items.length ;
-    if (items.objectAt) {
-      while(--idx >= 0) this.add(items.objectAt(idx)) ;
-    } else {
-      while(--idx >= 0) this.add(items[idx]) ;
+SC.Set = SC.mixin({}, 
+  SC.Enumerable, 
+  SC.Observable, 
+  SC.Freezable, 
+/** @scope SC.Set.prototype */ {
+
+  /** 
+    Creates a new set, with the optional array of items included in the 
+    return set.
+
+    @param {SC.Enumerable} items items to add
+    @return {SC.Set}
+  */
+  create: function(items) {
+    var ret, idx, pool = SC.Set._pool, isObservable = this.isObservable;
+    if (!isObservable && items===undefined && pool.length>0) ret = pool.pop();
+    else {
+      ret = SC.beget(this);
+      if (isObservable) ret.initObservable();
+      
+      if (items && items.isEnumerable && items.get('length')>0) {
+
+        ret.isObservable = NO; // suspend change notifications
+        
+        // arrays and sets get special treatment to make them a bit faster
+        if (items.isSCArray) {
+          idx = items.get ? items.get('length') : items.length;
+          while(--idx>=0) ret.add(items.objectAt(idx));
+        
+        } else if (items.isSet) {
+          idx = items.length;
+          while(--idx>=0) ret.add(items[idx]);
+          
+        // otherwise use standard SC.Enumerable API
+        } else items.forEach(function(i) { ret.add(i); }, this);
+        
+        ret.isObservable = isObservable;
+      }
     }
-  }
-  return this ;
-} ;
-
-SC.Set.prototype = {
-
+    return ret ;
+  },
+  
+  isSet: YES,
+  
   /**
     This property will change as the number of objects in the set changes.
 
@@ -100,10 +143,18 @@ SC.Set.prototype = {
   */
   length: 0,
 
+  firstObject: function() {
+    return (this.length>0) ? this[0] : undefined ;
+  }.property(),
+  
   /**
     Clears the set 
   */
-  clear: function() { this.length = 0; },
+  clear: function() { 
+    if (this.isFrozen) throw SC.FROZEN_ERROR;
+    this.length = 0;
+    return this ;
+  },
 
   /**
     Call this method to test for membership.
@@ -116,7 +167,28 @@ SC.Set.prototype = {
     // the current length.
     if (obj === null) return NO ;
     var idx = this[SC.hashFor(obj)] ;
-    return (!SC.none(idx) && (idx < this.length)) ;
+    return (!SC.none(idx) && (idx < this.length) && (this[idx]===obj)) ;
+  },
+  
+  /**
+    Returns YES if the passed object is also a set that contains the same 
+    objects as the receiver.
+  
+    @param {SC.Set} obj the other object
+    @returns {Boolean}
+  */
+  isEqual: function(obj) {
+    // fail fast
+    if (!obj || !obj.isSet || (obj.get('length') !== this.get('length'))) {
+      return NO ;
+    }
+    
+    var loc = this.get('length');
+    while(--loc>=0) {
+      if (!obj.contains(this[loc])) return NO ;
+    }
+    
+    return YES;
   },
 
   /**
@@ -128,29 +200,47 @@ SC.Set.prototype = {
     @returns {Object} this
   */
   add: function(obj) {
-    if (SC.none(obj)) return this; // cannot add null to a set.
+    if (this.isFrozen) throw SC.FROZEN_ERROR;
+    
+    // cannot add null to a set.
+    if (obj===null || obj===undefined) return this; 
 
     var guid = SC.hashFor(obj) ;
     var idx = this[guid] ;
     var len = this.length ;
-    if (SC.none(idx) || (idx >= len)) {
+    if ((idx===null || idx===undefined) || (idx >= len) || (this[idx]!==obj)){
       this[len] = obj ;
       this[guid] = len ;
       this.length = len+1;
     }
+    
+    if (this.isObservable) this.enumerableContentDidChange();
+    
     return this ;
   },
 
   /**
-    Add all the items in the passed array.
+    Add all the items in the passed array or enumerable
   */
   addEach: function(objects) {
-    var idx = objects.get('length') ;
-    if (objects.objectAt) {
-      while(--idx >= 0) this.add(objects.objectAt(idx)) ;
-    } else {
-      while(--idx >= 0) this.add(objects[idx]) ;
+    if (this.isFrozen) throw SC.FROZEN_ERROR;
+    if (!objects || !objects.isEnumerable) {
+      throw "%@.addEach must pass enumerable".fmt(this);
     }
+
+    var idx, isObservable = this.isObservable ;
+    
+    if (isObservable) this.beginPropertyChanges();
+    if (objects.isSCArray) {
+      idx = objects.get('length');
+      while(--idx >= 0) this.add(objects.objectAt(idx)) ;
+    } else if (objects.isSet) {
+      idx = objects.length;
+      while(--idx>=0) this.add(objects[idx]);
+      
+    } else objects.forEach(function(i) { this.add(i); }, this);
+    if (isObservable) this.endPropertyChanges();
+    
     return this ;
   },  
 
@@ -163,13 +253,15 @@ SC.Set.prototype = {
     @returns {this} this
   */  
   remove: function(obj) {
+    if (this.isFrozen) throw SC.FROZEN_ERROR;
 
     if (SC.none(obj)) return this ;
     var guid = SC.hashFor(obj);
     var idx = this[guid] ;
     var len = this.length;
 
-    if (SC.none(idx) || (idx >= len)) return this; // not in set.
+    // not in set.
+    if (SC.none(idx) || (idx >= len) || (this[idx] !== obj)) return this; 
 
     // clear the guid key
     delete this[guid] ;
@@ -183,6 +275,7 @@ SC.Set.prototype = {
 
     // reduce the length
     this.length = len-1;
+    if (this.isObservable) this.enumerableContentDidChange();
     return this ;
   },
 
@@ -192,6 +285,7 @@ SC.Set.prototype = {
     @returns {Object} an object from the set or null
   */
   pop: function() {
+    if (this.isFrozen) throw SC.FROZEN_ERROR;
     var obj = (this.length > 0) ? this[this.length-1] : null ;
     if (obj) this.remove(obj) ;
     return obj ;
@@ -201,12 +295,23 @@ SC.Set.prototype = {
     Removes all the items in the passed array.
   */
   removeEach: function(objects) {
-    var idx = objects.get('length') ;
-    if (objects.objectAt) {
-      while(--idx >= 0) this.remove(objects.objectAt(idx)) ;
-    } else {
-      while(--idx >= 0) this.remove(objects[idx]) ;
+    if (this.isFrozen) throw SC.FROZEN_ERROR;
+    if (!objects || !objects.isEnumerable) {
+      throw "%@.addEach must pass enumerable".fmt(this);
     }
+
+    var idx, isObservable = this.isObservable ;
+    
+    if (isObservable) this.beginPropertyChanges();
+    if (objects.isSCArray) {
+      idx = objects.get('length');
+      while(--idx >= 0) this.remove(objects.objectAt(idx)) ;
+    } else if (objects.isSet) {
+      idx = objects.length;
+      while(--idx>=0) this.remove(objects[idx]);
+    } else objects.forEach(function(i) { this.remove(i); }, this);
+    if (isObservable) this.endPropertyChanges();
+    
     return this ;
   },  
 
@@ -214,33 +319,57 @@ SC.Set.prototype = {
    Clones the set into a new set.  
   */
   clone: function() {
-    return SC.Set.create(this);    
+    return this.constructor.create(this);    
   },
 
+  /**
+    Return a set to the pool for reallocation.
+  */
+  destroy: function() {
+    this.isFrozen = NO ; // unfreeze to return to pool
+    if (!this.isObservable) SC.Set._pool.push(this.clear());
+    return this;
+  },
+  
   // .......................................
   // PRIVATE 
   //
-  _each: function(iterator) {
-    var len = this.length ;
-    for(var idx=0;idx<len;idx++) iterator(this[idx]) ;
+
+  // optimized
+  forEach: function(iterator, target) {
+    var len = this.length;
+    if (!target) target = this ;
+    for(var idx=0;idx<len;idx++) iterator.call(target, this[idx], idx, this);
+    return this ;
   },
 
   toString: function() {
-    return "SC.Set<%@>".fmt(SC.$A(this)) ;
-  }  
+    var len = this.length, idx, ary = [];
+    for(idx=0;idx<len;idx++) ary[idx] = this[idx];
+    return "SC.Set<%@>".fmt(ary.join(',')) ;
+  },
+  
+  // the pool used for non-observable sets
+  _pool: [],
+  
+  isObservable: YES
 
-} ;
+}) ;
 
-SC.Set.prototype.slice = SC.Set.prototype.clone ;
+SC.Set.constructor = SC.Set;
 
-// Make this enumerable and observable
-SC.mixin(SC.Set.prototype, SC.Enumerable, SC.Observable) ;
+// Make SC.Set look a bit more like other enumerables
+SC.Set.copy = SC.Set.clone ;
+SC.Set.push = SC.Set.unshift = SC.Set.add ;
+SC.Set.shift = SC.Set.pop ;
 
-SC.Set.prototype.push = SC.Set.prototype.unshift = SC.Set.prototype.add ;
-SC.Set.prototype.shift = SC.Set.prototype.pop ;
+// add generic add/remove enumerable support
+SC.Set.addObject = SC.Set.add ;
+SC.Set.removeObject = SC.Set.remove;
 
+SC.Set._pool = [];
 
-/**
-  To create a set, pass an array of items instead of a hash.
-*/
-SC.Set.create = function(items) { return new SC.Set(items); };
+// CoreSet is like Set but not observable
+SC.CoreSet = SC.beget(SC.Set);
+SC.CoreSet.isObservable = NO ;
+SC.CoreSet.constructor = SC.CoreSet;

data/frameworks/sproutcore/frameworks/runtime/system/sparse_array.js

@@ -46,7 +46,10 @@ SC.SparseArray = SC.Object.extend(SC.Observable, SC.Enumerable, SC.Array,
   // ..........................................................
   // LENGTH SUPPORT
   // 
-  
+
+  _requestingLength: 0,  
+  _requestingIndex: 0,
+   
   /**
     The length of the sparse array.  The delegate for the array should set 
     this length.
@@ -55,8 +58,10 @@ SC.SparseArray = SC.Object.extend(SC.Observable, SC.Enumerable, SC.Array,
   */
   length: function() {
     var del = this.delegate ;
-    if (del && SC.none(this._length) && del.sparseArrayDidRequestLength) {      
+    if (del && SC.none(this._length) && del.sparseArrayDidRequestLength) {
+      this._requestingLength++ ;
       del.sparseArrayDidRequestLength(this);
+      this._requestingLength-- ;
     }
     return this._length || 0 ;
   }.property().cacheable(),
@@ -74,11 +79,11 @@ SC.SparseArray = SC.Object.extend(SC.Observable, SC.Enumerable, SC.Array,
     if (SC.none(length)) this._sa_content = null ;
     if (length !== this._length) {
       this._length = length ;
-      this.enumerableContentDidChange() ;
+      if (this._requestingLength <= 0) this.enumerableContentDidChange() ;
     }
     return this ;
   },
-  
+
   // ..........................................................
   // READING CONTENT 
   // 
@@ -129,6 +134,7 @@ SC.SparseArray = SC.Object.extend(SC.Observable, SC.Enumerable, SC.Array,
     if (len < 1) len = 1 ;
     
     // invoke appropriate callback
+    this._requestingIndex++;
     if (del.sparseArrayDidRequestRange) {
       var range = this._TMP_RANGE;
       range.start = start;
@@ -136,8 +142,10 @@ SC.SparseArray = SC.Object.extend(SC.Observable, SC.Enumerable, SC.Array,
       del.sparseArrayDidRequestRange(this, range);
       
     } else if (del.sparseArrayDidRequestIndex) {
-      while(--len >= 0) del.sparseArrayDidRequestIndex(start + len);
+      while(--len >= 0) del.sparseArrayDidRequestIndex(this, start + len);
     }
+    this._requestingIndex--;
+
     return this ;
   },
   
@@ -156,7 +164,7 @@ SC.SparseArray = SC.Object.extend(SC.Observable, SC.Enumerable, SC.Array,
     if (!content) content = this._sa_content = [] ;
     var start = range.start, len = range.length;
     while(--len >= 0) content[start+len] = array[len];
-    this.enumerableContentDidChange() ;
+    if (this._requestingIndex <= 0) this.enumerableContentDidChange() ;
     return this ;
   },
 
@@ -217,7 +225,7 @@ SC.SparseArray = SC.Object.extend(SC.Observable, SC.Enumerable, SC.Array,
   indexOf: function(obj) {
     var del = this.delegate ;
     if (del && del.sparseArrayDidRequestIndexOf) {
-      return del.del.sparseArrayDidRequestIndexOf(this, obj);
+      return del.sparseArrayDidRequestIndexOf(this, obj);
     } else {
       var content = this._sa_content ;
       if (!content) content = this._sa_content = [] ;
@@ -256,14 +264,15 @@ SC.SparseArray = SC.Object.extend(SC.Observable, SC.Enumerable, SC.Array,
     content.replace(idx, amt, objects) ;
     
     // update length
-    var delta = objects.length - amt ;
-    if (delta!==0 && !SC.none(this._length)) {
+    var len = objects ? (objects.get ? objects.get('length') : objects.length) : 0;
+    var delta = len - amt ;
+    if (!SC.none(this._length)) {
       this.propertyWillChange('length');
       this._length += delta;
       this.propertyDidChange('length');
-    } 
+    }
 
-    this.enumerableContentDidChange() ;
+    this.enumerableContentDidChange(idx, amt, delta) ;
     return this ;
   },
 

data/frameworks/sproutcore/frameworks/runtime/tests/core/clone.js

@@ -5,7 +5,7 @@
 // License:   Licened under MIT license (see license.js)
 // ==========================================================================
 
-/*globals module test ok isObj equals expects object isSet */
+/*globals module test ok equals expects object same */
 
 var object ;
 
@@ -48,7 +48,7 @@ test("should return a cloned object", function() {
   	equals(SC.clone(objectB), SC.clone(objectB)) ;
 	equals(SC.clone(objectC), SC.clone(objectC)) ;
 	equals(SC.clone(objectE), SC.clone(objectE)) ;
-	isSet(a, b);
+	same(a, b);
 });
 
 test("should return cloned object when the object is null", function() {