Skip to content

Relationships with classes #224

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
spruce wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Relationships with classes #224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7115fa9
Add Failing Tests
spruce Jan 26, 2020
120d221
Add fix for compound relationships
spruce Jan 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion lib/serializer-utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
'use strict';
var isPlainObject = require('lodash/isPlainObject');
var isObjectLike = require('lodash/isObjectLike');
var isFunction = require('lodash/isFunction');
var _find = require('lodash/find');
var _merge = require('lodash/merge');
Expand All @@ -16,7 +17,7 @@ var Inflector = require('./inflector');

module.exports = function (collectionName, record, payload, opts) {
function isComplexType(obj) {
return Array.isArray(obj) || isPlainObject(obj);
return Array.isArray(obj) || isObjectLike(obj);
}

function keyForAttribute(attribute) {
Expand Down
218 changes: 218 additions & 0 deletions test/serializer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1152,6 +1152,96 @@ describe('JSON API Serializer', function () {
}
});

done(null, json);
});
it('should be set into the `data.relationships` and `included` for Classes as well', function (done) {
class Author{
constructor(id, firstName, lastName){
this.id = id;
this.firstName = firstName;
this.lastName = lastName;
}
}
let vance = new Author('2934f384bb824a7cb7b238b8dc194a22', 'Ashlee', 'Vance');
let isaacson = new Author('5ed95269a8334d8a970a2bd9fa599288', 'Walter', 'Isaacson');
var dataSet = [{
id: '54735750e16638ba1eee59cb',
firstName: 'Sandro',
lastName: 'Munda',
books: [{
id: '52735730e16632ba1eee62dd',
title: 'Tesla, SpaceX, and the Quest for a Fantastic Future',
isbn: '978-0062301239',
author: vance
}, {
id: '52735780e16610ba1eee15cd',
title: 'Steve Jobs',
isbn: '978-1451648546',
author: isaacson
}]
}];

var json = new JSONAPISerializer('users', {
attributes: ['firstName', 'lastName', 'books'],
books: {
ref: 'id',
attributes: ['title', 'isbn', 'author'],
author: {
ref: 'id',
attributes: ['firstName', 'lastName']
}
}
}).serialize(dataSet);

expect(json.included).to.include({
type: 'books',
id: '52735730e16632ba1eee62dd',
attributes: {
title: 'Tesla, SpaceX, and the Quest for a Fantastic Future',
isbn: '978-0062301239'
},
relationships: {
author: {
data: { id: '2934f384bb824a7cb7b238b8dc194a22', type: 'authors' }
}
}
});

expect(json.included).to.include({
type: 'books',
id: '52735780e16610ba1eee15cd',
attributes: {
title: 'Steve Jobs',
isbn: '978-1451648546'
},
relationships: {
author: {
data: {
id: '5ed95269a8334d8a970a2bd9fa599288',
type: 'authors'
}
}
}
});

expect(json.included).to.include({
id: '2934f384bb824a7cb7b238b8dc194a22',
type: 'authors',
attributes: {
'first-name': 'Ashlee',
'last-name': 'Vance'
}
});

expect(json.included).to.include({
id: '5ed95269a8334d8a970a2bd9fa599288',
type: 'authors',
attributes: {
'first-name': 'Walter',
'last-name': 'Isaacson'
}
});

done(null, json);
});
});
Expand Down Expand Up @@ -1225,6 +1315,77 @@ describe('JSON API Serializer', function () {
}
});

done(null, json);
});
it('should be set into the `data.relationships` and `included for Classes as well`', function (done) {
class Author{
constructor(id, firstName, lastName){
this.id = id;
this.firstName = firstName;
this.lastName = lastName;
}
}
let vance = new Author('2934f384bb824a7cb7b238b8dc194a22', 'Ashlee', 'Vance');
let isaacson = new Author('5ed95269a8334d8a970a2bd9fa599288', 'Walter', 'Isaacson');
var dataSet = [{
id: '54735750e16638ba1eee59cb',
firstName: 'Sandro',
lastName: 'Munda',
books: [{
id: '52735730e16632ba1eee62dd',
title: 'Tesla, SpaceX, and the Quest for a Fantastic Future',
isbn: '978-0062301239',
authors: [vance, isaacson]
}]
}];

var json = new JSONAPISerializer('users', {
attributes: ['firstName', 'lastName', 'books'],
books: {
ref: 'id',
attributes: ['title', 'isbn', 'authors'],
authors: {
ref: 'id',
attributes: ['firstName', 'lastName']
}
}
}).serialize(dataSet);

expect(json.included).to.include({
type: 'books',
id: '52735730e16632ba1eee62dd',
attributes: {
title: 'Tesla, SpaceX, and the Quest for a Fantastic Future',
isbn: '978-0062301239'
},
relationships: {
authors: {
data: [
{ id: '2934f384bb824a7cb7b238b8dc194a22', type: 'authors' },
{ id: '5ed95269a8334d8a970a2bd9fa599288', type: 'authors' },
]
}
}
});

expect(json.included).to.include({
id: '2934f384bb824a7cb7b238b8dc194a22',
type: 'authors',
attributes: {
'first-name': 'Ashlee',
'last-name': 'Vance'
}
});

expect(json.included).to.include({
id: '5ed95269a8334d8a970a2bd9fa599288',
type: 'authors',
attributes: {
'first-name': 'Walter',
'last-name': 'Isaacson'
}
});

done(null, json);
});
});
Expand Down Expand Up @@ -1282,6 +1443,63 @@ describe('JSON API Serializer', function () {
attributes: { 'first-name': 'Lawrence', 'last-name': 'Bennett' }
});

done(null, json);
});
it('should be set into the `data.relationships` and `included for Classes as well`', function (done) {
class Neighbour{
constructor(id, firstName, lastName){
this.id = id;
this.firstName = firstName;
this.lastName = lastName;
}
}
let bennett = new Neighbour('5490143e69e49d0c8f9fc6bc', 'Lawrence', 'Bennett');
var dataSet = [{
id: '54735750e16638ba1eee59cb',
firstName: 'Sandro',
lastName: 'Munda',
address: {
id: '5cd95269a8334d8a970a2bd9fa599278',
addressLine1: '406 Madison Court',
zipCode: '49426',
country: 'USA',
neighbours: [bennett]
}
}];

var json = new JSONAPISerializer('users', {
attributes: ['firstName', 'lastName', 'address'],
address: {
ref: 'id',
attributes: ['addressLine1', 'zipCode', 'country', 'neighbours'],
neighbours: {
ref: 'id',
attributes: ['firstName', 'lastName'],
}
}
}).serialize(dataSet);

expect(json.included).to.include({
id: '5cd95269a8334d8a970a2bd9fa599278',
type: 'addresses',
attributes: {
'address-line1': '406 Madison Court',
'zip-code': '49426',
country: 'USA'
},
relationships: {
neighbours: {
data: [{ type: 'neighbours', id: '5490143e69e49d0c8f9fc6bc' }]
}
}
});

expect(json.included).to.include({
type: 'neighbours',
id: '5490143e69e49d0c8f9fc6bc',
attributes: { 'first-name': 'Lawrence', 'last-name': 'Bennett' }
});

done(null, json);
});
});
Expand Down