active_model_serializers 0.10.0 → 0.10.3

data/test/serializers/associations_test.rb

@@ -1,5 +1,4 @@
 require 'test_helper'
-
 module ActiveModel
   class Serializer
     class AssociationsTest < ActiveSupport::TestCase
@@ -7,10 +6,10 @@ module ActiveModel
         @author = Author.new(name: 'Steve K.')
         @author.bio = nil
         @author.roles = []
-        @blog = Blog.new({ name: 'AMS Blog' })
-        @post = Post.new({ title: 'New Post', body: 'Body' })
-        @tag = Tag.new({ name: '#hashtagged' })
-        @comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
+        @blog = Blog.new(name: 'AMS Blog')
+        @post = Post.new(title: 'New Post', body: 'Body')
+        @tag = Tag.new(name: '#hashtagged')
+        @comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
         @post.comments = [@comment]
         @post.tags = [@tag]
         @post.blog = @blog
@@ -19,7 +18,7 @@ module ActiveModel
         @post.author = @author
         @author.posts = [@post]
 
-        @post_serializer = PostSerializer.new(@post, { custom_options: true })
+        @post_serializer = PostSerializer.new(@post, custom_options: true)
         @author_serializer = AuthorSerializer.new(@author)
         @comment_serializer = CommentSerializer.new(@comment)
       end
@@ -32,13 +31,13 @@ module ActiveModel
 
           case key
           when :posts
-            assert_equal({ include_data: true }, options)
+            assert_equal true, options.fetch(:include_data)
             assert_kind_of(ActiveModelSerializers.config.collection_serializer, serializer)
           when :bio
-            assert_equal({ include_data: true }, options)
+            assert_equal true, options.fetch(:include_data)
             assert_nil serializer
           when :roles
-            assert_equal({ include_data: true }, options)
+            assert_equal true, options.fetch(:include_data)
             assert_kind_of(ActiveModelSerializers.config.collection_serializer, serializer)
           else
             flunk "Unknown association: #{key}"
@@ -80,7 +79,7 @@ module ActiveModel
             flunk "Unknown association: #{key}"
           end
 
-          assert_equal({ include_data: true }, association.options)
+          assert_equal true, association.options.fetch(:include_data)
         end
       end
 
@@ -104,13 +103,13 @@ module ActiveModel
         end
 
         assert(
-          PostSerializer._reflections.all? do |reflection|
-            inherited_klass._reflections.include?(reflection)
+          PostSerializer._reflections.values.all? do |reflection|
+            inherited_klass._reflections.values.include?(reflection)
           end
         )
 
         assert(
-          inherited_klass._reflections.any? do |reflection|
+          inherited_klass._reflections.values.any? do |reflection|
             reflection.name == :top_comments
           end
         )
@@ -143,12 +142,12 @@ module ActiveModel
         )
         actual = serializable(post, adapter: :attributes, serializer: InlineAssociationTestPostSerializer).as_json
         expected = {
-          :comments => [
-            { :id => 1, :contents => 'first comment' },
-            { :id => 2, :contents => 'last comment' }
+          comments: [
+            { id: 1, contents: 'first comment' },
+            { id: 2, contents: 'last comment' }
           ],
-          :last_comments => [
-            { :id => 2, :contents => 'last comment' }
+          last_comments: [
+            { id: 2, contents: 'last comment' }
           ]
         }
 
@@ -160,18 +159,18 @@ module ActiveModel
 
       class NamespacedResourcesTest < ActiveSupport::TestCase
         class ResourceNamespace
-          Post    = Class.new(::Model)
-          Comment = Class.new(::Model)
-          Author  = Class.new(::Model)
-          Description = Class.new(::Model)
+          class Post    < ::Model; end
+          class Comment < ::Model; end
+          class Author  < ::Model; end
+          class Description < ::Model; end
           class PostSerializer < ActiveModel::Serializer
             has_many :comments
             belongs_to :author
             has_one :description
           end
-          CommentSerializer     = Class.new(ActiveModel::Serializer)
-          AuthorSerializer      = Class.new(ActiveModel::Serializer)
-          DescriptionSerializer = Class.new(ActiveModel::Serializer)
+          class CommentSerializer     < ActiveModel::Serializer; end
+          class AuthorSerializer      < ActiveModel::Serializer; end
+          class DescriptionSerializer < ActiveModel::Serializer; end
         end
 
         def setup
@@ -201,17 +200,17 @@ module ActiveModel
       end
 
       class NestedSerializersTest < ActiveSupport::TestCase
-        Post    = Class.new(::Model)
-        Comment = Class.new(::Model)
-        Author  = Class.new(::Model)
-        Description = Class.new(::Model)
+        class Post    < ::Model; end
+        class Comment < ::Model; end
+        class Author  < ::Model; end
+        class Description < ::Model; end
         class PostSerializer < ActiveModel::Serializer
           has_many :comments
-          CommentSerializer = Class.new(ActiveModel::Serializer)
+          class CommentSerializer < ActiveModel::Serializer; end
           belongs_to :author
-          AuthorSerializer = Class.new(ActiveModel::Serializer)
+          class AuthorSerializer < ActiveModel::Serializer; end
           has_one :description
-          DescriptionSerializer = Class.new(ActiveModel::Serializer)
+          class DescriptionSerializer < ActiveModel::Serializer; end
         end
 
         def setup
@@ -290,6 +289,82 @@ module ActiveModel
           assert_match(/:if should be a Symbol, String or Proc/, exception.message)
         end
       end
+
+      class InheritedSerializerTest < ActiveSupport::TestCase
+        class PostSerializer < ActiveModel::Serializer
+          belongs_to :author
+          has_many :comments
+          belongs_to :blog
+        end
+
+        class InheritedPostSerializer < PostSerializer
+          belongs_to :author, polymorphic: true
+          has_many :comments, key: :reviews
+        end
+
+        class AuthorSerializer < ActiveModel::Serializer
+          has_many :posts
+          has_many :roles
+          has_one :bio
+        end
+
+        class InheritedAuthorSerializer < AuthorSerializer
+          has_many :roles, polymorphic: true
+          has_one :bio, polymorphic: true
+        end
+
+        def setup
+          @author = Author.new(name: 'Steve K.')
+          @post = Post.new(title: 'New Post', body: 'Body')
+          @post_serializer = PostSerializer.new(@post)
+          @author_serializer = AuthorSerializer.new(@author)
+          @inherited_post_serializer = InheritedPostSerializer.new(@post)
+          @inherited_author_serializer = InheritedAuthorSerializer.new(@author)
+          @author_associations = @author_serializer.associations.to_a
+          @inherited_author_associations = @inherited_author_serializer.associations.to_a
+          @post_associations = @post_serializer.associations.to_a
+          @inherited_post_associations = @inherited_post_serializer.associations.to_a
+        end
+
+        test 'an author serializer must have [posts,roles,bio] associations' do
+          expected = [:posts, :roles, :bio].sort
+          result = @author_serializer.associations.map(&:name).sort
+          assert_equal(result, expected)
+        end
+
+        test 'a post serializer must have [author,comments,blog] associations' do
+          expected = [:author, :comments, :blog].sort
+          result = @post_serializer.associations.map(&:name).sort
+          assert_equal(result, expected)
+        end
+
+        test 'a serializer inheriting from another serializer can redefine has_many and has_one associations' do
+          expected = [:roles, :bio].sort
+          result = (@inherited_author_associations - @author_associations).map(&:name).sort
+          assert_equal(result, expected)
+        end
+
+        test 'a serializer inheriting from another serializer can redefine belongs_to associations' do
+          assert_equal [:author, :comments, :blog], @post_associations.map(&:name)
+          assert_equal [:author, :comments, :blog, :comments], @inherited_post_associations.map(&:name)
+
+          refute @post_associations.detect { |assoc| assoc.name == :author }.options.key?(:polymorphic)
+          assert_equal true, @inherited_post_associations.detect { |assoc| assoc.name == :author }.options.fetch(:polymorphic)
+
+          refute @post_associations.detect { |assoc| assoc.name == :comments }.options.key?(:key)
+          original_comment_assoc, new_comments_assoc = @inherited_post_associations.select { |assoc| assoc.name == :comments }
+          refute original_comment_assoc.options.key?(:key)
+          assert_equal :reviews, new_comments_assoc.options.fetch(:key)
+
+          assert_equal @post_associations.detect { |assoc| assoc.name == :blog }, @inherited_post_associations.detect { |assoc| assoc.name == :blog }
+        end
+
+        test 'a serializer inheriting from another serializer can have an additional association with the same name but with different key' do
+          expected = [:author, :comments, :blog, :reviews].sort
+          result = @inherited_post_serializer.associations.map { |a| a.options.fetch(:key, a.name) }.sort
+          assert_equal(result, expected)
+        end
+      end
     end
   end
 end

data/test/serializers/attribute_test.rb

@@ -22,7 +22,7 @@ module ActiveModel
         inherited_klass = Class.new(AlternateBlogSerializer)
         blog_serializer = inherited_klass.new(@blog)
         adapter = ActiveModelSerializers::Adapter::Attributes.new(blog_serializer)
-        assert_equal({ :id => 1, :title => 'AMS Hints' }, adapter.serializable_hash)
+        assert_equal({ id: 1, title: 'AMS Hints' }, adapter.serializable_hash)
       end
 
       def test_multiple_calls_with_the_same_attribute
@@ -81,7 +81,7 @@ module ActiveModel
         assert_equal('custom', hash[:blog][:id])
       end
 
-      PostWithVirtualAttribute = Class.new(::Model)
+      class PostWithVirtualAttribute < ::Model; end
       class PostWithVirtualAttributeSerializer < ActiveModel::Serializer
         attribute :name do
           "#{object.first_name} #{object.last_name}"

data/test/serializers/attributes_test.rb

@@ -4,7 +4,7 @@ module ActiveModel
   class Serializer
     class AttributesTest < ActiveSupport::TestCase
       def setup
-        @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+        @profile = Profile.new(name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
         @profile_serializer = ProfileSerializer.new(@profile)
         @comment = Comment.new(id: 1, body: 'ZOMG!!', date: '2015')
         @serializer_klass = Class.new(CommentSerializer)

data/test/serializers/fieldset_test.rb

@@ -5,7 +5,7 @@ module ActiveModel
     class FieldsetTest < ActiveSupport::TestCase
       def test_fieldset_with_hash
         fieldset = ActiveModel::Serializer::Fieldset.new('post' => %w(id title), 'comment' => ['body'])
-        expected = { :post => [:id, :title], :comment => [:body] }
+        expected = { post: [:id, :title], comment: [:body] }
 
         assert_equal(expected, fieldset.fields)
       end

data/test/serializers/meta_test.rb

@@ -15,7 +15,8 @@ module ActiveModel
           @blog,
           adapter: :json,
           serializer: AlternateBlogSerializer,
-          meta: { total: 10 }).as_json
+          meta: { total: 10 }
+        ).as_json
         expected = {
           blog: {
             id: 1,
@@ -65,7 +66,8 @@ module ActiveModel
           @blog,
           adapter: :attributes,
           serializer: AlternateBlogSerializer,
-          meta: { total: 10 }).as_json
+          meta: { total: 10 }
+        ).as_json
         expected = {
           id: 1,
           title: 'AMS Hints'
@@ -79,7 +81,8 @@ module ActiveModel
           adapter: :json,
           serializer: AlternateBlogSerializer,
           meta: { total: 10 },
-          meta_key: 'haha_meta').as_json
+          meta_key: 'haha_meta'
+        ).as_json
         expected = {
           blog: {
             id: 1,
@@ -98,7 +101,8 @@ module ActiveModel
           adapter: :json_api,
           serializer: AlternateBlogSerializer,
           meta: { total: 10 },
-          meta_key: 'haha_meta').as_json
+          meta_key: 'haha_meta'
+        ).as_json
         expected = {
           data: {
             id: '1',
@@ -148,7 +152,8 @@ module ActiveModel
         actual = ActiveModelSerializers::SerializableResource.new(
           [@blog],
           adapter: :attributes,
-          meta: { total: 10 }).as_json
+          meta: { total: 10 }
+        ).as_json
         expected = [{
           id: 1,
           name: 'AMS Hints',
@@ -170,7 +175,8 @@ module ActiveModel
           [@blog],
           adapter: :json,
           meta: { total: 10 },
-          meta_key: 'haha_meta').as_json
+          meta_key: 'haha_meta'
+        ).as_json
         expected = {
           blogs: [{
             id: 1,

data/test/serializers/root_test.rb

@@ -8,7 +8,7 @@ module ActiveModel
       end
 
       def test_overwrite_root
-        serializer = VirtualValueSerializer.new(@virtual_value, { root: 'smth' })
+        serializer = VirtualValueSerializer.new(@virtual_value, root: 'smth')
         assert_equal('smth', serializer.json_key)
       end
 

data/test/serializers/serializer_for_test.rb

@@ -28,8 +28,8 @@ module ActiveModel
 
       class SerializerTest < ActiveSupport::TestCase
         module ResourceNamespace
-          Post    = Class.new(::Model)
-          Comment = Class.new(::Model)
+          class Post    < ::Model; end
+          class Comment < ::Model; end
 
           class PostSerializer < ActiveModel::Serializer
             class CommentSerializer < ActiveModel::Serializer
@@ -41,10 +41,12 @@ module ActiveModel
         end
 
         class CustomProfile
-          def serializer_class; ProfileSerializer; end
+          def serializer_class
+            ProfileSerializer
+          end
         end
 
-        Tweet = Class.new(::Model)
+        class Tweet < ::Model; end
         TweetSerializer = Class.new
 
         def setup

data/test/serializers/serializer_for_with_namespace_test.rb

@@ -0,0 +1,87 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class SerializerForWithNamespaceTest < ActiveSupport::TestCase
+      class Book < ::Model; end
+      class Page < ::Model; end
+      class Publisher < ::Model; end
+
+      module Api
+        module V3
+          class BookSerializer < ActiveModel::Serializer
+            attributes :title, :author_name
+
+            has_many :pages
+            belongs_to :publisher
+          end
+
+          class PageSerializer < ActiveModel::Serializer
+            attributes :number, :text
+
+            belongs_to :book
+          end
+
+          class PublisherSerializer < ActiveModel::Serializer
+            attributes :name
+          end
+        end
+      end
+
+      class BookSerializer < ActiveModel::Serializer
+        attributes :title, :author_name
+      end
+      test 'resource without a namespace' do
+        book = Book.new(title: 'A Post', author_name: 'hello')
+
+        # TODO: this should be able to pull up this serializer without explicitly specifying the serializer
+        #       currently, with no options, it still uses the Api::V3 serializer
+        result = ActiveModelSerializers::SerializableResource.new(book, serializer: BookSerializer).serializable_hash
+
+        expected = { title: 'A Post', author_name: 'hello' }
+        assert_equal expected, result
+      end
+
+      test 'resource with namespace' do
+        book = Book.new(title: 'A Post', author_name: 'hi')
+
+        result = ActiveModelSerializers::SerializableResource.new(book, namespace: Api::V3).serializable_hash
+
+        expected = { title: 'A Post', author_name: 'hi', pages: nil, publisher: nil }
+        assert_equal expected, result
+      end
+
+      test 'has_many with nested serializer under the namespace' do
+        page = Page.new(number: 1, text: 'hello')
+        book = Book.new(title: 'A Post', author_name: 'hi', pages: [page])
+
+        result = ActiveModelSerializers::SerializableResource.new(book, namespace: Api::V3).serializable_hash
+
+        expected = {
+          title: 'A Post', author_name: 'hi',
+          publisher: nil,
+          pages: [{
+            number: 1, text: 'hello'
+          }]
+        }
+        assert_equal expected, result
+      end
+
+      test 'belongs_to with nested serializer under the namespace' do
+        publisher = Publisher.new(name: 'Disney')
+        book = Book.new(title: 'A Post', author_name: 'hi', publisher: publisher)
+
+        result = ActiveModelSerializers::SerializableResource.new(book, namespace: Api::V3).serializable_hash
+
+        expected = {
+          title: 'A Post', author_name: 'hi',
+          pages: nil,
+          publisher: {
+            name: 'Disney'
+          }
+        }
+        assert_equal expected, result
+      end
+    end
+  end
+end

data/test/support/isolated_unit.rb

@@ -41,6 +41,7 @@ require 'active_support/core_ext/string/access'
 
 # These files do not require any others and are needed
 # to run the tests
+require 'active_support/testing/autorun'
 require 'active_support/testing/isolation'
 
 module TestHelpers
@@ -74,6 +75,8 @@ module TestHelpers
   end
 end
 
-class ActiveSupport::TestCase
-  include TestHelpers::Generation
+module ActiveSupport
+  class TestCase
+    include TestHelpers::Generation
+  end
 end

data/test/support/rails5_shims.rb

@@ -1,7 +1,7 @@
 module Rails5Shims
   module ControllerTests
     # https://github.com/rails/rails/blob/b217354/actionpack/lib/action_controller/test_case.rb
-    REQUEST_KWARGS = [:params, :session, :flash, :method, :body, :xhr].freeze
+    REQUEST_KWARGS = [:params, :headers, :session, :flash, :method, :body, :xhr].freeze
 
     def get(path, *args)
       fold_kwargs!(args)
@@ -30,7 +30,12 @@ module Rails5Shims
       return unless hash.respond_to?(:key)
       Rails5Shims::ControllerTests::REQUEST_KWARGS.each do |kwarg|
         next unless hash.key?(kwarg)
-        hash.merge! hash.delete(kwarg)
+        value = hash.delete(kwarg)
+        if value.is_a? String
+          args.insert(0, value)
+        else
+          hash.merge! value
+        end
       end
     end
 
@@ -44,4 +49,5 @@ module Rails5Shims
 end
 if Rails::VERSION::MAJOR < 5
   ActionController::TestCase.send :include, Rails5Shims::ControllerTests
+  ActionDispatch::IntegrationTest.send :include, Rails5Shims::ControllerTests
 end

data/test/support/rails_app.rb

@@ -22,15 +22,6 @@ ActionController::TestCase.class_eval do
   def setup
     @routes = Routes
   end
-
-  # For Rails5
-  # https://github.com/rails/rails/commit/ca83436d1b3b6cedd1eca2259f65661e69b01909#diff-b9bbf56e85d3fe1999f16317f2751e76L17
-  def assigns(key = nil)
-    warn "DEPRECATION: Calling 'assigns(#{key})' from #{caller[0]}"
-    assigns = {}.with_indifferent_access
-    @controller.view_assigns.each { |k, v| assigns.regular_writer(k, v) }
-    key.nil? ? assigns : assigns[key]
-  end
 end
 
 # ActiveRecord::Migrator.migrations_paths = [File.expand_path("../../test/dummy/db/migrate", __FILE__)]

data/test/support/serialization_testing.rb

@@ -9,6 +9,22 @@ module SerializationTesting
     ActiveModelSerializers::SerializableResource.new(obj).to_json
   end
 
+  def with_namespace_separator(separator)
+    original_separator = ActiveModelSerializers.config.jsonapi_namespace_separator
+    ActiveModelSerializers.config.jsonapi_namespace_separator = separator
+    yield
+  ensure
+    ActiveModelSerializers.config.jsonapi_namespace_separator = original_separator
+  end
+
+  def with_prepended_lookup(lookup_proc)
+    original_lookup = ActiveModelSerializers.config.serializer_lookup_cahin
+    ActiveModelSerializers.config.serializer_lookup_chain.unshift lookup_proc
+    yield
+  ensure
+    ActiveModelSerializers.config.serializer_lookup_cahin = original_lookup
+  end
+
   # Aliased as :with_configured_adapter to clarify that
   # this method tests the configured adapter.
   # When not testing configuration, it may be preferable
@@ -44,10 +60,12 @@ module SerializationTesting
   end
 end
 
-class Minitest::Test
-  def before_setup
-    ActionController::Base.cache_store.clear
-  end
+module Minitest
+  class Test
+    def before_setup
+      ActionController::Base.cache_store.clear
+    end
 
-  include SerializationTesting
+    include SerializationTesting
+  end
 end

data/test/test_helper.rb

@@ -9,6 +9,7 @@ rescue LoadError
   STDERR.puts 'Running without SimpleCov'
 end
 
+require 'pry'
 require 'timecop'
 require 'rails'
 require 'action_controller'