jsonapi-serializers 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41b4f33131c66343d6703be670fe9a9e58f32c91
-  data.tar.gz: 5660da86b24a037e99e5cb21b7d60f484a8e6884
+  metadata.gz: cd3e1e9535b28c3bd4aa6649bce141d36c312edc
+  data.tar.gz: 44a9e5b6079c4b8fc61a871f28e63914df7b6d94
 SHA512:
-  metadata.gz: dc1f3bd07a774a7e2703a00f700280b3013ada8eda1977b12fd9525c8f5fee9f162a831d0c0d6c91bd0c01db383e52904bd8916179d523aa9a5fd5e9f16173a8
-  data.tar.gz: 940b4a24eedd64d9f5e568592972bd3c2f6c4e3e04ddefeedbaefd977f02016e707f5fb672629720def6db6b82cb2ea3e64fac95178188a65e0cc492a30697c6
+  metadata.gz: a70aa04850d27c037bed576a368f74d76b4e8eda1ef40b65b933e04b1abcf2151245026461114dd19fe61b3f0e13265a9ba513e7606acbe4d10927d20bc48d87
+  data.tar.gz: d41530712d4454f0e73dead332a0e657853fe74d5f3a1f1ee2c400b7fb7c150d57e074af0c628b30106ced93ef2ed41d5c44a98d90fe195964ec37be2a369ecf

data/lib/jsonapi-serializers/serializer.rb

@@ -28,6 +28,7 @@ module JSONAPI
 
       def initialize(object, options = {})
         @object = object
+        @options = options
         @context = options[:context] || {}
         @base_url = options[:base_url]
 
@@ -110,7 +111,7 @@ module JSONAPI
               # http://jsonapi.org/format/#document-structure-resource-relationships
               data[formatted_attribute_name]['data'] = nil
             else
-              related_object_serializer = JSONAPI::Serializer.find_serializer(object)
+              related_object_serializer = JSONAPI::Serializer.find_serializer(object, @options)
               data[formatted_attribute_name]['data'] = {
                 'type' => related_object_serializer.type.to_s,
                 'id' => related_object_serializer.id.to_s,
@@ -138,7 +139,7 @@ module JSONAPI
             data[formatted_attribute_name]['data'] = []
             objects = has_many_relationship(attribute_name, attr_data) || []
             objects.each do |obj|
-              related_object_serializer = JSONAPI::Serializer.find_serializer(obj)
+              related_object_serializer = JSONAPI::Serializer.find_serializer(obj, @options)
               data[formatted_attribute_name]['data'] << {
                 'type' => related_object_serializer.type.to_s,
                 'id' => related_object_serializer.id.to_s,
@@ -221,8 +222,8 @@ module JSONAPI
       class_name.constantize
     end
 
-    def self.find_serializer(object)
-      find_serializer_class(object).new(object)
+    def self.find_serializer(object, options)
+      find_serializer_class(object).new(object, options)
     end
 
     def self.serialize(objects, options = {})
@@ -298,12 +299,13 @@ module JSONAPI
         objects.compact.each do |obj|
           # Use the mutability of relationship_data as the return datastructure to take advantage
           # of the internal special merging logic.
-          find_recursive_relationships(obj, inclusion_tree, relationship_data)
+          find_recursive_relationships(obj, inclusion_tree, relationship_data, passthrough_options)
         end
 
         result['included'] = relationship_data.map do |_, data|
           included_passthrough_options = {}
           included_passthrough_options[:base_url] = passthrough_options[:base_url]
+          included_passthrough_options[:context] = passthrough_options[:context]
           included_passthrough_options[:serializer] = find_serializer_class(data[:object])
           included_passthrough_options[:include_linkages] = data[:include_linkages]
           serialize_primary(data[:object], included_passthrough_options)
@@ -358,12 +360,12 @@ module JSONAPI
     #   ['users', '1'] => {object: <User>, include_linkages: []},
     #   ['users', '2'] => {object: <User>, include_linkages: []},
     # }
-    def self.find_recursive_relationships(root_object, root_inclusion_tree, results)
+    def self.find_recursive_relationships(root_object, root_inclusion_tree, results, options)
       root_inclusion_tree.each do |attribute_name, child_inclusion_tree|
         # Skip the sentinal value, but we need to preserve it for siblings.
         next if attribute_name == :_include
 
-        serializer = JSONAPI::Serializer.find_serializer(root_object)
+        serializer = JSONAPI::Serializer.find_serializer(root_object, options)
         unformatted_attr_name = serializer.unformat_name(attribute_name).to_sym
 
         # We know the name of this relationship, but we don't know where it is stored internally.
@@ -409,7 +411,7 @@ module JSONAPI
           # If it is not set, that indicates that this is an inner path and not a leaf and will
           # be followed by the recursion below.
           objects.each do |obj|
-            obj_serializer = JSONAPI::Serializer.find_serializer(obj)
+            obj_serializer = JSONAPI::Serializer.find_serializer(obj, options)
             # Use keys of ['posts', '1'] for the results to enforce uniqueness.
             # Spec: A compound document MUST NOT include more than one resource object for each
             # type and id pair.
@@ -443,7 +445,7 @@ module JSONAPI
         if !child_inclusion_tree.empty?
           # For each object we just loaded, find all deeper recursive relationships.
           objects.each do |obj|
-            find_recursive_relationships(obj, child_inclusion_tree, results)
+            find_recursive_relationships(obj, child_inclusion_tree, results, options)
           end
         end
       end

data/lib/jsonapi-serializers/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Serializer
-    VERSION = '0.7.0'
+    VERSION = '0.8.0'
   end
 end

data/spec/serializer_spec.rb

@@ -753,7 +753,7 @@ describe JSONAPI::Serializer do
   describe 'if/unless handling with contexts' do
     it 'can be used to show/hide attributes' do
       post = create(:post)
-      options = {serializer: MyApp::PostSerializerWithContextHandling}
+      options = {serializer: MyApp::PostSerializerWithContext}
 
       options[:context] = {show_body: false}
       data = JSONAPI::Serializer.serialize(post, options)
@@ -794,7 +794,36 @@ describe JSONAPI::Serializer do
     end
   end
   describe 'context' do
-    xit 'is correctly passed through all serializers' do
+    it 'is passed through all relationship serializers' do
+      # Force long_comments to be serialized by the context-sensitive serializer.
+      expect_any_instance_of(MyApp::LongComment).to receive(:jsonapi_serializer_class_name)
+        .at_least(:once)
+        .and_return('MyApp::LongCommentsSerializerWithContext')
+
+      user = create(:user, name: 'Long Comment Author -- Should Not Be Serialized')
+      long_comment = create(:long_comment, user: user)
+      post = create(:post, :with_author, long_comments: [long_comment])
+
+      context = {show_body: false, show_comments_user: false}
+      expected_data = {
+        'data' => serialize_primary(post, {
+          serializer: MyApp::PostSerializerWithContext,
+          include_linkages: ['long-comments'],
+          context: context,
+        }),
+        'included' => [
+          serialize_primary(long_comment, {
+            serializer: MyApp::LongCommentsSerializerWithContext,
+            context: context,
+          }),
+        ],
+      }
+      includes = ['long-comments']
+      actual_data = JSONAPI::Serializer.serialize(post, context: context, include: includes)
+      # Multiple expectations for better diff output for debugging.
+      expect(actual_data['data']).to eq(expected_data['data'])
+      expect(actual_data['included']).to eq(expected_data['included'])
+      expect(actual_data).to eq(expected_data)
     end
   end
 

data/spec/support/serializers.rb

@@ -21,6 +21,11 @@ module MyApp
     attr_accessor :body
     attr_accessor :user
     attr_accessor :post
+
+    # Just a copy of the default implementation, we need this to exist to be able to stub in tests.
+    def jsonapi_serializer_class_name
+      'MyApp::LongCommentSerializer'
+    end
   end
 
   class User
@@ -108,7 +113,7 @@ module MyApp
     end
   end
 
-  class PostSerializerWithContextHandling < SimplestPostSerializer
+  class PostSerializerWithContext < PostSerializer
     attribute :body, if: :show_body?, unless: :hide_body?
 
     def show_body?
@@ -120,6 +125,22 @@ module MyApp
     end
   end
 
+  class LongCommentsSerializerWithContext
+    include JSONAPI::Serializer
+
+    attribute :body, if: :show_body?
+    has_one :user, if: :show_comments_user?
+
+    def show_body?
+      context.fetch(:show_body, true)
+    end
+
+    def show_comments_user?
+      context.fetch(:show_comments_user, true)
+    end
+  end
+
+
   class PostSerializerWithoutLinks
     include JSONAPI::Serializer
 

metadata

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