Merge pull request rails#50987 from skipkayhil/hm-deprecate-kw-enum

Deprecate defining enums with keywords args

Author: rafaelfranca

activerecord/CHANGELOG.md

@@ -1,3 +1,19 @@
+*   Deprecate defining an `enum` with keyword arguments.
+
+    ```ruby
+    class Function > ApplicationRecord
+      # BAD
+      enum color: [:red, :blue],
+           type: [:instance, :class]
+
+      # GOOD
+      enum :color, [:red, :blue]
+      enum :type, [:instance, :class]
+    end
+    ```
+
+    *Hartley McGuire*
+
 *   Add `active_record.config.validate_migration_timestamps` option for validating migration timestamps.
 
     When set, validates that the timestamp prefix for a migration is no more than a day ahead of

activerecord/lib/active_record/enum.rb

@@ -223,6 +223,13 @@ def enum(name = nil, values = nil, **options)
       options.transform_keys! { |key| :"#{key[1..-1]}" }
 
       definitions.each { |name, values| _enum(name, values, **options) }
+
+      ActiveRecord.deprecator.warn(<<~MSG)
+        Defining enums with keyword arguments is deprecated and will be removed
+        in Rails 7.3. Positional arguments should be used instead:
+
+        #{definitions.map { |name, values| "enum :#{name}, #{values}" }.join("\n")}
+      MSG
     end
 
     private

activerecord/test/cases/associations/has_many_associations_test.rb

@@ -486,7 +486,7 @@ class SpecialBook < ActiveRecord::Base
     self.table_name = "books"
 
     belongs_to :author
-    enum last_read: { unread: 0, reading: 2, read: 3, forgotten: nil }
+    enum :last_read, { unread: 0, reading: 2, read: 3, forgotten: nil }
   end
 
   def test_association_enum_works_properly

activerecord/test/cases/associations/has_one_associations_test.rb

@@ -807,7 +807,7 @@ class SpecialBook < ActiveRecord::Base
     belongs_to :author, class_name: "SpecialAuthor"
     has_one :subscription, class_name: "SpecialSubscription", foreign_key: "subscriber_id"
 
-    enum status: [:proposed, :written, :published]
+    enum :status, [:proposed, :written, :published]
   end
 
   class SpecialAuthor < ActiveRecord::Base

activerecord/test/cases/attribute_methods_test.rb

@@ -1381,7 +1381,8 @@ class ChildWithDeprecatedBehaviorResolved < ClassWithDeprecatedAliasAttributeBeh
     self.table_name = "books"
 
     attribute :status, :string
-    enum status: {
+
+    enum :status, {
       pending: "0",
       completed: "1",
     }