(function() { window.DS = Ember.Namespace.create({ // this one goes to 11 CURRENT_API_REVISION: 11 }); })(); (function() { var DeferredMixin = Ember.DeferredMixin, // ember-runtime/mixins/deferred Evented = Ember.Evented, // ember-runtime/mixins/evented run = Ember.run, // ember-metal/run-loop get = Ember.get; // ember-metal/accessors var LoadPromise = Ember.Mixin.create(Evented, DeferredMixin, { init: function() { this._super.apply(this, arguments); this.one('didLoad', function() { run(this, 'resolve', this); }); if (get(this, 'isLoaded')) { this.trigger('didLoad'); } } }); DS.LoadPromise = LoadPromise; })(); (function() { var get = Ember.get, set = Ember.set; var LoadPromise = DS.LoadPromise; // system/mixins/load_promise /** A record array is an array that contains records of a certain type. The record array materializes records as needed when they are retrieved for the first time. You should not create record arrays yourself. Instead, an instance of DS.RecordArray or its subclasses will be returned by your application's store in response to queries. */ DS.RecordArray = Ember.ArrayProxy.extend(Ember.Evented, LoadPromise, { /** The model type contained by this record array. @type DS.Model */ type: null, // The array of client ids backing the record array. When a // record is requested from the record array, the record // for the client id at the same index is materialized, if // necessary, by the store. content: null, isLoaded: false, isUpdating: false, // The store that created this record array. store: null, objectAtContent: function(index) { var content = get(this, 'content'), reference = content.objectAt(index), store = get(this, 'store'); if (reference) { return store.recordForReference(reference); } }, materializedObjectAt: function(index) { var reference = get(this, 'content').objectAt(index); if (!reference) { return; } if (get(this, 'store').recordIsMaterialized(reference)) { return this.objectAt(index); } }, update: function() { if (get(this, 'isUpdating')) { return; } var store = get(this, 'store'), type = get(this, 'type'); store.fetchAll(type, this); }, addReference: function(reference) { get(this, 'content').addObject(reference); }, removeReference: function(reference) { get(this, 'content').removeObject(reference); } }); })(); (function() { var get = Ember.get; DS.FilteredRecordArray = DS.RecordArray.extend({ filterFunction: null, isLoaded: true, replace: function() { var type = get(this, 'type').toString(); throw new Error("The result of a client-side filter (on " + type + ") is immutable."); }, updateFilter: Ember.observer(function() { var store = get(this, 'store'); store.updateRecordArrayFilter(this, get(this, 'type'), get(this, 'filterFunction')); }, 'filterFunction') }); })(); (function() { var get = Ember.get, set = Ember.set; DS.AdapterPopulatedRecordArray = DS.RecordArray.extend({ query: null, replace: function() { var type = get(this, 'type').toString(); throw new Error("The result of a server query (on " + type + ") is immutable."); }, load: function(references) { var store = get(this, 'store'), type = get(this, 'type'); this.beginPropertyChanges(); set(this, 'content', Ember.A(references)); set(this, 'isLoaded', true); this.endPropertyChanges(); var self = this; // TODO: does triggering didLoad event should be the last action of the runLoop? Ember.run.once(function() { self.trigger('didLoad'); }); } }); })(); (function() { var get = Ember.get, set = Ember.set; /** A ManyArray is a RecordArray that represents the contents of a has-many relationship. The ManyArray is instantiated lazily the first time the relationship is requested. ### Inverses Often, the relationships in Ember Data applications will have an inverse. For example, imagine the following models are defined: App.Post = DS.Model.extend({ comments: DS.hasMany('App.Comment') }); App.Comment = DS.Model.extend({ post: DS.belongsTo('App.Post') }); If you created a new instance of `App.Post` and added a `App.Comment` record to its `comments` has-many relationship, you would expect the comment's `post` property to be set to the post that contained the has-many. We call the record to which a relationship belongs the relationship's _owner_. */ DS.ManyArray = DS.RecordArray.extend({ init: function() { this._super.apply(this, arguments); this._changesToSync = Ember.OrderedSet.create(); }, /** @private The record to which this relationship belongs. @property {DS.Model} */ owner: null, // LOADING STATE isLoaded: false, loadingRecordsCount: function(count) { this.loadingRecordsCount = count; }, loadedRecord: function() { this.loadingRecordsCount--; if (this.loadingRecordsCount === 0) { set(this, 'isLoaded', true); this.trigger('didLoad'); } }, fetch: function() { var references = get(this, 'content'), store = get(this, 'store'), type = get(this, 'type'), owner = get(this, 'owner'); store.fetchUnloadedReferences(type, references, owner); }, // Overrides Ember.Array's replace method to implement replaceContent: function(index, removed, added) { // Map the array of record objects into an array of client ids. added = added.map(function(record) { return get(record, '_reference'); }, this); this._super(index, removed, added); }, arrangedContentDidChange: function() { this.fetch(); }, arrayContentWillChange: function(index, removed, added) { var owner = get(this, 'owner'), name = get(this, 'name'); if (!owner._suspendedRelationships) { // This code is the first half of code that continues inside // of arrayContentDidChange. It gets or creates a change from // the child object, adds the current owner as the old // parent if this is the first time the object was removed // from a ManyArray, and sets `newParent` to null. // // Later, if the object is added to another ManyArray, // the `arrayContentDidChange` will set `newParent` on // the change. for (var i=index; i "created.uncommitted" The `DS.Model` states are themselves stateless. What we mean is that, though each instance of a record also has a unique instance of a `DS.StateManager`, the hierarchical states that each of *those* points to is a shared data structure. For performance reasons, instead of each record getting its own copy of the hierarchy of states, each state manager points to this global, immutable shared instance. How does a state know which record it should be acting on? We pass a reference to the current state manager as the first parameter to every method invoked on a state. The state manager passed as the first parameter is where you should stash state about the record if needed; you should never store data on the state object itself. If you need access to the record being acted on, you can retrieve the state manager's `record` property. For example, if you had an event handler `myEvent`: myEvent: function(manager) { var record = manager.get('record'); record.doSomething(); } For more information about state managers in general, see the Ember.js documentation on `Ember.StateManager`. ### Events, Flags, and Transitions A state may implement zero or more events, flags, or transitions. #### Events Events are named functions that are invoked when sent to a record. The state manager will first look for a method with the given name on the current state. If no method is found, it will search the current state's parent, and then its grandparent, and so on until reaching the top of the hierarchy. If the root is reached without an event handler being found, an exception will be raised. This can be very helpful when debugging new features. Here's an example implementation of a state with a `myEvent` event handler: aState: DS.State.create({ myEvent: function(manager, param) { console.log("Received myEvent with "+param); } }) To trigger this event: record.send('myEvent', 'foo'); //=> "Received myEvent with foo" Note that an optional parameter can be sent to a record's `send()` method, which will be passed as the second parameter to the event handler. Events should transition to a different state if appropriate. This can be done by calling the state manager's `transitionTo()` method with a path to the desired state. The state manager will attempt to resolve the state path relative to the current state. If no state is found at that path, it will attempt to resolve it relative to the current state's parent, and then its parent, and so on until the root is reached. For example, imagine a hierarchy like this: * created * start <-- currentState * inFlight * updated * inFlight If we are currently in the `start` state, calling `transitionTo('inFlight')` would transition to the `created.inFlight` state, while calling `transitionTo('updated.inFlight')` would transition to the `updated.inFlight` state. Remember that *only events* should ever cause a state transition. You should never call `transitionTo()` from outside a state's event handler. If you are tempted to do so, create a new event and send that to the state manager. #### Flags Flags are Boolean values that can be used to introspect a record's current state in a more user-friendly way than examining its state path. For example, instead of doing this: var statePath = record.get('stateManager.currentPath'); if (statePath === 'created.inFlight') { doSomething(); } You can say: if (record.get('isNew') && record.get('isSaving')) { doSomething(); } If your state does not set a value for a given flag, the value will be inherited from its parent (or the first place in the state hierarchy where it is defined). The current set of flags are defined below. If you want to add a new flag, in addition to the area below, you will also need to declare it in the `DS.Model` class. #### Transitions Transitions are like event handlers but are called automatically upon entering or exiting a state. To implement a transition, just call a method either `enter` or `exit`: myState: DS.State.create({ // Gets called automatically when entering // this state. enter: function(manager) { console.log("Entered myState"); } }) Note that enter and exit events are called once per transition. If the current state changes, but changes to another child state of the parent, the transition event on the parent will not be triggered. */ var stateProperty = Ember.computed(function(key) { var parent = get(this, 'parentState'); if (parent) { return get(parent, key); } }).property(); var isEmptyObject = function(object) { for (var name in object) { if (object.hasOwnProperty(name)) { return false; } } return true; }; var hasDefinedProperties = function(object) { for (var name in object) { if (object.hasOwnProperty(name) && object[name]) { return true; } } return false; }; var didChangeData = function(manager) { var record = get(manager, 'record'); record.materializeData(); }; var willSetProperty = function(manager, context) { context.oldValue = get(get(manager, 'record'), context.name); var change = DS.AttributeChange.createChange(context); get(manager, 'record')._changesToSync[context.attributeName] = change; }; var didSetProperty = function(manager, context) { var change = get(manager, 'record')._changesToSync[context.attributeName]; change.value = get(get(manager, 'record'), context.name); change.sync(); }; // Whenever a property is set, recompute all dependent filters var updateRecordArrays = function(manager) { var record = manager.get('record'); record.updateRecordArraysLater(); }; DS.State = Ember.State.extend({ isLoaded: stateProperty, isReloading: stateProperty, isDirty: stateProperty, isSaving: stateProperty, isDeleted: stateProperty, isError: stateProperty, isNew: stateProperty, isValid: stateProperty, // For states that are substates of a // DirtyState (updated or created), it is // useful to be able to determine which // type of dirty state it is. dirtyType: stateProperty }); // Implementation notes: // // Each state has a boolean value for all of the following flags: // // * isLoaded: The record has a populated `data` property. When a // record is loaded via `store.find`, `isLoaded` is false // until the adapter sets it. When a record is created locally, // its `isLoaded` property is always true. // * isDirty: The record has local changes that have not yet been // saved by the adapter. This includes records that have been // created (but not yet saved) or deleted. // * isSaving: The record's transaction has been committed, but // the adapter has not yet acknowledged that the changes have // been persisted to the backend. // * isDeleted: The record was marked for deletion. When `isDeleted` // is true and `isDirty` is true, the record is deleted locally // but the deletion was not yet persisted. When `isSaving` is // true, the change is in-flight. When both `isDirty` and // `isSaving` are false, the change has persisted. // * isError: The adapter reported that it was unable to save // local changes to the backend. This may also result in the // record having its `isValid` property become false if the // adapter reported that server-side validations failed. // * isNew: The record was created on the client and the adapter // did not yet report that it was successfully saved. // * isValid: No client-side validations have failed and the // adapter did not report any server-side validation failures. // The dirty state is a abstract state whose functionality is // shared between the `created` and `updated` states. // // The deleted state shares the `isDirty` flag with the // subclasses of `DirtyState`, but with a very different // implementation. // // Dirty states have three child states: // // `uncommitted`: the store has not yet handed off the record // to be saved. // `inFlight`: the store has handed off the record to be saved, // but the adapter has not yet acknowledged success. // `invalid`: the record has invalid information and cannot be // send to the adapter yet. var DirtyState = DS.State.extend({ initialState: 'uncommitted', // FLAGS isDirty: true, // SUBSTATES // When a record first becomes dirty, it is `uncommitted`. // This means that there are local pending changes, but they // have not yet begun to be saved, and are not invalid. uncommitted: DS.State.extend({ // TRANSITIONS enter: function(manager) { var dirtyType = get(this, 'dirtyType'), record = get(manager, 'record'); record.withTransaction(function (t) { t.recordBecameDirty(dirtyType, record); }); }, // EVENTS willSetProperty: willSetProperty, didSetProperty: didSetProperty, becomeDirty: Ember.K, willCommit: function(manager) { manager.transitionTo('inFlight'); }, becameClean: function(manager) { var record = get(manager, 'record'), dirtyType = get(this, 'dirtyType'); record.withTransaction(function(t) { t.recordBecameClean(dirtyType, record); }); manager.transitionTo('loaded.materializing'); }, becameInvalid: function(manager) { var dirtyType = get(this, 'dirtyType'), record = get(manager, 'record'); record.withTransaction(function (t) { t.recordBecameInFlight(dirtyType, record); }); manager.transitionTo('invalid'); }, rollback: function(manager) { get(manager, 'record').rollback(); } }), // Once a record has been handed off to the adapter to be // saved, it is in the 'in flight' state. Changes to the // record cannot be made during this window. inFlight: DS.State.extend({ // FLAGS isSaving: true, // TRANSITIONS enter: function(manager) { var dirtyType = get(this, 'dirtyType'), record = get(manager, 'record'); record.becameInFlight(); record.withTransaction(function (t) { t.recordBecameInFlight(dirtyType, record); }); }, // EVENTS didCommit: function(manager) { var dirtyType = get(this, 'dirtyType'), record = get(manager, 'record'); record.withTransaction(function(t) { t.recordBecameClean('inflight', record); }); manager.transitionTo('saved'); manager.send('invokeLifecycleCallbacks', dirtyType); }, becameInvalid: function(manager, errors) { var record = get(manager, 'record'); set(record, 'errors', errors); manager.transitionTo('invalid'); manager.send('invokeLifecycleCallbacks'); }, becameError: function(manager) { manager.transitionTo('error'); manager.send('invokeLifecycleCallbacks'); } }), // A record is in the `invalid` state when its client-side // invalidations have failed, or if the adapter has indicated // the the record failed server-side invalidations. invalid: DS.State.extend({ // FLAGS isValid: false, exit: function(manager) { var record = get(manager, 'record'); record.withTransaction(function (t) { t.recordBecameClean('inflight', record); }); }, // EVENTS deleteRecord: function(manager) { manager.transitionTo('deleted'); get(manager, 'record').clearRelationships(); }, willSetProperty: willSetProperty, didSetProperty: function(manager, context) { var record = get(manager, 'record'), errors = get(record, 'errors'), key = context.name; set(errors, key, null); if (!hasDefinedProperties(errors)) { manager.send('becameValid'); } didSetProperty(manager, context); }, becomeDirty: Ember.K, rollback: function(manager) { manager.send('becameValid'); manager.send('rollback'); }, becameValid: function(manager) { manager.transitionTo('uncommitted'); }, invokeLifecycleCallbacks: function(manager) { var record = get(manager, 'record'); record.trigger('becameInvalid', record); } }) }); // The created and updated states are created outside the state // chart so we can reopen their substates and add mixins as // necessary. var createdState = DirtyState.create({ dirtyType: 'created', // FLAGS isNew: true }); var updatedState = DirtyState.create({ dirtyType: 'updated' }); createdState.states.uncommitted.reopen({ deleteRecord: function(manager) { var record = get(manager, 'record'); record.withTransaction(function(t) { t.recordIsMoving('created', record); }); record.clearRelationships(); manager.transitionTo('deleted.saved'); } }); createdState.states.uncommitted.reopen({ rollback: function(manager) { this._super(manager); manager.transitionTo('deleted.saved'); } }); updatedState.states.uncommitted.reopen({ deleteRecord: function(manager) { var record = get(manager, 'record'); record.withTransaction(function(t) { t.recordIsMoving('updated', record); }); manager.transitionTo('deleted'); get(manager, 'record').clearRelationships(); } }); var states = { rootState: Ember.State.create({ // FLAGS isLoaded: false, isReloading: false, isDirty: false, isSaving: false, isDeleted: false, isError: false, isNew: false, isValid: true, // SUBSTATES // A record begins its lifecycle in the `empty` state. // If its data will come from the adapter, it will // transition into the `loading` state. Otherwise, if // the record is being created on the client, it will // transition into the `created` state. empty: DS.State.create({ // EVENTS loadingData: function(manager) { manager.transitionTo('loading'); }, loadedData: function(manager) { manager.transitionTo('loaded.created'); } }), // A record enters this state when the store askes // the adapter for its data. It remains in this state // until the adapter provides the requested data. // // Usually, this process is asynchronous, using an // XHR to retrieve the data. loading: DS.State.create({ // EVENTS loadedData: didChangeData, materializingData: function(manager) { manager.transitionTo('loaded.materializing.firstTime'); } }), // A record enters this state when its data is populated. // Most of a record's lifecycle is spent inside substates // of the `loaded` state. loaded: DS.State.create({ initialState: 'saved', // FLAGS isLoaded: true, // SUBSTATES materializing: DS.State.create({ // FLAGS isLoaded: false, // EVENTS willSetProperty: Ember.K, didSetProperty: Ember.K, didChangeData: didChangeData, finishedMaterializing: function(manager) { manager.transitionTo('loaded.saved'); }, // SUBSTATES firstTime: DS.State.create({ exit: function(manager) { var record = get(manager, 'record'); Ember.run.once(function() { record.trigger('didLoad'); }); } }) }), reloading: DS.State.create({ // FLAGS isReloading: true, // TRANSITIONS enter: function(manager) { var record = get(manager, 'record'), store = get(record, 'store'); store.reloadRecord(record); }, exit: function(manager) { var record = get(manager, 'record'); once(record, 'trigger', 'didReload'); }, // EVENTS loadedData: didChangeData, materializingData: function(manager) { manager.transitionTo('loaded.materializing'); } }), // If there are no local changes to a record, it remains // in the `saved` state. saved: DS.State.create({ // EVENTS willSetProperty: willSetProperty, didSetProperty: didSetProperty, didChangeData: didChangeData, loadedData: didChangeData, reloadRecord: function(manager) { manager.transitionTo('loaded.reloading'); }, materializingData: function(manager) { manager.transitionTo('loaded.materializing'); }, becomeDirty: function(manager) { manager.transitionTo('updated'); }, deleteRecord: function(manager) { manager.transitionTo('deleted'); get(manager, 'record').clearRelationships(); }, unloadRecord: function(manager) { manager.transitionTo('deleted.saved'); get(manager, 'record').clearRelationships(); }, invokeLifecycleCallbacks: function(manager, dirtyType) { var record = get(manager, 'record'); if (dirtyType === 'created') { record.trigger('didCreate', record); } else { record.trigger('didUpdate', record); } } }), // A record is in this state after it has been locally // created but before the adapter has indicated that // it has been saved. created: createdState, // A record is in this state if it has already been // saved to the server, but there are new local changes // that have not yet been saved. updated: updatedState }), // A record is in this state if it was deleted from the store. deleted: DS.State.create({ initialState: 'uncommitted', dirtyType: 'deleted', // FLAGS isDeleted: true, isLoaded: true, isDirty: true, // TRANSITIONS setup: function(manager) { var record = get(manager, 'record'), store = get(record, 'store'); store.removeFromRecordArrays(record); }, // SUBSTATES // When a record is deleted, it enters the `start` // state. It will exit this state when the record's // transaction starts to commit. uncommitted: DS.State.create({ // TRANSITIONS enter: function(manager) { var record = get(manager, 'record'); record.withTransaction(function(t) { t.recordBecameDirty('deleted', record); }); }, // EVENTS willCommit: function(manager) { manager.transitionTo('inFlight'); }, rollback: function(manager) { get(manager, 'record').rollback(); }, becomeDirty: Ember.K, becameClean: function(manager) { var record = get(manager, 'record'); record.withTransaction(function(t) { t.recordBecameClean('deleted', record); }); manager.transitionTo('loaded.materializing'); } }), // After a record's transaction is committing, but // before the adapter indicates that the deletion // has saved to the server, a record is in the // `inFlight` substate of `deleted`. inFlight: DS.State.create({ // FLAGS isSaving: true, // TRANSITIONS enter: function(manager) { var record = get(manager, 'record'); record.becameInFlight(); record.withTransaction(function (t) { t.recordBecameInFlight('deleted', record); }); }, // EVENTS didCommit: function(manager) { var record = get(manager, 'record'); record.withTransaction(function(t) { t.recordBecameClean('inflight', record); }); manager.transitionTo('saved'); manager.send('invokeLifecycleCallbacks'); } }), // Once the adapter indicates that the deletion has // been saved, the record enters the `saved` substate // of `deleted`. saved: DS.State.create({ // FLAGS isDirty: false, setup: function(manager) { var record = get(manager, 'record'), store = get(record, 'store'); store.dematerializeRecord(record); }, invokeLifecycleCallbacks: function(manager) { var record = get(manager, 'record'); record.trigger('didDelete', record); } }) }), // If the adapter indicates that there was an unknown // error saving a record, the record enters the `error` // state. error: DS.State.create({ isError: true, // EVENTS invokeLifecycleCallbacks: function(manager) { var record = get(manager, 'record'); record.trigger('becameError', record); } }) }) }; DS.StateManager = Ember.StateManager.extend({ record: null, initialState: 'rootState', states: states, unhandledEvent: function(manager, originalEvent) { var record = manager.get('record'), contexts = [].slice.call(arguments, 2), errorMessage; errorMessage = "Attempted to handle event `" + originalEvent + "` "; errorMessage += "on " + record.toString() + " while in state "; errorMessage += get(manager, 'currentState.path') + ". Called with "; errorMessage += arrayMap.call(contexts, function(context){ return Ember.inspect(context); }).join(', '); throw new Ember.Error(errorMessage); } }); })(); (function() { var LoadPromise = DS.LoadPromise; // system/mixins/load_promise var get = Ember.get, set = Ember.set, none = Ember.isNone, map = Ember.EnumerableUtils.map; var retrieveFromCurrentState = Ember.computed(function(key) { return get(get(this, 'stateManager.currentState'), key); }).property('stateManager.currentState'); DS.Model = Ember.Object.extend(Ember.Evented, LoadPromise, { isLoaded: retrieveFromCurrentState, isReloading: retrieveFromCurrentState, isDirty: retrieveFromCurrentState, isSaving: retrieveFromCurrentState, isDeleted: retrieveFromCurrentState, isError: retrieveFromCurrentState, isNew: retrieveFromCurrentState, isValid: retrieveFromCurrentState, clientId: null, id: null, transaction: null, stateManager: null, errors: null, /** Create a JSON representation of the record, using the serialization strategy of the store's adapter. Available options: * `includeId`: `true` if the record's ID should be included in the JSON representation. @param {Object} options @returns {Object} an object whose values are primitive JSON values only */ serialize: function(options) { var store = get(this, 'store'); return store.serialize(this, options); }, didLoad: Ember.K, didReload: Ember.K, didUpdate: Ember.K, didCreate: Ember.K, didDelete: Ember.K, becameInvalid: Ember.K, becameError: Ember.K, data: Ember.computed(function() { if (!this._data) { this.materializeData(); } return this._data; }).property(), materializeData: function() { this.send('materializingData'); get(this, 'store').materializeData(this); this.suspendRelationshipObservers(function() { this.notifyPropertyChange('data'); }); }, _data: null, init: function() { this._super(); var stateManager = DS.StateManager.create({ record: this }); set(this, 'stateManager', stateManager); this._setup(); stateManager.goToState('empty'); }, _setup: function() { this._relationshipChanges = {}; this._changesToSync = {}; }, send: function(name, context) { return get(this, 'stateManager').send(name, context); }, withTransaction: function(fn) { var transaction = get(this, 'transaction'); if (transaction) { fn(transaction); } }, loadingData: function() { this.send('loadingData'); }, loadedData: function() { this.send('loadedData'); }, didChangeData: function() { this.send('didChangeData'); }, setProperty: function(key, value, oldValue) { this.send('setProperty', { key: key, value: value, oldValue: oldValue }); }, /** Reload the record from the adapter. This will only work if the record has already finished loading and has not yet been modified (`isLoaded` but not `isDirty`, or `isSaving`). */ reload: function() { this.send('reloadRecord'); }, deleteRecord: function() { this.send('deleteRecord'); }, unloadRecord: function() { this.send('unloadRecord'); }, clearRelationships: function() { this.eachRelationship(function(name, relationship) { if (relationship.kind === 'belongsTo') { set(this, name, null); } else if (relationship.kind === 'hasMany') { get(this, name).clear(); } }, this); }, updateRecordArrays: function() { var store = get(this, 'store'); if (store) { store.dataWasUpdated(this.constructor, get(this, '_reference'), this); } }, /** If the adapter did not return a hash in response to a commit, merge the changed attributes and relationships into the existing saved data. */ adapterDidCommit: function() { var attributes = get(this, 'data').attributes; get(this.constructor, 'attributes').forEach(function(name, meta) { attributes[name] = get(this, name); }, this); this.send('didCommit'); this.updateRecordArraysLater(); }, adapterDidDirty: function() { this.send('becomeDirty'); this.updateRecordArraysLater(); }, dataDidChange: Ember.observer(function() { var relationships = get(this.constructor, 'relationshipsByName'); this.updateRecordArraysLater(); relationships.forEach(function(name, relationship) { if (relationship.kind === 'hasMany') { this.hasManyDidChange(relationship.key); } }, this); this.send('finishedMaterializing'); }, 'data'), hasManyDidChange: function(key) { var cachedValue = this.cacheFor(key); if (cachedValue) { var type = get(this.constructor, 'relationshipsByName').get(key).type; var store = get(this, 'store'); var ids = this._data.hasMany[key] || []; var references = map(ids, function(id) { // if it was already a reference, return the reference if (typeof id === 'object') { return id; } return store.referenceForId(type, id); }); set(cachedValue, 'content', Ember.A(references)); } }, updateRecordArraysLater: function() { Ember.run.once(this, this.updateRecordArrays); }, setupData: function(prematerialized) { this._data = { attributes: {}, belongsTo: {}, hasMany: {}, id: null }; }, materializeId: function(id) { set(this, 'id', id); }, materializeAttributes: function(attributes) { this._data.attributes = attributes; }, materializeAttribute: function(name, value) { this._data.attributes[name] = value; }, materializeHasMany: function(name, ids) { this._data.hasMany[name] = ids; }, materializeBelongsTo: function(name, id) { this._data.belongsTo[name] = id; }, rollback: function() { this._setup(); this.send('becameClean'); this.suspendRelationshipObservers(function() { this.notifyPropertyChange('data'); }); }, toStringExtension: function() { return get(this, 'id'); }, /** @private The goal of this method is to temporarily disable specific observers that take action in response to application changes. This allows the system to make changes (such as materialization and rollback) that should not trigger secondary behavior (such as setting an inverse relationship or marking records as dirty). The specific implementation will likely change as Ember proper provides better infrastructure for suspending groups of observers, and if Array observation becomes more unified with regular observers. */ suspendRelationshipObservers: function(callback, binding) { var observers = get(this.constructor, 'relationshipNames').belongsTo; var self = this; try { this._suspendedRelationships = true; Ember._suspendObservers(self, observers, null, 'belongsToDidChange', function() { Ember._suspendBeforeObservers(self, observers, null, 'belongsToWillChange', function() { callback.call(binding || self); }); }); } finally { this._suspendedRelationships = false; } }, becameInFlight: function() { }, // FOR USE DURING COMMIT PROCESS adapterDidUpdateAttribute: function(attributeName, value) { // If a value is passed in, update the internal attributes and clear // the attribute cache so it picks up the new value. Otherwise, // collapse the current value into the internal attributes because // the adapter has acknowledged it. if (value !== undefined) { get(this, 'data.attributes')[attributeName] = value; this.notifyPropertyChange(attributeName); } else { value = get(this, attributeName); get(this, 'data.attributes')[attributeName] = value; } this.updateRecordArraysLater(); }, _reference: Ember.computed(function() { return get(this, 'store').referenceForClientId(get(this, 'clientId')); }), adapterDidInvalidate: function(errors) { this.send('becameInvalid', errors); }, adapterDidError: function() { this.send('becameError'); }, /** @private Override the default event firing from Ember.Evented to also call methods with the given name. */ trigger: function(name) { Ember.tryInvoke(this, name, [].slice.call(arguments, 1)); this._super.apply(this, arguments); } }); // Helper function to generate store aliases. // This returns a function that invokes the named alias // on the default store, but injects the class as the // first parameter. var storeAlias = function(methodName) { return function() { var store = get(DS, 'defaultStore'), args = [].slice.call(arguments); args.unshift(this); return store[methodName].apply(store, args); }; }; DS.Model.reopenClass({ isLoaded: storeAlias('recordIsLoaded'), find: storeAlias('find'), all: storeAlias('all'), filter: storeAlias('filter'), _create: DS.Model.create, create: function() { throw new Ember.Error("You should not call `create` on a model. Instead, call `createRecord` with the attributes you would like to set."); }, createRecord: storeAlias('createRecord') }); })(); (function() { var get = Ember.get; DS.Model.reopenClass({ attributes: Ember.computed(function() { var map = Ember.Map.create(); this.eachComputedProperty(function(name, meta) { if (meta.isAttribute) { meta.name = name; map.set(name, meta); } }); return map; }) }); var AttributeChange = DS.AttributeChange = function(options) { this.reference = options.reference; this.store = options.store; this.name = options.name; this.oldValue = options.oldValue; }; AttributeChange.createChange = function(options) { return new AttributeChange(options); }; AttributeChange.prototype = { sync: function() { this.store.recordAttributeDidChange(this.reference, this.name, this.value, this.oldValue); // TODO: Use this object in the commit process this.destroy(); }, destroy: function() { delete this.store.recordForReference(this.reference)._changesToSync[this.name]; } }; DS.Model.reopen({ eachAttribute: function(callback, binding) { get(this.constructor, 'attributes').forEach(function(name, meta) { callback.call(binding, name, meta); }, binding); }, attributeWillChange: Ember.beforeObserver(function(record, key) { var reference = get(record, '_reference'), store = get(record, 'store'); record.send('willSetProperty', { reference: reference, store: store, name: key }); }), attributeDidChange: Ember.observer(function(record, key) { record.send('didSetProperty', { name: key }); }) }); function getAttr(record, options, key) { var attributes = get(record, 'data').attributes; var value = attributes[key]; if (value === undefined) { value = options.defaultValue; } return value; } DS.attr = function(type, options) { options = options || {}; var meta = { type: type, isAttribute: true, options: options }; return Ember.computed(function(key, value, oldValue) { var data; if (arguments.length > 1) { } else { value = getAttr(this, options, key); } return value; // `data` is never set directly. However, it may be // invalidated from the state manager's setData // event. }).property('data').meta(meta); }; })(); (function() { })(); (function() { var get = Ember.get, set = Ember.set, none = Ember.isNone; DS.belongsTo = function(type, options) { options = options || {}; var meta = { type: type, isRelationship: true, options: options, kind: 'belongsTo' }; return Ember.computed(function(key, value) { if (arguments.length === 2) { return value === undefined ? null : value; } var data = get(this, 'data').belongsTo, store = get(this, 'store'), id; if (typeof type === 'string') { type = get(this, type, false) || get(Ember.lookup, type); } id = data[key]; if(!id) { return null; } else if (typeof id === 'object') { return store.recordForReference(id); } else { return store.find(type, id); } }).property('data').meta(meta); }; /** These observers observe all `belongsTo` relationships on the record. See `relationships/ext` to see how these observers get their dependencies. */ DS.Model.reopen({ /** @private */ belongsToWillChange: Ember.beforeObserver(function(record, key) { if (get(record, 'isLoaded')) { var oldParent = get(record, key); var childReference = get(record, '_reference'), store = get(record, 'store'); if (oldParent){ var change = DS.RelationshipChange.createChange(childReference, get(oldParent, '_reference'), store, { key: key, kind:"belongsTo", changeType: "remove" }); change.sync(); this._changesToSync[key] = change; } } }), /** @private */ belongsToDidChange: Ember.immediateObserver(function(record, key) { if (get(record, 'isLoaded')) { var newParent = get(record, key); if(newParent){ var childReference = get(record, '_reference'), store = get(record, 'store'); var change = DS.RelationshipChange.createChange(childReference, get(newParent, '_reference'), store, { key: key, kind:"belongsTo", changeType: "add" }); change.sync(); if(this._changesToSync[key]){ DS.OneToManyChange.ensureSameTransaction([change, this._changesToSync[key]], store); } } } delete this._changesToSync[key]; }) }); })(); (function() { var get = Ember.get, set = Ember.set; var hasRelationship = function(type, options) { options = options || {}; var meta = { type: type, isRelationship: true, options: options, kind: 'hasMany' }; return Ember.computed(function(key, value) { var data = get(this, 'data').hasMany, store = get(this, 'store'), ids, relationship; if (typeof type === 'string') { type = get(this, type, false) || get(Ember.lookup, type); } ids = data[key]; relationship = store.findMany(type, ids || [], this, meta); set(relationship, 'owner', this); set(relationship, 'name', key); return relationship; }).property().meta(meta); }; DS.hasMany = function(type, options) { return hasRelationship(type, options); }; })(); (function() { var get = Ember.get, set = Ember.set; /** @private This file defines several extensions to the base `DS.Model` class that add support for one-to-many relationships. */ DS.Model.reopen({ // This Ember.js hook allows an object to be notified when a property // is defined. // // In this case, we use it to be notified when an Ember Data user defines a // belongs-to relationship. In that case, we need to set up observers for // each one, allowing us to track relationship changes and automatically // reflect changes in the inverse has-many array. // // This hook passes the class being set up, as well as the key and value // being defined. So, for example, when the user does this: // // DS.Model.extend({ // parent: DS.belongsTo(App.User) // }); // // This hook would be called with "parent" as the key and the computed // property returned by `DS.belongsTo` as the value. didDefineProperty: function(proto, key, value) { // Check if the value being set is a computed property. if (value instanceof Ember.Descriptor) { // If it is, get the metadata for the relationship. This is // populated by the `DS.belongsTo` helper when it is creating // the computed property. var meta = value.meta(); if (meta.isRelationship && meta.kind === 'belongsTo') { Ember.addObserver(proto, key, null, 'belongsToDidChange'); Ember.addBeforeObserver(proto, key, null, 'belongsToWillChange'); } if (meta.isAttribute) { Ember.addObserver(proto, key, null, 'attributeDidChange'); Ember.addBeforeObserver(proto, key, null, 'attributeWillChange'); } meta.parentType = proto.constructor; } } }); /** These DS.Model extensions add class methods that provide relationship introspection abilities about relationships. A note about the computed properties contained here: **These properties are effectively sealed once called for the first time.** To avoid repeatedly doing expensive iteration over a model's fields, these values are computed once and then cached for the remainder of the runtime of your application. If your application needs to modify a class after its initial definition (for example, using `reopen()` to add additional attributes), make sure you do it before using your model with the store, which uses these properties extensively. */ DS.Model.reopenClass({ /** For a given relationship name, returns the model type of the relationship. For example, if you define a model like this: App.Post = DS.Model.extend({ comments: DS.hasMany(App.Comment) }); Calling `App.Post.typeForRelationship('comments')` will return `App.Comment`. @param {String} name the name of the relationship @return {subclass of DS.Model} the type of the relationship, or undefined */ typeForRelationship: function(name) { var relationship = get(this, 'relationshipsByName').get(name); return relationship && relationship.type; }, /** The model's relationships as a map, keyed on the type of the relationship. The value of each entry is an array containing a descriptor for each relationship with that type, describing the name of the relationship as well as the type. For example, given the following model definition: App.Blog = DS.Model.extend({ users: DS.hasMany(App.User), owner: DS.belongsTo(App.User), posts: DS.hasMany(App.Post) }); This computed property would return a map describing these relationships, like this: var relationships = Ember.get(App.Blog, 'relationships'); associatons.get(App.User); //=> [ { name: 'users', kind: 'hasMany' }, // { name: 'owner', kind: 'belongsTo' } ] relationships.get(App.Post); //=> [ { name: 'posts', kind: 'hasMany' } ] @type Ember.Map @readOnly */ relationships: Ember.computed(function() { var map = new Ember.MapWithDefault({ defaultValue: function() { return []; } }); // Loop through each computed property on the class this.eachComputedProperty(function(name, meta) { // If the computed property is a relationship, add // it to the map. if (meta.isRelationship) { if (typeof meta.type === 'string') { meta.type = Ember.get(Ember.lookup, meta.type); } var relationshipsForType = map.get(meta.type); relationshipsForType.push({ name: name, kind: meta.kind }); } }); return map; }), /** A hash containing lists of the model's relationships, grouped by the relationship kind. For example, given a model with this definition: App.Blog = DS.Model.extend({ users: DS.hasMany(App.User), owner: DS.belongsTo(App.User), posts: DS.hasMany(App.Post) }); This property would contain the following: var relationshipNames = Ember.get(App.Blog, 'relationshipNames'); relationshipNames.hasMany; //=> ['users', 'posts'] relationshipNames.belongsTo; //=> ['owner'] @type Object @readOnly */ relationshipNames: Ember.computed(function() { var names = { hasMany: [], belongsTo: [] }; this.eachComputedProperty(function(name, meta) { if (meta.isRelationship) { names[meta.kind].push(name); } }); return names; }), /** A map whose keys are the relationships of a model and whose values are relationship descriptors. For example, given a model with this definition: App.Blog = DS.Model.extend({ users: DS.hasMany(App.User), owner: DS.belongsTo(App.User), posts: DS.hasMany(App.Post) }); This property would contain the following: var relationshipsByName = Ember.get(App.Blog, 'relationshipsByName'); relationshipsByName.get('users'); //=> { key: 'users', kind: 'hasMany', type: App.User } relationshipsByName.get('owner'); //=> { key: 'owner', kind: 'belongsTo', type: App.User } @type Ember.Map @readOnly */ relationshipsByName: Ember.computed(function() { var map = Ember.Map.create(), type; this.eachComputedProperty(function(name, meta) { if (meta.isRelationship) { meta.key = name; type = meta.type; if (typeof type === 'string') { type = get(this, type, false) || get(Ember.lookup, type); meta.type = type; } map.set(name, meta); } }); return map; }), /** A map whose keys are the fields of the model and whose values are strings describing the kind of the field. A model's fields are the union of all of its attributes and relationships. For example: App.Blog = DS.Model.extend({ users: DS.hasMany(App.User), owner: DS.belongsTo(App.User), posts: DS.hasMany(App.Post), title: DS.attr('string') }); var fields = Ember.get(App.Blog, 'fields'); fields.forEach(function(field, kind) { console.log(field, kind); }); // prints: // users, hasMany // owner, belongsTo // posts, hasMany // title, attribute @type Ember.Map @readOnly */ fields: Ember.computed(function() { var map = Ember.Map.create(), type; this.eachComputedProperty(function(name, meta) { if (meta.isRelationship) { map.set(name, meta.kind); } else if (meta.isAttribute) { map.set(name, 'attribute'); } }); return map; }), /** Given a callback, iterates over each of the relationships in the model, invoking the callback with the name of each relationship and its relationship descriptor. @param {Function} callback the callback to invoke @param {any} binding the value to which the callback's `this` should be bound */ eachRelationship: function(callback, binding) { get(this, 'relationshipsByName').forEach(function(name, relationship) { callback.call(binding, name, relationship); }); } }); DS.Model.reopen({ /** Given a callback, iterates over each of the relationships in the model, invoking the callback with the name of each relationship and its relationship descriptor. @param {Function} callback the callback to invoke @param {any} binding the value to which the callback's `this` should be bound */ eachRelationship: function(callback, binding) { this.constructor.eachRelationship(callback, binding); } }); /** @private Helper method to look up the name of the inverse of a relationship. In a has-many relationship, there are always two sides: the `belongsTo` side and the `hasMany` side. When one side changes, the other side should be updated automatically. Given a model, the model of the inverse, and the kind of the relationship, this helper returns the name of the relationship on the inverse. For example, imagine the following two associated models: App.Post = DS.Model.extend({ comments: DS.hasMany('App.Comment') }); App.Comment = DS.Model.extend({ post: DS.belongsTo('App.Post') }); If the `post` property of a `Comment` was modified, Ember Data would invoke this helper like this: DS._inverseNameFor(App.Comment, App.Post, 'hasMany'); //=> 'comments' Ember Data uses the name of the relationship returned to reflect the changed relationship on the other side. */ DS._inverseRelationshipFor = function(modelType, inverseModelType) { var relationshipMap = get(modelType, 'relationships'), possibleRelationships = relationshipMap.get(inverseModelType), possible, actual, oldValue; if (!possibleRelationships) { return; } if (possibleRelationships.length > 1) { return; } return possibleRelationships[0]; }; /** @private Given a model and a relationship name, returns the model type of the named relationship. App.Post = DS.Model.extend({ comments: DS.hasMany('App.Comment') }); DS._inverseTypeFor(App.Post, 'comments'); //=> App.Comment @param {DS.Model class} modelType @param {String} relationshipName @return {DS.Model class} */ DS._inverseTypeFor = function(modelType, relationshipName) { var relationships = get(modelType, 'relationshipsByName'), relationship = relationships.get(relationshipName); if (relationship) { return relationship.type; } }; })(); (function() { var get = Ember.get, set = Ember.set; var forEach = Ember.EnumerableUtils.forEach; DS.RelationshipChange = function(options) { this.parentReference = options.parentReference; this.childReference = options.childReference; this.firstRecordReference = options.firstRecordReference; this.firstRecordKind = options.firstRecordKind; this.firstRecordName = options.firstRecordName; this.secondRecordReference = options.secondRecordReference; this.secondRecordKind = options.secondRecordKind; this.secondRecordName = options.secondRecordName; this.store = options.store; this.committed = {}; this.changeType = options.changeType; }; DS.RelationshipChangeAdd = function(options){ DS.RelationshipChange.call(this, options); }; DS.RelationshipChangeRemove = function(options){ DS.RelationshipChange.call(this, options); }; /** @private */ DS.RelationshipChange.create = function(options) { return new DS.RelationshipChange(options); }; /** @private */ DS.RelationshipChangeAdd.create = function(options) { return new DS.RelationshipChangeAdd(options); }; /** @private */ DS.RelationshipChangeRemove.create = function(options) { return new DS.RelationshipChangeRemove(options); }; DS.OneToManyChange = {}; DS.OneToNoneChange = {}; DS.ManyToNoneChange = {}; DS.OneToOneChange = {}; DS.ManyToManyChange = {}; DS.RelationshipChange._createChange = function(options){ if(options.changeType === "add"){ return DS.RelationshipChangeAdd.create(options); } if(options.changeType === "remove"){ return DS.RelationshipChangeRemove.create(options); } }; DS.RelationshipChange.determineRelationshipType = function(recordType, knownSide){ var knownKey = knownSide.key, key, type, otherContainerType,assoc; var knownContainerType = knownSide.kind; var options = recordType.metaForProperty(knownKey).options; var otherType = DS._inverseTypeFor(recordType, knownKey); if(options.inverse){ key = options.inverse; otherContainerType = get(otherType, 'relationshipsByName').get(key).kind; } else if(assoc = DS._inverseRelationshipFor(otherType, recordType)){ key = assoc.name; otherContainerType = assoc.kind; } if(!key){ return knownContainerType === "belongsTo" ? "oneToNone" : "manyToNone"; } else{ if(otherContainerType === "belongsTo"){ return knownContainerType === "belongsTo" ? "oneToOne" : "manyToOne"; } else{ return knownContainerType === "belongsTo" ? "oneToMany" : "manyToMany"; } } }; DS.RelationshipChange.createChange = function(firstRecordReference, secondRecordReference, store, options){ // Get the type of the child based on the child's client ID var firstRecordType = firstRecordReference.type, key, changeType; changeType = DS.RelationshipChange.determineRelationshipType(firstRecordType, options); if (changeType === "oneToMany"){ return DS.OneToManyChange.createChange(firstRecordReference, secondRecordReference, store, options); } else if (changeType === "manyToOne"){ return DS.OneToManyChange.createChange(secondRecordReference, firstRecordReference, store, options); } else if (changeType === "oneToNone"){ return DS.OneToNoneChange.createChange(firstRecordReference, secondRecordReference, store, options); } else if (changeType === "manyToNone"){ return DS.ManyToNoneChange.createChange(firstRecordReference, secondRecordReference, store, options); } else if (changeType === "oneToOne"){ return DS.OneToOneChange.createChange(firstRecordReference, secondRecordReference, store, options); } else if (changeType === "manyToMany"){ return DS.ManyToManyChange.createChange(firstRecordReference, secondRecordReference, store, options); } }; /** @private */ DS.OneToNoneChange.createChange = function(childReference, parentReference, store, options) { var key = options.key; var change = DS.RelationshipChange._createChange({ parentReference: parentReference, childReference: childReference, firstRecordReference: childReference, store: store, changeType: options.changeType, firstRecordName: key, firstRecordKind: "belongsTo" }); store.addRelationshipChangeFor(childReference, key, parentReference, null, change); return change; }; /** @private */ DS.ManyToNoneChange.createChange = function(childReference, parentReference, store, options) { var key = options.key; var change = DS.RelationshipChange._createChange({ parentReference: childReference, childReference: parentReference, secondRecordReference: childReference, store: store, changeType: options.changeType, secondRecordName: options.key, secondRecordKind: "hasMany" }); store.addRelationshipChangeFor(childReference, key, parentReference, null, change); return change; }; /** @private */ DS.ManyToManyChange.createChange = function(childReference, parentReference, store, options) { // Get the type of the child based on the child's client ID var childType = childReference.type, key; // If the name of the belongsTo side of the relationship is specified, // use that // If the type of the parent is specified, look it up on the child's type // definition. key = options.key; var change = DS.RelationshipChange._createChange({ parentReference: parentReference, childReference: childReference, firstRecordReference: childReference, secondRecordReference: parentReference, firstRecordKind: "hasMany", secondRecordKind: "hasMany", store: store, changeType: options.changeType, firstRecordName: key }); store.addRelationshipChangeFor(childReference, key, parentReference, null, change); return change; }; /** @private */ DS.OneToOneChange.createChange = function(childReference, parentReference, store, options) { // Get the type of the child based on the child's client ID var childType = childReference.type, key; // If the name of the belongsTo side of the relationship is specified, // use that // If the type of the parent is specified, look it up on the child's type // definition. if (options.parentType) { key = inverseBelongsToName(options.parentType, childType, options.key); //DS.OneToOneChange.maintainInvariant( options, store, childReference, key ); } else if (options.key) { key = options.key; } else { } var change = DS.RelationshipChange._createChange({ parentReference: parentReference, childReference: childReference, firstRecordReference: childReference, secondRecordReference: parentReference, firstRecordKind: "belongsTo", secondRecordKind: "belongsTo", store: store, changeType: options.changeType, firstRecordName: key }); store.addRelationshipChangeFor(childReference, key, parentReference, null, change); return change; }; DS.OneToOneChange.maintainInvariant = function(options, store, childReference, key){ if (options.changeType === "add" && store.recordIsMaterialized(childReference)) { var child = store.recordForReference(childReference); var oldParent = get(child, key); if (oldParent){ var correspondingChange = DS.OneToOneChange.createChange(childReference, oldParent.get('_reference'), store, { parentType: options.parentType, hasManyName: options.hasManyName, changeType: "remove", key: options.key }); store.addRelationshipChangeFor(childReference, key, options.parentReference , null, correspondingChange); correspondingChange.sync(); } } }; /** @private */ DS.OneToManyChange.createChange = function(childReference, parentReference, store, options) { // Get the type of the child based on the child's client ID var childType = childReference.type, key; // If the name of the belongsTo side of the relationship is specified, // use that // If the type of the parent is specified, look it up on the child's type // definition. if (options.parentType) { key = inverseBelongsToName(options.parentType, childType, options.key); DS.OneToManyChange.maintainInvariant( options, store, childReference, key ); } else if (options.key) { key = options.key; } else { } var change = DS.RelationshipChange._createChange({ parentReference: parentReference, childReference: childReference, firstRecordReference: childReference, secondRecordReference: parentReference, firstRecordKind: "belongsTo", secondRecordKind: "hasMany", store: store, changeType: options.changeType, firstRecordName: key }); store.addRelationshipChangeFor(childReference, key, parentReference, null, change); return change; }; DS.OneToManyChange.maintainInvariant = function(options, store, childReference, key){ if (options.changeType === "add" && store.recordIsMaterialized(childReference)) { var child = store.recordForReference(childReference); var oldParent = get(child, key); if (oldParent){ var correspondingChange = DS.OneToManyChange.createChange(childReference, oldParent.get('_reference'), store, { parentType: options.parentType, hasManyName: options.hasManyName, changeType: "remove", key: options.key }); store.addRelationshipChangeFor(childReference, key, options.parentReference , null, correspondingChange); correspondingChange.sync(); } } }; DS.OneToManyChange.ensureSameTransaction = function(changes, store){ var records = Ember.A(); forEach(changes, function(change){ records.addObject(change.getSecondRecord()); records.addObject(change.getFirstRecord()); }); var transaction = store.ensureSameTransaction(records); forEach(changes, function(change){ change.transaction = transaction; }); }; DS.RelationshipChange.prototype = { getSecondRecordName: function() { var name = this.secondRecordName, store = this.store, parent; if (!name) { parent = this.secondRecordReference; if (!parent) { return; } var childType = this.firstRecordReference.type; var inverseType = DS._inverseTypeFor(childType, this.firstRecordName); name = inverseHasManyName(inverseType, childType, this.firstRecordName); this.secondRecordName = name; } return name; }, /** Get the name of the relationship on the belongsTo side. @returns {String} */ getFirstRecordName: function() { var name = this.firstRecordName, store = this.store, parent, child; if (!name) { parent = this.secondRecordReference; child = this.firstRecordReference; if (!(child && parent)) { return; } name = DS._inverseRelationshipFor(child.type, parent.type).name; this.firstRecordName = name; } return name; }, /** @private */ destroy: function() { var childReference = this.childReference, belongsToName = this.getFirstRecordName(), hasManyName = this.getSecondRecordName(), store = this.store, child, oldParent, newParent, lastParent, transaction; store.removeRelationshipChangeFor(childReference, belongsToName, this.parentReference, hasManyName, this.changeType); if (transaction = this.transaction) { transaction.relationshipBecameClean(this); } }, /** @private */ getByReference: function(reference) { var store = this.store; // return null or undefined if the original reference was null or undefined if (!reference) { return reference; } if (store.recordIsMaterialized(reference)) { return store.recordForReference(reference); } }, getSecondRecord: function(){ return this.getByReference(this.secondRecordReference); }, /** @private */ getFirstRecord: function() { return this.getByReference(this.firstRecordReference); }, /** @private Make sure that all three parts of the relationship change are part of the same transaction. If any of the three records is clean and in the default transaction, and the rest are in a different transaction, move them all into that transaction. */ ensureSameTransaction: function() { var child = this.getFirstRecord(), parentRecord = this.getSecondRecord(); var transaction = this.store.ensureSameTransaction([child, parentRecord]); this.transaction = transaction; return transaction; }, callChangeEvents: function(){ var hasManyName = this.getSecondRecordName(), belongsToName = this.getFirstRecordName(), child = this.getFirstRecord(), parentRecord = this.getSecondRecord(); var dirtySet = new Ember.OrderedSet(); // TODO: This implementation causes a race condition in key-value // stores. The fix involves buffering changes that happen while // a record is loading. A similar fix is required for other parts // of ember-data, and should be done as new infrastructure, not // a one-off hack. [tomhuda] if (parentRecord && get(parentRecord, 'isLoaded')) { this.store.recordHasManyDidChange(dirtySet, parentRecord, this); } if (child) { this.store.recordBelongsToDidChange(dirtySet, child, this); } dirtySet.forEach(function(record) { record.adapterDidDirty(); }); }, coalesce: function(){ var relationshipPairs = this.store.relationshipChangePairsFor(this.firstRecordReference); forEach(relationshipPairs, function(pair){ var addedChange = pair["add"]; var removedChange = pair["remove"]; if(addedChange && removedChange) { addedChange.destroy(); removedChange.destroy(); } }); } }; DS.RelationshipChangeAdd.prototype = Ember.create(DS.RelationshipChange.create({})); DS.RelationshipChangeRemove.prototype = Ember.create(DS.RelationshipChange.create({})); DS.RelationshipChangeAdd.prototype.changeType = "add"; DS.RelationshipChangeAdd.prototype.sync = function() { var secondRecordName = this.getSecondRecordName(), firstRecordName = this.getFirstRecordName(), firstRecord = this.getFirstRecord(), secondRecord = this.getSecondRecord(); //Ember.assert("You specified a hasMany (" + hasManyName + ") on " + (!belongsToName && (newParent || oldParent || this.lastParent).constructor) + " but did not specify an inverse belongsTo on " + child.constructor, belongsToName); //Ember.assert("You specified a belongsTo (" + belongsToName + ") on " + child.constructor + " but did not specify an inverse hasMany on " + (!hasManyName && (newParent || oldParent || this.lastParentRecord).constructor), hasManyName); var transaction = this.ensureSameTransaction(); transaction.relationshipBecameDirty(this); this.callChangeEvents(); if (secondRecord && firstRecord) { if(this.secondRecordKind === "belongsTo"){ secondRecord.suspendRelationshipObservers(function(){ set(secondRecord, secondRecordName, firstRecord); }); } else if(this.secondRecordKind === "hasMany"){ secondRecord.suspendRelationshipObservers(function(){ get(secondRecord, secondRecordName).addObject(firstRecord); }); } } if (firstRecord && secondRecord && get(firstRecord, firstRecordName) !== secondRecord) { if(this.firstRecordKind === "belongsTo"){ firstRecord.suspendRelationshipObservers(function(){ set(firstRecord, firstRecordName, secondRecord); }); } else if(this.firstdRecordKind === "hasMany"){ firstRecord.suspendRelationshipObservers(function(){ get(firstRecord, firstRecordName).addObject(secondRecord); }); } } this.coalesce(); }; DS.RelationshipChangeRemove.prototype.changeType = "remove"; DS.RelationshipChangeRemove.prototype.sync = function() { var secondRecordName = this.getSecondRecordName(), firstRecordName = this.getFirstRecordName(), firstRecord = this.getFirstRecord(), secondRecord = this.getSecondRecord(); //Ember.assert("You specified a hasMany (" + hasManyName + ") on " + (!belongsToName && (newParent || oldParent || this.lastParent).constructor) + " but did not specify an inverse belongsTo on " + child.constructor, belongsToName); //Ember.assert("You specified a belongsTo (" + belongsToName + ") on " + child.constructor + " but did not specify an inverse hasMany on " + (!hasManyName && (newParent || oldParent || this.lastParentRecord).constructor), hasManyName); var transaction = this.ensureSameTransaction(firstRecord, secondRecord, secondRecordName, firstRecordName); transaction.relationshipBecameDirty(this); this.callChangeEvents(); if (secondRecord && firstRecord) { if(this.secondRecordKind === "belongsTo"){ set(secondRecord, secondRecordName, null); } else if(this.secondRecordKind === "hasMany"){ secondRecord.suspendRelationshipObservers(function(){ get(secondRecord, secondRecordName).removeObject(firstRecord); }); } } if (firstRecord && get(firstRecord, firstRecordName)) { if(this.firstRecordKind === "belongsTo"){ firstRecord.suspendRelationshipObservers(function(){ set(firstRecord, firstRecordName, null); }); } else if(this.firstdRecordKind === "hasMany"){ firstRecord.suspendRelationshipObservers(function(){ get(firstRecord, firstRecordName).removeObject(secondRecord); }); } } this.coalesce(); }; function inverseBelongsToName(parentType, childType, hasManyName) { // Get the options passed to the parent's DS.hasMany() var options = parentType.metaForProperty(hasManyName).options; var belongsToName; if (belongsToName = options.inverse) { return belongsToName; } return DS._inverseRelationshipFor(childType, parentType).name; } function inverseHasManyName(parentType, childType, belongsToName) { var options = childType.metaForProperty(belongsToName).options; var hasManyName; if (hasManyName = options.inverse) { return hasManyName; } return DS._inverseRelationshipFor(parentType, childType).name; } })(); (function() { })(); (function() { var set = Ember.set; /** This code registers an injection for Ember.Application. If an Ember.js developer defines a subclass of DS.Store on their application, this code will automatically instantiate it and make it available on the router. Additionally, after an application's controllers have been injected, they will each have the store made available to them. For example, imagine an Ember.js application with the following classes: App.Store = DS.Store.extend({ adapter: 'App.MyCustomAdapter' }); App.PostsController = Ember.ArrayController.extend({ // ... }); When the application is initialized, `App.Store` will automatically be instantiated, and the instance of `App.PostsController` will have its `store` property set to that instance. Note that this code will only be run if the `ember-application` package is loaded. If Ember Data is being used in an environment other than a typical application (e.g., node.js where only `ember-runtime` is available), this code will be ignored. */ Ember.onLoad('Ember.Application', function(Application) { if (Application.registerInjection) { Application.registerInjection({ name: "store", before: "controllers", // If a store subclass is defined, like App.Store, // instantiate it and inject it into the router. injection: function(app, stateManager, property) { if (!stateManager) { return; } if (property === 'Store') { set(stateManager, 'store', app[property].create()); } } }); Application.registerInjection({ name: "giveStoreToControllers", after: ['store','controllers'], // For each controller, set its `store` property // to the DS.Store instance we created above. injection: function(app, stateManager, property) { if (!stateManager) { return; } if (/^[A-Z].*Controller$/.test(property)) { var controllerName = property.charAt(0).toLowerCase() + property.substr(1); var store = stateManager.get('store'); var controller = stateManager.get(controllerName); if(!controller) { return; } controller.set('store', store); } } }); } else if (Application.initializer) { Application.initializer({ name: "store", initialize: function(container, application) { container.register('store', 'main', application.Store); // Eagerly generate the store so defaultStore is populated. // TODO: Do this in a finisher hook container.lookup('store:main'); } }); Application.initializer({ name: "injectStore", initialize: function(container) { container.typeInjection('controller', 'store', 'store:main'); container.typeInjection('route', 'store', 'store:main'); } }); } }); })(); (function() { var get = Ember.get, set = Ember.set, map = Ember.ArrayPolyfills.map, isNone = Ember.isNone; function mustImplement(name) { return function() { throw new Ember.Error("Your serializer " + this.toString() + " does not implement the required method " + name); }; } /** A serializer is responsible for serializing and deserializing a group of records. `DS.Serializer` is an abstract base class designed to help you build a serializer that can read to and write from any serialized form. While most applications will use `DS.JSONSerializer`, which reads and writes JSON, the serializer architecture allows your adapter to transmit things like XML, strings, or custom binary data. Typically, your application's `DS.Adapter` is responsible for both creating a serializer as well as calling the appropriate methods when it needs to materialize data or serialize a record. The serializer API is designed as a series of layered hooks that you can override to customize any of the individual steps of serialization and deserialization. The hooks are organized by the three responsibilities of the serializer: 1. Determining naming conventions 2. Serializing records into a serialized form 3. Deserializing records from a serialized form Because Ember Data lazily materializes records, the deserialization step, and therefore the hooks you implement, are split into two phases: 1. Extraction, where the serialized forms for multiple records are extracted from a single payload. The IDs of each record are also extracted for indexing. 2. Materialization, where a newly-created record has its attributes and relationships initialized based on the serialized form loaded by the adapter. Additionally, a serializer can convert values from their JavaScript versions into their serialized versions via a declarative API. ## Naming Conventions One of the most common uses of the serializer is to map attribute names from the serialized form to your `DS.Model`. For example, in your model, you may have an attribute called `firstName`: ```javascript App.Person = DS.Model.extend({ firstName: DS.attr('string') }); ``` However, because the web API your adapter is communicating with is legacy, it calls this attribute `FIRST_NAME`. You can determine the attribute name used in the serialized form by implementing `keyForAttributeName`: ```javascript keyForAttributeName: function(type, name) { return name.underscore.toUpperCase(); } ``` If your attribute names are not predictable, you can re-map them one-by-one using the `map` API: ```javascript App.Person.map('App.Person', { firstName: { key: '*API_USER_FIRST_NAME*' } }); ``` ## Serialization During the serialization process, a record or records are converted from Ember.js objects into their serialized form. These methods are designed in layers, like a delicious 7-layer cake (but with fewer layers). The main entry point for serialization is the `serialize` method, which takes the record and options. The `serialize` method is responsible for: * turning the record's attributes (`DS.attr`) into attributes on the JSON object. * optionally adding the record's ID onto the hash * adding relationships (`DS.hasMany` and `DS.belongsTo`) to the JSON object. Depending on the backend, the serializer can choose whether to include the `hasMany` or `belongsTo` relationships on the JSON hash. For very custom serialization, you can implement your own `serialize` method. In general, however, you will want to override the hooks described below. ### Adding the ID The default `serialize` will optionally call your serializer's `addId` method with the JSON hash it is creating, the record's type, and the record's ID. The `serialize` method will not call `addId` if the record's ID is undefined. Your adapter must specifically request ID inclusion by passing `{ includeId: true }` as an option to `serialize`. NOTE: You may not want to include the ID when updating an existing record, because your server will likely disallow changing an ID after it is created, and the PUT request itself will include the record's identification. By default, `addId` will: 1. Get the primary key name for the record by calling the serializer's `primaryKey` with the record's type. Unless you override the `primaryKey` method, this will be `'id'`. 2. Assign the record's ID to the primary key in the JSON hash being built. If your backend expects a JSON object with the primary key at the root, you can just override the `primaryKey` method on your serializer subclass. Otherwise, you can override the `addId` method for more specialized handling. ### Adding Attributes By default, the serializer's `serialize` method will call `addAttributes` with the JSON object it is creating and the record to serialize. The `addAttributes` method will then call `addAttribute` in turn, with the JSON object, the record to serialize, the attribute's name and its type. Finally, the `addAttribute` method will serialize the attribute: 1. It will call `keyForAttributeName` to determine the key to use in the JSON hash. 2. It will get the value from the record. 3. It will call `serializeValue` with the attribute's value and attribute type to convert it into a JSON-compatible value. For example, it will convert a Date into a String. If your backend expects a JSON object with attributes as keys at the root, you can just override the `serializeValue` and `keyForAttributeName` methods in your serializer subclass and let the base class do the heavy lifting. If you need something more specialized, you can probably override `addAttribute` and let the default `addAttributes` handle the nitty gritty. ### Adding Relationships By default, `serialize` will call your serializer's `addRelationships` method with the JSON object that is being built and the record being serialized. The default implementation of this method is to loop over all of the relationships defined on your record type and: * If the relationship is a `DS.hasMany` relationship, call `addHasMany` with the JSON object, the record and a description of the relationship. * If the relationship is a `DS.belongsTo` relationship, call `addBelongsTo` with the JSON object, the record and a description of the relationship. The relationship description has the following keys: * `type`: the class of the associated information (the first parameter to `DS.hasMany` or `DS.belongsTo`) * `kind`: either `hasMany` or `belongsTo` The relationship description may get additional information in the future if more capabilities or relationship types are added. However, it will remain backwards-compatible, so the mere existence of new features should not break existing adapters. */ DS.Serializer = Ember.Object.extend({ init: function() { this.mappings = Ember.Map.create(); this.configurations = Ember.Map.create(); this.globalConfigurations = {}; }, extract: mustImplement('extract'), extractMany: mustImplement('extractMany'), extractRecordRepresentation: function(loader, type, json, shouldSideload) { var mapping = this.mappingForType(type); var embeddedData, prematerialized = {}, reference; if (shouldSideload) { reference = loader.sideload(type, json); } else { reference = loader.load(type, json); } this.eachEmbeddedHasMany(type, function(name, relationship) { var embeddedData = json[this.keyFor(relationship)]; if (!isNone(embeddedData)) { this.extractEmbeddedHasMany(loader, relationship, embeddedData, reference, prematerialized); } }, this); this.eachEmbeddedBelongsTo(type, function(name, relationship) { var embeddedData = json[this.keyFor(relationship)]; if (!isNone(embeddedData)) { this.extractEmbeddedBelongsTo(loader, relationship, embeddedData, reference, prematerialized); } }, this); loader.prematerialize(reference, prematerialized); return reference; }, extractEmbeddedHasMany: function(loader, relationship, array, parent, prematerialized) { var references = map.call(array, function(item) { if (!item) { return; } var reference = this.extractRecordRepresentation(loader, relationship.type, item, true); // If the embedded record should also be saved back when serializing the parent, // make sure we set its parent since it will not have an ID. var embeddedType = this.embeddedType(parent.type, relationship.key); if (embeddedType === 'always') { reference.parent = parent; } return reference; }, this); prematerialized[relationship.key] = references; }, extractEmbeddedBelongsTo: function(loader, relationship, data, parent, prematerialized) { var reference = this.extractRecordRepresentation(loader, relationship.type, data, true); prematerialized[relationship.key] = reference; // If the embedded record should also be saved back when serializing the parent, // make sure we set its parent since it will not have an ID. var embeddedType = this.embeddedType(parent.type, relationship.key); if (embeddedType === 'always') { reference.parent = parent; } }, //....................... //. SERIALIZATION HOOKS //....................... /** The main entry point for serializing a record. While you can consider this a hook that can be overridden in your serializer, you will have to manually handle serialization. For most cases, there are more granular hooks that you can override. If overriding this method, these are the responsibilities that you will need to implement yourself: * If the option hash contains `includeId`, add the record's ID to the serialized form. By default, `serialize` calls `addId` if appropriate. * Add the record's attributes to the serialized form. By default, `serialize` calls `addAttributes`. * Add the record's relationships to the serialized form. By default, `serialize` calls `addRelationships`. @param {DS.Model} record the record to serialize @param {Object} [options] a hash of options @returns {any} the serialized form of the record */ serialize: function(record, options) { options = options || {}; var serialized = this.createSerializedForm(), id; if (options.includeId) { if (id = get(record, 'id')) { this._addId(serialized, record.constructor, id); } } this.addAttributes(serialized, record); this.addRelationships(serialized, record); return serialized; }, /** @private Given an attribute type and value, convert the value into the serialized form using the transform registered for that type. @param {any} value the value to convert to the serialized form @param {String} attributeType the registered type (e.g. `string` or `boolean`) @returns {any} the serialized form of the value */ serializeValue: function(value, attributeType) { var transform = this.transforms ? this.transforms[attributeType] : null; return transform.serialize(value); }, /** A hook you can use to normalize IDs before adding them to the serialized representation. Because the store coerces all IDs to strings for consistency, this is the opportunity for the serializer to, for example, convert numerical IDs back into number form. @param {String} id the id from the record @returns {any} the serialized representation of the id */ serializeId: function(id) { if (isNaN(id)) { return id; } return +id; }, /** A hook you can use to change how attributes are added to the serialized representation of a record. By default, `addAttributes` simply loops over all of the attributes of the passed record, maps the attribute name to the key for the serialized form, and invokes any registered transforms on the value. It then invokes the more granular `addAttribute` with the key and transformed value. Since you can override `keyForAttributeName`, `addAttribute`, and register custom tranforms, you should rarely need to override this hook. @param {any} data the serialized representation that is being built @param {DS.Model} record the record to serialize */ addAttributes: function(data, record) { record.eachAttribute(function(name, attribute) { this._addAttribute(data, record, name, attribute.type); }, this); }, /** A hook you can use to customize how the key/value pair is added to the serialized data. @param {any} serialized the serialized form being built @param {String} key the key to add to the serialized data @param {any} value the value to add to the serialized data */ addAttribute: Ember.K, /** A hook you can use to customize how the record's id is added to the serialized data. The `addId` hook is called with: * the serialized representation being built * the resolved primary key (taking configurations and the `primaryKey` hook into consideration) * the serialized id (after calling the `serializeId` hook) @param {any} data the serialized representation that is being built @param {String} key the resolved primary key @param {id} id the serialized id */ addId: Ember.K, /** A hook you can use to change how relationships are added to the serialized representation of a record. By default, `addAttributes` loops over all of the relationships of the passed record, maps the relationship names to the key for the serialized form, and then invokes the public `addBelongsTo` and `addHasMany` hooks. Since you can override `keyForBelongsTo`, `keyForHasMany`, `addBelongsTo`, `addHasMany`, and register mappings, you should rarely need to override this hook. @param {any} data the serialized representation that is being built @param {DS.Model} record the record to serialize */ addRelationships: function(data, record) { record.eachRelationship(function(name, relationship) { if (relationship.kind === 'belongsTo') { this._addBelongsTo(data, record, name, relationship); } else if (relationship.kind === 'hasMany') { this._addHasMany(data, record, name, relationship); } }, this); }, /** A hook you can use to add a `belongsTo` relationship to the serialized representation. The specifics of this hook are very adapter-specific, so there is no default implementation. You can see `DS.JSONSerializer` for an example of an implementation of the `addBelongsTo` hook. The `belongsTo` relationship object has the following properties: * **type** a subclass of DS.Model that is the type of the relationship. This is the first parameter to DS.belongsTo * **options** the options passed to the call to DS.belongsTo * **kind** always `belongsTo` Additional properties may be added in the future. @param {any} data the serialized representation that is being built @param {DS.Model} record the record to serialize @param {String} key the key for the serialized object @param {Object} relationship an object representing the relationship */ addBelongsTo: Ember.K, /** A hook you can use to add a `hasMany` relationship to the serialized representation. The specifics of this hook are very adapter-specific, so there is no default implementation. You may not need to implement this, for example, if your backend only expects relationships on the child of a one to many relationship. The `hasMany` relationship object has the following properties: * **type** a subclass of DS.Model that is the type of the relationship. This is the first parameter to DS.hasMany * **options** the options passed to the call to DS.hasMany * **kind** always `hasMany` Additional properties may be added in the future. @param {any} data the serialized representation that is being built @param {DS.Model} record the record to serialize @param {String} key the key for the serialized object @param {Object} relationship an object representing the relationship */ addHasMany: Ember.K, /** NAMING CONVENTIONS The most commonly overridden APIs of the serializer are the naming convention methods: * `keyForAttributeName`: converts a camelized attribute name into a key in the adapter-provided data hash. For example, if the model's attribute name was `firstName`, and the server used underscored names, you would return `first_name`. * `primaryKey`: returns the key that should be used to extract the id from the adapter-provided data hash. It is also used when serializing a record. */ /** A hook you can use in your serializer subclass to customize how an unmapped attribute name is converted into a key. By default, this method returns the `name` parameter. For example, if the attribute names in your JSON are underscored, you will want to convert them into JavaScript conventional camelcase: ```javascript App.MySerializer = DS.Serializer.extend({ // ... keyForAttributeName: function(type, name) { return name.camelize(); } }); ``` @param {DS.Model subclass} type the type of the record with the attribute name `name` @param {String} name the attribute name to convert into a key @returns {String} the key */ keyForAttributeName: function(type, name) { return name; }, /** A hook you can use in your serializer to specify a conventional primary key. By default, this method will return the string `id`. In general, you should not override this hook to specify a special primary key for an individual type; use `configure` instead. For example, if your primary key is always `__id__`: ```javascript App.MySerializer = DS.Serializer.extend({ // ... primaryKey: function(type) { return '__id__'; } }); ``` In another example, if the primary key always includes the underscored version of the type before the string `id`: ```javascript App.MySerializer = DS.Serializer.extend({ // ... primaryKey: function(type) { // If the type is `BlogPost`, this will return // `blog_post_id`. var typeString = type.toString.split(".")[1].underscore(); return typeString + "_id"; } }); ``` @param {DS.Model subclass} type @returns {String} the primary key for the type */ primaryKey: function(type) { return "id"; }, /** A hook you can use in your serializer subclass to customize how an unmapped `belongsTo` relationship is converted into a key. By default, this method calls `keyForAttributeName`, so if your naming convention is uniform across attributes and relationships, you can use the default here and override just `keyForAttributeName` as needed. For example, if the `belongsTo` names in your JSON always begin with `BT_` (e.g. `BT_posts`), you can strip out the `BT_` prefix:" ```javascript App.MySerializer = DS.Serializer.extend({ // ... keyForBelongsTo: function(type, name) { return name.match(/^BT_(.*)$/)[1].camelize(); } }); ``` @param {DS.Model subclass} type the type of the record with the `belongsTo` relationship. @param {String} name the relationship name to convert into a key @returns {String} the key */ keyForBelongsTo: function(type, name) { return this.keyForAttributeName(type, name); }, /** A hook you can use in your serializer subclass to customize how an unmapped `hasMany` relationship is converted into a key. By default, this method calls `keyForAttributeName`, so if your naming convention is uniform across attributes and relationships, you can use the default here and override just `keyForAttributeName` as needed. For example, if the `hasMany` names in your JSON always begin with the "table name" for the current type (e.g. `post_comments`), you can strip out the prefix:" ```javascript App.MySerializer = DS.Serializer.extend({ // ... keyForHasMany: function(type, name) { // if your App.BlogPost has many App.BlogComment, the key from // the server would look like: `blog_post_blog_comments` // // 1. Convert the type into a string and underscore the // second part (App.BlogPost -> blog_post) // 2. Extract the part after `blog_post_` (`blog_comments`) // 3. Underscore it, to become `blogComments` var typeString = type.toString().split(".")[1].underscore(); return name.match(new RegExp("^" + typeString + "_(.*)$"))[1].camelize(); } }); ``` @param {DS.Model subclass} type the type of the record with the `belongsTo` relationship. @param {String} name the relationship name to convert into a key @returns {String} the key */ keyForHasMany: function(type, name) { return this.keyForAttributeName(type, name); }, //......................... //. MATERIALIZATION HOOKS //......................... materialize: function(record, serialized, prematerialized) { var id; if (Ember.isNone(get(record, 'id'))) { if (prematerialized && prematerialized.hasOwnProperty('id')) { id = prematerialized.id; } else { id = this.extractId(record.constructor, serialized); } record.materializeId(id); } this.materializeAttributes(record, serialized, prematerialized); this.materializeRelationships(record, serialized, prematerialized); }, deserializeValue: function(value, attributeType) { var transform = this.transforms ? this.transforms[attributeType] : null; return transform.deserialize(value); }, materializeAttributes: function(record, serialized, prematerialized) { record.eachAttribute(function(name, attribute) { if (prematerialized && prematerialized.hasOwnProperty(name)) { record.materializeAttribute(name, prematerialized[name]); } else { this.materializeAttribute(record, serialized, name, attribute.type); } }, this); }, materializeAttribute: function(record, serialized, attributeName, attributeType) { var value = this.extractAttribute(record.constructor, serialized, attributeName); value = this.deserializeValue(value, attributeType); record.materializeAttribute(attributeName, value); }, materializeRelationships: function(record, hash, prematerialized) { record.eachRelationship(function(name, relationship) { if (relationship.kind === 'hasMany') { if (prematerialized && prematerialized.hasOwnProperty(name)) { record.materializeHasMany(name, prematerialized[name]); } else { this.materializeHasMany(name, record, hash, relationship, prematerialized); } } else if (relationship.kind === 'belongsTo') { if (prematerialized && prematerialized.hasOwnProperty(name)) { record.materializeBelongsTo(name, prematerialized[name]); } else { this.materializeBelongsTo(name, record, hash, relationship, prematerialized); } } }, this); }, materializeHasMany: function(name, record, hash, relationship) { var key = this._keyForHasMany(record.constructor, relationship.key); record.materializeHasMany(name, this.extractHasMany(record.constructor, hash, key)); }, materializeBelongsTo: function(name, record, hash, relationship) { var key = this._keyForBelongsTo(record.constructor, relationship.key); record.materializeBelongsTo(name, this.extractBelongsTo(record.constructor, hash, key)); }, _extractEmbeddedRelationship: function(type, hash, name, relationshipType) { var key = this['_keyFor' + relationshipType](type, name); if (this.embeddedType(type, name)) { return this['extractEmbedded' + relationshipType](type, hash, key); } }, _extractEmbeddedBelongsTo: function(type, hash, name) { return this._extractEmbeddedRelationship(type, hash, name, 'BelongsTo'); }, _extractEmbeddedHasMany: function(type, hash, name) { return this._extractEmbeddedRelationship(type, hash, name, 'HasMany'); }, /** @private This method is called to get the primary key for a given type. If a primary key configuration exists for this type, this method will return the configured value. Otherwise, it will call the public `primaryKey` hook. @param {DS.Model subclass} type @returns {String} the primary key for the type */ _primaryKey: function(type) { var config = this.configurationForType(type), primaryKey = config && config.primaryKey; if (primaryKey) { return primaryKey; } else { return this.primaryKey(type); } }, /** @private This method looks up the key for the attribute name and transforms the attribute's value using registered transforms. Specifically: 1. Look up the key for the attribute name. If available, this will use any registered mappings. Otherwise, it will invoke the public `keyForAttributeName` hook. 2. Get the value from the record using the `attributeName`. 3. Transform the value using registered transforms for the `attributeType`. 4. Invoke the public `addAttribute` hook with the hash, key, and transformed value. @param {any} data the serialized representation being built @param {DS.Model} record the record to serialize @param {String} attributeName the name of the attribute on the record @param {String} attributeType the type of the attribute (e.g. `string` or `boolean`) */ _addAttribute: function(data, record, attributeName, attributeType) { var key = this._keyForAttributeName(record.constructor, attributeName); var value = get(record, attributeName); this.addAttribute(data, key, this.serializeValue(value, attributeType)); }, /** @private This method looks up the primary key for the `type` and invokes `serializeId` on the `id`. It then invokes the public `addId` hook with the primary key and the serialized id. @param {any} data the serialized representation that is being built @param {Ember.Model subclass} type @param {any} id the materialized id from the record */ _addId: function(hash, type, id) { var primaryKey = this._primaryKey(type); this.addId(hash, primaryKey, this.serializeId(id)); }, /** @private This method is called to get a key used in the data from an attribute name. It first checks for any mappings before calling the public hook `keyForAttributeName`. @param {DS.Model subclass} type the type of the record with the attribute name `name` @param {String} name the attribute name to convert into a key @returns {String} the key */ _keyForAttributeName: function(type, name) { return this._keyFromMappingOrHook('keyForAttributeName', type, name); }, /** @private This method is called to get a key used in the data from a belongsTo relationship. It first checks for any mappings before calling the public hook `keyForBelongsTo`. @param {DS.Model subclass} type the type of the record with the `belongsTo` relationship. @param {String} name the relationship name to convert into a key @returns {String} the key */ _keyForBelongsTo: function(type, name) { return this._keyFromMappingOrHook('keyForBelongsTo', type, name); }, keyFor: function(description) { var type = description.parentType, name = description.key; switch (description.kind) { case 'belongsTo': return this._keyForBelongsTo(type, name); case 'hasMany': return this._keyForHasMany(type, name); } }, /** @private This method is called to get a key used in the data from a hasMany relationship. It first checks for any mappings before calling the public hook `keyForHasMany`. @param {DS.Model subclass} type the type of the record with the `hasMany` relationship. @param {String} name the relationship name to convert into a key @returns {String} the key */ _keyForHasMany: function(type, name) { return this._keyFromMappingOrHook('keyForHasMany', type, name); }, /** @private This method converts the relationship name to a key for serialization, and then invokes the public `addBelongsTo` hook. @param {any} data the serialized representation that is being built @param {DS.Model} record the record to serialize @param {String} name the relationship name @param {Object} relationship an object representing the relationship */ _addBelongsTo: function(data, record, name, relationship) { var key = this._keyForBelongsTo(record.constructor, name); this.addBelongsTo(data, record, key, relationship); }, /** @private This method converts the relationship name to a key for serialization, and then invokes the public `addHasMany` hook. @param {any} data the serialized representation that is being built @param {DS.Model} record the record to serialize @param {String} name the relationship name @param {Object} relationship an object representing the relationship */ _addHasMany: function(data, record, name, relationship) { var key = this._keyForHasMany(record.constructor, name); this.addHasMany(data, record, key, relationship); }, /** @private An internal method that handles checking whether a mapping exists for a particular attribute or relationship name before calling the public hooks. If a mapping is found, and the mapping has a key defined, use that instead of invoking the hook. @param {String} publicMethod the public hook to invoke if a mapping is not found (e.g. `keyForAttributeName`) @param {DS.Model subclass} type the type of the record with the attribute or relationship name. @param {String} name the attribute or relationship name to convert into a key */ _keyFromMappingOrHook: function(publicMethod, type, name) { var key = this.mappingOption(type, name, 'key'); if (key) { return key; } else { return this[publicMethod](type, name); } }, /** TRANSFORMS */ registerTransform: function(type, transform) { this.transforms[type] = transform; }, registerEnumTransform: function(type, objects) { var transform = { deserialize: function(deserialized) { return objects.objectAt(deserialized); }, serialize: function(serialized) { return objects.indexOf(serialized); }, values: objects }; this.registerTransform(type, transform); }, /** MAPPING CONVENIENCE */ map: function(type, mappings) { this.mappings.set(type, mappings); }, configure: function(type, configuration) { if (type && !configuration) { Ember.merge(this.globalConfigurations, type); return; } var config = Ember.create(this.globalConfigurations); Ember.merge(config, configuration); this.configurations.set(type, config); }, mappingForType: function(type) { this._reifyMappings(); return this.mappings.get(type) || {}; }, configurationForType: function(type) { this._reifyConfigurations(); return this.configurations.get(type) || this.globalConfigurations; }, _reifyMappings: function() { if (this._didReifyMappings) { return; } var mappings = this.mappings, reifiedMappings = Ember.Map.create(); mappings.forEach(function(key, mapping) { if (typeof key === 'string') { var type = Ember.get(Ember.lookup, key); reifiedMappings.set(type, mapping); } else { reifiedMappings.set(key, mapping); } }); this.mappings = reifiedMappings; this._didReifyMappings = true; }, _reifyConfigurations: function() { if (this._didReifyConfigurations) { return; } var configurations = this.configurations, reifiedConfigurations = Ember.Map.create(); configurations.forEach(function(key, mapping) { if (typeof key === 'string' && key !== 'plurals') { var type = Ember.get(Ember.lookup, key); reifiedConfigurations.set(type, mapping); } else { reifiedConfigurations.set(key, mapping); } }); this.configurations = reifiedConfigurations; this._didReifyConfigurations = true; }, mappingOption: function(type, name, option) { var mapping = this.mappingForType(type)[name]; return mapping && mapping[option]; }, configOption: function(type, option) { var config = this.configurationForType(type); return config[option]; }, // EMBEDDED HELPERS embeddedType: function(type, name) { return this.mappingOption(type, name, 'embedded'); }, eachEmbeddedRecord: function(record, callback, binding) { this.eachEmbeddedBelongsToRecord(record, callback, binding); this.eachEmbeddedHasManyRecord(record, callback, binding); }, eachEmbeddedBelongsToRecord: function(record, callback, binding) { var type = record.constructor; this.eachEmbeddedBelongsTo(record.constructor, function(name, relationship, embeddedType) { var embeddedRecord = get(record, name); if (embeddedRecord) { callback.call(binding, embeddedRecord, embeddedType); } }); }, eachEmbeddedHasManyRecord: function(record, callback, binding) { var type = record.constructor; this.eachEmbeddedHasMany(record.constructor, function(name, relationship, embeddedType) { var array = get(record, name); for (var i=0, l=get(array, 'length'); i 'low' Server Response / Load: { myTask: {priority: 0} } @param {String} type of the transform @param {Array} array of String objects to use for the enumerated values. This is an ordered list and the index values will be used for the transform. */ registerEnumTransform: function(attributeType, objects) { get(this, 'serializer').registerEnumTransform(attributeType, objects); }, /** If the globally unique IDs for your records should be generated on the client, implement the `generateIdForRecord()` method. This method will be invoked each time you create a new record, and the value returned from it will be assigned to the record's `primaryKey`. Most traditional REST-like HTTP APIs will not use this method. Instead, the ID of the record will be set by the server, and your adapter will update the store with the new ID when it calls `didCreateRecord()`. Only implement this method if you intend to generate record IDs on the client-side. The `generateIdForRecord()` method will be invoked with the requesting store as the first parameter and the newly created record as the second parameter: generateIdForRecord: function(store, record) { var uuid = App.generateUUIDWithStatisticallyLowOddsOfCollision(); return uuid; } */ generateIdForRecord: null, materialize: function(record, data, prematerialized) { get(this, 'serializer').materialize(record, data, prematerialized); }, serialize: function(record, options) { return get(this, 'serializer').serialize(record, options); }, extractId: function(type, data) { return get(this, 'serializer').extractId(type, data); }, groupByType: function(enumerable) { var map = Ember.MapWithDefault.create({ defaultValue: function() { return Ember.OrderedSet.create(); } }); enumerable.forEach(function(item) { map.get(item.constructor).add(item); }); return map; }, commit: function(store, commitDetails) { this.save(store, commitDetails); }, save: function(store, commitDetails) { var adapter = this; function filter(records) { var filteredSet = Ember.OrderedSet.create(); records.forEach(function(record) { if (adapter.shouldSave(record)) { filteredSet.add(record); } }); return filteredSet; } this.groupByType(commitDetails.created).forEach(function(type, set) { this.createRecords(store, type, filter(set)); }, this); this.groupByType(commitDetails.updated).forEach(function(type, set) { this.updateRecords(store, type, filter(set)); }, this); this.groupByType(commitDetails.deleted).forEach(function(type, set) { this.deleteRecords(store, type, filter(set)); }, this); }, shouldSave: Ember.K, createRecords: function(store, type, records) { records.forEach(function(record) { this.createRecord(store, type, record); }, this); }, updateRecords: function(store, type, records) { records.forEach(function(record) { this.updateRecord(store, type, record); }, this); }, deleteRecords: function(store, type, records) { records.forEach(function(record) { this.deleteRecord(store, type, record); }, this); }, findMany: function(store, type, ids) { ids.forEach(function(id) { this.find(store, type, id); }, this); } }); DS.Adapter.reopenClass({ registerTransform: function(attributeType, transform) { var registeredTransforms = this._registeredTransforms || {}; registeredTransforms[attributeType] = transform; this._registeredTransforms = registeredTransforms; }, map: DS._Mappable.generateMapFunctionFor('attributes', function(key, newValue, map) { var existingValue = map.get(key); merge(existingValue, newValue); }), configure: DS._Mappable.generateMapFunctionFor('configurations', function(key, newValue, map) { var existingValue = map.get(key); // If a mapping configuration is provided, peel it off and apply it // using the DS.Adapter.map API. var mappings = newValue && newValue.mappings; if (mappings) { this.map(key, mappings); delete newValue.mappings; } merge(existingValue, newValue); }), resolveMapConflict: function(oldValue, newValue, mappingsKey) { merge(newValue, oldValue); return newValue; } }); })(); (function() { var get = Ember.get; DS.FixtureAdapter = DS.Adapter.extend({ simulateRemoteResponse: true, latency: 50, /* Implement this method in order to provide data associated with a type */ fixturesForType: function(type) { if (type.FIXTURES) { var fixtures = Ember.A(type.FIXTURES); return fixtures.map(function(fixture){ if(!fixture.id){ throw new Error('the id property must be defined for fixture %@'.fmt(fixture)); } fixture.id = fixture.id + ''; return fixture; }); } return null; }, /* Implement this method in order to query fixtures data */ queryFixtures: function(fixtures, query, type) { return fixtures; }, /* Implement this method in order to provide provide json for CRUD methods */ mockJSON: function(type, record) { return this.serialize(record, { includeId: true }); }, /* Adapter methods */ generateIdForRecord: function(store, record) { return Ember.guidFor(record); }, find: function(store, type, id) { var fixtures = this.fixturesForType(type); if (fixtures) { fixtures = fixtures.findProperty('id', id); } if (fixtures) { this.simulateRemoteCall(function() { store.load(type, fixtures); }, store, type); } }, findMany: function(store, type, ids) { var fixtures = this.fixturesForType(type); if (fixtures) { fixtures = fixtures.filter(function(item) { return ids.indexOf(item.id) !== -1; }); } if (fixtures) { this.simulateRemoteCall(function() { store.loadMany(type, fixtures); }, store, type); } }, findAll: function(store, type) { var fixtures = this.fixturesForType(type); this.simulateRemoteCall(function() { store.loadMany(type, fixtures); store.didUpdateAll(type); }, store, type); }, findQuery: function(store, type, query, array) { var fixtures = this.fixturesForType(type); fixtures = this.queryFixtures(fixtures, query, type); if (fixtures) { this.simulateRemoteCall(function() { array.load(fixtures); }, store, type); } }, createRecord: function(store, type, record) { var fixture = this.mockJSON(type, record); fixture.id = this.generateIdForRecord(store, record); this.simulateRemoteCall(function() { store.didSaveRecord(record, fixture); }, store, type, record); }, updateRecord: function(store, type, record) { var fixture = this.mockJSON(type, record); this.simulateRemoteCall(function() { store.didSaveRecord(record, fixture); }, store, type, record); }, deleteRecord: function(store, type, record) { this.simulateRemoteCall(function() { store.didSaveRecord(record); }, store, type, record); }, /* @private */ simulateRemoteCall: function(callback, store, type, record) { if (get(this, 'simulateRemoteResponse')) { setTimeout(callback, get(this, 'latency')); } else { callback(); } } }); })(); (function() { DS.RESTSerializer = DS.JSONSerializer.extend({ keyForAttributeName: function(type, name) { return Ember.String.decamelize(name); }, keyForBelongsTo: function(type, name) { var key = this.keyForAttributeName(type, name); if (this.embeddedType(type, name)) { return key; } return key + "_id"; } }); })(); (function() { /*global jQuery*/ var get = Ember.get, set = Ember.set, merge = Ember.merge; /** The REST adapter allows your store to communicate with an HTTP server by transmitting JSON via XHR. Most Ember.js apps that consume a JSON API should use the REST adapter. This adapter is designed around the idea that the JSON exchanged with the server should be conventional. ## JSON Structure The REST adapter expects the JSON returned from your server to follow these conventions. ### Object Root The JSON payload should be an object that contains the record inside a root property. For example, in response to a `GET` request for `/posts/1`, the JSON should look like this: ```js { "post": { title: "I'm Running to Reform the W3C's Tag", author: "Yehuda Katz" } } ``` ### Conventional Names Attribute names in your JSON payload should be the underscored versions of the attributes in your Ember.js models. For example, if you have a `Person` model: ```js App.Person = DS.Model.extend({ firstName: DS.attr('string'), lastName: DS.attr('string'), occupation: DS.attr('string') }); ``` The JSON returned should look like this: ```js { "person": { "first_name": "Barack", "last_name": "Obama", "occupation": "President" } } ``` */ DS.RESTAdapter = DS.Adapter.extend({ bulkCommit: false, since: 'since', serializer: DS.RESTSerializer, init: function() { this._super.apply(this, arguments); }, shouldSave: function(record) { var reference = get(record, '_reference'); return !reference.parent; }, createRecord: function(store, type, record) { var root = this.rootForType(type); var data = {}; data[root] = this.serialize(record, { includeId: true }); this.ajax(this.buildURL(root), "POST", { data: data, context: this, success: function(json) { Ember.run(this, function(){ this.didCreateRecord(store, type, record, json); }); }, error: function(xhr) { this.didError(store, type, record, xhr); } }); }, dirtyRecordsForRecordChange: function(dirtySet, record) { this._dirtyTree(dirtySet, record); }, dirtyRecordsForHasManyChange: function(dirtySet, record, relationship) { var embeddedType = get(this, 'serializer').embeddedType(record.constructor, relationship.secondRecordName); if (embeddedType === 'always') { relationship.childReference.parent = relationship.parentReference; this._dirtyTree(dirtySet, record); } }, _dirtyTree: function(dirtySet, record) { dirtySet.add(record); get(this, 'serializer').eachEmbeddedRecord(record, function(embeddedRecord, embeddedType) { if (embeddedType !== 'always') { return; } if (dirtySet.has(embeddedRecord)) { return; } this._dirtyTree(dirtySet, embeddedRecord); }, this); var reference = record.get('_reference'); if (reference.parent) { var store = get(record, 'store'); var parent = store.recordForReference(reference.parent); this._dirtyTree(dirtySet, parent); } }, createRecords: function(store, type, records) { if (get(this, 'bulkCommit') === false) { return this._super(store, type, records); } var root = this.rootForType(type), plural = this.pluralize(root); var data = {}; data[plural] = []; records.forEach(function(record) { data[plural].push(this.serialize(record, { includeId: true })); }, this); this.ajax(this.buildURL(root), "POST", { data: data, context: this, success: function(json) { Ember.run(this, function(){ this.didCreateRecords(store, type, records, json); }); } }); }, updateRecord: function(store, type, record) { var id = get(record, 'id'); var root = this.rootForType(type); var data = {}; data[root] = this.serialize(record); this.ajax(this.buildURL(root, id), "PUT", { data: data, context: this, success: function(json) { Ember.run(this, function(){ this.didSaveRecord(store, type, record, json); }); }, error: function(xhr) { this.didError(store, type, record, xhr); } }); }, updateRecords: function(store, type, records) { if (get(this, 'bulkCommit') === false) { return this._super(store, type, records); } var root = this.rootForType(type), plural = this.pluralize(root); var data = {}; data[plural] = []; records.forEach(function(record) { data[plural].push(this.serialize(record, { includeId: true })); }, this); this.ajax(this.buildURL(root, "bulk"), "PUT", { data: data, context: this, success: function(json) { Ember.run(this, function(){ this.didSaveRecords(store, type, records, json); }); } }); }, deleteRecord: function(store, type, record) { var id = get(record, 'id'); var root = this.rootForType(type); this.ajax(this.buildURL(root, id), "DELETE", { context: this, success: function(json) { Ember.run(this, function(){ this.didSaveRecord(store, type, record, json); }); } }); }, deleteRecords: function(store, type, records) { if (get(this, 'bulkCommit') === false) { return this._super(store, type, records); } var root = this.rootForType(type), plural = this.pluralize(root), serializer = get(this, 'serializer'); var data = {}; data[plural] = []; records.forEach(function(record) { data[plural].push(serializer.serializeId( get(record, 'id') )); }); this.ajax(this.buildURL(root, 'bulk'), "DELETE", { data: data, context: this, success: function(json) { Ember.run(this, function(){ this.didSaveRecords(store, type, records, json); }); } }); }, find: function(store, type, id) { var root = this.rootForType(type); this.ajax(this.buildURL(root, id), "GET", { success: function(json) { Ember.run(this, function(){ this.didFindRecord(store, type, json, id); }); } }); }, findAll: function(store, type, since) { var root = this.rootForType(type); this.ajax(this.buildURL(root), "GET", { data: this.sinceQuery(since), success: function(json) { Ember.run(this, function(){ this.didFindAll(store, type, json); }); } }); }, findQuery: function(store, type, query, recordArray) { var root = this.rootForType(type); this.ajax(this.buildURL(root), "GET", { data: query, success: function(json) { Ember.run(this, function(){ this.didFindQuery(store, type, json, recordArray); }); } }); }, findMany: function(store, type, ids, owner) { var root = this.rootForType(type); ids = this.serializeIds(ids); this.ajax(this.buildURL(root), "GET", { data: {ids: ids}, success: function(json) { Ember.run(this, function(){ this.didFindMany(store, type, json); }); } }); }, /** @private This method serializes a list of IDs using `serializeId` @returns {Array} an array of serialized IDs */ serializeIds: function(ids) { var serializer = get(this, 'serializer'); return Ember.EnumerableUtils.map(ids, function(id) { return serializer.serializeId(id); }); }, didError: function(store, type, record, xhr) { if (xhr.status === 422) { var data = JSON.parse(xhr.responseText); store.recordWasInvalid(record, data['errors']); } else { this._super.apply(this, arguments); } }, ajax: function(url, type, hash) { hash.url = url; hash.type = type; hash.dataType = 'json'; hash.contentType = 'application/json; charset=utf-8'; hash.context = this; if (hash.data && type !== 'GET') { hash.data = JSON.stringify(hash.data); } jQuery.ajax(hash); }, url: "", rootForType: function(type) { var serializer = get(this, 'serializer'); return serializer.rootForType(type); }, pluralize: function(string) { var serializer = get(this, 'serializer'); return serializer.pluralize(string); }, buildURL: function(record, suffix) { var url = [this.url]; if (this.namespace !== undefined) { url.push(this.namespace); } url.push(this.pluralize(record)); if (suffix !== undefined) { url.push(suffix); } return url.join("/"); }, sinceQuery: function(since) { var query = {}; query[get(this, 'since')] = since; return since ? query : null; } }); })(); (function() { })(); (function() { //Copyright (C) 2011 by Living Social, Inc. //Permission is hereby granted, free of charge, to any person obtaining a copy of //this software and associated documentation files (the "Software"), to deal in //the Software without restriction, including without limitation the rights to //use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies //of the Software, and to permit persons to whom the Software is furnished to do //so, subject to the following conditions: //The above copyright notice and this permission notice shall be included in all //copies or substantial portions of the Software. //THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR //IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, //FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE //AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER //LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, //OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE //SOFTWARE. })();