sproutcore 1.0.1046 → 1.0.1049.pre.1

data/frameworks/sproutcore/frameworks/datastore/system/record_array.js

@@ -2,7 +2,7 @@
 // Project:   SproutCore - JavaScript Application Framework
 // Copyright: ©2006-2009 Sprout Systems, Inc. and contributors.
 //            Portions ©2008-2009 Apple Inc. All rights reserved.
-// License:   Licened under MIT license (see license.js)
+// License:   Licensed under MIT license (see license.js)
 // ==========================================================================
 
 sc_require('models/record');

data/frameworks/sproutcore/frameworks/datastore/system/store.js

@@ -2,7 +2,7 @@
 // Project:   SproutCore - JavaScript Application Framework
 // Copyright: ©2006-2009 Sprout Systems, Inc. and contributors.
 //            Portions ©2008-2009 Apple Inc. All rights reserved.
-// License:   Licened under MIT license (see license.js)
+// License:   Licensed under MIT license (see license.js)
 // ==========================================================================
 
 sc_require('models/record');
@@ -239,7 +239,7 @@ SC.Store = SC.Object.extend( /** @scope SC.Store.prototype */ {
     you call commitRecords() without passing any other parameters, the keys
     in this set will be committed instead.
   
-    @property {Array}
+    @property {SC.Set}
   */
   changelog: null,
   
@@ -653,7 +653,7 @@ SC.Store = SC.Object.extend( /** @scope SC.Store.prototype */ {
     if (records) {
       for(storeKey in records) {
         if (!records.hasOwnProperty(storeKey)) continue ;
-        this._notifyRecordPropertyChange(storeKey, NO);
+        this._notifyRecordPropertyChange(parseInt(storeKey, 10), NO);
       }
     }
     
@@ -672,7 +672,7 @@ SC.Store = SC.Object.extend( /** @scope SC.Store.prototype */ {
     time.
   
     @param {SC.Store} nestedStore the child store
-    @param {Array} changes the array of changed store keys
+    @param {SC.Set} changes the set of changed store keys
     @param {Boolean} force
     @returns {SC.Store} receiver
   */
@@ -1068,7 +1068,8 @@ SC.Store = SC.Object.extend( /** @scope SC.Store.prototype */ {
     @returns {SC.Record} Returns the created record
   */
   createRecord: function(recordType, dataHash, id) {
-    var primaryKey, storeKey, status, K = SC.Record, changelog, defaultVal;
+    var primaryKey, storeKey, status, K = SC.Record, changelog, defaultVal,
+        ret;
     
     // First, try to get an id.  If no id is passed, look it up in the 
     // dataHash.
@@ -1117,8 +1118,11 @@ SC.Store = SC.Object.extend( /** @scope SC.Store.prototype */ {
       this.invokeLast(this.commitRecords);
     }
     
-    // finally return materialized record
-    return this.materializeRecord(storeKey) ;
+    // Finally return materialized record, after we propagate the status to
+    // any aggregrate records.
+    ret = this.materializeRecord(storeKey);
+    if (ret) ret.propagateToAggregates();
+    return ret;
   },
   
   /**
@@ -1146,6 +1150,81 @@ SC.Store = SC.Object.extend( /** @scope SC.Store.prototype */ {
     return ret ;
   },
   
+  
+  /**
+    Unloads a record, removing the data hash from the store.  If you try to 
+    unload a record that is already destroyed then this method will have no effect.  
+    If you unload a record that does not exist or an error then an exception 
+    will be raised.
+    
+    @param {SC.Record} recordType the recordType
+    @param {String} id the record id
+    @param {Number} storeKey (optional) if passed, ignores recordType and id
+    @returns {SC.Store} receiver
+  */
+  unloadRecord: function(recordType, id, storeKey, newStatus) {
+    if (storeKey === undefined) storeKey = recordType.storeKeyFor(id);
+    var status = this.readStatus(storeKey), K = SC.Record;
+    newStatus = newStatus || K.EMPTY;
+    // handle status - ignore if destroying or destroyed
+    if ((status === K.BUSY_DESTROYING) || (status & K.DESTROYED)) {
+      return this; // nothing to do
+      
+    // error out if empty
+    } else if (status & K.BUSY) {
+      throw K.BUSY_ERROR ;
+           
+    // otherwise, destroy in dirty state
+    } else status = newStatus ;
+    
+    // remove the data hash, set new status
+    this.removeDataHash(storeKey, status);
+    this.dataHashDidChange(storeKey);
+            
+    return this ;
+  },
+  
+  /**
+    Unloads a group of records.  If you have a set of record ids, unloading
+    them this way can be faster than retrieving each record and unloading 
+    it individually.
+    
+    You can pass either a single recordType or an array of recordTypes.  If
+    you pass a single recordType, then the record type will be used for each
+    record.  If you pass an array, then each id must have a matching record 
+    type in the array.
+
+    You can optionally pass an array of storeKeys instead of the recordType
+    and ids.  In this case the first two parameters will be ignored.  This
+    is usually only used by low-level internal methods.  You will not usually
+    unload records this way.
+    
+    @param {SC.Record|Array} recordTypes class or array of classes
+    @param {Array} ids ids to unload
+    @param {Array} storeKeys (optional) store keys to unload
+    @returns {SC.Store} receiver
+  */
+  unloadRecords: function(recordTypes, ids, storeKeys, newStatus) {
+    var len, isArray, idx, id, recordType, storeKey;
+    if(storeKeys===undefined){
+      len = ids.length;
+      isArray = SC.typeOf(recordTypes) === SC.T_ARRAY;
+      if (!isArray) recordType = recordTypes;
+      for(idx=0;idx<len;idx++) {
+        if (isArray) recordType = recordTypes[idx] || SC.Record;
+        id = ids ? ids[idx] : undefined ;
+        this.unloadRecord(recordType, id, undefined, newStatus);
+      }
+    }else{
+      len = storeKeys.length;
+      for(idx=0;idx<len;idx++) {
+        storeKey = storeKeys ? storeKeys[idx] : undefined ;
+        this.unloadRecord(undefined, undefined, storeKey, newStatus);
+      }
+    }
+    return this ;
+  },
+  
   /**
     Destroys a record, removing the data hash from the store and adding the
     record to the destroyed changelog.  If you try to destroy a record that is 
@@ -1505,7 +1584,7 @@ SC.Store = SC.Object.extend( /** @scope SC.Store.prototype */ {
     
     @param {Array} recordTypes the expected record types (SC.Record)
     @param {Array} ids to commit
-    @param {Array} storeKeys to commit
+    @param {SC.Set} storeKeys to commit
     @param {Hash} params optional additional parameters to pass along to the
       data source
 
@@ -1573,8 +1652,13 @@ SC.Store = SC.Object.extend( /** @scope SC.Store.prototype */ {
     }
     
     //remove all commited changes from changelog
-    if (ret && !recordTypes && !ids && storeKeys===this.changelog){ 
-      this.changelog = null; 
+    if (ret && !recordTypes && !ids) {
+      if (storeKeys === this.changelog) {
+        this.changelog = null;
+      }
+      else {
+        this.changelog.removeEach(storeKeys);
+      }
     }
     return ret ;
   },
@@ -1966,7 +2050,7 @@ SC.Store = SC.Object.extend( /** @scope SC.Store.prototype */ {
     @param {Object} id the record id or null
     @param {Hash} dataHash data hash to load
     @param {Number} storeKey optional store key.  
-    @returns {Boolean} YES if push was allowed
+    @returns {Number|Boolean} storeKey if push was allowed, NO if not
   */
   pushRetrieve: function(recordType, id, dataHash, storeKey) {
     var K = SC.Record, status;
@@ -1981,7 +2065,7 @@ SC.Store = SC.Object.extend( /** @scope SC.Store.prototype */ {
 
       this.dataHashDidChange(storeKey);
       
-      return YES;
+      return storeKey;
     }
     //conflicted (ready)
     return NO;
@@ -1994,7 +2078,7 @@ SC.Store = SC.Object.extend( /** @scope SC.Store.prototype */ {
     @param {Class} recordType the SC.Record subclass
     @param {Object} id the record id or null
     @param {Number} storeKey optional store key.  
-    @returns {Boolean} YES if push was allowed
+    @returns {Number|Boolean} storeKey if push was allowed, NO if not
   */
   pushDestroy: function(recordType, id, storeKey) {
     var K = SC.Record, status;
@@ -2007,7 +2091,7 @@ SC.Store = SC.Object.extend( /** @scope SC.Store.prototype */ {
       status = K.DESTROYED_CLEAN;
       this.removeDataHash(storeKey, status) ;
       this.dataHashDidChange(storeKey);
-      return YES;
+      return storeKey;
     }
     //conflicted (destroy)
     return NO;
@@ -2021,7 +2105,7 @@ SC.Store = SC.Object.extend( /** @scope SC.Store.prototype */ {
     @param {Object} id the record id or null
     @param {SC.Error} error [optional] an SC.Error instance to associate with id or storeKey
     @param {Number} storeKey optional store key.
-    @returns {Boolean} YES if push was allowed
+    @returns {Number|Boolean} storeKey if push was allowed, NO if not
   */
   pushError: function(recordType, id, error, storeKey) {
     var K = SC.Record, status, errors = this.recordErrors;
@@ -2040,7 +2124,7 @@ SC.Store = SC.Object.extend( /** @scope SC.Store.prototype */ {
       
       this.writeStatus(storeKey, status) ;
       this.dataHashDidChange(storeKey, null, YES);
-      return YES;
+      return storeKey;
     }
     //conflicted (error)
     return NO;
@@ -2089,9 +2173,9 @@ SC.Store = SC.Object.extend( /** @scope SC.Store.prototype */ {
     query.  This will put the query into a READY state if it was loading.
     
     Note that if the query is a REMOTE query, then you must separately load 
-    the results into the query using loadQuery().  If the query is LOCAL, then
-    the query will update automatically with any new records you added to the
-    store.
+    the results into the query using loadQueryResults().  If the query is 
+    LOCAL, then the query will update automatically with any new records you 
+    added to the store.
     
     @param {SC.Query} query the query you fetched
     @returns {SC.Store} receiver
@@ -2273,7 +2357,7 @@ SC.Store = SC.Object.extend( /** @scope SC.Store.prototype */ {
       if (isEnum) isMatch = recordType.contains(recType);
       else isMatch = recType === recordType;
       
-      if(isMatch && this.statuses[storeKey]) ret.push(parseInt(storeKey, 0));
+      if(isMatch && this.statuses[storeKey]) ret.push(parseInt(storeKey, 10));
     }
     
     return ret;
@@ -2287,12 +2371,12 @@ SC.Store = SC.Object.extend( /** @scope SC.Store.prototype */ {
   */
   storeKeys: function() {
     var ret = [], storeKey;
-    if(!this.statuses) return;
+    if(!this.statuses) return ret;
     
     for(storeKey in this.statuses) {
       // if status is not empty
       if(this.statuses[storeKey] != SC.Record.EMPTY) {
-        ret.push(parseInt(storeKey,0));
+        ret.push(parseInt(storeKey, 10));
       }
     }
     

data/frameworks/sproutcore/frameworks/datastore/tests/data_sources/fixtures.js

@@ -1,7 +1,7 @@
 // ==========================================================================
 // Project:   SproutCore - JavaScript Application Framework
 // Copyright: ©2006-2009 Apple Inc. and contributors.
-// License:   Licened under MIT license (see license.js)
+// License:   Licensed under MIT license (see license.js)
 // ==========================================================================
 /*globals module ok equals same test MyApp Sample */
 

data/frameworks/sproutcore/frameworks/datastore/tests/integration/contact_model.js

@@ -2,7 +2,7 @@
 // Project:   SproutCore - JavaScript Application Framework
 // Copyright: ©2006-2009 Sprout Systems, Inc. and contributors.
 //            Portions ©2008-2009 Apple Inc. All rights reserved.
-// License:   Licened under MIT license (see license.js)
+// License:   Licensed under MIT license (see license.js)
 // ==========================================================================
 /*globals module test ok equals same AB */
 

data/frameworks/sproutcore/frameworks/datastore/tests/integration/cyclical_relationship.js

@@ -2,7 +2,7 @@
 // Project:   SproutCore - JavaScript Application Framework
 // Copyright: ©2006-2009 Sprout Systems, Inc. and contributors.
 //            Portions ©2008-2009 Apple Inc. All rights reserved.
-// License:   Licened under MIT license (see license.js)
+// License:   Licensed under MIT license (see license.js)
 // ==========================================================================
 /*globals module test ok equals same AB */
 

data/frameworks/sproutcore/frameworks/datastore/tests/integration/mail_model.js

@@ -2,7 +2,7 @@
 // Project:   SproutCore - JavaScript Application Framework
 // Copyright: ©2006-2009 Sprout Systems, Inc. and contributors.
 //            Portions ©2008-2009 Apple Inc. All rights reserved.
-// License:   Licened under MIT license (see license.js)
+// License:   Licensed under MIT license (see license.js)
 // ==========================================================================
 /*globals module test ok equals same */
 

data/frameworks/sproutcore/frameworks/datastore/tests/integration/test_runner_model.js

@@ -2,7 +2,7 @@
 // Project:   SproutCore - JavaScript Application Framework
 // Copyright: ©2006-2009 Sprout Systems, Inc. and contributors.
 //            Portions ©2008-2009 Apple Inc. All rights reserved.
-// License:   Licened under MIT license (see license.js)
+// License:   Licensed under MIT license (see license.js)
 // ==========================================================================
 /*globals module test ok equals same */
 

data/frameworks/sproutcore/frameworks/datastore/tests/models/many_attribute.js

@@ -1,7 +1,7 @@
 // ==========================================================================
 // Project:   SproutCore - JavaScript Application Framework
 // Copyright: ©2006-2009 Apple Inc. and contributors.
-// License:   Licened under MIT license (see license.js)
+// License:   Licensed under MIT license (see license.js)
 // ==========================================================================
 /*globals module ok equals same test MyApp */
 
@@ -230,6 +230,17 @@ test("modifying a toMany array should mark the record as changed", function() {
 
 });
 
+test("Modifying a toMany array using replace", function() {
+  var recs = rec.get('barToOne'),
+      objectForRemoval = recs.objectAt(1);
+  
+  recs.replace(1, 1, null); // the object should be removed
+  
+  ok(objectForRemoval !== recs.objectAt(1), "record should not be present after a replace");
+  equals(bar2.get('fooToOne'), null, "record should have notified attribute of change");
+});
+
+
 test("modifying a toMany array within a nested store", function() {
 
   var child = MyApp.store.chain() ; // get a chained store

data/frameworks/sproutcore/frameworks/datastore/tests/models/nested_records/nested_record.js

@@ -0,0 +1,235 @@
+/**
+ * Nested Records (SC.ChildRecord) Unit Test
+ *
+ * @author Evin Grano
+ */
+
+// ..........................................................
+// Basic Set up needs to move to the setup and teardown
+// 
+var NestedRecord, store, testParent, testParent2, childData1; 
+
+var initModels = function(){
+  NestedRecord.ParentRecordTest = SC.Record.extend({
+    /** Child Record Namespace */
+    childRecordNamespace: NestedRecord,
+
+    name: SC.Record.attr(String),
+    info: SC.Record.toOne('NestedRecord.ChildRecordTest', { nested: true })
+  });
+
+  NestedRecord.ChildRecordTest = SC.ChildRecord.extend({
+    id: SC.Record.attr(String),
+    name: SC.Record.attr(String),
+    value: SC.Record.attr(String)
+  });
+};
+
+// ..........................................................
+// Basic SC.Record Stuff
+// 
+module("Basic SC.Record Functions w/ Parent > Child", {
+
+  setup: function() {
+    NestedRecord = SC.Object.create({
+      store: SC.Store.create()
+    });
+    store = NestedRecord.store;
+    initModels();
+    SC.RunLoop.begin();
+    // Test Parent 1
+    testParent = store.createRecord(NestedRecord.ParentRecordTest, {
+      name: 'Parent Name',
+      info: {
+        type: 'ChildRecordTest',
+        name: 'Child Name',
+        value: 'Blue Goo',
+        id: '5001'
+      }
+    });
+    // Test parent 2
+    testParent2 = NestedRecord.store.createRecord(NestedRecord.ParentRecordTest, {
+      name: 'Parent Name 2',
+      info: {
+        type: 'ChildRecordTest',
+        name: 'Child Name 2',
+        value: 'Purple Goo',
+        id: '5002'
+      }
+    });
+    SC.RunLoop.end();
+    
+    
+    // ..........................................................
+    // Child Data
+    // 
+    childData1 = {
+      type: 'ChildRecordTest',
+      name: 'Child Name',
+      value: 'Green Goo',
+      id: '5002'
+    };
+  },
+
+  teardown: function() {
+    delete NestedRecord.ParentRecordTest;
+    delete NestedRecord.ChildRecordTest;
+    testParent = null;
+    testParent2 = null;
+    store = null;
+    childData1 = null;
+    NestedRecord = null;
+  }
+});
+
+test("Function: readAttribute()", function() {
+  equals(testParent.readAttribute('name'), 'Parent Name', "readAttribute should be correct for name attribute");
+  
+  equals(testParent.readAttribute('nothing'), null, "readAttribute should be correct for invalid key");
+  
+  same(testParent.readAttribute('info'),   
+    {
+      type: 'ChildRecordTest',
+      name: 'Child Name',
+      value: 'Blue Goo',
+      id: '5001'
+    },
+    "readAttribute should be correct for info child attribute");
+  
+});
+
+test("Support Multiple Parent Records With Different Child Records", function() {
+  
+  same(testParent2.readAttribute('info'),
+    {
+      type: 'ChildRecordTest',
+      name: 'Child Name 2',
+      value: 'Purple Goo',
+      id: '5002'
+    },
+    "readAttribute should be correct for info child attribute on new record");
+  equals(testParent2.get('info').get('value'), 'Purple Goo', "get should retrieve the proper value on new record");
+
+  same(testParent.readAttribute('info'),
+    {
+      type: 'ChildRecordTest',
+      name: 'Child Name',
+      value: 'Blue Goo',
+      id: '5001'
+    },
+    "readAttribute should be correct for info child attribute on first record");
+  equals(testParent.get('info').get('value'), 'Blue Goo', "get should retrieve the proper value on first record");
+});
+
+test("Function: writeAttribute()", function() {
+  
+  testParent.writeAttribute('name', 'New Parent Name');
+  equals(testParent.get('name'), 'New Parent Name', "writeAttribute should be the new name attribute");
+  
+  testParent.writeAttribute('nothing', 'nothing');
+  equals(testParent.get('nothing'), 'nothing', "writeAttribute should be correct for new key");
+  
+  testParent.writeAttribute('info', {
+    type: 'ChildRecordTest',
+    name: 'New Child Name',
+    value: 'Red Goo'
+  });
+  same(testParent.readAttribute('info'),   
+    {
+      type: 'ChildRecordTest',
+      name: 'New Child Name',
+      value: 'Red Goo'
+    },
+    "writeAttribute with readAttribute should be correct for info child attribute");
+});
+
+test("Basic Read", function() {
+  var id;
+  // Test general gets
+  equals(testParent.get('name'), 'Parent Name', "get should be correct for name attribute");
+  equals(testParent.get('nothing'), null, "get should be correct for invalid key");
+  
+  // Test Child Record creation
+  var cr = testParent.get('info');
+  // Check Model Class information
+  ok(SC.kindOf(cr, SC.ChildRecord), "get() creates an actual instance that is a kind of a SC.ChildRecord Object");
+  ok(SC.instanceOf(cr, NestedRecord.ChildRecordTest), "get() creates an actual instance of a ChildRecordTest Object");
+  
+  // Check reference information
+  var pm = cr.get('primaryKey');
+  var key = cr.get(pm);
+  var storeRef = store.find(NestedRecord.ChildRecordTest, key);
+  ok(storeRef, 'checking that the store has the instance of the child record with proper primary key');
+  equals(cr, storeRef, "checking the parent reference is the same as the direct store reference");
+  
+  // Check to see if the attributes of a Child Record match the refrence of the parent
+  same(storeRef.get('attributes'), testParent.readAttribute('info'), "check that the ChildRecord's attributes are the same as the ParentRecord's readAttribute for the reference");
+  
+  // Duplication check
+  var sameCR = testParent.get('info');
+  ok(sameCR, "check to see if we have an instance of a child record again");
+  var oldKey = cr.get(pm), newKey = sameCR.get(pm);
+  equals(oldKey, newKey, "check to see if the Primary Key are the same");
+  same(sameCR, cr, "check to see that it is the same child record as before");
+  
+  // ID check
+  id = sameCR.get('id');
+  ok((id !== oldKey), "if there is an id param, it should be different from the Primary Key: %@ != %@".fmt(id, oldKey));
+});
+
+test("Basic Write", function() {
+  
+  // Test general gets
+  testParent.set('name', 'New Parent Name');
+  equals(testParent.get('name'), 'New Parent Name', "set() should change name attribute");
+  testParent.set('nothing', 'nothing');
+  equals(testParent.get('nothing'), 'nothing', "set should change non-existent property to a new property");
+  
+  // Test Child Record creation
+  var oldCR = testParent.get('info');
+  testParent.set('info', {
+    type: 'ChildRecordTest',
+    name: 'New Child Name',
+    value: 'Red Goo'
+  });
+  var cr = testParent.get('info');
+  // Check Model Class information
+  ok(SC.kindOf(cr, SC.ChildRecord), "set() with an object creates an actual instance that is a kind of a SC.ChildRecord Object");
+  ok(SC.instanceOf(cr, NestedRecord.ChildRecordTest), "set() with an object creates an actual instance of a ChildRecordTest Object");
+  
+  // Check reference information
+  var pm = cr.get('primaryKey');
+  var key = cr.get(pm);
+  var storeRef = store.find(NestedRecord.ChildRecordTest, key);
+  ok(storeRef, 'after a set() with an object, checking that the store has the instance of the child record with proper primary key');
+  equals(cr, storeRef, "after a set with an object, checking the parent reference is the same as the direct store reference");
+  var oldKey = oldCR.get(pm);
+  ok(!(oldKey === key), 'check to see that the old child record has a different key from the new child record');
+  
+  // Check for changes on the child bubble to the parent.
+  cr.set('name', 'Child Name Change');
+  equals(cr.get('name'), 'Child Name Change', "after a set('name', <new>) on child, checking that the value is updated");
+  ok(cr.get('status') & SC.Record.DIRTY, 'check that the child record is dirty');
+  ok(testParent.get('status') & SC.Record.DIRTY, 'check that the parent record is dirty');
+  var newCR = testParent.get('info');
+  same(newCR, cr, "after a set('name', <new>) on child, checking to see that the parent has recieved the changes from the child record");
+  same(testParent.readAttribute('info'), cr.get('attributes'), "after a set('name', <new>) on child, readAttribute on the parent should be correct for info child attributes");
+});
+
+test("Child Status Changed", function() {
+  var cr;
+  cr = testParent.get('info');
+  equals(cr.get('status'), testParent.get('status'), 'after initializing the parent to READY_NEW, check that the child record matches');
+  
+  SC.RunLoop.begin();
+  store.writeStatus(testParent.storeKey, SC.Record.DIRTY_NEW);
+  store.dataHashDidChange(testParent.storeKey);
+  equals(cr.get('status'), testParent.get('status'), 'after setting the parent to DIRTY_NEW, check that the child record matches');
+  SC.RunLoop.end();
+  
+  SC.RunLoop.begin();
+  store.writeStatus(testParent.storeKey, SC.Record.BUSY_REFRESH);
+  store.dataHashDidChange(testParent.storeKey);
+  equals(cr.get('status'), testParent.get('status'), 'after setting the parent to BUSY_REFRESH, check that the child record matches');
+  SC.RunLoop.end();
+});