active_model_serializers 0.9.11 → 0.9.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1c2dbb7d1b6d7673364e690d624e5a8dffa5fddf2f9ee9d6838ac399ab14a96
-  data.tar.gz: 5fcef7df6ec5deb692b68ffd8198e438b8bf2bafe812d12ace97087f9eb9c3f8
+  metadata.gz: a8649ea9bfdefabb0215cc90a6a47a87d902573ecd0e2c73b6142c9cefe17825
+  data.tar.gz: 420e8afdc1ba7cbaaab42d7f8f36c3e10b702587cc7484e270428ded2eeccbdd
 SHA512:
-  metadata.gz: 281b4a64ab65e4f2aff6b45a393e684e1d69a5fe203c450268cfc001deb20fce6e1269c9aafd1bf54e847bc5a282cfd28f630cb45096ec750bb531363cd93cbd
-  data.tar.gz: 13cd7cfa482532515a8629c35c4e5c0847b1dd791494025f4d6177e05f45f5845641b8bc04cfb543a503b8767afcb8505fd1c433afc0cd73c5bcd0d9a8066119
+  metadata.gz: 237f372c6dd5e73cb7d5f944d90918a23e6acf0f7aa137f0e2972a275445a549a6cf4ffd9e410386c611e89e1dc0137d5451c6d61702d6c6381e43a41e3434ac
+  data.tar.gz: 5d009500e9e616e7d1a7f83adaf7874022f1f039594983e923ef82d4b8f6b8f6268259404b097545a27512b149ec22c8e113a8c0bb51effbef3c0fdd728d7973

data/CHANGELOG.md

@@ -1,6 +1,21 @@
 ## 0.09.x
 
-### [0-9-stable](https://github.com/rails-api/active_model_serializers/compare/v0.9.11...0-9-stable)
+### [0-9-stable](https://github.com/rails-api/active_model_serializers/compare/v0.9.13...0-9-stable)
+
+### [v0.9.13 (2024-09-17)](https://github.com/rails-api/active_model_serializers/compare/v0.9.12...v0.9.13)
+
+- Perf
+  - [#2471](https://github.com/rails-api/active_model_serializers/pull/2471) Generate better attribute accessors, that also don't trigger warnings when redefined. (@byroot)
+
+### [v0.9.12 (2024-04-11)](https://github.com/rails-api/active_model_serializers/compare/v0.9.11...v0.9.12)
+
+- Fix
+  - [#2468](https://github.com/rails-api/active_model_serializers/pull/2468) Fix bug introduced in v0.9.9. Revert "Allow serializer_for to accept String instead of just class objects". (@byroot)
+- Perf
+  - [#2466](https://github.com/rails-api/active_model_serializers/pull/2466) Prefer `defined?` to `Object.constants.include?` (@byroot)
+  - [#2467](https://github.com/rails-api/active_model_serializers/pull/2467) Lazily compute possible serializer class names (@byroot)
+- Chore
+  - [#2469](https://github.com/rails-api/active_model_serializers/pull/2469) Fix various warnings in the test suite (@byroot)
 
 ### [v0.9.11 (2024-04-09)](https://github.com/rails-api/active_model_serializers/compare/v0.9.10...v0.9.11)
 

data/lib/active_model/serializer/association.rb

@@ -9,9 +9,7 @@ module ActiveModel
     class Association
       def initialize(name, options={})
         if options.has_key?(:include)
-          ActiveSupport::Deprecation.warn <<-WARN
-** Notice: include was renamed to embed_in_root. **
-          WARN
+          ActiveSupport::Deprecation.warn("** Notice: include was renamed to embed_in_root. **")
         end
 
         @name          = name.to_s

data/lib/active_model/serializer/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveModel
   class Serializer
-    VERSION = '0.9.11'
+    VERSION = '0.9.13'
   end
 end

data/lib/active_model/serializer.rb

@@ -62,20 +62,19 @@ end
         if resource.respond_to?(:serializer_class)
           resource.serializer_class
         elsif resource.respond_to?(:to_ary)
-          if Object.constants.include?(:ArraySerializer)
+          if defined?(::ArraySerializer)
             ::ArraySerializer
           else
             ArraySerializer
           end
         else
-          search_list = build_serializer_class_list(resource, options)
-          result = search_list.map do |klass_name|
-                     Serializer.serializers_cache.fetch_or_store(klass_name) do
-                       _const_get(klass_name)
-                     end
-                   end
-
-          result.find { |serializer| !serializer.nil? }
+          each_possible_serializer(resource, options) do |klass_name|
+            serializer = Serializer.serializers_cache.fetch_or_store(klass_name) do
+              _const_get(klass_name)
+            end
+            return serializer unless serializer.nil?
+          end
+          nil
         end
       end
 
@@ -91,15 +90,27 @@ end
       end
 
       def attributes(*attrs)
+        # Use `class_eval` rather than `define_method` for faster access
+        # and avoid retaining objects in the closure.
+        # Batch all methods in a single `class_eval` for efficiceny,
+        # and define all methods on the same line so the eventual backtrace
+        # properly maps to the `attributes` call.
+        source = ["# frozen_string_literal: true\n"]
         attrs.each do |attr|
           striped_attr = strip_attribute attr
 
           @_attributes << striped_attr
 
-          define_method striped_attr do
-            object.read_attribute_for_serialization attr
-          end unless method_defined?(attr)
+          unless method_defined?(attr)
+            source <<
+            "def #{striped_attr}" <<
+              "object.read_attribute_for_serialization(#{attr.inspect})" <<
+            "end" <<
+            "alias_method :#{striped_attr}, :#{striped_attr}" # suppress method redefinition warning
+          end
         end
+        caller = caller_locations(1, 1).first
+        class_eval(source.join(";"), caller.path, caller.lineno - 1)
       end
 
       def has_one(*attrs)
@@ -124,22 +135,17 @@ end
         attr
       end
 
-      def build_serializer_class_list(resource, options)
-        list = []
-        list << build_serializer_class(resource, options)
-        list << build_serializer_class(resource, {})
-        list << build_serializer_class(resource.class.name.demodulize, {})
+      def each_possible_serializer(resource, options)
+        yield build_serializer_class(resource, options)
+        yield build_serializer_class(resource, {})
+        yield build_serializer_class(resource.class.name.demodulize, {})
       end
 
       def build_serializer_class(resource, options)
         klass_name = +""
         klass_name << "#{options[:namespace]}::" if options[:namespace]
         klass_name << options[:prefix].to_s.classify if options[:prefix]
-        if resource.is_a?(String)
-          klass_name << "#{resource}Serializer"
-        else
-          klass_name << "#{resource.class.name}Serializer"
-        end
+        klass_name << "#{resource.class.name}Serializer"
       end
 
       def associate(klass, *attrs)
@@ -169,7 +175,8 @@ end
       @context       = options[:context]
       @namespace     = options[:namespace]
     end
-    attr_accessor :object, :scope, :root, :meta_key, :meta, :key_format, :context, :polymorphic
+    attr_accessor :object, :scope, :root, :meta_key, :meta, :context, :polymorphic
+    attr_writer :key_format
 
     def json_key
       key = if root == true || root.nil?

data/test/fixtures/poro.rb

@@ -144,14 +144,14 @@ end
 
 class SelfReferencingUserParentSerializer < ActiveModel::Serializer
   attributes :name
-  has_one :type, serializer: TypeSerializer, embed: :ids, include: true
+  has_one :type, serializer: TypeSerializer, embed: :ids, embed_in_root: true
 end
 
 class SelfReferencingUserSerializer < ActiveModel::Serializer
   attributes :name
 
-  has_one :type, serializer: TypeSerializer, embed: :ids, include: true
-  has_one :parent, serializer: SelfReferencingUserSerializer, embed: :ids, include: true
+  has_one :type, serializer: TypeSerializer, embed: :ids, embed_in_root: true
+  has_one :parent, serializer: SelfReferencingUserSerializer, embed: :ids, embed_in_root: true
 end
 
 class UserInfoSerializer < ActiveModel::Serializer
@@ -176,6 +176,7 @@ end
 class PostSerializer < ActiveModel::Serializer
   attributes :title, :body
 
+  alias_method :title, :title # silence method redefinition warning
   def title
     keyword = serialization_options[:highlight_keyword]
     title = object.read_attribute_for_serialization(:title)

data/test/integration/generators/scaffold_controller_generator_test.rb

@@ -17,44 +17,44 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
 
     assert_file 'app/controllers/accounts_controller.rb' do |content|
       assert_instance_method :index, content do |m|
-        assert_match /@accounts = Account\.all/, m
-        assert_match /format.html/, m
-        assert_match /format.json \{ render json: @accounts \}/, m
+        assert_match(/@accounts = Account\.all/, m)
+        assert_match(/format.html/, m)
+        assert_match(/format.json \{ render json: @accounts \}/, m)
       end
 
       assert_instance_method :show, content do |m|
-        assert_match /format.html/, m
-        assert_match /format.json \{ render json: @account \}/, m
+        assert_match(/format.html/, m)
+        assert_match(/format.json \{ render json: @account \}/, m)
       end
 
       assert_instance_method :new, content do |m|
-        assert_match /@account = Account\.new/, m
+        assert_match(/@account = Account\.new/, m)
       end
 
       assert_instance_method :edit, content do |m|
-        assert m.blank?
+        assert_predicate m, :blank?
       end
 
       assert_instance_method :create, content do |m|
-        assert_match /@account = Account\.new\(account_params\)/, m
-        assert_match /@account\.save/, m
-        assert_match /format\.html \{ redirect_to @account, notice: 'Account was successfully created\.' \}/, m
-        assert_match /format\.json \{ render json: @account, status: :created \}/, m
-        assert_match /format\.html \{ render action: 'new' \}/, m
-        assert_match /format\.json \{ render json: @account\.errors, status: :unprocessable_entity \}/, m
+        assert_match(/@account = Account\.new\(account_params\)/, m)
+        assert_match(/@account\.save/, m)
+        assert_match(/format\.html \{ redirect_to @account, notice: 'Account was successfully created\.' \}/, m)
+        assert_match(/format\.json \{ render json: @account, status: :created \}/, m)
+        assert_match(/format\.html \{ render action: 'new' \}/, m)
+        assert_match(/format\.json \{ render json: @account\.errors, status: :unprocessable_entity \}/, m)
       end
 
       assert_instance_method :update, content do |m|
-        assert_match /format\.html \{ redirect_to @account, notice: 'Account was successfully updated\.' \}/, m
-        assert_match /format\.json \{ head :no_content \}/, m
-        assert_match /format\.html \{ render action: 'edit' \}/, m
-        assert_match /format\.json \{ render json: @account.errors, status: :unprocessable_entity \}/, m
+        assert_match(/format\.html \{ redirect_to @account, notice: 'Account was successfully updated\.' \}/, m)
+        assert_match(/format\.json \{ head :no_content \}/, m)
+        assert_match(/format\.html \{ render action: 'edit' \}/, m)
+        assert_match(/format\.json \{ render json: @account.errors, status: :unprocessable_entity \}/, m)
       end
 
       assert_instance_method :destroy, content do |m|
-        assert_match /@account\.destroy/, m
-        assert_match /format\.html { redirect_to accounts_url \}/, m
-        assert_match /format\.json \{ head :no_content \}/, m
+        assert_match(/@account\.destroy/, m)
+        assert_match(/format\.html { redirect_to accounts_url \}/, m)
+        assert_match(/format\.json \{ head :no_content \}/, m)
       end
 
       assert_match(/def account_params/, content)

data/test/test_app.rb

@@ -1,4 +1,8 @@
 class TestApp < Rails::Application
+  if config.respond_to?(:load_defaults)
+    config.load_defaults("#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}")
+  end
+
   if Rails.version.to_s.first >= '4'
     config.eager_load = false
     config.secret_key_base = 'abc123'

data/test/tmp/app/serializers/account_serializer.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
-class AccountSerializer < ActiveModel::Serializer
+class AccountSerializer < MySerializer
   attributes :id
 end

data/test/unit/active_model/array_serializer/serialization_test.rb

@@ -49,7 +49,7 @@ module ActiveModel
         def object.serializer_class; CustomSerializer; end
 
         assert_equal CustomSerializer, Serializer.serializer_for(object)
-        assert_equal CustomSerializer, Serializer.serializer_for('Custom')
+        assert_nil Serializer.serializer_for('Custom')
       end
     end
 

data/test/unit/active_model/default_serializer_test.rb

@@ -4,7 +4,7 @@ module ActiveModel
   class DefaultSerializer
     class Test < Minitest::Test
       def test_serialize_objects
-        assert_equal(nil, DefaultSerializer.new(nil).serializable_object)
+        assert_nil(DefaultSerializer.new(nil).serializable_object)
         assert_equal(1, DefaultSerializer.new(1).serializable_object)
         assert_equal('hi', DefaultSerializer.new('hi').serializable_object)
       end

data/test/unit/active_model/serializer/url_helpers_test.rb

@@ -21,6 +21,7 @@ module ActiveModel
         serializer = Class.new(ActiveModel::Serializer) do
           attributes :url
 
+          alias_method :url, :url # silence redefinition warning
           def url
             profile_url(id: object.object_id)
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_model_serializers
 version: !ruby/object:Gem::Version
-  version: 0.9.11
+  version: 0.9.13
 platform: ruby
 authors:
 - José Valim
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-09 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -115,12 +115,7 @@ files:
 - test/integration/generators/serializer_generator_test.rb
 - test/test_app.rb
 - test/test_helper.rb
-- test/tmp/app/assets/javascripts/accounts.js
-- test/tmp/app/assets/stylesheets/accounts.css
-- test/tmp/app/controllers/accounts_controller.rb
-- test/tmp/app/helpers/accounts_helper.rb
 - test/tmp/app/serializers/account_serializer.rb
-- test/tmp/config/routes.rb
 - test/unit/active_model/array_serializer/except_test.rb
 - test/unit/active_model/array_serializer/key_format_test.rb
 - test/unit/active_model/array_serializer/meta_test.rb
@@ -198,12 +193,7 @@ test_files:
 - test/integration/generators/serializer_generator_test.rb
 - test/test_app.rb
 - test/test_helper.rb
-- test/tmp/app/assets/javascripts/accounts.js
-- test/tmp/app/assets/stylesheets/accounts.css
-- test/tmp/app/controllers/accounts_controller.rb
-- test/tmp/app/helpers/accounts_helper.rb
 - test/tmp/app/serializers/account_serializer.rb
-- test/tmp/config/routes.rb
 - test/unit/active_model/array_serializer/except_test.rb
 - test/unit/active_model/array_serializer/key_format_test.rb
 - test/unit/active_model/array_serializer/meta_test.rb

data/test/tmp/app/assets/javascripts/accounts.js

@@ -1,2 +0,0 @@
-// Place all the behaviors and hooks related to the matching controller here.
-// All this logic will automatically be available in application.js.

data/test/tmp/app/assets/stylesheets/accounts.css

@@ -1,4 +0,0 @@
-/*
-  Place all the styles related to the matching controller here.
-  They will automatically be included in application.css.
-*/

data/test/tmp/app/controllers/accounts_controller.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-class AccountsController < ApplicationController
-end

data/test/tmp/app/helpers/accounts_helper.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-module AccountsHelper
-end

data/test/tmp/config/routes.rb

@@ -1,2 +0,0 @@
-# frozen_string_literal: true
-Rails.application.routes.draw {}