active_model_serializers 0.10.0 → 0.10.7

data/test/adapter/json_api/include_data_if_sideloaded_test.rb

@@ -0,0 +1,213 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    module Adapter
+      class JsonApi
+        class IncludeParamTest < ActiveSupport::TestCase
+          IncludeParamAuthor = Class.new(::Model) do
+            associations :tags, :posts, :roles
+          end
+
+          class CustomCommentLoader
+            def all
+              [{ foo: 'bar' }]
+            end
+          end
+          class Tag < ::Model
+            attributes :id, :name
+          end
+
+          class TagSerializer < ActiveModel::Serializer
+            type 'tags'
+            attributes :id, :name
+          end
+
+          class PostWithTagsSerializer < ActiveModel::Serializer
+            type 'posts'
+            attributes :id
+            has_many :tags
+          end
+
+          class IncludeParamAuthorSerializer < ActiveModel::Serializer
+            class_attribute :comment_loader
+
+            has_many :tags, serializer: TagSerializer do
+              link :self, '//example.com/link_author/relationships/tags'
+              include_data :if_sideloaded
+            end
+
+            has_many :unlinked_tags, serializer: TagSerializer do
+              include_data :if_sideloaded
+            end
+
+            has_many :posts, serializer: PostWithTagsSerializer do
+              include_data :if_sideloaded
+            end
+            has_many :locations do
+              include_data :if_sideloaded
+            end
+            has_many :comments do
+              include_data :if_sideloaded
+              IncludeParamAuthorSerializer.comment_loader.all
+            end
+            has_many :roles, key: :granted_roles do
+              include_data :if_sideloaded
+            end
+          end
+
+          def setup
+            IncludeParamAuthorSerializer.comment_loader = Class.new(CustomCommentLoader).new
+            @tag = Tag.new(id: 1337, name: 'mytag')
+            @role = Role.new(id: 1337, name: 'myrole')
+            @author = IncludeParamAuthor.new(
+              id: 1337,
+              tags: [@tag],
+              roles: [@role]
+            )
+          end
+
+          def test_relationship_not_loaded_when_not_included
+            expected = {
+              links: {
+                self: '//example.com/link_author/relationships/tags'
+              }
+            }
+
+            @author.define_singleton_method(:read_attribute_for_serialization) do |attr|
+              fail 'should not be called' if attr == :tags
+              super(attr)
+            end
+
+            assert_relationship(:tags, expected)
+          end
+
+          def test_relationship_included
+            expected = {
+              data: [
+                {
+                  id: '1337',
+                  type: 'tags'
+                }
+              ],
+              links: {
+                self: '//example.com/link_author/relationships/tags'
+              }
+            }
+
+            assert_relationship(:tags, expected, include: :tags)
+          end
+
+          def test_sideloads_included
+            expected = [
+              {
+                id: '1337',
+                type: 'tags',
+                attributes: { name: 'mytag' }
+              }
+            ]
+            hash = result(include: :tags)
+            assert_equal(expected, hash[:included])
+          end
+
+          def test_sideloads_included_when_using_key
+            expected = [
+              {
+                id: '1337',
+                type: 'roles',
+                attributes: {
+                  name: 'myrole',
+                  description: nil,
+                  slug: 'myrole-1337'
+                },
+                relationships: {
+                  author: { data: nil }
+                }
+              }
+            ]
+
+            hash = result(include: :granted_roles)
+            assert_equal(expected, hash[:included])
+          end
+
+          def test_sideloads_not_included_when_using_name_when_key_defined
+            hash = result(include: :roles)
+            assert_nil(hash[:included])
+          end
+
+          def test_nested_relationship
+            expected = {
+              data: [
+                {
+                  id: '1337',
+                  type: 'tags'
+                }
+              ],
+              links: {
+                self: '//example.com/link_author/relationships/tags'
+              }
+            }
+
+            expected_no_data = {
+              links: {
+                self: '//example.com/link_author/relationships/tags'
+              }
+            }
+
+            assert_relationship(:tags, expected, include: [:tags, { posts: :tags }])
+
+            @author.define_singleton_method(:read_attribute_for_serialization) do |attr|
+              fail 'should not be called' if attr == :tags
+              super(attr)
+            end
+
+            assert_relationship(:tags, expected_no_data, include: { posts: :tags })
+          end
+
+          def test_include_params_with_no_block
+            @author.define_singleton_method(:read_attribute_for_serialization) do |attr|
+              fail 'should not be called' if attr == :locations
+              super(attr)
+            end
+
+            expected = { meta: {} }
+
+            assert_relationship(:locations, expected)
+          end
+
+          def test_block_relationship
+            expected = {
+              data: [
+                { 'foo' => 'bar' }
+              ]
+            }
+
+            assert_relationship(:comments, expected, include: [:comments])
+          end
+
+          def test_node_not_included_when_no_link
+            expected = { meta: {} }
+            assert_relationship(:unlinked_tags, expected, key_transform: :unaltered)
+          end
+
+          private
+
+          def assert_relationship(relationship_name, expected, opts = {})
+            actual = relationship_data(relationship_name, opts)
+            assert_equal(expected, actual)
+          end
+
+          def result(opts)
+            opts = { adapter: :json_api }.merge(opts)
+            serializable(@author, opts).serializable_hash
+          end
+
+          def relationship_data(relationship_name, opts = {})
+            hash = result(opts)
+            hash[:data][:relationships][relationship_name]
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/json_api_test.rb

@@ -22,13 +22,11 @@ module ActiveModelSerializers
         adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
 
         assert_equal({
-          reviews: { data: [
-                      { type: 'comments', id: '1' },
-                      { type: 'comments', id: '2' }
-                  ] },
-          writer: { data: { type: 'authors', id: '1' } },
-          site: { data: { type: 'blogs', id: '1' } }
-          }, adapter.serializable_hash[:data][:relationships])
+                       reviews: { data: [{ type: 'comments', id: '1' },
+                                         { type: 'comments', id: '2' }] },
+                       writer: { data: { type: 'authors', id: '1' } },
+                       site: { data: { type: 'blogs', id: '1' } }
+                     }, adapter.serializable_hash[:data][:relationships])
       end
     end
   end

data/test/adapter/json_api/linked_test.rb

@@ -1,10 +1,9 @@
 require 'test_helper'
 
-NestedPost = Class.new(Model)
+class NestedPost < ::Model; associations :nested_posts end
 class NestedPostSerializer < ActiveModel::Serializer
   has_many :nested_posts
 end
-
 module ActiveModelSerializers
   module Adapter
     class JsonApi
@@ -17,7 +16,7 @@ module ActiveModelSerializers
           @first_post = Post.new(id: 10, title: 'Hello!!', body: 'Hello, world!!')
           @second_post = Post.new(id: 20, title: 'New Post', body: 'Body')
           @third_post = Post.new(id: 30, title: 'Yet Another Post', body: 'Body')
-          @blog = Blog.new({ name: 'AMS Blog' })
+          @blog = Blog.new(name: 'AMS Blog')
           @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
           @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
           @first_post.blog = @blog
@@ -224,6 +223,25 @@ module ActiveModelSerializers
           assert_equal expected, relationships
         end
 
+        def test_underscore_model_namespace_with_namespace_separator_for_linked_resource_type
+          spammy_post = Post.new(id: 123)
+          spammy_post.related = [Spam::UnrelatedLink.new(id: 456)]
+          serializer = SpammyPostSerializer.new(spammy_post)
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
+          relationships = with_namespace_separator '--' do
+            adapter.serializable_hash[:data][:relationships]
+          end
+          expected = {
+            related: {
+              data: [{
+                type: 'spam--unrelated-links',
+                id: '456'
+              }]
+            }
+          }
+          assert_equal expected, relationships
+        end
+
         def test_multiple_references_to_same_resource
           serializer = ActiveModel::Serializer::CollectionSerializer.new([@first_comment, @second_comment])
           adapter = ActiveModelSerializers::Adapter::JsonApi.new(
@@ -283,8 +301,8 @@ module ActiveModelSerializers
       end
 
       class NoDuplicatesTest < ActiveSupport::TestCase
-        Post = Class.new(::Model)
-        Author = Class.new(::Model)
+        class Post < ::Model; associations :author end
+        class Author < ::Model; associations :posts, :roles, :bio end
 
         class PostSerializer < ActiveModel::Serializer
           type 'posts'
@@ -303,8 +321,8 @@ module ActiveModelSerializers
           @author.posts << @post1
           @author.posts << @post2
 
-          @nestedpost1 = ::NestedPost.new(id: 1, nested_posts: [])
-          @nestedpost2 = ::NestedPost.new(id: 2, nested_posts: [])
+          @nestedpost1 = NestedPost.new(id: 1, nested_posts: [])
+          @nestedpost2 = NestedPost.new(id: 2, nested_posts: [])
           @nestedpost1.nested_posts << @nestedpost1
           @nestedpost1.nested_posts << @nestedpost2
           @nestedpost2.nested_posts << @nestedpost1
@@ -341,9 +359,10 @@ module ActiveModelSerializers
 
         def test_no_duplicates_collection
           hash = ActiveModelSerializers::SerializableResource.new(
-            [@post1, @post2], adapter: :json_api,
-                              include: '*.*')
-                                                             .serializable_hash
+            [@post1, @post2],
+            adapter: :json_api,
+            include: '*.*'
+          ).serializable_hash
           expected = [
             {
               type: 'authors', id: '1',
@@ -364,7 +383,8 @@ module ActiveModelSerializers
           hash = ActiveModelSerializers::SerializableResource.new(
             @nestedpost1,
             adapter: :json_api,
-            include: '*').serializable_hash
+            include: '*'
+          ).serializable_hash
           expected = [
             type: 'nested-posts', id: '2',
             relationships: {
@@ -383,7 +403,8 @@ module ActiveModelSerializers
           hash = ActiveModelSerializers::SerializableResource.new(
             [@nestedpost1, @nestedpost2],
             adapter: :json_api,
-            include: '*').serializable_hash
+            include: '*'
+          ).serializable_hash
           assert_nil(hash[:included])
         end
       end

data/test/adapter/json_api/links_test.rb

@@ -4,7 +4,7 @@ module ActiveModelSerializers
   module Adapter
     class JsonApi
       class LinksTest < ActiveSupport::TestCase
-        LinkAuthor = Class.new(::Model)
+        class LinkAuthor < ::Model; associations :posts end
         class LinkAuthorSerializer < ActiveModel::Serializer
           link :self do
             href "http://example.com/link_author/#{object.id}"
@@ -17,6 +17,7 @@ module ActiveModelSerializers
           link :yet_another do
             "http://example.com/resource/#{object.id}"
           end
+          link(:nil) { nil }
         end
 
         def setup
@@ -40,7 +41,8 @@ module ActiveModelSerializers
                   stuff: 'value'
                 }
               }
-            }).serializable_hash
+            }
+          ).serializable_hash
           expected = {
             self: {
               href: 'http://example.com/posts',

data/test/adapter/json_api/pagination_links_test.rb

@@ -13,11 +13,11 @@ module ActiveModelSerializers
         def setup
           ActionController::Base.cache_store.clear
           @array = [
-            Profile.new({ id: 1, name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
-            Profile.new({ id: 2, name: 'Name 2', description: 'Description 2', comments: 'Comments 2' }),
-            Profile.new({ id: 3, name: 'Name 3', description: 'Description 3', comments: 'Comments 3' }),
-            Profile.new({ id: 4, name: 'Name 4', description: 'Description 4', comments: 'Comments 4' }),
-            Profile.new({ id: 5, name: 'Name 5', description: 'Description 5', comments: 'Comments 5' })
+            Profile.new(id: 1, name: 'Name 1', description: 'Description 1', comments: 'Comments 1'),
+            Profile.new(id: 2, name: 'Name 2', description: 'Description 2', comments: 'Comments 2'),
+            Profile.new(id: 3, name: 'Name 3', description: 'Description 3', comments: 'Comments 3'),
+            Profile.new(id: 4, name: 'Name 4', description: 'Description 4', comments: 'Comments 4'),
+            Profile.new(id: 5, name: 'Name 5', description: 'Description 5', comments: 'Comments 5')
           ]
         end
 
@@ -43,7 +43,8 @@ module ActiveModelSerializers
         end
 
         def data
-          { data: [
+          {
+            data: [
               { id: '1', type: 'profiles', attributes: { name: 'Name 1', description: 'Description 1' } },
               { id: '2', type: 'profiles', attributes: { name: 'Name 2', description: 'Description 2' } },
               { id: '3', type: 'profiles', attributes: { name: 'Name 3', description: 'Description 3' } },
@@ -53,6 +54,16 @@ module ActiveModelSerializers
           }
         end
 
+        def empty_collection_links
+          {
+            self: "#{URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2",
+            first: "#{URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2",
+            prev: nil,
+            next: nil,
+            last: "#{URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2"
+          }
+        end
+
         def links
           {
             links: {
@@ -70,12 +81,14 @@ module ActiveModelSerializers
             links: {
               self: "#{URI}?page%5Bnumber%5D=3&page%5Bsize%5D=2",
               first: "#{URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2",
-              prev: "#{URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2"
+              prev: "#{URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2",
+              next: nil,
+              last: "#{URI}?page%5Bnumber%5D=3&page%5Bsize%5D=2"
             }
           }
         end
 
-        def expected_response_without_pagination_links
+        def expected_response_when_unpaginatable
           data
         end
 
@@ -86,6 +99,12 @@ module ActiveModelSerializers
           end
         end
 
+        def expected_response_without_pagination_links
+          {}.tap do |hash|
+            hash[:data] = data.values.flatten[2..3]
+          end
+        end
+
         def expected_response_with_pagination_links_and_additional_params
           new_links = links[:links].each_with_object({}) { |(key, value), hash| hash[key] = "#{value}&test=test" }
           {}.tap do |hash|
@@ -101,10 +120,10 @@ module ActiveModelSerializers
           end
         end
 
-        def expected_response_with_no_data_pagination_links
+        def expected_response_with_empty_collection_pagination_links
           {}.tap do |hash|
             hash[:data] = []
-            hash[:links] = {}
+            hash.merge! links: empty_collection_links
           end
         end
 
@@ -121,7 +140,7 @@ module ActiveModelSerializers
         end
 
         def test_pagination_links_with_additional_params
-          adapter = load_adapter(using_will_paginate, mock_request({ test: 'test' }))
+          adapter = load_adapter(using_will_paginate, mock_request(test: 'test'))
 
           assert_equal expected_response_with_pagination_links_and_additional_params,
             adapter.serializable_hash
@@ -132,7 +151,7 @@ module ActiveModelSerializers
 
           adapter = load_adapter(using_kaminari(1), mock_request)
 
-          assert_equal expected_response_with_no_data_pagination_links, adapter.serializable_hash
+          assert_equal expected_response_with_empty_collection_pagination_links, adapter.serializable_hash
         end
 
         def test_pagination_links_when_zero_results_will_paginate
@@ -140,7 +159,7 @@ module ActiveModelSerializers
 
           adapter = load_adapter(using_will_paginate(1), mock_request)
 
-          assert_equal expected_response_with_no_data_pagination_links, adapter.serializable_hash
+          assert_equal expected_response_with_empty_collection_pagination_links, adapter.serializable_hash
         end
 
         def test_last_page_pagination_links_using_kaminari
@@ -158,7 +177,28 @@ module ActiveModelSerializers
         def test_not_showing_pagination_links
           adapter = load_adapter(@array, mock_request)
 
+          assert_equal expected_response_when_unpaginatable, adapter.serializable_hash
+        end
+
+        def test_raises_descriptive_error_when_serialization_context_unset
+          render_options = { adapter: :json_api }
+          adapter = serializable(using_kaminari, render_options)
+          exception_class = ActiveModelSerializers::Adapter::JsonApi::PaginationLinks::MissingSerializationContextError
+
+          exception = assert_raises(exception_class) do
+            adapter.as_json
+          end
+          assert_equal exception_class, exception.class
+          assert_match(/CollectionSerializer#paginated\?/, exception.message)
+        end
+
+        def test_pagination_links_not_present_when_disabled
+          ActiveModel::Serializer.config.jsonapi_pagination_links_enabled = false
+          adapter = load_adapter(using_kaminari, mock_request)
+
           assert_equal expected_response_without_pagination_links, adapter.serializable_hash
+        ensure
+          ActiveModel::Serializer.config.jsonapi_pagination_links_enabled = true
         end
       end
     end

data/test/adapter/json_api/parse_test.rb

@@ -125,7 +125,7 @@ module ActiveModelSerializers
               src: 'http://example.com/images/productivity.png',
               author_id: nil,
               photographer_id: '9',
-              photographer_type: 'people',
+              photographer_type: 'Person',
               comment_ids: %w(1 2)
             }
             assert_equal(expected, parsed_hash)