jsonapi-serializers 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3b9ea3fd617b920688a8694e6d2a923c39de458
-  data.tar.gz: e5fd7307ab8acd411c31e96a4fab0f4e82b25a93
+  metadata.gz: d89dc4f009841a5431c7e79060da4208c2d7dde2
+  data.tar.gz: 1eb85ed60e4d91ba8f33ed28a8151ac3ff21cf71
 SHA512:
-  metadata.gz: 5c4ac246ad0366b5d3cdfb165a62982b79e3f9a36d2762fff3feb404f6ef3adfd1b22f2fe88e6651d421ecd52406a6c458d73c87fe29e66fb80c3a86e5a5847e
-  data.tar.gz: 4c7c6b9793a408ad4ca7cbc1bc504654817900a57ecb2cbaf190c900864c5a04391df1a983b0229cc0925d908a8ed49b69b98ff3684e7d3c07dcd225bc4eaaa5
+  metadata.gz: fa10630f9a9181a194e831cf538d65c7fcafa910ee7054e3838efbe30ef1775eb447b4f4eb84c4900d9fa4a99a539caf9df6d47f0e8db3299a0b4116ec0d9c08
+  data.tar.gz: c8d6f28e77762831850999491d2f05237ed0a4c2fd4215a09d88b7d8ccdefa2732955da77ebe1009bbc43cf6270e659ffb830f1544880c234783db0495c20767

data/README.md

@@ -543,12 +543,19 @@ end
 
 ## Sinatra example
 
-Using [Sequel ORM](http://sequel.jeremyevans.net) instead of ActiveRecord. The
-important things to note here are the `:tactical_eager_loading` plugin, which
-will greatly reduce the number of queries performed when sideloading related
-records, and the `:skip_collection_check` option that must be set to true in
-order for `JSONAPI::Serializer.serialize` to be able to serialize single
-Sequel::Model instances.
+Here's an example using [Sinatra](http://www.sinatrarb.com) and
+[Sequel ORM](http://sequel.jeremyevans.net) instead of Rails and ActiveRecord.
+The important takeaways here are that:
+
+1. The `:tactical_eager_loading` plugin will greatly reduce the number of
+   queries performed when sideloading associated records. You can add this
+   plugin to a single model (as demonstrated here), or globally to all models.
+   For more information, please see the Sequel
+   [documentation](http://sequel.jeremyevans.net/rdoc-plugins/classes/Sequel/Plugins/TacticalEagerLoading.html).
+1. The `:skip_collection_check` option must be set to true in order for
+   JSONAPI::Serializer to be able to serialize a single Sequel::Model instance.
+1. You should call `#all` on your Sequel::Dataset instances before passing them
+   to JSONAPI::Serializer to greatly reduce the number of queries performed.
 
 ```ruby
 require 'sequel'
@@ -575,15 +582,13 @@ class BaseSerializer
 end
 
 class PostSerializer < BaseSerializer
-  attribute :title
-  attribute :content
+  attributes :title, :content
 
   has_many :comments
 end
 
 class CommentSerializer < BaseSerializer
-  attribute :username
-  attribute :body
+  attributes :username, :content
 
   has_one :post
 end
@@ -642,12 +647,12 @@ end
 ## Unfinished business
 
 * Support for passing `context` through to serializers is partially complete, but needs more work.
-* Support for a `serializer_class` attribute on objects that overrides serializer discovery, would love a PR contribution for this.
 * Support for the `fields` spec is planned, would love a PR contribution for this.
 * Support for pagination/sorting is unlikely to be supported because it would likely involve coupling to ActiveRecord, but please open an issue if you have ideas of how to support this generically.
 
 ## Release notes
 
+* v0.6.1: Spec compliance fix, include intermediate resources on compound documents.
 * v0.6.0: Support for polymorphic collections and inheriting serializer attributes.
 * v0.5.0: Support for explicit serializer discovery.
 * v0.4.0: Support for declaring multiple `attributes`.

data/lib/jsonapi-serializers/serializer.rb

@@ -466,12 +466,9 @@ module JSONAPI
     def self.merge_relationship_path(path, data)
       parts = path.split('.', 2)
       current_level = parts[0].strip
-      data[current_level] ||= {}
+      data[current_level] ||= {_include: true}
 
-      if parts.length == 1
-        # Leaf node.
-        data[current_level].merge!({_include: true})
-      elsif parts.length == 2
+      if parts.length == 2
         # Need to recurse more.
         merge_relationship_path(parts[1], data[current_level])
       end

data/lib/jsonapi-serializers/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Serializer
-    VERSION = '0.6.0'
+    VERSION = '0.6.1'
   end
 end

data/spec/serializer_spec.rb

@@ -531,23 +531,23 @@ describe JSONAPI::Serializer do
       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']
@@ -568,13 +568,21 @@ describe JSONAPI::Serializer do
       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)
 
@@ -625,8 +633,18 @@ describe JSONAPI::Serializer do
       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}),
         ],
       }
@@ -684,7 +702,7 @@ describe JSONAPI::Serializer do
     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
@@ -713,7 +731,7 @@ describe JSONAPI::Serializer 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializers
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-06 00:00:00.000000000 Z
+date: 2016-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport