active_model_serializers 0.10.0 → 0.10.9

data/test/action_controller/json_api/pagination_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'will_paginate/array'
 require 'kaminari'
@@ -14,9 +16,9 @@ module ActionController
         class PaginationTestController < ActionController::Base
           def setup
             @array = [
-              Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
-              Profile.new({ name: 'Name 2', description: 'Description 2', comments: 'Comments 2' }),
-              Profile.new({ name: 'Name 3', description: 'Description 3', comments: 'Comments 3' })
+              Profile.new(name: 'Name 1', description: 'Description 1', comments: 'Comments 1'),
+              Profile.new(name: 'Name 2', description: 'Description 2', comments: 'Comments 2'),
+              Profile.new(name: 'Name 3', description: 'Description 3', comments: 'Comments 3')
             ]
           end
 
@@ -48,20 +50,22 @@ module ActionController
 
         def test_render_pagination_links_with_will_paginate
           expected_links = { 'self' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=1",
-            'first' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
-            'prev' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
-            'next' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1",
-            'last' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1" }
+                             'first' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
+                             'prev' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
+                             'next' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1",
+                             'last' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1" }
 
           get :render_pagination_using_will_paginate, params: { page: { number: 2, size: 1 } }
           response = JSON.parse(@response.body)
           assert_equal expected_links, response['links']
         end
 
-        def test_render_only_last_and_next_pagination_links
+        def test_render_only_first_last_and_next_pagination_links
           expected_links = { 'self' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2",
-            'next' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2",
-            'last' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2" }
+                             'first' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2",
+                             'prev' => nil,
+                             'next' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2",
+                             'last' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2" }
           get :render_pagination_using_will_paginate, params: { page: { number: 1, size: 2 } }
           response = JSON.parse(@response.body)
           assert_equal expected_links, response['links']
@@ -69,37 +73,43 @@ module ActionController
 
         def test_render_pagination_links_with_kaminari
           expected_links = { 'self' => "#{KAMINARI_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=1",
-            'first' => "#{KAMINARI_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
-            'prev' => "#{KAMINARI_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
-            'next' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1",
-            'last' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1" }
+                             'first' => "#{KAMINARI_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
+                             'prev' => "#{KAMINARI_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
+                             'next' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1",
+                             'last' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1" }
           get :render_pagination_using_kaminari, params: { page: { number: 2, size: 1 } }
           response = JSON.parse(@response.body)
           assert_equal expected_links, response['links']
         end
 
-        def test_render_only_prev_and_first_pagination_links
+        def test_render_only_prev_first_and_last_pagination_links
           expected_links = { 'self' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1",
-            'first' => "#{KAMINARI_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
-            'prev' => "#{KAMINARI_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=1" }
+                             'first' => "#{KAMINARI_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
+                             'prev' => "#{KAMINARI_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=1",
+                             'next' => nil,
+                             'last' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1" }
           get :render_pagination_using_kaminari, params: { page: { number: 3, size: 1 } }
           response = JSON.parse(@response.body)
           assert_equal expected_links, response['links']
         end
 
-        def test_render_only_last_and_next_pagination_links_with_additional_params
+        def test_render_only_first_last_and_next_pagination_links_with_additional_params
           expected_links = { 'self' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2&teste=additional",
-            'next' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2&teste=additional",
-            'last' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2&teste=additional" }
+                             'first' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2&teste=additional",
+                             'prev' => nil,
+                             'next' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2&teste=additional",
+                             'last' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2&teste=additional" }
           get :render_pagination_using_will_paginate, params: { page: { number: 1, size: 2 }, teste: 'additional' }
           response = JSON.parse(@response.body)
           assert_equal expected_links, response['links']
         end
 
-        def test_render_only_prev_and_first_pagination_links_with_additional_params
+        def test_render_only_prev_first_and_last_pagination_links_with_additional_params
           expected_links = { 'self' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1&teste=additional",
-            'first' => "#{KAMINARI_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1&teste=additional",
-            'prev' => "#{KAMINARI_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=1&teste=additional" }
+                             'first' => "#{KAMINARI_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1&teste=additional",
+                             'prev' => "#{KAMINARI_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=1&teste=additional",
+                             'next' => nil,
+                             'last' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1&teste=additional" }
           get :render_pagination_using_kaminari, params: { page: { number: 3, size: 1 }, teste: 'additional' }
           response = JSON.parse(@response.body)
           assert_equal expected_links, response['links']

data/test/action_controller/json_api/transform_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module ActionController
@@ -5,7 +7,17 @@ module ActionController
     class JsonApi
       class KeyTransformTest < ActionController::TestCase
         class KeyTransformTestController < ActionController::Base
-          Post = Class.new(::Model)
+          class Post < ::Model
+            attributes :title, :body, :publish_at
+            associations :author, :top_comments
+          end
+          class Author < ::Model
+            attributes :first_name, :last_name
+          end
+          class TopComment < ::Model
+            attributes :body
+            associations :author, :post
+          end
           class PostSerializer < ActiveModel::Serializer
             type 'posts'
             attributes :title, :body, :publish_at
@@ -22,13 +34,11 @@ module ActionController
             end
           end
 
-          Author = Class.new(::Model)
           class AuthorSerializer < ActiveModel::Serializer
             type 'authors'
             attributes :first_name, :last_name
           end
 
-          TopComment = Class.new(::Model)
           class TopCommentSerializer < ActiveModel::Serializer
             type 'top_comments'
             attributes :body

data/test/action_controller/lookup_proc_test.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class LookupProcTest < ActionController::TestCase
+      module Api
+        module V3
+          class PostCustomSerializer < ActiveModel::Serializer
+            attributes :title, :body
+
+            belongs_to :author
+          end
+
+          class AuthorCustomSerializer < ActiveModel::Serializer
+            attributes :name
+          end
+
+          class LookupProcTestController < ActionController::Base
+            def implicit_namespaced_serializer
+              author = Author.new(name: 'Bob')
+              post = Post.new(title: 'New Post', body: 'Body', author: author)
+
+              render json: post
+            end
+          end
+        end
+      end
+
+      tests Api::V3::LookupProcTestController
+
+      test 'implicitly uses namespaced serializer' do
+        controller_namespace = lambda do |resource_class, _parent_serializer_class, namespace|
+          "#{namespace}::#{resource_class}CustomSerializer" if namespace
+        end
+
+        with_prepended_lookup(controller_namespace) do
+          get :implicit_namespaced_serializer
+
+          assert_serializer Api::V3::PostCustomSerializer
+
+          expected = { 'title' => 'New Post', 'body' => 'Body', 'author' => { 'name' => 'Bob' } }
+          actual = JSON.parse(@response.body)
+
+          assert_equal expected, actual
+        end
+      end
+    end
+  end
+end

data/test/action_controller/namespace_lookup_test.rb

@@ -0,0 +1,234 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class NamespaceLookupTest < ActionController::TestCase
+      class Book < ::Model
+        attributes :id, :title, :body
+        associations :writer, :chapters
+      end
+      class Chapter < ::Model
+        attributes :title
+      end
+      class Writer < ::Model
+        attributes :name
+      end
+
+      module Api
+        module V2
+          class BookSerializer < ActiveModel::Serializer
+            attributes :title
+          end
+        end
+
+        module VHeader
+          class BookSerializer < ActiveModel::Serializer
+            attributes :title, :body
+
+            def body
+              'header'
+            end
+          end
+        end
+
+        module V3
+          class BookSerializer < ActiveModel::Serializer
+            attributes :title, :body
+
+            belongs_to :writer
+            has_many :chapters
+          end
+
+          class ChapterSerializer < ActiveModel::Serializer
+            attribute :title do
+              "Chapter - #{object.title}"
+            end
+          end
+
+          class WriterSerializer < ActiveModel::Serializer
+            attributes :name
+          end
+
+          class LookupTestController < ActionController::Base
+            before_action only: [:namespace_set_in_before_filter] do
+              self.namespace_for_serializer = Api::V2
+            end
+
+            def implicit_namespaced_serializer
+              writer = Writer.new(name: 'Bob')
+              book = Book.new(title: 'New Post', body: 'Body', writer: writer, chapters: [])
+
+              render json: book
+            end
+
+            def implicit_namespaced_collection_serializer
+              chapter1 = Chapter.new(title: 'Oh')
+              chapter2 = Chapter.new(title: 'Oh my')
+
+              render json: [chapter1, chapter2]
+            end
+
+            def implicit_has_many_namespaced_serializer
+              chapter1 = Chapter.new(title: 'Odd World')
+              chapter2 = Chapter.new(title: 'New World')
+              book = Book.new(title: 'New Post', body: 'Body', chapters: [chapter1, chapter2])
+
+              render json: book
+            end
+
+            def explicit_namespace_as_module
+              book = Book.new(title: 'New Post', body: 'Body')
+
+              render json: book, namespace: Api::V2
+            end
+
+            def explicit_namespace_as_string
+              book = Book.new(title: 'New Post', body: 'Body')
+
+              # because this is a string, ruby can't auto-lookup the constant, so otherwise
+              # the lookup thinks we mean ::Api::V2
+              render json: book, namespace: 'ActionController::Serialization::NamespaceLookupTest::Api::V2'
+            end
+
+            def explicit_namespace_as_symbol
+              book = Book.new(title: 'New Post', body: 'Body')
+
+              # because this is a string, ruby can't auto-lookup the constant, so otherwise
+              # the lookup thinks we mean ::Api::V2
+              render json: book, namespace: :'ActionController::Serialization::NamespaceLookupTest::Api::V2'
+            end
+
+            def invalid_namespace
+              book = Book.new(id: 'invalid_namespace_book_id', title: 'New Post', body: 'Body')
+
+              render json: book, namespace: :api_v2
+            end
+
+            def namespace_set_in_before_filter
+              book = Book.new(title: 'New Post', body: 'Body')
+              render json: book
+            end
+
+            def namespace_set_by_request_headers
+              book = Book.new(title: 'New Post', body: 'Body')
+              version_from_header = request.headers['X-API_VERSION']
+              namespace = "ActionController::Serialization::NamespaceLookupTest::#{version_from_header}"
+
+              render json: book, namespace: namespace
+            end
+          end
+        end
+      end
+
+      tests Api::V3::LookupTestController
+
+      setup do
+        @test_namespace = self.class.parent
+      end
+
+      test 'uses request headers to determine the namespace' do
+        request.env['X-API_VERSION'] = 'Api::VHeader'
+        get :namespace_set_by_request_headers
+
+        assert_serializer Api::VHeader::BookSerializer
+      end
+
+      test 'implicitly uses namespaced serializer' do
+        get :implicit_namespaced_serializer
+
+        assert_serializer Api::V3::BookSerializer
+
+        expected = { 'title' => 'New Post', 'body' => 'Body', 'writer' => { 'name' => 'Bob' }, 'chapters' => [] }
+        actual = JSON.parse(@response.body)
+
+        assert_equal expected, actual
+      end
+
+      test 'implicitly uses namespaced serializer for collection' do
+        get :implicit_namespaced_collection_serializer
+
+        assert_serializer 'ActiveModel::Serializer::CollectionSerializer'
+
+        expected = [{ 'title' => 'Chapter - Oh' }, { 'title' => 'Chapter - Oh my' }]
+        actual = JSON.parse(@response.body)
+
+        assert_equal expected, actual
+      end
+
+      test 'implicitly uses namespaced serializer for has_many' do
+        get :implicit_has_many_namespaced_serializer
+
+        assert_serializer Api::V3::BookSerializer
+
+        expected = {
+          'title' => 'New Post',
+          'body' => 'Body', 'writer' => nil,
+          'chapters' => [
+            { 'title' => 'Chapter - Odd World' },
+            { 'title' => 'Chapter - New World' }
+          ]
+        }
+        actual = JSON.parse(@response.body)
+
+        assert_equal expected, actual
+      end
+
+      test 'explicit namespace as module' do
+        get :explicit_namespace_as_module
+
+        assert_serializer Api::V2::BookSerializer
+
+        expected = { 'title' => 'New Post' }
+        actual = JSON.parse(@response.body)
+
+        assert_equal expected, actual
+      end
+
+      test 'explicit namespace as string' do
+        get :explicit_namespace_as_string
+
+        assert_serializer Api::V2::BookSerializer
+
+        expected = { 'title' => 'New Post' }
+        actual = JSON.parse(@response.body)
+
+        assert_equal expected, actual
+      end
+
+      test 'explicit namespace as symbol' do
+        get :explicit_namespace_as_symbol
+
+        assert_serializer Api::V2::BookSerializer
+
+        expected = { 'title' => 'New Post' }
+        actual = JSON.parse(@response.body)
+
+        assert_equal expected, actual
+      end
+
+      test 'invalid namespace' do
+        get :invalid_namespace
+
+        assert_serializer ActiveModel::Serializer::Null
+
+        expected = { 'id' => 'invalid_namespace_book_id', 'title' => 'New Post', 'body' => 'Body' }
+        actual = JSON.parse(@response.body)
+
+        assert_equal expected, actual
+      end
+
+      test 'namespace set in before filter' do
+        get :namespace_set_in_before_filter
+
+        assert_serializer Api::V2::BookSerializer
+
+        expected = { 'title' => 'New Post' }
+        actual = JSON.parse(@response.body)
+
+        assert_equal expected, actual
+      end
+    end
+  end
+end

data/test/action_controller/serialization_scope_name_test.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module SerializationScopeTesting
   class User < ActiveModelSerializers::Model
-    attr_accessor :id, :name, :admin
+    attributes :id, :name, :admin
     def admin?
       admin
     end
   end
   class Comment < ActiveModelSerializers::Model
-    attr_accessor :id, :body
+    attributes :id, :body
   end
   class Post < ActiveModelSerializers::Model
-    attr_accessor :id, :title, :body, :comments
+    attributes :id, :title, :body, :comments
   end
   class PostSerializer < ActiveModel::Serializer
     attributes :id, :title, :body, :comments
@@ -33,7 +35,8 @@ module SerializationScopeTesting
     end
   end
   class PostTestController < ActionController::Base
-    attr_accessor :current_user
+    attr_writer :current_user
+
     def render_post_by_non_admin
       self.current_user = User.new(id: 3, name: 'Pete', admin: false)
       render json: new_post, serializer: serializer, adapter: :json
@@ -44,6 +47,10 @@ module SerializationScopeTesting
       render json: new_post, serializer: serializer, adapter: :json
     end
 
+    def current_user
+      defined?(@current_user) ? @current_user : :current_user_not_set
+    end
+
     private
 
     def new_post
@@ -75,7 +82,8 @@ module SerializationScopeTesting
     end
 
     def test_default_serialization_scope_object
-      assert_equal @controller.current_user, @controller.serialization_scope
+      assert_equal :current_user_not_set, @controller.current_user
+      assert_equal :current_user_not_set, @controller.serialization_scope
     end
 
     def test_default_scope_non_admin
@@ -125,7 +133,7 @@ module SerializationScopeTesting
     end
 
     def test_defined_serialization_scope_object
-      assert_equal @controller.view_context.class, @controller.serialization_scope.class
+      assert_equal @controller.view_context.controller, @controller.serialization_scope.controller
     end
 
     def test_serialization_scope_non_admin

data/test/action_controller/serialization_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module ActionController
@@ -74,7 +76,7 @@ module ActionController
         end
 
         def update_and_render_object_with_cache_enabled
-          @post.updated_at = Time.now
+          @post.updated_at = Time.zone.now
 
           generate_cached_serializer(@post)
           render json: @post
@@ -135,7 +137,7 @@ module ActionController
           like = Like.new(id: 1, likeable: comment, time: 3.days.ago)
 
           generate_cached_serializer(like)
-          like.likable = comment2
+          like.likeable = comment2
           like.time = Time.zone.now.to_s
 
           render json: like
@@ -163,7 +165,7 @@ module ActionController
         end
         expected = {
           data: {
-            id: assigns(:profile).id.to_s,
+            id: @controller.instance_variable_get(:@profile).id.to_s,
             type: 'profiles',
             attributes: {
               name: 'Name 1',
@@ -246,7 +248,7 @@ module ActionController
         expected = {
           data: [
             {
-              id: assigns(:profiles).first.id.to_s,
+              id: @controller.instance_variable_get(:@profiles).first.id.to_s,
               type: 'profiles',
               attributes: {
                 name: 'Name 1',
@@ -269,7 +271,7 @@ module ActionController
         expected = {
           data: [
             {
-              id: assigns(:profiles).first.id.to_s,
+              id: @controller.instance_variable_get(:@profiles).first.id.to_s,
               type: 'profiles',
               attributes: {
                 name: 'Name 1',
@@ -294,7 +296,8 @@ module ActionController
           comments: [
             {
               id: 1,
-              body: 'ZOMG A COMMENT' }
+              body: 'ZOMG A COMMENT'
+            }
           ],
           blog: {
             id: 999,
@@ -333,7 +336,8 @@ module ActionController
           comments: [
             {
               id: 1,
-              body: 'ZOMG A COMMENT' }
+              body: 'ZOMG A COMMENT'
+            }
           ],
           blog: {
             id: 999,
@@ -407,7 +411,8 @@ module ActionController
           comments: [
             {
               id: 1,
-              body: 'ZOMG A COMMENT' }
+              body: 'ZOMG A COMMENT'
+            }
           ],
           blog: {
             id: 999,
@@ -453,14 +458,20 @@ module ActionController
         end
       end
 
-      def test_render_event_is_emmited
-        subscriber = ::ActiveSupport::Notifications.subscribe('render.active_model_serializers') do |name|
-          @name = name
+      def test_render_event_is_emitted
+        subscriber = ::ActiveSupport::Notifications.subscribe('render.active_model_serializers') do |subscribed_event|
+          @subscribed_event = subscribed_event
         end
 
         get :render_using_implicit_serializer
 
-        assert_equal 'render.active_model_serializers', @name
+        subscribed_event_name =
+          if @subscribed_event.is_a?(String)
+            @subscribed_event
+          else
+            @subscribed_event.name # is a ActiveSupport::Notifications::Event
+          end
+        assert_equal 'render.active_model_serializers', subscribed_event_name
       ensure
         ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
       end

data/test/active_model_serializers/adapter_for_test.rb

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

data/test/active_model_serializers/json_pointer_test.rb

@@ -1,20 +1,24 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
-class ActiveModelSerializers::JsonPointerTest < ActiveSupport::TestCase
-  def test_attribute_pointer
-    attribute_name = 'title'
-    pointer = ActiveModelSerializers::JsonPointer.new(:attribute, attribute_name)
-    assert_equal '/data/attributes/title', pointer
-  end
+module ActiveModelSerializers
+  class JsonPointerTest < ActiveSupport::TestCase
+    def test_attribute_pointer
+      attribute_name = 'title'
+      pointer = ActiveModelSerializers::JsonPointer.new(:attribute, attribute_name)
+      assert_equal '/data/attributes/title', pointer
+    end
 
-  def test_primary_data_pointer
-    pointer = ActiveModelSerializers::JsonPointer.new(:primary_data)
-    assert_equal '/data', pointer
-  end
+    def test_primary_data_pointer
+      pointer = ActiveModelSerializers::JsonPointer.new(:primary_data)
+      assert_equal '/data', pointer
+    end
 
-  def test_unkown_data_pointer
-    assert_raises(TypeError) do
-      ActiveModelSerializers::JsonPointer.new(:unknown)
+    def test_unknown_data_pointer
+      assert_raises(TypeError) do
+        ActiveModelSerializers::JsonPointer.new(:unknown)
+      end
     end
   end
 end

data/test/active_model_serializers/logging_test.rb

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