active_model_serializers 0.10.0 → 0.10.9

data/test/adapter/json_api/collection_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module ActiveModelSerializers
@@ -58,9 +60,10 @@ module ActiveModelSerializers
 
         def test_limiting_fields
           actual = ActiveModelSerializers::SerializableResource.new(
-            [@first_post, @second_post], adapter: :json_api,
-                                         fields: { posts: %w(title comments blog author) })
-                                                               .serializable_hash
+            [@first_post, @second_post],
+            adapter: :json_api,
+            fields: { posts: %w(title comments blog author) }
+          ).serializable_hash
           expected = [
             {
               id: '1',

data/test/adapter/json_api/errors_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module ActiveModelSerializers
@@ -12,8 +14,8 @@ module ActiveModelSerializers
 
         def test_active_model_with_error
           options = {
-              serializer: ActiveModel::Serializer::ErrorSerializer,
-              adapter: :json_api
+            serializer: ActiveModel::Serializer::ErrorSerializer,
+            adapter: :json_api
           }
 
           @resource.errors.add(:name, 'cannot be nil')
@@ -22,22 +24,21 @@ module ActiveModelSerializers
           assert_equal serializable_resource.serializer_instance.attributes, {}
           assert_equal serializable_resource.serializer_instance.object, @resource
 
-          expected_errors_object =
-            { :errors =>
-              [
-                {
-                  source: { pointer: '/data/attributes/name' },
-                  detail: 'cannot be nil'
-                }
-              ]
+          expected_errors_object = {
+            errors: [
+              {
+                source: { pointer: '/data/attributes/name' },
+                detail: 'cannot be nil'
+              }
+            ]
           }
           assert_equal serializable_resource.as_json, expected_errors_object
         end
 
         def test_active_model_with_multiple_errors
           options = {
-              serializer: ActiveModel::Serializer::ErrorSerializer,
-              adapter: :json_api
+            serializer: ActiveModel::Serializer::ErrorSerializer,
+            adapter: :json_api
           }
 
           @resource.errors.add(:name, 'cannot be nil')
@@ -48,13 +49,12 @@ module ActiveModelSerializers
           assert_equal serializable_resource.serializer_instance.attributes, {}
           assert_equal serializable_resource.serializer_instance.object, @resource
 
-          expected_errors_object =
-            { :errors =>
-              [
-                { :source => { :pointer => '/data/attributes/name' }, :detail => 'cannot be nil' },
-                { :source => { :pointer => '/data/attributes/name' }, :detail => 'must be longer' },
-                { :source => { :pointer => '/data/attributes/id' }, :detail => 'must be a uuid' }
-              ]
+          expected_errors_object = {
+            errors: [
+              { source: { pointer: '/data/attributes/name' }, detail: 'cannot be nil' },
+              { source: { pointer: '/data/attributes/name' }, detail: 'must be longer' },
+              { source: { pointer: '/data/attributes/id' }, detail: 'must be a uuid' }
+            ]
           }
           assert_equal serializable_resource.as_json, expected_errors_object
         end

data/test/adapter/json_api/fields_test.rb

@@ -1,10 +1,23 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module ActiveModelSerializers
   module Adapter
     class JsonApi
       class FieldsTest < ActiveSupport::TestCase
-        Post = Class.new(::Model)
+        class Post < ::Model
+          attributes :title, :body
+          associations :author, :comments
+        end
+        class Author < ::Model
+          attributes :name, :birthday
+        end
+        class Comment < ::Model
+          attributes :body
+          associations :author, :post
+        end
+
         class PostSerializer < ActiveModel::Serializer
           type 'posts'
           attributes :title, :body
@@ -12,13 +25,11 @@ module ActiveModelSerializers
           has_many :comments
         end
 
-        Author = Class.new(::Model)
         class AuthorSerializer < ActiveModel::Serializer
           type 'authors'
           attributes :name, :birthday
         end
 
-        Comment = Class.new(::Model)
         class CommentSerializer < ActiveModel::Serializer
           type 'comments'
           attributes :body

data/test/adapter/json_api/has_many_explicit_serializer_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module ActiveModelSerializers

data/test/adapter/json_api/has_many_test.rb

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module ActiveModelSerializers
   module Adapter
     class JsonApi
       class HasManyTest < ActiveSupport::TestCase
+        class ModelWithoutSerializer < ::Model
+          attributes :id, :name
+        end
+
         def setup
           ActionController::Base.cache_store.clear
           @author = Author.new(id: 1, name: 'Steve K.')
@@ -26,7 +32,7 @@ module ActiveModelSerializers
           @blog.articles = [@post]
           @post.blog = @blog
           @post_without_comments.blog = nil
-          @tag = Tag.new(id: 1, name: '#hash_tag')
+          @tag = ModelWithoutSerializer.new(id: 1, name: '#hash_tag')
           @post.tags = [@tag]
           @serializer = PostSerializer.new(@post)
           @adapter = ActiveModelSerializers::Adapter::JsonApi.new(@serializer)
@@ -40,6 +46,27 @@ module ActiveModelSerializers
           assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:comments])
         end
 
+        test 'relationships can be whitelisted via fields' do
+          @adapter = ActiveModelSerializers::Adapter::JsonApi.new(@serializer, fields: { posts: [:author] })
+          result = @adapter.serializable_hash
+          expected = {
+            data: {
+              id: '1',
+              type: 'posts',
+              relationships: {
+                author: {
+                  data: {
+                    id: '1',
+                    type: 'authors'
+                  }
+                }
+              }
+            }
+          }
+
+          assert_equal expected, result
+        end
+
         def test_includes_linked_comments
           @adapter = ActiveModelSerializers::Adapter::JsonApi.new(@serializer, include: [:comments])
           expected = [{
@@ -108,18 +135,22 @@ module ActiveModelSerializers
         end
 
         def test_has_many_with_no_serializer
-          serializer = PostWithTagsSerializer.new(@post)
+          post_serializer_class = Class.new(ActiveModel::Serializer) do
+            attributes :id
+            has_many :tags
+          end
+          serializer = post_serializer_class.new(@post)
           adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
 
           assert_equal({
-            data: {
-              id: '1',
-              type: 'posts',
-              relationships: {
-                tags: { data: [@tag.as_json] }
-              }
-            }
-          }, adapter.serializable_hash)
+                         data: {
+                           id: '1',
+                           type: 'posts',
+                           relationships: {
+                             tags: { data: [@tag.as_json] }
+                           }
+                         }
+                       }, adapter.serializable_hash)
         end
 
         def test_has_many_with_virtual_value
@@ -127,16 +158,16 @@ module ActiveModelSerializers
           adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
 
           assert_equal({
-            data: {
-              id: '1',
-              type: 'virtual-values',
-              relationships: {
-                maker: { data: { type: 'makers', id: '1' } },
-                reviews: { data: [{ type: 'reviews', id: '1' },
-                                  { type: 'reviews', id: '2' }] }
-              }
-            }
-          }, adapter.serializable_hash)
+                         data: {
+                           id: '1',
+                           type: 'virtual-values',
+                           relationships: {
+                             maker: { data: { type: 'makers', id: '1' } },
+                             reviews: { data: [{ type: 'reviews', id: '1' },
+                                               { type: 'reviews', id: '2' }] }
+                           }
+                         }
+                       }, adapter.serializable_hash)
         end
       end
     end

data/test/adapter/json_api/has_one_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module ActiveModelSerializers

data/test/adapter/json_api/include_data_if_sideloaded_test.rb

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+
+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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module ActiveModelSerializers
@@ -22,13 +24,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,11 @@
+# frozen_string_literal: true
+
 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 +18,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 +225,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 +303,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 +323,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 +361,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 +385,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 +405,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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 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 +19,21 @@ module ActiveModelSerializers
           link :yet_another do
             "http://example.com/resource/#{object.id}"
           end
+          link :conditional1, if: -> { instance_truth } do
+            "http://example.com/conditional1/#{object.id}"
+          end
+          link :conditional2, if: :instance_falsey do
+            "http://example.com/conditional2/#{object.id}"
+          end
+          link(:nil) { nil }
+
+          def instance_truth
+            true
+          end
+
+          def instance_falsey
+            false
+          end
         end
 
         def setup
@@ -40,7 +57,8 @@ module ActiveModelSerializers
                   stuff: 'value'
                 }
               }
-            }).serializable_hash
+            }
+          ).serializable_hash
           expected = {
             self: {
               href: 'http://example.com/posts',
@@ -83,7 +101,8 @@ module ActiveModelSerializers
             :"link-authors" => 'http://example.com/link_authors',
             resource: 'http://example.com/resource',
             posts: 'http://example.com/link_authors/1337/posts',
-            :"yet-another" => 'http://example.com/resource/1337'
+            :"yet-another" => 'http://example.com/resource/1337',
+            conditional1: 'http://example.com/conditional1/1337'
           }
           assert_equal(expected, hash[:data][:links])
         end