active_model_serializers 0.10.0 → 0.10.3

data/test/fixtures/poro.rb

@@ -8,7 +8,7 @@ class Model < ActiveModelSerializers::Model
   # Convenience when not adding @attributes readers and writers
   def method_missing(meth, *args)
     if meth.to_s =~ /^(.*)=$/
-      attributes[$1.to_sym] = args[0]
+      attributes[Regexp.last_match(1).to_sym] = args[0]
     elsif attributes.key?(meth)
       attributes[meth]
     else
@@ -50,21 +50,21 @@ class ProfilePreviewSerializer < ActiveModel::Serializer
   attributes :name
 end
 
-Post     = Class.new(Model)
-Like     = Class.new(Model)
-Author   = Class.new(Model)
-Bio      = Class.new(Model)
-Blog     = Class.new(Model)
-Role     = Class.new(Model)
-User     = Class.new(Model)
-Location = Class.new(Model)
-Place    = Class.new(Model)
-Tag      = Class.new(Model)
-VirtualValue = Class.new(Model)
-Comment = Class.new(Model) do
+class Post < Model; end
+class Like < Model; end
+class Author < Model; end
+class Bio < Model; end
+class Blog < Model; end
+class Role < Model; end
+class User < Model; end
+class Location < Model; end
+class Place < Model; end
+class Tag < Model; end
+class VirtualValue < Model; end
+class Comment < Model
   # Uses a custom non-time-based cache key
   def cache_key
-    "#{self.class.name.downcase}/#{self.id}"
+    "#{self.class.name.downcase}/#{id}"
   end
 end
 
@@ -87,10 +87,11 @@ class PolyTag < ActiveRecord::Base
   has_many :object_tags
 end
 
-module Spam; end
-Spam::UnrelatedLink = Class.new(Model)
+module Spam
+  class UnrelatedLink < Model; end
+end
 
-PostSerializer = Class.new(ActiveModel::Serializer) do
+class PostSerializer < ActiveModel::Serializer
   cache key: 'post', expires_in: 0.1, skip_digest: true
   attributes :id, :title, :body
 
@@ -108,12 +109,12 @@ PostSerializer = Class.new(ActiveModel::Serializer) do
   end
 end
 
-SpammyPostSerializer = Class.new(ActiveModel::Serializer) do
+class SpammyPostSerializer < ActiveModel::Serializer
   attributes :id
   has_many :related
 end
 
-CommentSerializer = Class.new(ActiveModel::Serializer) do
+class CommentSerializer < ActiveModel::Serializer
   cache expires_in: 1.day, skip_digest: true
   attributes :id, :body
 
@@ -125,7 +126,7 @@ CommentSerializer = Class.new(ActiveModel::Serializer) do
   end
 end
 
-AuthorSerializer = Class.new(ActiveModel::Serializer) do
+class AuthorSerializer < ActiveModel::Serializer
   cache key: 'writer', skip_digest: true
   attribute :id
   attribute :name
@@ -135,48 +136,49 @@ AuthorSerializer = Class.new(ActiveModel::Serializer) do
   has_one :bio
 end
 
-RoleSerializer = Class.new(ActiveModel::Serializer) do
-  cache only: [:name], skip_digest: true
-  attributes :id, :name, :description, :slug
+class RoleSerializer < ActiveModel::Serializer
+  cache only: [:name, :slug], skip_digest: true
+  attributes :id, :name, :description
+  attribute :friendly_id, key: :slug
 
-  def slug
+  def friendly_id
     "#{object.name}-#{object.id}"
   end
 
   belongs_to :author
 end
 
-LikeSerializer = Class.new(ActiveModel::Serializer) do
+class LikeSerializer < ActiveModel::Serializer
   attributes :id, :time
 
   belongs_to :likeable
 end
 
-LocationSerializer = Class.new(ActiveModel::Serializer) do
-  cache only: [:place], skip_digest: true
+class LocationSerializer < ActiveModel::Serializer
+  cache only: [:address], skip_digest: true
   attributes :id, :lat, :lng
 
-  belongs_to :place
+  belongs_to :place, key: :address
 
   def place
     'Nowhere'
   end
 end
 
-PlaceSerializer = Class.new(ActiveModel::Serializer) do
+class PlaceSerializer < ActiveModel::Serializer
   attributes :id, :name
 
   has_many :locations
 end
 
-BioSerializer = Class.new(ActiveModel::Serializer) do
+class BioSerializer < ActiveModel::Serializer
   cache except: [:content], skip_digest: true
   attributes :id, :content, :rating
 
   belongs_to :author
 end
 
-BlogSerializer = Class.new(ActiveModel::Serializer) do
+class BlogSerializer < ActiveModel::Serializer
   cache key: 'blog'
   attributes :id, :name
 
@@ -184,50 +186,50 @@ BlogSerializer = Class.new(ActiveModel::Serializer) do
   has_many :articles
 end
 
-PaginatedSerializer = Class.new(ActiveModel::Serializer::CollectionSerializer) do
+class PaginatedSerializer < ActiveModel::Serializer::CollectionSerializer
   def json_key
     'paginated'
   end
 end
 
-AlternateBlogSerializer = Class.new(ActiveModel::Serializer) do
+class AlternateBlogSerializer < ActiveModel::Serializer
   attribute :id
   attribute :name, key: :title
 end
 
-CustomBlogSerializer = Class.new(ActiveModel::Serializer) do
+class CustomBlogSerializer < ActiveModel::Serializer
   attribute :id
   attribute :special_attribute
 
   has_many :articles
 end
 
-CommentPreviewSerializer = Class.new(ActiveModel::Serializer) do
+class CommentPreviewSerializer < ActiveModel::Serializer
   attributes :id
 
   belongs_to :post
 end
 
-AuthorPreviewSerializer = Class.new(ActiveModel::Serializer) do
+class AuthorPreviewSerializer < ActiveModel::Serializer
   attributes :id
 
   has_many :posts
 end
 
-PostPreviewSerializer = Class.new(ActiveModel::Serializer) do
+class PostPreviewSerializer < ActiveModel::Serializer
   attributes :title, :body, :id
 
   has_many :comments, serializer: CommentPreviewSerializer
   belongs_to :author, serializer: AuthorPreviewSerializer
 end
 
-PostWithTagsSerializer = Class.new(ActiveModel::Serializer) do
+class PostWithTagsSerializer < ActiveModel::Serializer
   attributes :id
 
   has_many :tags
 end
 
-PostWithCustomKeysSerializer = Class.new(ActiveModel::Serializer) do
+class PostWithCustomKeysSerializer < ActiveModel::Serializer
   attributes :id
 
   has_many :comments, key: :reviews
@@ -235,7 +237,7 @@ PostWithCustomKeysSerializer = Class.new(ActiveModel::Serializer) do
   has_one :blog, key: :site
 end
 
-VirtualValueSerializer = Class.new(ActiveModel::Serializer) do
+class VirtualValueSerializer < ActiveModel::Serializer
   attributes :id
 
   has_many :reviews, virtual_value: [{ type: 'reviews', id: '1' },
@@ -249,34 +251,36 @@ VirtualValueSerializer = Class.new(ActiveModel::Serializer) do
   end
 end
 
-PolymorphicHasManySerializer = Class.new(ActiveModel::Serializer) do
+class PolymorphicHasManySerializer < ActiveModel::Serializer
   attributes :id, :name
 end
 
-PolymorphicBelongsToSerializer = Class.new(ActiveModel::Serializer) do
+class PolymorphicBelongsToSerializer < ActiveModel::Serializer
   attributes :id, :title
 
   has_one :imageable, serializer: PolymorphicHasManySerializer, polymorphic: true
 end
 
-PolymorphicSimpleSerializer = Class.new(ActiveModel::Serializer) do
+class PolymorphicSimpleSerializer < ActiveModel::Serializer
   attributes :id
 end
 
-PolymorphicObjectTagSerializer = Class.new(ActiveModel::Serializer) do
+class PolymorphicObjectTagSerializer < ActiveModel::Serializer
   attributes :id
 
   has_many :taggable, serializer: PolymorphicSimpleSerializer, polymorphic: true
 end
 
-PolymorphicTagSerializer = Class.new(ActiveModel::Serializer) do
+class PolymorphicTagSerializer < ActiveModel::Serializer
   attributes :id, :phrase
 
   has_many :object_tags, serializer: PolymorphicObjectTagSerializer
 end
 
-Spam::UnrelatedLinkSerializer = Class.new(ActiveModel::Serializer) do
-  cache only: [:id]
-  attributes :id
+module Spam
+  class UnrelatedLinkSerializer < ActiveModel::Serializer
+    cache only: [:id]
+    attributes :id
+  end
 end
 $VERBOSE = verbose

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/grape_test.rb

@@ -1,82 +1,178 @@
 require 'test_helper'
 require 'grape'
 require 'grape/active_model_serializers'
+require 'kaminari'
+require 'kaminari/hooks'
+::Kaminari::Hooks.init
+
+module ActiveModelSerializers
+  class GrapeTest < ActiveSupport::TestCase
+    include Rack::Test::Methods
+    module Models
+      def self.model1
+        ARModels::Post.new(id: 1, title: 'Dummy Title', body: 'Lorem Ipsum')
+      end
 
-class ActiveModelSerializers::GrapeTest < ActiveSupport::TestCase
-  include Rack::Test::Methods
-  module Models
-    def self.model1
-      ARModels::Post.new(id: 1, title: 'Dummy Title', body: 'Lorem Ipsum')
-    end
+      def self.model2
+        ARModels::Post.new(id: 2, title: 'Second Dummy Title', body: 'Second Lorem Ipsum')
+      end
+
+      def self.all
+        @all ||=
+          begin
+            model1.save!
+            model2.save!
+            ARModels::Post.all
+          end
+      end
+
+      def self.reset_all
+        ARModels::Post.delete_all
+        @all = nil
+      end
+
+      def self.collection_per
+        2
+      end
 
-    def self.model2
-      ARModels::Post.new(id: 2, title: 'Second Dummy Title', body: 'Second Lorem Ipsum')
+      def self.collection
+        @collection ||=
+          begin
+            Kaminari.paginate_array(
+              [
+                Profile.new(id: 1, name: 'Name 1', description: 'Description 1', comments: 'Comments 1'),
+                Profile.new(id: 2, name: 'Name 2', description: 'Description 2', comments: 'Comments 2'),
+                Profile.new(id: 3, name: 'Name 3', description: 'Description 3', comments: 'Comments 3'),
+                Profile.new(id: 4, name: 'Name 4', description: 'Description 4', comments: 'Comments 4'),
+                Profile.new(id: 5, name: 'Name 5', description: 'Description 5', comments: 'Comments 5')
+              ]
+            ).page(1).per(collection_per)
+          end
+      end
     end
 
-    def self.all
-      @all ||=
-        begin
-          model1.save!
-          model2.save!
-          ARModels::Post.all
+    class GrapeTest < Grape::API
+      format :json
+      include Grape::ActiveModelSerializers
+
+      resources :grape do
+        get '/render' do
+          render Models.model1
         end
-    end
-  end
 
-  class GrapeTest < Grape::API
-    format :json
-    include Grape::ActiveModelSerializers
+        get '/render_with_json_api' do
+          post = Models.model1
+          render post, meta: { page: 1, total_pages: 2 }, adapter: :json_api
+        end
 
-    resources :grape do
-      get '/render' do
-        render Models.model1
-      end
+        get '/render_array_with_json_api' do
+          posts = Models.all
+          render posts, adapter: :json_api
+        end
 
-      get '/render_with_json_api' do
-        post = Models.model1
-        render post, meta: { page: 1, total_pages: 2 }, adapter: :json_api
-      end
+        get '/render_collection_with_json_api' do
+          posts = Models.collection
+          render posts, adapter: :json_api
+        end
 
-      get '/render_array_with_json_api' do
-        posts = Models.all
-        render posts, adapter: :json_api
+        get '/render_with_implicit_formatter' do
+          Models.model1
+        end
+
+        get '/render_array_with_implicit_formatter' do
+          Models.all
+        end
+
+        get '/render_collection_with_implicit_formatter' do
+          Models.collection
+        end
       end
     end
-  end
 
-  def app
-    GrapeTest.new
-  end
+    def app
+      Grape::Middleware::Globals.new(GrapeTest.new)
+    end
 
-  def test_formatter_returns_json
-    get '/grape/render'
+    def test_formatter_returns_json
+      get '/grape/render'
 
-    post = Models.model1
-    serializable_resource = serializable(post)
+      post = Models.model1
+      serializable_resource = serializable(post)
 
-    assert last_response.ok?
-    assert_equal serializable_resource.to_json, last_response.body
-  end
+      assert last_response.ok?
+      assert_equal serializable_resource.to_json, last_response.body
+    end
 
-  def test_render_helper_passes_through_options_correctly
-    get '/grape/render_with_json_api'
+    def test_render_helper_passes_through_options_correctly
+      get '/grape/render_with_json_api'
 
-    post = Models.model1
-    serializable_resource = serializable(post, serializer: ARModels::PostSerializer, adapter: :json_api, meta: { page: 1, total_pages: 2 })
+      post = Models.model1
+      serializable_resource = serializable(post, serializer: ARModels::PostSerializer, adapter: :json_api, meta: { page: 1, total_pages: 2 })
 
-    assert last_response.ok?
-    assert_equal serializable_resource.to_json, last_response.body
-  end
+      assert last_response.ok?
+      assert_equal serializable_resource.to_json, last_response.body
+    end
+
+    def test_formatter_handles_arrays
+      get '/grape/render_array_with_json_api'
+
+      posts = Models.all
+      serializable_resource = serializable(posts, adapter: :json_api)
+
+      assert last_response.ok?
+      assert_equal serializable_resource.to_json, last_response.body
+    ensure
+      Models.reset_all
+    end
+
+    def test_formatter_handles_collections
+      get '/grape/render_collection_with_json_api'
+      assert last_response.ok?
+
+      representation = JSON.parse(last_response.body)
+      assert representation.include?('data')
+      assert representation['data'].count == Models.collection_per
+      assert representation.include?('links')
+      assert representation['links'].count > 0
+    end
+
+    def test_implicit_formatter
+      post = Models.model1
+      serializable_resource = serializable(post, adapter: :json_api)
+
+      with_adapter :json_api do
+        get '/grape/render_with_implicit_formatter'
+      end
+
+      assert last_response.ok?
+      assert_equal serializable_resource.to_json, last_response.body
+    end
 
-  def test_formatter_handles_arrays
-    get '/grape/render_array_with_json_api'
+    def test_implicit_formatter_handles_arrays
+      posts = Models.all
+      serializable_resource = serializable(posts, adapter: :json_api)
 
-    posts = Models.all
-    serializable_resource = serializable(posts, adapter: :json_api)
+      with_adapter :json_api do
+        get '/grape/render_array_with_implicit_formatter'
+      end
+
+      assert last_response.ok?
+      assert_equal serializable_resource.to_json, last_response.body
+    ensure
+      Models.reset_all
+    end
 
-    assert last_response.ok?
-    assert_equal serializable_resource.to_json, last_response.body
-  ensure
-    ARModels::Post.delete_all
+    def test_implicit_formatter_handles_collections
+      with_adapter :json_api do
+        get '/grape/render_collection_with_implicit_formatter'
+      end
+
+      representation = JSON.parse(last_response.body)
+      assert last_response.ok?
+      assert representation.include?('data')
+      assert representation['data'].count == Models.collection_per
+      assert representation.include?('links')
+      assert representation['links'].count > 0
+    end
   end
 end

data/test/lint_test.rb

@@ -30,7 +30,7 @@ module ActiveModel
         def errors
         end
 
-        def self.human_attribute_name(attr, options = {})
+        def self.human_attribute_name(_, _ = {})
         end
 
         def self.lookup_ancestors

data/test/logger_test.rb

@@ -1,18 +1,20 @@
 require 'test_helper'
 
-class ActiveModelSerializers::LoggerTest < ActiveSupport::TestCase
-  def test_logger_is_set_to_action_controller_logger_when_initializer_runs
-    assert_equal $action_controller_logger, ActionController::Base.logger # rubocop:disable Style/GlobalVars
-  end
+module ActiveModelSerializers
+  class LoggerTest < ActiveSupport::TestCase
+    def test_logger_is_set_to_action_controller_logger_when_initializer_runs
+      assert_equal $action_controller_logger, ActionController::Base.logger # rubocop:disable Style/GlobalVars
+    end
 
-  def test_logger_can_be_set
-    original_logger = ActiveModelSerializers.logger
-    logger = Logger.new(STDOUT)
+    def test_logger_can_be_set
+      original_logger = ActiveModelSerializers.logger
+      logger = Logger.new(STDOUT)
 
-    ActiveModelSerializers.logger = logger
+      ActiveModelSerializers.logger = logger
 
-    assert_equal ActiveModelSerializers.logger, logger
-  ensure
-    ActiveModelSerializers.logger = original_logger
+      assert_equal ActiveModelSerializers.logger, logger
+    ensure
+      ActiveModelSerializers.logger = original_logger
+    end
   end
 end

data/test/serializable_resource_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 module ActiveModelSerializers
   class SerializableResourceTest < ActiveSupport::TestCase
     def setup
-      @resource = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+      @resource = Profile.new(name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
       @serializer = ProfileSerializer.new(@resource)
       @adapter = ActiveModelSerializers::Adapter.create(@serializer)
       @serializable_resource = SerializableResource.new(@resource)
@@ -32,11 +32,11 @@ module ActiveModelSerializers
     end
 
     def test_use_adapter_with_adapter_option
-      assert SerializableResource.new(@resource, { adapter: 'json' }).use_adapter?
+      assert SerializableResource.new(@resource, adapter: 'json').use_adapter?
     end
 
     def test_use_adapter_with_adapter_option_as_false
-      refute SerializableResource.new(@resource, { adapter: false }).use_adapter?
+      refute SerializableResource.new(@resource, adapter: false).use_adapter?
     end
 
     class SerializableResourceErrorsTest < Minitest::Test
@@ -45,15 +45,13 @@ module ActiveModelSerializers
         resource = ModelWithErrors.new
         resource.errors.add(:name, 'must be awesome')
         serializable_resource = ActiveModelSerializers::SerializableResource.new(
-          resource, {
-            serializer: ActiveModel::Serializer::ErrorSerializer,
-            adapter: :json_api
-          })
-        expected_response_document =
-          { :errors =>
-            [
-              { :source => { :pointer => '/data/attributes/name' }, :detail => 'must be awesome' }
-            ]
+          resource,             serializer: ActiveModel::Serializer::ErrorSerializer,
+                                adapter: :json_api
+        )
+        expected_response_document = {
+          errors: [
+            { source: { pointer: '/data/attributes/name' }, detail: 'must be awesome' }
+          ]
         }
         assert_equal serializable_resource.as_json(options), expected_response_document
       end
@@ -65,16 +63,14 @@ module ActiveModelSerializers
         resource.errors.add(:title, 'must be amazing')
         resources << ModelWithErrors.new
         serializable_resource = SerializableResource.new(
-          resources, {
-            serializer: ActiveModel::Serializer::ErrorsSerializer,
-            each_serializer: ActiveModel::Serializer::ErrorSerializer,
-            adapter: :json_api
-          })
-        expected_response_document =
-          { :errors =>
-            [
-              { :source => { :pointer => '/data/attributes/title' }, :detail => 'must be amazing' }
-            ]
+          resources, serializer: ActiveModel::Serializer::ErrorsSerializer,
+                     each_serializer: ActiveModel::Serializer::ErrorSerializer,
+                     adapter: :json_api
+        )
+        expected_response_document = {
+          errors: [
+            { source: { pointer: '/data/attributes/title' }, detail: 'must be amazing' }
+          ]
         }
         assert_equal serializable_resource.as_json(options), expected_response_document
       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