jsonapi-serializers 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 492ef52b3e744f06e226ebe911fd6671dfc637b6
-  data.tar.gz: 19f25d49bb9bb8450b9538bdc31aaf6ee4bf3a12
+  metadata.gz: 42699af4d36a1e0a2293c857393c2dc3536d8d82
+  data.tar.gz: 92ef3e0b867d350c32fe4145c01958e38ceb2a8b
 SHA512:
-  metadata.gz: 1ad6cd857ffccc11bccf9ee0d33aa0c35dddb8f6da4b188984ac56609c3e38d9373c66fb12518045dec75ebf26473a7624002dc8d1ecb16ea9eb784f0ace8dac
-  data.tar.gz: b6212c674cd0d71bf345aeca14c6e8215e13b9b06614a03510cee65311ef09164b8b7f7effa460a729083963c8d60ae141acf1a62650e4016aa705dd49e5c937
+  metadata.gz: 06c90bbb58c2910078140c46592ee8f6ce81d20504b530e1ca853484b7573a198fd1da7e2f98d54cbb8f76eb471eda50cc41599b5e99cd76733c6e66a7280c57
+  data.tar.gz: 696761f2e0863825c0b232d506795758e4eda93a166d32f05095e59b412cde1531dc992e7c89e83afe86b1b568712a57fd9bb5a44d4fad628f181022a4b290c4

data/README.md

@@ -19,6 +19,7 @@ This library is up-to-date with the finalized v1 JSON API spec.
   * [More customizations](#more-customizations)
   * [Base URL](#base-url)
   * [Root metadata](#root-metadata)
+  * [Explicit serializer discovery](#explicit-serializer-discovery)
 * [Relationships](#relationships)
   * [Compound documents and includes](#compound-documents-and-includes)
   * [Relationship path handling](#relationship-path-handling)
@@ -313,6 +314,20 @@ You can pass a `meta` argument to specify top-level metadata:
 JSONAPI::Serializer.serialize(post, meta: {copyright: 'Copyright 2015 Example Corp.'})
 ```
 
+### Explicit serializer discovery
+
+By default, jsonapi-serializers assumes that the serializer class for `Namespace::User` is `Namespace::UserSerializer`. You can override this behavior on a per-object basis by implementing the `jsonapi_serializer_class_name` method.
+
+```ruby
+class User
+  def jsonapi_serializer_class_name
+    'SomeOtherNamespace::CustomUserSerializer'
+  end
+end
+```
+
+Now, when a `User` object is serialized, it will use the `SomeOtherNamespace::CustomUserSerializer`.
+
 ## Relationships
 
 You can easily specify relationships with the `has_one` and `has_many` directives.
@@ -513,9 +528,16 @@ module JSONAPI
   MIMETYPE = "application/vnd.api+json"
 end
 Mime::Type.register(JSONAPI::MIMETYPE, :api_json)
+
+# Rails 4
 ActionDispatch::ParamsParser::DEFAULT_PARSERS[Mime::Type.lookup(JSONAPI::MIMETYPE)] = lambda do |body|
   JSON.parse(body)
 end
+
+# Rails 5 moved DEFAULT_PARSERS
+ActionDispatch::Http::Parameters::DEFAULT_PARSERS[Mime::Type.lookup(JSONAPI::MIMETYPE)] = lambda do |body|
+  JSON.parse(body)
+end
 ```
 
 ## Unfinished business
@@ -527,6 +549,7 @@ end
 
 ## Release notes
 
+* v0.5.0: Support for explicit serializer discovery.
 * v0.4.0: Support for declaring multiple `attributes`.
 * v0.3.1: Improve performance of loading included relationships.
 * v0.3.0: Add top-level `meta` support.

data/lib/jsonapi-serializers/serializer.rb

@@ -211,6 +211,9 @@ module JSONAPI
     end
 
     def self.find_serializer_class_name(object)
+      if object.respond_to?(:jsonapi_serializer_class_name)
+        return object.jsonapi_serializer_class_name.to_s
+      end
       "#{object.class.name}Serializer"
     end
 

data/lib/jsonapi-serializers/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Serializer
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

data/spec/serializer_spec.rb

@@ -423,7 +423,7 @@ describe JSONAPI::Serializer do
       expect(JSONAPI::Serializer.serialize(post, include: ['author'])).to eq({
         'data' => expected_primary_data,
         'included' => [
-          serialize_primary(post.author, {serializer: MyApp::UserSerializer}),
+          serialize_primary(post.author, {serializer: MyAppOtherNamespace::UserSerializer}),
         ],
       })
     end
@@ -518,7 +518,7 @@ describe JSONAPI::Serializer do
         'data' => serialize_primary(post, {serializer: MyApp::PostSerializer}),
         'included' => [
           # Only the author is included:
-          serialize_primary(post.author, {serializer: MyApp::UserSerializer}),
+          serialize_primary(post.author, {serializer: MyAppOtherNamespace::UserSerializer}),
         ],
       }
       includes = ['long-comments.post.author']
@@ -542,8 +542,8 @@ describe JSONAPI::Serializer do
         # Same note about primary data linkages as above.
         'data' => serialize_primary(post, {serializer: MyApp::PostSerializer}),
         'included' => [
-          serialize_primary(first_user, {serializer: MyApp::UserSerializer}),
-          serialize_primary(second_user, {serializer: MyApp::UserSerializer}),
+          serialize_primary(first_user, {serializer: MyAppOtherNamespace::UserSerializer}),
+          serialize_primary(second_user, {serializer: MyAppOtherNamespace::UserSerializer}),
         ],
       }
       includes = ['long-comments.user']
@@ -571,7 +571,7 @@ describe JSONAPI::Serializer do
             include_linkages: ['user'],
           }),
           # Note: post.author does not show up here because it was not included.
-          serialize_primary(comment_user, {serializer: MyApp::UserSerializer}),
+          serialize_primary(comment_user, {serializer: MyAppOtherNamespace::UserSerializer}),
         ],
       }
       includes = ['long-comments', 'long-comments.user']
@@ -598,7 +598,7 @@ describe JSONAPI::Serializer do
         'included' => [
           serialize_primary(long_comments.first, {serializer: MyApp::LongCommentSerializer}),
           serialize_primary(long_comments.last, {serializer: MyApp::LongCommentSerializer}),
-          serialize_primary(post.author, {serializer: MyApp::UserSerializer}),
+          serialize_primary(post.author, {serializer: MyAppOtherNamespace::UserSerializer}),
         ],
       }
       # Also test that it handles string include arguments.

data/spec/support/serializers.rb

@@ -17,6 +17,10 @@ module MyApp
   class User
     attr_accessor :id
     attr_accessor :name
+
+    def jsonapi_serializer_class_name
+      'MyAppOtherNamespace::UserSerializer'
+    end
   end
 
   class PostSerializer
@@ -41,12 +45,6 @@ module MyApp
     has_one :post
   end
 
-  class UserSerializer
-    include JSONAPI::Serializer
-
-    attribute :name
-  end
-
   # More customized, one-off serializers to test particular behaviors:
 
   class SimplestPostSerializer
@@ -141,3 +139,13 @@ module MyApp
     attributes :title, :body
   end
 end
+
+# Test the `jsonapi_serializer_class_name` override method for serializers in different namespaces.
+# There is no explicit test for this, just implicit tests that correctly serialize User objects.
+module MyAppOtherNamespace
+  class UserSerializer
+    include JSONAPI::Serializer
+
+    attribute :name
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializers
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2016-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport