active_model_serializers 0.10.2 → 0.10.3

data/test/generators/serializer_generator_test.rb

@@ -20,11 +20,10 @@ class SerializerGeneratorTest < Rails::Generators::TestCase
   end
 
   def test_uses_application_serializer_if_one_exists
-    Object.const_set(:ApplicationSerializer, Class.new)
-    run_generator
-    assert_file 'app/serializers/account_serializer.rb', /class AccountSerializer < ApplicationSerializer/
-  ensure
-    Object.send :remove_const, :ApplicationSerializer
+    stub_safe_constantize(expected: 'ApplicationSerializer') do
+      run_generator
+      assert_file 'app/serializers/account_serializer.rb', /class AccountSerializer < ApplicationSerializer/
+    end
   end
 
   def test_uses_given_parent
@@ -54,4 +53,22 @@ class SerializerGeneratorTest < Rails::Generators::TestCase
       end
     end
   end
+
+  private
+
+  def stub_safe_constantize(expected:)
+    String.class_eval do
+      alias_method :old, :safe_constantize
+    end
+    String.send(:define_method, :safe_constantize) do
+      Class if self == expected
+    end
+
+    yield
+  ensure
+    String.class_eval do
+      alias_method :safe_constantize, :old
+      undef_method :old
+    end
+  end
 end

data/test/serializers/association_macros_test.rb

@@ -3,7 +3,8 @@ require 'test_helper'
 module ActiveModel
   class Serializer
     class AssociationMacrosTest < ActiveSupport::TestCase
-      AuthorSummarySerializer = Class.new
+      class AuthorSummarySerializer < ActiveModel::Serializer; end
+
       class AssociationsTestSerializer < Serializer
         belongs_to :author, serializer: AuthorSummarySerializer
         has_many :comments
@@ -11,7 +12,7 @@ module ActiveModel
       end
 
       def before_setup
-        @reflections = AssociationsTestSerializer._reflections
+        @reflections = AssociationsTestSerializer._reflections.values
       end
 
       def test_has_one_defines_reflection

data/test/serializers/associations_test.rb

@@ -1,5 +1,4 @@
 require 'test_helper'
-
 module ActiveModel
   class Serializer
     class AssociationsTest < ActiveSupport::TestCase
@@ -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
         )
@@ -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

@@ -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/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
@@ -46,7 +46,7 @@ module ActiveModel
           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/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

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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_model_serializers
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.10.3
 platform: ruby
 authors:
 - Steve Klabnik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-05 00:00:00.000000000 Z
+date: 2016-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -60,7 +60,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -74,14 +74,14 @@ dependencies:
   name: jsonapi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.1.1.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.1.1.beta2
 - !ruby/object:Gem::Dependency
@@ -249,6 +249,7 @@ files:
 - ".simplecov"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
 - MIT-LICENSE
@@ -275,11 +276,14 @@ files:
 - docs/general/serializers.md
 - docs/how-open-source-maintained.jpg
 - docs/howto/add_pagination_links.md
+- docs/howto/add_relationship_links.md
 - docs/howto/add_root_key.md
+- docs/howto/grape_integration.md
 - docs/howto/outside_controller_use.md
 - docs/howto/passing_arbitrary_options.md
 - docs/howto/serialize_poro.md
 - docs/howto/test.md
+- docs/howto/upgrade_from_0_8_to_0_10.md
 - docs/integrations/ember-and-json-api.md
 - docs/integrations/grape.md
 - docs/jsonapi/errors.md
@@ -298,27 +302,27 @@ files:
 - lib/active_model/serializer/adapter/null.rb
 - lib/active_model/serializer/array_serializer.rb
 - lib/active_model/serializer/association.rb
-- lib/active_model/serializer/associations.rb
 - lib/active_model/serializer/attribute.rb
-- lib/active_model/serializer/attributes.rb
 - lib/active_model/serializer/belongs_to_reflection.rb
-- lib/active_model/serializer/caching.rb
 - lib/active_model/serializer/collection_reflection.rb
 - lib/active_model/serializer/collection_serializer.rb
-- lib/active_model/serializer/configuration.rb
+- lib/active_model/serializer/concerns/associations.rb
+- lib/active_model/serializer/concerns/attributes.rb
+- lib/active_model/serializer/concerns/caching.rb
+- lib/active_model/serializer/concerns/configuration.rb
+- lib/active_model/serializer/concerns/links.rb
+- lib/active_model/serializer/concerns/meta.rb
+- lib/active_model/serializer/concerns/type.rb
 - lib/active_model/serializer/error_serializer.rb
 - lib/active_model/serializer/errors_serializer.rb
 - lib/active_model/serializer/field.rb
 - lib/active_model/serializer/fieldset.rb
 - lib/active_model/serializer/has_many_reflection.rb
 - lib/active_model/serializer/has_one_reflection.rb
-- lib/active_model/serializer/links.rb
 - lib/active_model/serializer/lint.rb
-- lib/active_model/serializer/meta.rb
 - lib/active_model/serializer/null.rb
 - lib/active_model/serializer/reflection.rb
 - lib/active_model/serializer/singular_reflection.rb
-- lib/active_model/serializer/type.rb
 - lib/active_model/serializer/version.rb
 - lib/active_model_serializers.rb
 - lib/active_model_serializers/adapter.rb
@@ -341,6 +345,7 @@ files:
 - lib/active_model_serializers/json_pointer.rb
 - lib/active_model_serializers/key_transform.rb
 - lib/active_model_serializers/logging.rb
+- lib/active_model_serializers/lookup_chain.rb
 - lib/active_model_serializers/model.rb
 - lib/active_model_serializers/railtie.rb
 - lib/active_model_serializers/register_jsonapi_renderer.rb
@@ -361,9 +366,12 @@ files:
 - test/action_controller/json/include_test.rb
 - test/action_controller/json_api/deserialization_test.rb
 - test/action_controller/json_api/errors_test.rb
+- test/action_controller/json_api/fields_test.rb
 - test/action_controller/json_api/linked_test.rb
 - test/action_controller/json_api/pagination_test.rb
 - test/action_controller/json_api/transform_test.rb
+- test/action_controller/lookup_proc_test.rb
+- test/action_controller/namespace_lookup_test.rb
 - test/action_controller/serialization_scope_name_test.rb
 - test/action_controller/serialization_test.rb
 - test/active_model_serializers/adapter_for_test.rb
@@ -377,6 +385,7 @@ files:
 - test/active_model_serializers/test/schema_test.rb
 - test/active_model_serializers/test/serializer_test.rb
 - test/active_record_test.rb
+- test/adapter/attributes_test.rb
 - test/adapter/deprecation_test.rb
 - test/adapter/json/belongs_to_test.rb
 - test/adapter/json/collection_test.rb
@@ -390,13 +399,13 @@ files:
 - test/adapter/json_api/has_many_explicit_serializer_test.rb
 - test/adapter/json_api/has_many_test.rb
 - test/adapter/json_api/has_one_test.rb
+- test/adapter/json_api/include_data_if_sideloaded_test.rb
 - test/adapter/json_api/json_api_test.rb
 - test/adapter/json_api/linked_test.rb
 - test/adapter/json_api/links_test.rb
 - test/adapter/json_api/pagination_links_test.rb
 - test/adapter/json_api/parse_test.rb
 - test/adapter/json_api/relationship_test.rb
-- test/adapter/json_api/relationships_test.rb
 - test/adapter/json_api/resource_identifier_test.rb
 - test/adapter/json_api/resource_meta_test.rb
 - test/adapter/json_api/toplevel_jsonapi_test.rb
@@ -409,7 +418,10 @@ files:
 - test/array_serializer_test.rb
 - test/benchmark/app.rb
 - test/benchmark/benchmarking_support.rb
+- test/benchmark/bm_active_record.rb
+- test/benchmark/bm_adapter.rb
 - test/benchmark/bm_caching.rb
+- test/benchmark/bm_lookup_chain.rb
 - test/benchmark/bm_transform.rb
 - test/benchmark/config.ru
 - test/benchmark/controllers.rb
@@ -438,6 +450,7 @@ files:
 - test/serializers/root_test.rb
 - test/serializers/serialization_test.rb
 - test/serializers/serializer_for_test.rb
+- test/serializers/serializer_for_with_namespace_test.rb
 - test/support/custom_schemas/active_model_serializers/test/schema_test/my/index.json
 - test/support/isolated_unit.rb
 - test/support/rails5_shims.rb
@@ -480,9 +493,12 @@ test_files:
 - test/action_controller/json/include_test.rb
 - test/action_controller/json_api/deserialization_test.rb
 - test/action_controller/json_api/errors_test.rb
+- test/action_controller/json_api/fields_test.rb
 - test/action_controller/json_api/linked_test.rb
 - test/action_controller/json_api/pagination_test.rb
 - test/action_controller/json_api/transform_test.rb
+- test/action_controller/lookup_proc_test.rb
+- test/action_controller/namespace_lookup_test.rb
 - test/action_controller/serialization_scope_name_test.rb
 - test/action_controller/serialization_test.rb
 - test/active_model_serializers/adapter_for_test.rb
@@ -496,6 +512,7 @@ test_files:
 - test/active_model_serializers/test/schema_test.rb
 - test/active_model_serializers/test/serializer_test.rb
 - test/active_record_test.rb
+- test/adapter/attributes_test.rb
 - test/adapter/deprecation_test.rb
 - test/adapter/json/belongs_to_test.rb
 - test/adapter/json/collection_test.rb
@@ -509,13 +526,13 @@ test_files:
 - test/adapter/json_api/has_many_explicit_serializer_test.rb
 - test/adapter/json_api/has_many_test.rb
 - test/adapter/json_api/has_one_test.rb
+- test/adapter/json_api/include_data_if_sideloaded_test.rb
 - test/adapter/json_api/json_api_test.rb
 - test/adapter/json_api/linked_test.rb
 - test/adapter/json_api/links_test.rb
 - test/adapter/json_api/pagination_links_test.rb
 - test/adapter/json_api/parse_test.rb
 - test/adapter/json_api/relationship_test.rb
-- test/adapter/json_api/relationships_test.rb
 - test/adapter/json_api/resource_identifier_test.rb
 - test/adapter/json_api/resource_meta_test.rb
 - test/adapter/json_api/toplevel_jsonapi_test.rb
@@ -528,7 +545,10 @@ test_files:
 - test/array_serializer_test.rb
 - test/benchmark/app.rb
 - test/benchmark/benchmarking_support.rb
+- test/benchmark/bm_active_record.rb
+- test/benchmark/bm_adapter.rb
 - test/benchmark/bm_caching.rb
+- test/benchmark/bm_lookup_chain.rb
 - test/benchmark/bm_transform.rb
 - test/benchmark/config.ru
 - test/benchmark/controllers.rb
@@ -557,6 +577,7 @@ test_files:
 - test/serializers/root_test.rb
 - test/serializers/serialization_test.rb
 - test/serializers/serializer_for_test.rb
+- test/serializers/serializer_for_with_namespace_test.rb
 - test/support/custom_schemas/active_model_serializers/test/schema_test/my/index.json
 - test/support/isolated_unit.rb
 - test/support/rails5_shims.rb