Merge pull request #125 from JoaoPedroAS51/feat/instance-nested-objects

feat(model): apply instances of relationships to nested objects

Author: robsontenorio

README.md

@@ -517,6 +517,90 @@ await this.posts.comments().attach(payload)
 await this.posts.comments().sync(payload) 
 ```
 
+You can also apply a model instance to a nested object by setting the key and the model in `relations` method.
+
+If the backend responds with:
+
+```js
+// response from API for /posts/1
+{
+  title: 'My title'
+  body: 'Some text here',
+  user: {
+    firstName: 'John',
+    lastName: 'Doe'
+  }
+}
+```
+
+We just need to set `user` to User model:
+
+
+**/models/Post.js**
+```js
+class Post extends Model {
+  relations () {
+    return {
+      // Apply User model to `user` object
+      user: User
+    }
+  }
+}
+```
+
+It also works for collections. So if the backend responds with:
+
+```js
+// response from API for /comments
+{
+  text: 'Some text here',
+  user: {
+    firstName: 'John',
+    lastName: 'Doe'
+  },
+  replies: [
+    {
+      text: 'A reply here',
+      user: {
+        firstName: 'Joe',
+        lastName: 'Doe'
+      }
+    },
+    {
+      text: 'Another reply here',
+      user: {
+        firstName: 'Mary',
+        lastName: 'Doe'
+      },
+      replies: [
+        {
+          text: 'Yes, this is the reply of the reply!',
+          user: {
+            firstName: 'Max',
+            lastName: 'Doe'
+          }
+        }
+      ]
+    }
+  ]
+}
+```
+
+Then we just need to set `user` to User model and `replies` to Comment model:
+
+**/models/Comment.js**
+```js
+class Comment extends Model {
+  relations () {
+    return {
+      // Apply User model to `user` object
+      user: User,
+      // Apply Comment model to each object of `replies` array
+      replies: Comment
+    }
+  }
+}
+```
 
 # Pagination
 

src/Model.js

@@ -10,6 +10,7 @@ export default class Model extends StaticModel {
       this._builder = new Builder(this)
     } else {
       Object.assign(this, ...attributes)
+      this._applyRelations(this)
     }
 
     if (this.baseURL === undefined) {
@@ -123,6 +124,10 @@ export default class Model extends StaticModel {
     return this
   }
 
+  relations () {
+    return {}
+  }
+
   /**
    * Helpers
    */
@@ -226,6 +231,48 @@ export default class Model extends StaticModel {
    * Result
    */
 
+  _applyInstance(data, model = this.constructor) {
+    const item = new model(data)
+
+    if(this._fromResource) {
+      item._from(this._fromResource)
+    }
+
+    return item
+  }
+
+  _applyInstanceCollection(data, model = this.constructor) {
+    let collection = data.data || data
+    collection = Array.isArray(collection) ? collection : [collection]
+
+    collection = collection.map(c => {
+      return this._applyInstance(c, model)
+    })
+    return collection
+  }
+
+  _applyRelations(model) {
+    const relations = model.relations()
+
+    for(const relation of Object.keys(relations)) {
+      if (!model[relation]) {
+        return;
+      }
+
+      if (Array.isArray(model[relation].data) || Array.isArray(model[relation])) {
+        const collection = this._applyInstanceCollection(model[relation], relations[relation])
+
+        if (model[relation].data !== undefined) {
+          model[relation].data = collection
+        } else {
+          model[relation] = collection
+        }
+      } else {
+        model[relation] = this._applyInstance(model[relation], relations[relation])
+      }
+    }
+  }
+
   first() {
     return this.get().then(response => {
       let item
@@ -257,13 +304,7 @@ export default class Model extends StaticModel {
       url,
       method: 'GET'
     }).then(response => {
-      const item = new this.constructor(response.data)
-
-      if (this._fromResource) {
-        item._from(this._fromResource)
-      }
-
-      return item
+      return this._applyInstance(response.data)
     })
   }
 
@@ -274,7 +315,7 @@ export default class Model extends StaticModel {
 
     return this
       .find(identifier)
-      .then(response => new this.constructor(response.data || response))
+      .then(response => this._applyInstance(response.data || response))
   }
 
   get() {
@@ -286,18 +327,7 @@ export default class Model extends StaticModel {
       url,
       method: 'GET'
     }).then(response => {
-      let collection = response.data.data || response.data
-      collection = Array.isArray(collection) ? collection : [collection]
-
-      collection = collection.map(c => {
-        let item = new this.constructor(c)
-
-        if (this._fromResource) {
-          item._from(this._fromResource)
-        }
-
-        return item
-      })
+      let collection = this._applyInstanceCollection(response.data)
 
       if (response.data.data !== undefined) {
         response.data.data = collection
@@ -340,8 +370,7 @@ export default class Model extends StaticModel {
       url: this.endpoint(),
       data: this
     }).then(response => {
-      let self = Object.assign(this, response.data)
-      return self
+      return this._applyInstance(response.data)
     })
   }
 
@@ -351,8 +380,7 @@ export default class Model extends StaticModel {
       url: this.endpoint(),
       data: this
     }).then(response => {
-      let self = Object.assign(this, response.data)
-      return self
+      return this._applyInstance(response.data)
     })
   }
 
@@ -375,5 +403,4 @@ export default class Model extends StaticModel {
       data: params
     }).then(response => response)
   }
-
 }

tests/dummy/data/comments.js

@@ -3,12 +3,34 @@ export const Comments = [
     id: 1,
     post_id: 1,
     someId: 'ma018-9ha12',
-    text: 'Hello'
+    text: 'Hello',
+    replies: [
+      {
+        id: 3,
+        comment_id: 1,
+        someId: 'ma020-9ha15',
+        text: 'Hello',
+      }
+    ]
   },
   {
     id: 2,
     post_id: 1,
     someId: 'mw012-7ha19',
-    text: 'How are you?'
+    text: 'How are you?',
+    replies: [
+      {
+        id: 4,
+        comment_id: 2,
+        someId: 'mw023-9ha18',
+        text: 'Hello',
+      },
+      {
+        id: 5,
+        comment_id: 2,
+        someId: 'mw035-0ha22',
+        text: 'Hello',
+      }
+    ]
   }
-]
+]

tests/dummy/data/commentsEmbed.js

@@ -0,0 +1,42 @@
+export const Comments = {
+  data: [
+    {
+      id: 1,
+      post_id: 1,
+      someId: 'ma018-9ha12',
+      text: 'Hello',
+      replies: {
+        data: [
+          {
+            id: 3,
+            comment_id: 1,
+            someId: 'ma020-9ha15',
+            text: 'Hello',
+          }
+        ]
+      }
+    },
+    {
+      id: 2,
+      post_id: 1,
+      someId: 'mw012-7ha19',
+      text: 'How are you?',
+      replies: {
+        data: [
+          {
+            id: 4,
+            comment_id: 2,
+            someId: 'mw023-9ha18',
+            text: 'Hello',
+          },
+          {
+            id: 5,
+            comment_id: 2,
+            someId: 'mw035-0ha22',
+            text: 'Hello',
+          }
+        ]
+      }
+    }
+  ]
+}

tests/dummy/data/post.js

@@ -2,7 +2,10 @@ export const Post =
   {
     id: 1,
     someId: 'af621-4aa41',
-    firstname: 'John',
-    lastname: 'Doe',
-    age: 25
-  }
+    text: 'Lorem Ipsum Dolor',
+    user: {
+      firstname: 'John',
+      lastname: 'Doe',
+      age: 25
+    }
+  }

tests/dummy/data/postEmbed.js

@@ -2,8 +2,11 @@ export const Post = {
   data: {
     id: 1,
     someId: 'af621-4aa41',
-    firstname: 'John',
-    lastname: 'Doe',
-    age: 25
+    text: 'Lorem Ipsum Dolor',
+    user: {
+      firstname: 'John',
+      lastname: 'Doe',
+      age: 25
+    }
   }
 }

tests/dummy/data/posts.js

@@ -2,15 +2,21 @@ export const Posts = [
   {
     id: 1,
     someId: 'du761-8bc98',
-    firstname: 'John',
-    lastname: 'Doe',
-    age: 25
+    text: 'Lorem Ipsum Dolor',
+    user: {
+      firstname: 'John',
+      lastname: 'Doe',
+      age: 25
+    }
   },
   {
     id: 1,
     someId: 'pa813-7jx02',
-    firstname: 'Mary',
-    lastname: 'Doe',
-    age: 25
+    text: 'Lorem Ipsum Dolor',
+    user: {
+      firstname: 'Mary',
+      lastname: 'Doe',
+      age: 25
+    }
   }
-]
+]