fix: deserializing with unconvertCase option (#90)

closes #90

Author: max-konin

lib/JSONAPISerializer.js

@@ -418,9 +418,9 @@ module.exports = class JSONAPISerializer {
         const deserializeFunction = relationshipData => {
           if (
             options.relationships[relationshipKey] &&
-            options.relationships[relationshipProperty].deserialize
+            options.relationships[relationshipKey].deserialize
           ) {
-            return options.relationships[relationshipProperty].deserialize(relationshipData);
+            return options.relationships[relationshipKey].deserialize(relationshipData);
           }
           return relationshipData.id;
         };
@@ -435,7 +435,7 @@ module.exports = class JSONAPISerializer {
                   ? this.deserializeIncluded(
                       d.type,
                       d.id,
-                      options.relationships[relationshipProperty],
+                      options.relationships[relationshipKey],
                       included
                     )
                   : deserializeFunction(d)
@@ -452,7 +452,7 @@ module.exports = class JSONAPISerializer {
                 ? this.deserializeIncluded(
                     relationship.data.type,
                     relationship.data.id,
-                    options.relationships[relationshipProperty],
+                    options.relationships[relationshipKey],
                     included
                   )
                 : deserializeFunction(relationship.data)

test/unit/JSONAPISerializer.test.js

@@ -400,7 +400,7 @@ describe('JSONAPISerializer', function() {
       done();
     });
 
-    
+
     it('should return serialized relationship with unpopulated relationship with mongoDB BSON ObjectID', function(done) {
       const serializedRelationshipData = Serializer.serializeRelationship('authors', 'default', new ObjectID());
       expect(serializedRelationshipData).to.have.property('type').to.eql('authors');
@@ -430,7 +430,7 @@ describe('JSONAPISerializer', function() {
         name: 'Author 1',
         gender: 'male'
       }, included);
-      
+
       included = [...included.values()];
       expect(serializedRelationshipData).to.have.property('type').to.eql('authors');
       expect(serializedRelationshipData).to.have.property('id').to.eql('1');
@@ -497,7 +497,7 @@ describe('JSONAPISerializer', function() {
           this.id = id;
           this.name = name;
         }
-      } 
+      }
 
       const data = new Author({
         id: '1',
@@ -513,7 +513,7 @@ describe('JSONAPISerializer', function() {
           attributes: { name: 'Kaley Maggio' },
           relationships: undefined,
           meta: undefined,
-          links: undefined 
+          links: undefined
         }]);
       done();
     });
@@ -1533,8 +1533,57 @@ describe('JSONAPISerializer', function() {
 
     it('should deserialize with \'unconvertCase\' options', function(done) {
       const Serializer = new JSONAPISerializer();
-      Serializer.register('articles', {
-        unconvertCase: 'snake_case'
+      Serializer.register('article', {
+        unconvertCase: 'snake_case',
+        relationships: {
+          article_author: {
+            type: 'people',
+          },
+        }
+      });
+      Serializer.register('people', {
+        unconvertCase: 'snake_case',
+      });
+
+      const data = {
+        data: {
+          type: 'article',
+          id: '1',
+          attributes: {
+            createdAt: '2015-05-22T14:56:29.000Z'
+          },
+          relationships: {
+            articleAuthor: {
+              data: {
+                type: 'people',
+                id: '1'
+              }
+            }
+          }
+        },
+        included: [{
+          type: 'people',
+          id: '1',
+          attributes: { firstName: 'Karl' }
+        }]
+      };
+
+      const deserializedData = Serializer.deserialize('article', data);
+      expect(deserializedData).to.have.property('created_at');
+      expect(deserializedData.article_author).to.deep.equal({ id: '1', first_name: 'Karl' });
+      done();
+    });
+
+    it('should deserialize with \'unconvertCase\' and \'deserialize\' options', function(done) {
+      const Serializer = new JSONAPISerializer();
+      Serializer.register('article', {
+        unconvertCase: 'snake_case',
+        relationships: {
+          article_author: {
+            deserialize: data => ({ id: data.id, additionalProperty: `${data.type}-${data.id}` }),
+            type: 'people',
+          },
+        }
       });
 
       const data = {
@@ -1555,12 +1604,12 @@ describe('JSONAPISerializer', function() {
         }
       };
 
-      const deserializedData = Serializer.deserialize('articles', data);
+      const deserializedData = Serializer.deserialize('article', data);
       expect(deserializedData).to.have.property('created_at');
-      expect(deserializedData).to.have.property('article_author');
+      expect(deserializedData.article_author).to.deep.equal({ id: '1', additional_property: 'people-1' });
       done();
     });
-    
+
     it('should deserialize with \'unconvertCase\' options with \'alternative_key\' relationship', function(done) {
       const Serializer = new JSONAPISerializer();
       Serializer.register('articles', {
@@ -1572,7 +1621,7 @@ describe('JSONAPISerializer', function() {
           },
         }
       });
-    
+
       const data = {
         data: {
           type: 'article',
@@ -1590,7 +1639,7 @@ describe('JSONAPISerializer', function() {
           }
         }
       };
-    
+
       const deserializedData = Serializer.deserialize('articles', data);
       expect(deserializedData).to.have.property('created_at');
       expect(deserializedData).to.have.property('article_author_id');
@@ -1731,7 +1780,7 @@ describe('JSONAPISerializer', function() {
     it('should deserialize with a custom schema', function(done) {
       const Serializer = new JSONAPISerializer();
       Serializer.register('articles', 'custom');
-    
+
       const data = {
         data: {
           type: 'article',
@@ -1741,7 +1790,7 @@ describe('JSONAPISerializer', function() {
           }
         }
       };
-    
+
       const deserializedData = Serializer.deserialize('articles', data, 'custom');
       expect(deserializedData).to.have.property('createdAt');
       done();
@@ -1855,7 +1904,7 @@ describe('JSONAPISerializer', function() {
     it('should deserialize with a custom schema', function(done) {
       const Serializer = new JSONAPISerializer();
       Serializer.register('articles', 'custom');
-    
+
       const data = {
         data: {
           type: 'article',
@@ -1865,7 +1914,7 @@ describe('JSONAPISerializer', function() {
           }
         }
       };
-    
+
       Serializer.deserializeAsync('articles', data, 'custom').then((deserializedData) => {
         expect(deserializedData).to.have.property('createdAt');
         done();
@@ -2026,7 +2075,7 @@ describe('JSONAPISerializer', function() {
       expect(serializedError.errors[0]).to.have.property('status').to.eql('500');
       expect(serializedError.errors[0]).to.have.property('code').to.eql('ERROR');
       expect(serializedError.errors[0]).to.have.property('detail').to.eql('An error occured');
-      
+
       done();
     });
 
@@ -2038,7 +2087,7 @@ describe('JSONAPISerializer', function() {
       expect(serializedErrors).to.have.property('errors').to.be.instanceof(Array).to.have.lengthOf(2);
       expect(serializedErrors.errors[0]).to.have.property('detail').to.eql('First Error');
       expect(serializedErrors.errors[1]).to.have.property('detail').to.eql('Second Error');
-      
+
       done();
     });
 
@@ -2048,7 +2097,7 @@ describe('JSONAPISerializer', function() {
       expect(function() {
         Serializer.serializeError(jsonapiError);
       }).to.throw(Error, 'error must be an object');
-      
+
       done();
     });
 
@@ -2080,7 +2129,7 @@ describe('JSONAPISerializer', function() {
       expect(function() {
         Serializer.serializeError(jsonapiError3);
       }).to.throw(Error, 'error \'source.parameter\' property must be a string');
-      
+
       done();
     });
 
@@ -2120,11 +2169,11 @@ describe('JSONAPISerializer', function() {
       expect(function() {
         Serializer.serializeError(jsonapiErrorBadLink3);
       }).to.throw(Error, '\'links.self.meta\' property must be an object');
-      
+
       expect(function() {
         Serializer.serializeError(jsonapiErrorBadLink4);
       }).to.throw(Error, 'error \'links.self\' must be a string or an object');
-      
+
       done();
     });
 
@@ -2148,7 +2197,7 @@ describe('JSONAPISerializer', function() {
 
       expect(serializedError).to.have.property('errors').to.be.instanceof(Array).to.have.lengthOf(1);
       expect(serializedError.errors[0]).to.deep.eql(jsonapiError);
-      
+
       done();
     });
 
@@ -2179,7 +2228,7 @@ describe('JSONAPISerializer', function() {
         title: 'Second Error',
         detail: 'Second Error'
       }]);
-      
+
       done();
     });
   })
@@ -2200,7 +2249,7 @@ describe('JSONAPISerializer', function() {
       }],
       'kebab-case'
     );
-    
+
     expect(converted).to.deep.equal([{
       'array-of-object': [{ 'first-property': 'test', 'second-property': null, 'third-property': 0 }],
       'array-of-number': [1, 2, 3, 4, 5]
@@ -2223,7 +2272,7 @@ describe('JSONAPISerializer', function() {
       },
       'kebab-case'
     );
-      
+
     expect(converted['array-of-object']).to.deep.equal([{ 'first-property': 'test', 'second-property': null, 'third-property': 0 }]);
     expect(converted['array-of-number']).to.deep.equal([1, 2, 3, 4, 5]);
     expect(converted.date).to.be.a('Date');