serializer_spec.rb in jsonapi-serializers-0.6.1

- old
+ new

@@ -529,27 +529,27 @@
       post = create(:post, :with_author, long_comments: long_comments)
       # Make sure each long-comment has a circular reference back to the post.
       long_comments.each { |c| c.post = post }
 
       expected_data = {
-        # Note that in this case the primary data does not include linkage for 'long-comments',
-        # forcing clients to still have to request linkage from long-comments and post. This is an
-        # odd but valid data state because the user requested to only include the leaf author node,
-        # and we only automatically expose direct children linkages if they match given includes.
-        #
-        # Spec: Resource linkage in a compound document allows a client to link together
-        # all of the included resource objects without having to GET any relationship URLs.
-        # http://jsonapi.org/format/#document-structure-resource-relationships
-        #
-        # Also, spec: A request for comments.author should not automatically also include
-        # comments in the response. This can happen if the client already has the comments locally,
-        # and now wants to fetch the associated authors without fetching the comments again.
-        # http://jsonapi.org/format/#fetching-includes
         'data' => serialize_primary(post, {serializer: MyApp::PostSerializer}),
         'included' => [
-          # Only the author is included:
-          serialize_primary(post.author, {serializer: MyAppOtherNamespace::UserSerializer}),
+          # Intermediates are included: long-comments, long-comments.post, and long-comments.post.author
+          #  http://jsonapi.org/format/#document-structure-compound-documents
+          serialize_primary(post.long_comments.first, {
+            serializer: MyApp::LongCommentSerializer,
+            include_linkages: ['post']
+          }),
+          serialize_primary(post.long_comments.last, {
+            serializer: MyApp::LongCommentSerializer,
+            include_linkages: ['post']
+          }),
+          serialize_primary(post, {
+            serializer: MyApp::PostSerializer,
+            include_linkages: ['author', 'post.long-comments', ]
+          }),
+          serialize_primary(post.author, {serializer: MyAppOtherNamespace::UserSerializer})
         ],
       }
       includes = ['long-comments.post.author']
       actual_data = JSONAPI::Serializer.serialize(post, include: includes)
       # Multiple expectations for better diff output for debugging.
@@ -566,17 +566,25 @@
       post = create(:post, :with_author, long_comments: long_comments)
       # Make sure each long-comment has a circular reference back to the post.
       long_comments.each { |c| c.post = post }
 
       expected_data = {
-        # Same note about primary data linkages as above.
         'data' => serialize_primary(post, {serializer: MyApp::PostSerializer}),
         'included' => [
+          serialize_primary(first_comment, {
+            serializer: MyApp::LongCommentSerializer,
+            include_linkages: ['user']
+          }),
+          serialize_primary(second_comment, {
+            serializer: MyApp::LongCommentSerializer,
+            include_linkages: ['user']
+          }),
           serialize_primary(first_user, {serializer: MyAppOtherNamespace::UserSerializer}),
           serialize_primary(second_user, {serializer: MyAppOtherNamespace::UserSerializer}),
         ],
       }
+
       includes = ['long-comments.user']
       actual_data = JSONAPI::Serializer.serialize(post, include: includes)
 
       # Multiple expectations for better diff output for debugging.
       expect(actual_data['data']).to eq(expected_data['data'])
@@ -623,12 +631,22 @@
         include_linkages: ['long-comments'],
       })
       expected_data = {
         'data' => expected_primary_data,
         'included' => [
-          serialize_primary(long_comments.first, {serializer: MyApp::LongCommentSerializer}),
-          serialize_primary(long_comments.last, {serializer: MyApp::LongCommentSerializer}),
+          serialize_primary(long_comments.first, {
+            serializer: MyApp::LongCommentSerializer,
+            include_linkages: ['post'],
+          }),
+          serialize_primary(long_comments.last, {
+            serializer: MyApp::LongCommentSerializer,
+            include_linkages: ['post'],
+          }),
+          serialize_primary(post, {
+            serializer: MyApp::PostSerializer,
+            include_linkages: ['author'],
+          }),
           serialize_primary(post.author, {serializer: MyAppOtherNamespace::UserSerializer}),
         ],
       }
       # Also test that it handles string include arguments.
       includes = 'long-comments, long-comments.post.author'
@@ -682,11 +700,11 @@
       })
     end
     it 'correctly handles multi-level relationship paths' do
       result = JSONAPI::Serializer.send(:parse_relationship_paths, ['foo.bar'])
       expect(result).to eq({
-        'foo' => {'bar' => {_include: true}}
+        'foo' => {_include: true, 'bar' => {_include: true}}
       })
     end
     it 'correctly handles multi-level relationship paths with same parent' do
       paths = ['foo', 'foo.bar']
       result = JSONAPI::Serializer.send(:parse_relationship_paths, paths)
@@ -711,10 +729,10 @@
     end
     it 'correctly handles three-leveled path with skipped middle' do
       paths = ['foo', 'foo.bar.baz']
       result = JSONAPI::Serializer.send(:parse_relationship_paths, paths)
       expect(result).to eq({
-        'foo' => {_include: true, 'bar' => {'baz' => {_include: true}}}
+        'foo' => {_include: true, 'bar' => {_include: true, 'baz' => {_include: true}}}
       })
     end
   end
   describe 'if/unless handling with contexts' do
     it 'can be used to show/hide attributes' do