active_model_serializers 0.10.7 → 0.10.12

data/docs/rfcs/0000-namespace.md

@@ -1,106 +0,0 @@
-- Start Date: (2015-10-29)
-- RFC PR: https://github.com/rails-api/active_model_serializers/pull/1310
-- ActiveModelSerializers Issue: https://github.com/rails-api/active_model_serializers/issues/1298
-
-# Summary
-
-Provide a consistent API for the user of the AMS.
-
-# Motivation
-
-The actual public API is defined under `ActiveModelSerializers`,
-`ActiveModel::Serializer` and `ActiveModel`.
-
-At the `ActiveModel::Serializer` we have:
-
-- `ActiveModel::Serializer.config`
-- `ActiveModel::Serializer`
-
-At the `ActiveModelSerializers` we have:
-
-- `ActiveModelSerializers::Model`
-- `ActiveModelSerializers.logger`
-
-At `ActiveModel` we have:
-
-- `ActiveModel::SerializableResource`
-
-The idea here is to provide a single namespace `ActiveModelSerializers` to the user.
-Following the same idea we have on other gems like
-[Devise](https://github.com/plataformatec/devise/blob/e9c82472ffe7c43a448945f77e034a0e47dde0bb/lib/devise.rb),
-[Refile](https://github.com/refile/refile/blob/6b24c293d044862dafbf1bfa4606672a64903aa2/lib/refile.rb) and
-[Active Job](https://github.com/rails/rails/blob/30bacc26f8f258b39e12f63fe52389a968d9c1ea/activejob/lib/active_job.rb)
-for example.
-
-This way we are clarifing the boundaries of
-[ActiveModelSerializers and Rails](https://github.com/rails-api/active_model_serializers/blob/master/CHANGELOG.md#prehistory)
-and make clear that the `ActiveModel::Serializer` class is no longer the primary
-behavior of the ActiveModelSerializers.
-
-# Detailed design
-
-## New classes and modules organization
-
-Since this will be a big change we can do this on baby steps, read small pull requests. A
-possible approach is:
-
-- All new code will be in `lib/active_model_serializers/` using
-  the module namespace `ActiveModelSerializers`.
-- Move all content under `ActiveModel::Serializer` to be under
-  `ActiveModelSerializers`, the adapter is on this steps;
-- Move all content under `ActiveModel` to be under `ActiveModelSerializers`,
-  the `SerializableResource` is on this step;
-- Change all public API that doesn't make sense, keeping in mind only to keep
-  this in the same namespace
-- Update the README;
-- Update the docs;
-
-The following table represents the current and the desired classes and modules
-at the first moment.
-
-| Current                                                | Desired                                          | Notes              |
-|--------------------------------------------------------|--------------------------------------------------|--------------------|
-| `ActiveModelSerializers` and `ActiveModel::Serializer` | `ActiveModelSerializers`                         | The main namespace |
-| `ActiveModelSerializers.logger`                        | `ActiveModelSerializers.logger`                  ||
-| `ActiveModelSerializers::Model`                        | `ActiveModelSerializers::Model`                  ||
-| `ActiveModel::SerializableResource`                    | `ActiveModelSerializers::SerializableResource`   ||
-| `ActiveModel::Serializer`                              | `ActiveModelSerializers::Serializer`             | The name can be discussed in a future pull request. For example, we can rename this to `Resource` [following this idea](https://github.com/rails-api/active_model_serializers/pull/1301/files#r42963185) more info about naming in the next section|
-| `ActiveModel::Serializer.config`                       | `ActiveModelSerializers.config`                ||
-
-## Renaming of class and modules
-
-When moving some content to the new namespace we can find some names that does
-not make much sense like `ActiveModel::Serializer::Adapter::JsonApi`.
-Discussion of renaming existing classes / modules and JsonApi objects will
-happen in separate pull requests, and issues, and in the google doc
-https://docs.google.com/document/d/1rcrJr0sVcazY2Opd_6Kmv1iIwuHbI84s1P_NzFn-05c/edit?usp=sharing
-
-Some of names already have a definition.
-
-- Adapters get their own namespace under ActiveModelSerializers. E.g
-  `ActiveModelSerializers::Adapter`
-- Serializers get their own namespace under ActiveModelSerializers. E.g
-  `ActiveModelSerializers::Serializer`
-
-## Keeping compatibility
-
-All moved classes or modules be aliased to their old name and location with
-deprecation warnings, such as
-[was done for CollectionSerializer](https://github.com/rails-api/active_model_serializers/pull/1251).
-
-# Drawbacks
-
-This will be a breaking change, so all users serializers will be broken after a
-major bump.
-All pull requests will need to rebase since the architeture will change a lot.
-
-# Alternatives
-
-We can keep the way it is, and keep in mind to not add another namespace as a
-public API.
-
-# Unresolved questions
-
-What is the better class name to be used to the class that will be inherited at
-the creation of a serializer. This can be discussed in other RFC or directly via
-pull request.

data/docs/rfcs/template.md

@@ -1,15 +0,0 @@
-- Start Date: (YYYY-MM-DD)
-- RFC PR: https://github.com/rails-api/active_model_serializers/pull/dddd
-- ActiveModelSerializers Issue: https://github.com/rails-api/active_model_serializers/issues/dddd
-
-# Summary
-
-# Motivation
-
-# Detailed design
-
-# Drawbacks
-
-# Alternatives
-
-# Unresolved questions

data/test/action_controller/adapter_selector_test.rb

@@ -1,62 +0,0 @@
-require 'test_helper'
-
-module ActionController
-  module Serialization
-    class AdapterSelectorTest < ActionController::TestCase
-      class Profile < Model
-        attributes :id, :name, :description
-        associations :comments
-      end
-      class ProfileSerializer < ActiveModel::Serializer
-        type 'profiles'
-        attributes :name, :description
-      end
-
-      class AdapterSelectorTestController < ActionController::Base
-        def render_using_default_adapter
-          @profile = Profile.new(name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
-          render json: @profile
-        end
-
-        def render_using_adapter_override
-          @profile = Profile.new(id: 'render_using_adapter_override', name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
-          render json: @profile, adapter: :json_api
-        end
-
-        def render_skipping_adapter
-          @profile = Profile.new(id: 'render_skipping_adapter_id', name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
-          render json: @profile, adapter: false
-        end
-      end
-
-      tests AdapterSelectorTestController
-
-      def test_render_using_default_adapter
-        get :render_using_default_adapter
-        assert_equal '{"name":"Name 1","description":"Description 1"}', response.body
-      end
-
-      def test_render_using_adapter_override
-        get :render_using_adapter_override
-
-        expected = {
-          data: {
-            id: 'render_using_adapter_override',
-            type: 'profiles',
-            attributes: {
-              name: 'Name 1',
-              description: 'Description 1'
-            }
-          }
-        }
-
-        assert_equal expected.to_json, response.body
-      end
-
-      def test_render_skipping_adapter
-        get :render_skipping_adapter
-        assert_equal '{"id":"render_skipping_adapter_id","name":"Name 1","description":"Description 1"}', response.body
-      end
-    end
-  end
-end

data/test/action_controller/explicit_serializer_test.rb

@@ -1,135 +0,0 @@
-require 'test_helper'
-
-module ActionController
-  module Serialization
-    class ExplicitSerializerTest < ActionController::TestCase
-      class ExplicitSerializerTestController < ActionController::Base
-        def render_using_explicit_serializer
-          @profile = Profile.new(name: 'Name 1',
-                                 description: 'Description 1',
-                                 comments: 'Comments 1')
-          render json: @profile, serializer: ProfilePreviewSerializer
-        end
-
-        def render_array_using_explicit_serializer
-          array = [
-            Profile.new(name: 'Name 1',
-                        description: 'Description 1',
-                        comments: 'Comments 1'),
-            Profile.new(name: 'Name 2',
-                        description: 'Description 2',
-                        comments: 'Comments 2')
-          ]
-          render json: array,
-                 serializer: PaginatedSerializer,
-                 each_serializer: ProfilePreviewSerializer
-        end
-
-        def render_array_using_implicit_serializer
-          array = [
-            Profile.new(name: 'Name 1',
-                        description: 'Description 1',
-                        comments: 'Comments 1'),
-            Profile.new(name: 'Name 2',
-                        description: 'Description 2',
-                        comments: 'Comments 2')
-          ]
-          render json: array,
-                 each_serializer: ProfilePreviewSerializer
-        end
-
-        def render_array_using_explicit_serializer_and_custom_serializers
-          @post = Post.new(title: 'New Post', body: 'Body')
-          @author = Author.new(name: 'Jane Blogger')
-          @author.posts = [@post]
-          @post.author = @author
-          @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
-          @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
-          @post.comments = [@first_comment, @second_comment]
-          @first_comment.post = @post
-          @first_comment.author = nil
-          @second_comment.post = @post
-          @second_comment.author = nil
-          @blog = Blog.new(id: 23, name: 'AMS Blog')
-          @post.blog = @blog
-
-          render json: [@post], each_serializer: PostPreviewSerializer
-        end
-
-        def render_using_explicit_each_serializer
-          location       = Location.new(id: 42, lat: '-23.550520', lng: '-46.633309')
-          place          = Place.new(id: 1337, name: 'Amazing Place', locations: [location])
-
-          render json: place, each_serializer: PlaceSerializer
-        end
-      end
-
-      tests ExplicitSerializerTestController
-
-      def test_render_using_explicit_serializer
-        get :render_using_explicit_serializer
-
-        assert_equal 'application/json', @response.content_type
-        assert_equal '{"name":"Name 1"}', @response.body
-      end
-
-      def test_render_array_using_explicit_serializer
-        get :render_array_using_explicit_serializer
-        assert_equal 'application/json', @response.content_type
-
-        expected = [
-          { 'name' => 'Name 1' },
-          { 'name' => 'Name 2' }
-        ]
-
-        assert_equal expected.to_json, @response.body
-      end
-
-      def test_render_array_using_implicit_serializer
-        get :render_array_using_implicit_serializer
-        assert_equal 'application/json', @response.content_type
-
-        expected = [
-          { 'name' => 'Name 1' },
-          { 'name' => 'Name 2' }
-        ]
-        assert_equal expected.to_json, @response.body
-      end
-
-      def test_render_array_using_explicit_serializer_and_custom_serializers
-        get :render_array_using_explicit_serializer_and_custom_serializers
-
-        expected = [
-          {
-            'title' => 'New Post',
-            'body' => 'Body',
-            'id' => @controller.instance_variable_get(:@post).id,
-            'comments' => [{ 'id' => 1 }, { 'id' => 2 }],
-            'author' => { 'id' => @controller.instance_variable_get(:@author).id }
-          }
-        ]
-
-        assert_equal expected.to_json, @response.body
-      end
-
-      def test_render_using_explicit_each_serializer
-        get :render_using_explicit_each_serializer
-
-        expected = {
-          id: 1337,
-          name: 'Amazing Place',
-          locations: [
-            {
-              id: 42,
-              lat: '-23.550520',
-              lng: '-46.633309',
-              address: 'Nowhere' # is a virtual attribute on LocationSerializer
-            }
-          ]
-        }
-
-        assert_equal expected.to_json, response.body
-      end
-    end
-  end
-end

data/test/action_controller/json/include_test.rb

@@ -1,246 +0,0 @@
-require 'test_helper'
-
-module ActionController
-  module Serialization
-    class Json
-      class IncludeTest < ActionController::TestCase
-        INCLUDE_STRING = 'posts.comments'.freeze
-        INCLUDE_HASH = { posts: :comments }.freeze
-        DEEP_INCLUDE = 'posts.comments.author'.freeze
-
-        class IncludeTestController < ActionController::Base
-          def setup_data
-            ActionController::Base.cache_store.clear
-
-            @author = Author.new(id: 1, name: 'Steve K.')
-
-            @post = Post.new(id: 42, title: 'New Post', body: 'Body')
-            @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
-            @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
-
-            @post.comments = [@first_comment, @second_comment]
-            @post.author = @author
-
-            @first_comment.post = @post
-            @second_comment.post = @post
-
-            @blog = Blog.new(id: 1, name: 'My Blog!!')
-            @post.blog = @blog
-            @author.posts = [@post]
-
-            @first_comment.author = @author
-            @second_comment.author = @author
-            @author.comments = [@first_comment, @second_comment]
-            @author.roles = []
-            @author.bio = {}
-          end
-
-          def render_without_include
-            setup_data
-            render json: @author, adapter: :json
-          end
-
-          def render_resource_with_include_hash
-            setup_data
-            render json: @author, include: INCLUDE_HASH, adapter: :json
-          end
-
-          def render_resource_with_include_string
-            setup_data
-            render json: @author, include: INCLUDE_STRING, adapter: :json
-          end
-
-          def render_resource_with_deep_include
-            setup_data
-            render json: @author, include: DEEP_INCLUDE, adapter: :json
-          end
-
-          def render_without_recursive_relationships
-            # testing recursive includes ('**') can't have any cycles in the
-            # relationships, or we enter an infinite loop.
-            author = Author.new(id: 11, name: 'Jane Doe')
-            post = Post.new(id: 12, title: 'Hello World', body: 'My first post')
-            comment = Comment.new(id: 13, body: 'Commentary')
-            author.posts = [post]
-            post.comments = [comment]
-            render json: author
-          end
-        end
-
-        tests IncludeTestController
-
-        def test_render_without_include
-          get :render_without_include
-          response = JSON.parse(@response.body)
-          expected = {
-            'author' => {
-              'id' => 1,
-              'name' => 'Steve K.',
-              'posts' => [
-                {
-                  'id' => 42, 'title' => 'New Post', 'body' => 'Body'
-                }
-              ],
-              'roles' => [],
-              'bio' => {}
-            }
-          }
-
-          assert_equal(expected, response)
-        end
-
-        def test_render_resource_with_include_hash
-          get :render_resource_with_include_hash
-          response = JSON.parse(@response.body)
-
-          assert_equal(expected_include_response, response)
-        end
-
-        def test_render_resource_with_include_string
-          get :render_resource_with_include_string
-
-          response = JSON.parse(@response.body)
-
-          assert_equal(expected_include_response, response)
-        end
-
-        def test_render_resource_with_deep_include
-          get :render_resource_with_deep_include
-
-          response = JSON.parse(@response.body)
-
-          assert_equal(expected_deep_include_response, response)
-        end
-
-        def test_render_with_empty_default_includes
-          with_default_includes '' do
-            get :render_without_include
-            response = JSON.parse(@response.body)
-            expected = {
-              'author' => {
-                'id' => 1,
-                'name' => 'Steve K.'
-              }
-            }
-            assert_equal(expected, response)
-          end
-        end
-
-        def test_render_with_recursive_default_includes
-          with_default_includes '**' do
-            get :render_without_recursive_relationships
-            response = JSON.parse(@response.body)
-
-            expected = {
-              'id' => 11,
-              'name' => 'Jane Doe',
-              'roles' => nil,
-              'bio' => nil,
-              'posts' => [
-                {
-                  'id' => 12,
-                  'title' => 'Hello World',
-                  'body' => 'My first post',
-                  'comments' => [
-                    {
-                      'id' => 13,
-                      'body' => 'Commentary',
-                      'post' => nil, # not set to avoid infinite recursion
-                      'author' => nil, # not set to avoid infinite recursion
-                    }
-                  ],
-                  'blog' => {
-                    'id' => 999,
-                    'name' => 'Custom blog',
-                    'writer' => nil,
-                    'articles' => nil
-                  },
-                  'author' => nil # not set to avoid infinite recursion
-                }
-              ]
-            }
-            assert_equal(expected, response)
-          end
-        end
-
-        def test_render_with_includes_overrides_default_includes
-          with_default_includes '' do
-            get :render_resource_with_include_hash
-            response = JSON.parse(@response.body)
-
-            assert_equal(expected_include_response, response)
-          end
-        end
-
-        private
-
-        def expected_include_response
-          {
-            'author' => {
-              'id' => 1,
-              'name' => 'Steve K.',
-              'posts' => [
-                {
-                  'id' => 42, 'title' => 'New Post', 'body' => 'Body',
-                  'comments' => [
-                    {
-                      'id' => 1, 'body' => 'ZOMG A COMMENT'
-                    },
-                    {
-                      'id' => 2, 'body' => 'ZOMG ANOTHER COMMENT'
-                    }
-                  ]
-                }
-              ]
-            }
-          }
-        end
-
-        def expected_deep_include_response
-          {
-            'author' => {
-              'id' => 1,
-              'name' => 'Steve K.',
-              'posts' => [
-                {
-                  'id' => 42, 'title' => 'New Post', 'body' => 'Body',
-                  'comments' => [
-                    {
-                      'id' => 1, 'body' => 'ZOMG A COMMENT',
-                      'author' => {
-                        'id' => 1,
-                        'name' => 'Steve K.'
-                      }
-                    },
-                    {
-                      'id' => 2, 'body' => 'ZOMG ANOTHER COMMENT',
-                      'author' => {
-                        'id' => 1,
-                        'name' => 'Steve K.'
-                      }
-                    }
-                  ]
-                }
-              ]
-            }
-          }
-        end
-
-        def with_default_includes(include_directive)
-          original = ActiveModelSerializers.config.default_includes
-          ActiveModelSerializers.config.default_includes = include_directive
-          clear_include_directive_cache
-          yield
-        ensure
-          ActiveModelSerializers.config.default_includes = original
-          clear_include_directive_cache
-        end
-
-        def clear_include_directive_cache
-          ActiveModelSerializers
-            .instance_variable_set(:@default_include_directive, nil)
-        end
-      end
-    end
-  end
-end