Merge pull request #4347 from pangratz/cleanup-ds-references

[CLEANUP ds-references]
emberjs · Apr 28, 2016 · f699952 · f699952
2 parents e319cc0 + 29a5fa9
commit f699952
Show file tree

Hide file tree

Showing 10 changed files with 1,309 additions and 1,384 deletions.
diff --git a/FEATURES.md b/FEATURES.md
@@ -29,10 +29,6 @@ entry in `config/features.json`.
   `methodForRequest`, `urlForRequest`, `headersForRequest` and `bodyForRequest`
   in the `DS.RESTAdapter`.
 
-- `ds-references`
-
-  Adds references as described in [RFC 57](https://github.com/emberjs/rfcs/pull/57)
-
 - `ds-transform-pass-options`
 
   Pass options specified for a `DS.attr` to the `DS.Tranform`'s `serialize` and

diff --git a/addon/-private/system/model/internal-model.js b/addon/-private/system/model/internal-model.js
@@ -4,7 +4,6 @@ import RootState from "ember-data/-private/system/model/states";
 import Relationships from "ember-data/-private/system/relationships/state/create";
 import Snapshot from "ember-data/-private/system/snapshot";
 import EmptyObject from "ember-data/-private/system/empty-object";
-import isEnabled from "ember-data/-private/features";
 
 import {
   getOwner
@@ -831,12 +830,9 @@ InternalModel.prototype = {
     } else {
       return `<${this.modelName}:${this.id}>`;
     }
-  }
-};
-
-if (isEnabled('ds-references')) {
+  },
 
-  InternalModel.prototype.referenceFor = function(type, name) {
+  referenceFor(type, name) {
     var reference = this.references[name];
 
     if (!reference) {
@@ -852,6 +848,5 @@ if (isEnabled('ds-references')) {
     }
 
     return reference;
-  };
-
-}
+  }
+};
diff --git a/addon/-private/system/model/model.js b/addon/-private/system/model/model.js
@@ -2,7 +2,6 @@ import Ember from 'ember';
 import { assert, deprecate } from "ember-data/-private/debug";
 import { PromiseObject } from "ember-data/-private/system/promise-proxies";
 import Errors from "ember-data/-private/system/model/errors";
-import isEnabled from 'ember-data/-private/features';
 import DebuggerInfoMixin from 'ember-data/-private/system/debug/debug-info';
 import { BelongsToMixin } from 'ember-data/-private/system/relationships/belongs-to';
 import { HasManyMixin } from 'ember-data/-private/system/relationships/has-many';
@@ -784,12 +783,123 @@ var Model = Ember.Object.extend(Ember.Evented, {
     assert("The `attr` method is not available on DS.Model, a DS.Snapshot was probably expected. Are you passing a DS.Model instead of a DS.Snapshot to your serializer?", false);
   },
 
-  belongsTo() {
-    assert("The `belongsTo` method is not available on DS.Model, a DS.Snapshot was probably expected. Are you passing a DS.Model instead of a DS.Snapshot to your serializer?", false);
+  /**
+    Get the reference for the specified belongsTo relationship.
+
+    Example
+
+    ```javascript
+    // models/blog.js
+    export default DS.Model.extend({
+      user: DS.belongsTo({ async: true })
+    });
+
+    var blog = store.push({
+      type: 'blog',
+      id: 1,
+      relationships: {
+        user: { type: 'user', id: 1 }
+      }
+    });
+    var userRef = blog.belongsTo('user');
+
+    // check if the user relationship is loaded
+    var isLoaded = userRef.value() !== null;
+
+    // get the record of the reference (null if not yet available)
+    var user = userRef.value();
+
+    // get the identifier of the reference
+    if (userRef.remoteType() === "id") {
+      var id = userRef.id();
+    } else if (userRef.remoteType() === "link") {
+      var link = userRef.link();
+    }
+
+    // load user (via store.findRecord or store.findBelongsTo)
+    userRef.load().then(...)
+
+    // or trigger a reload
+    userRef.reload().then(...)
+
+    // provide data for reference
+    userRef.push({
+      type: 'user',
+      id: 1,
+      attributes: {
+        username: "@user"
+      }
+    }).then(function(user) {
+      userRef.value() === user;
+    });
+    ```
+
+    @method belongsTo
+    @param {String} name of the relationship
+    @since 2.5.0
+    @return {BelongsToReference} reference for this relationship
+  */
+  belongsTo: function(name) {
+    return this._internalModel.referenceFor('belongsTo', name);
   },
 
-  hasMany() {
-    assert("The `hasMany` method is not available on DS.Model, a DS.Snapshot was probably expected. Are you passing a DS.Model instead of a DS.Snapshot to your serializer?", false);
+  /**
+    Get the reference for the specified hasMany relationship.
+
+    Example
+
+    ```javascript
+    // models/blog.js
+    export default DS.Model.extend({
+      comments: DS.hasMany({ async: true })
+    });
+
+    var blog = store.push({
+      type: 'blog',
+      id: 1,
+      relationships: {
+        comments: {
+          data: [
+            { type: 'comment', id: 1 },
+            { type: 'comment', id: 2 }
+          ]
+        }
+      }
+    });
+    var commentsRef = blog.hasMany('comments');
+
+    // check if the comments are loaded already
+    var isLoaded = commentsRef.value() !== null;
+
+    // get the records of the reference (null if not yet available)
+    var comments = commentsRef.value();
+
+    // get the identifier of the reference
+    if (commentsRef.remoteType() === "ids") {
+      var ids = commentsRef.ids();
+    } else if (commentsRef.remoteType() === "link") {
+      var link = commentsRef.link();
+    }
+
+    // load comments (via store.findMany or store.findHasMany)
+    commentsRef.load().then(...)
+
+    // or trigger a reload
+    commentsRef.reload().then(...)
+
+    // provide data for reference
+    commentsRef.push([{ type: 'comment', id: 1 }, { type: 'comment', id: 2 }]).then(function(comments) {
+      commentsRef.value() === comments;
+    });
+    ```
+
+    @method hasMany
+    @param {String} name of the relationship
+    @since 2.5.0
+    @return {HasManyReference} reference for this relationship
+  */
+  hasMany: function(name) {
+    return this._internalModel.referenceFor('hasMany', name);
   },
 
   setId: Ember.observer('id', function () {
@@ -872,130 +982,6 @@ if (Ember.setOwner) {
   });
 }
 
-if (isEnabled("ds-references")) {
-
-  Model.reopen({
-
-    /**
-      Get the reference for the specified belongsTo relationship.
-
-      Example
-
-      ```javascript
-      // models/blog.js
-      export default DS.Model.extend({
-        user: DS.belongsTo({ async: true })
-      });
-
-      var blog = store.push({
-        type: 'blog',
-        id: 1,
-        relationships: {
-          user: { type: 'user', id: 1 }
-        }
-      });
-      var userRef = blog.belongsTo('user');
-
-      // check if the user relationship is loaded
-      var isLoaded = userRef.value() !== null;
-
-      // get the record of the reference (null if not yet available)
-      var user = userRef.value();
-
-      // get the identifier of the reference
-      if (userRef.remoteType() === "id") {
-        var id = userRef.id();
-      } else if (userRef.remoteType() === "link") {
-        var link = userRef.link();
-      }
-
-      // load user (via store.findRecord or store.findBelongsTo)
-      userRef.load().then(...)
-
-      // or trigger a reload
-      userRef.reload().then(...)
-
-      // provide data for reference
-      userRef.push({
-        type: 'user',
-        id: 1,
-        attributes: {
-          username: "@user"
-        }
-      }).then(function(user) {
-        userRef.value() === user;
-      });
-      ```
-
-      @method belongsTo
-      @param {String} name of the relationship
-      @return {BelongsToReference} reference for this relationship
-    */
-    belongsTo: function(name) {
-      return this._internalModel.referenceFor('belongsTo', name);
-    },
-
-    /**
-      Get the reference for the specified hasMany relationship.
-
-      Example
-
-      ```javascript
-      // models/blog.js
-      export default DS.Model.extend({
-        comments: DS.hasMany({ async: true })
-      });
-
-      var blog = store.push({
-        type: 'blog',
-        id: 1,
-        relationships: {
-          comments: {
-            data: [
-              { type: 'comment', id: 1 },
-              { type: 'comment', id: 2 }
-            ]
-          }
-        }
-      });
-      var commentsRef = blog.hasMany('comments');
-
-      // check if the comments are loaded already
-      var isLoaded = commentsRef.value() !== null;
-
-      // get the records of the reference (null if not yet available)
-      var comments = commentsRef.value();
-
-      // get the identifier of the reference
-      if (commentsRef.remoteType() === "ids") {
-        var ids = commentsRef.ids();
-      } else if (commentsRef.remoteType() === "link") {
-        var link = commentsRef.link();
-      }
-
-      // load comments (via store.findMany or store.findHasMany)
-      commentsRef.load().then(...)
-
-      // or trigger a reload
-      commentsRef.reload().then(...)
-
-      // provide data for reference
-      commentsRef.push([{ type: 'comment', id: 1 }, { type: 'comment', id: 2 }]).then(function(comments) {
-        commentsRef.value() === comments;
-      });
-      ```
-
-      @method hasMany
-      @param {String} name of the relationship
-      @return {HasManyReference} reference for this relationship
-    */
-    hasMany: function(name) {
-      return this._internalModel.referenceFor('hasMany', name);
-    }
-  });
-
-}
-
 Model.reopenClass(RelationshipsClassMethodsMixin);
 Model.reopenClass(AttrClassMethodsMixin);