Merge pull request #20 from MehulKChaudhari/add/model-schemaRecord-comparison

Add model definition comparing EmberData models with SchemaRecord

Author: jaredgalanis

app/routes/application.js

@@ -86,6 +86,16 @@ export default class ApplicationRoute extends Route {
           },
         ],
       },
+      {
+        id: 'models',
+        subsections: [
+          {
+            id: 'model-definition',
+            classicFiles: ['old.js'],
+            octaneFiles: ['new.js'],
+          },
+        ],
+      },
     ];
   }
 }

snippets/models/model-definition/new.js

@@ -0,0 +1,70 @@
+import { withDefaults } from '@warp-drive/schema-record';
+
+// Register schemas for all resources at once
+store.schema.registerResources([
+  // User schema
+  withDefaults({
+    type: 'user',
+    fields: [
+      { kind: 'field', name: 'firstName' },
+      { kind: 'field', name: 'lastName' },
+      {
+        kind: 'derived',
+        name: 'name',
+        type: 'concat',
+        options: { fields: ['firstName', 'lastName'], separator: ' ' }
+      },
+      {
+        kind: 'hasMany',
+        name: 'pets',
+        type: 'pet',
+        options: {
+          async: false,
+          inverse: 'owner',
+          polymorphic: true,
+          linksMode: true,
+          resetOnRemoteUpdate: false,
+        }
+      }
+    ]
+  }),
+
+  // Pet schema
+  withDefaults({
+    type: 'pet',
+    fields: [
+      { kind: 'field', name: 'name' },
+      {
+        kind: 'belongsTo',
+        name: 'owner',
+        type: 'user',
+        options: {
+          async: false,
+          inverse: 'pets',
+          linksMode: true,
+          resetOnRemoteUpdate: false,
+        }
+      }
+    ]
+  }),
+
+  // Dog schema (extends pet)
+  withDefaults({
+    type: 'dog',
+    fields: [
+      { kind: 'field', name: 'breed' },
+      {
+        kind: 'belongsTo',
+        name: 'owner',
+        type: 'user',
+        options: {
+          async: false,
+          inverse: 'pets',
+          as: 'pet',
+          linksMode: true,
+          resetOnRemoteUpdate: false,
+        }
+      }
+    ]
+  })
+]);

snippets/models/model-definition/old.js

@@ -0,0 +1,23 @@
+// Traditional EmberData Model Definition
+import Model, { attr, hasMany, belongsTo } from '@ember-data/model';
+
+export default class UserModel extends Model {
+  @attr('string') firstName;
+  @attr('string') lastName;
+  @hasMany('pet', { polymorphic: true, inverse: 'owner' }) pets;
+
+  get name() {
+    return `${this.firstName} ${this.lastName}`;
+  }
+}
+
+// Related models would be defined in separate files:
+
+// export default class PetModel extends Model {
+//   @attr('string') name;
+//   @belongsTo('user', { inverse: 'pets' }) owner;
+// }
+
+// export default class DogModel extends PetModel {
+//   @attr('string') breed;
+// }

translations/models/en-us.yaml

@@ -0,0 +1,2 @@
+title: Models
+description: See how traditional EmberData models compare to the new SchemaRecord approach. 

translations/models/model-definition/en-us.yaml

@@ -0,0 +1,2 @@
+title: Model Definition
+description: See how to define resources using the traditional EmberData models and the new SchemaRecord approach.