activerecord 8.0.0 → 8.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (186) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +703 -248
  3. data/README.rdoc +2 -2
  4. data/lib/active_record/association_relation.rb +1 -1
  5. data/lib/active_record/associations/alias_tracker.rb +6 -4
  6. data/lib/active_record/associations/association.rb +1 -1
  7. data/lib/active_record/associations/belongs_to_association.rb +18 -2
  8. data/lib/active_record/associations/builder/association.rb +16 -5
  9. data/lib/active_record/associations/builder/belongs_to.rb +17 -4
  10. data/lib/active_record/associations/builder/collection_association.rb +7 -3
  11. data/lib/active_record/associations/builder/has_one.rb +1 -1
  12. data/lib/active_record/associations/builder/singular_association.rb +33 -5
  13. data/lib/active_record/associations/collection_association.rb +3 -3
  14. data/lib/active_record/associations/collection_proxy.rb +22 -4
  15. data/lib/active_record/associations/deprecation.rb +88 -0
  16. data/lib/active_record/associations/errors.rb +3 -0
  17. data/lib/active_record/associations/join_dependency/join_association.rb +25 -27
  18. data/lib/active_record/associations/join_dependency.rb +4 -2
  19. data/lib/active_record/associations/preloader/batch.rb +7 -1
  20. data/lib/active_record/associations/preloader/branch.rb +1 -0
  21. data/lib/active_record/associations.rb +159 -21
  22. data/lib/active_record/attribute_methods/primary_key.rb +2 -1
  23. data/lib/active_record/attribute_methods/query.rb +34 -0
  24. data/lib/active_record/attribute_methods/serialization.rb +17 -4
  25. data/lib/active_record/attribute_methods/time_zone_conversion.rb +10 -2
  26. data/lib/active_record/attribute_methods.rb +23 -18
  27. data/lib/active_record/attributes.rb +40 -26
  28. data/lib/active_record/autosave_association.rb +22 -12
  29. data/lib/active_record/base.rb +3 -4
  30. data/lib/active_record/coders/json.rb +14 -5
  31. data/lib/active_record/connection_adapters/abstract/connection_handler.rb +19 -18
  32. data/lib/active_record/connection_adapters/abstract/connection_pool/queue.rb +16 -3
  33. data/lib/active_record/connection_adapters/abstract/connection_pool/reaper.rb +51 -12
  34. data/lib/active_record/connection_adapters/abstract/connection_pool.rb +458 -108
  35. data/lib/active_record/connection_adapters/abstract/database_statements.rb +55 -40
  36. data/lib/active_record/connection_adapters/abstract/query_cache.rb +36 -9
  37. data/lib/active_record/connection_adapters/abstract/quoting.rb +15 -24
  38. data/lib/active_record/connection_adapters/abstract/schema_creation.rb +7 -2
  39. data/lib/active_record/connection_adapters/abstract/schema_definitions.rb +31 -35
  40. data/lib/active_record/connection_adapters/abstract/schema_dumper.rb +2 -1
  41. data/lib/active_record/connection_adapters/abstract/schema_statements.rb +89 -23
  42. data/lib/active_record/connection_adapters/abstract/transaction.rb +25 -3
  43. data/lib/active_record/connection_adapters/abstract_adapter.rb +154 -64
  44. data/lib/active_record/connection_adapters/abstract_mysql_adapter.rb +57 -20
  45. data/lib/active_record/connection_adapters/column.rb +17 -4
  46. data/lib/active_record/connection_adapters/mysql/database_statements.rb +4 -4
  47. data/lib/active_record/connection_adapters/mysql/quoting.rb +7 -1
  48. data/lib/active_record/connection_adapters/mysql/schema_creation.rb +2 -0
  49. data/lib/active_record/connection_adapters/mysql/schema_definitions.rb +42 -5
  50. data/lib/active_record/connection_adapters/mysql/schema_statements.rb +33 -4
  51. data/lib/active_record/connection_adapters/mysql2/database_statements.rb +66 -15
  52. data/lib/active_record/connection_adapters/mysql2_adapter.rb +9 -3
  53. data/lib/active_record/connection_adapters/pool_config.rb +7 -7
  54. data/lib/active_record/connection_adapters/postgresql/column.rb +4 -0
  55. data/lib/active_record/connection_adapters/postgresql/database_statements.rb +26 -17
  56. data/lib/active_record/connection_adapters/postgresql/oid/array.rb +2 -2
  57. data/lib/active_record/connection_adapters/postgresql/oid/type_map_initializer.rb +1 -1
  58. data/lib/active_record/connection_adapters/postgresql/quoting.rb +21 -10
  59. data/lib/active_record/connection_adapters/postgresql/schema_creation.rb +8 -6
  60. data/lib/active_record/connection_adapters/postgresql/schema_definitions.rb +22 -33
  61. data/lib/active_record/connection_adapters/postgresql/schema_dumper.rb +67 -31
  62. data/lib/active_record/connection_adapters/postgresql/schema_statements.rb +82 -49
  63. data/lib/active_record/connection_adapters/postgresql_adapter.rb +38 -10
  64. data/lib/active_record/connection_adapters/schema_cache.rb +2 -2
  65. data/lib/active_record/connection_adapters/sqlite3/database_statements.rb +39 -23
  66. data/lib/active_record/connection_adapters/sqlite3/quoting.rb +13 -8
  67. data/lib/active_record/connection_adapters/sqlite3/schema_dumper.rb +14 -2
  68. data/lib/active_record/connection_adapters/sqlite3/schema_statements.rb +5 -12
  69. data/lib/active_record/connection_adapters/sqlite3_adapter.rb +65 -36
  70. data/lib/active_record/connection_adapters/statement_pool.rb +4 -2
  71. data/lib/active_record/connection_adapters/trilogy/database_statements.rb +4 -3
  72. data/lib/active_record/connection_adapters/trilogy_adapter.rb +2 -2
  73. data/lib/active_record/connection_adapters.rb +1 -0
  74. data/lib/active_record/connection_handling.rb +15 -10
  75. data/lib/active_record/core.rb +44 -12
  76. data/lib/active_record/counter_cache.rb +34 -9
  77. data/lib/active_record/database_configurations/connection_url_resolver.rb +3 -1
  78. data/lib/active_record/database_configurations/database_config.rb +5 -1
  79. data/lib/active_record/database_configurations/hash_config.rb +59 -9
  80. data/lib/active_record/database_configurations/url_config.rb +13 -3
  81. data/lib/active_record/database_configurations.rb +7 -3
  82. data/lib/active_record/delegated_type.rb +19 -19
  83. data/lib/active_record/dynamic_matchers.rb +54 -69
  84. data/lib/active_record/encryption/encryptable_record.rb +5 -5
  85. data/lib/active_record/encryption/encrypted_attribute_type.rb +2 -2
  86. data/lib/active_record/encryption/encryptor.rb +39 -25
  87. data/lib/active_record/encryption/scheme.rb +1 -1
  88. data/lib/active_record/enum.rb +37 -20
  89. data/lib/active_record/errors.rb +23 -7
  90. data/lib/active_record/explain.rb +1 -1
  91. data/lib/active_record/explain_registry.rb +51 -2
  92. data/lib/active_record/filter_attribute_handler.rb +73 -0
  93. data/lib/active_record/fixture_set/table_row.rb +19 -2
  94. data/lib/active_record/fixtures.rb +2 -2
  95. data/lib/active_record/future_result.rb +3 -3
  96. data/lib/active_record/gem_version.rb +2 -2
  97. data/lib/active_record/inheritance.rb +1 -1
  98. data/lib/active_record/insert_all.rb +12 -7
  99. data/lib/active_record/locking/optimistic.rb +7 -0
  100. data/lib/active_record/locking/pessimistic.rb +5 -0
  101. data/lib/active_record/log_subscriber.rb +2 -6
  102. data/lib/active_record/middleware/shard_selector.rb +34 -17
  103. data/lib/active_record/migration/command_recorder.rb +19 -3
  104. data/lib/active_record/migration/compatibility.rb +34 -24
  105. data/lib/active_record/migration/default_schema_versions_formatter.rb +30 -0
  106. data/lib/active_record/migration.rb +31 -21
  107. data/lib/active_record/model_schema.rb +36 -10
  108. data/lib/active_record/nested_attributes.rb +2 -0
  109. data/lib/active_record/persistence.rb +34 -3
  110. data/lib/active_record/query_cache.rb +22 -15
  111. data/lib/active_record/query_logs.rb +7 -7
  112. data/lib/active_record/querying.rb +4 -4
  113. data/lib/active_record/railtie.rb +35 -6
  114. data/lib/active_record/railties/controller_runtime.rb +11 -6
  115. data/lib/active_record/railties/databases.rake +24 -20
  116. data/lib/active_record/railties/job_checkpoints.rb +15 -0
  117. data/lib/active_record/railties/job_runtime.rb +10 -11
  118. data/lib/active_record/reflection.rb +35 -0
  119. data/lib/active_record/relation/batches.rb +25 -11
  120. data/lib/active_record/relation/calculations.rb +54 -38
  121. data/lib/active_record/relation/delegation.rb +0 -1
  122. data/lib/active_record/relation/finder_methods.rb +42 -25
  123. data/lib/active_record/relation/predicate_builder/association_query_value.rb +11 -9
  124. data/lib/active_record/relation/predicate_builder/polymorphic_array_value.rb +7 -7
  125. data/lib/active_record/relation/predicate_builder.rb +9 -7
  126. data/lib/active_record/relation/query_attribute.rb +4 -2
  127. data/lib/active_record/relation/query_methods.rb +43 -32
  128. data/lib/active_record/relation/spawn_methods.rb +6 -6
  129. data/lib/active_record/relation/where_clause.rb +10 -11
  130. data/lib/active_record/relation.rb +43 -19
  131. data/lib/active_record/result.rb +44 -21
  132. data/lib/active_record/runtime_registry.rb +42 -58
  133. data/lib/active_record/sanitization.rb +2 -0
  134. data/lib/active_record/schema_dumper.rb +42 -22
  135. data/lib/active_record/scoping.rb +0 -1
  136. data/lib/active_record/secure_token.rb +3 -3
  137. data/lib/active_record/signed_id.rb +47 -18
  138. data/lib/active_record/statement_cache.rb +15 -11
  139. data/lib/active_record/store.rb +44 -19
  140. data/lib/active_record/structured_event_subscriber.rb +85 -0
  141. data/lib/active_record/table_metadata.rb +5 -20
  142. data/lib/active_record/tasks/abstract_tasks.rb +76 -0
  143. data/lib/active_record/tasks/database_tasks.rb +44 -45
  144. data/lib/active_record/tasks/mysql_database_tasks.rb +3 -40
  145. data/lib/active_record/tasks/postgresql_database_tasks.rb +14 -40
  146. data/lib/active_record/tasks/sqlite_database_tasks.rb +14 -26
  147. data/lib/active_record/test_databases.rb +14 -4
  148. data/lib/active_record/test_fixtures.rb +27 -2
  149. data/lib/active_record/testing/query_assertions.rb +8 -2
  150. data/lib/active_record/timestamp.rb +4 -2
  151. data/lib/active_record/transaction.rb +2 -5
  152. data/lib/active_record/transactions.rb +39 -16
  153. data/lib/active_record/type/hash_lookup_type_map.rb +2 -1
  154. data/lib/active_record/type/internal/timezone.rb +7 -0
  155. data/lib/active_record/type/json.rb +15 -2
  156. data/lib/active_record/type/serialized.rb +11 -4
  157. data/lib/active_record/type/type_map.rb +1 -1
  158. data/lib/active_record/type_caster/connection.rb +2 -1
  159. data/lib/active_record/validations/associated.rb +1 -1
  160. data/lib/active_record.rb +71 -6
  161. data/lib/arel/alias_predication.rb +2 -0
  162. data/lib/arel/collectors/bind.rb +1 -1
  163. data/lib/arel/collectors/sql_string.rb +1 -1
  164. data/lib/arel/collectors/substitute_binds.rb +2 -2
  165. data/lib/arel/crud.rb +8 -11
  166. data/lib/arel/delete_manager.rb +5 -0
  167. data/lib/arel/nodes/binary.rb +1 -1
  168. data/lib/arel/nodes/count.rb +2 -2
  169. data/lib/arel/nodes/delete_statement.rb +4 -2
  170. data/lib/arel/nodes/function.rb +4 -10
  171. data/lib/arel/nodes/named_function.rb +2 -2
  172. data/lib/arel/nodes/node.rb +2 -2
  173. data/lib/arel/nodes/sql_literal.rb +1 -1
  174. data/lib/arel/nodes/update_statement.rb +4 -2
  175. data/lib/arel/nodes.rb +0 -2
  176. data/lib/arel/select_manager.rb +13 -4
  177. data/lib/arel/update_manager.rb +5 -0
  178. data/lib/arel/visitors/dot.rb +2 -3
  179. data/lib/arel/visitors/postgresql.rb +55 -0
  180. data/lib/arel/visitors/sqlite.rb +55 -8
  181. data/lib/arel/visitors/to_sql.rb +6 -22
  182. data/lib/arel.rb +3 -1
  183. data/lib/rails/generators/active_record/application_record/USAGE +1 -1
  184. metadata +16 -15
  185. data/lib/active_record/explain_subscriber.rb +0 -34
  186. data/lib/active_record/normalization.rb +0 -163
@@ -18,7 +18,7 @@ module ActiveRecord
18
18
  # For example the following migration is not reversible.
19
19
  # Rolling back this migration will raise an ActiveRecord::IrreversibleMigration error.
20
20
  #
21
- # class IrreversibleMigrationExample < ActiveRecord::Migration[8.0]
21
+ # class IrreversibleMigrationExample < ActiveRecord::Migration[8.1]
22
22
  # def change
23
23
  # create_table :distributors do |t|
24
24
  # t.string :zipcode
@@ -36,7 +36,7 @@ module ActiveRecord
36
36
  #
37
37
  # 1. Define <tt>#up</tt> and <tt>#down</tt> methods instead of <tt>#change</tt>:
38
38
  #
39
- # class ReversibleMigrationExample < ActiveRecord::Migration[8.0]
39
+ # class ReversibleMigrationExample < ActiveRecord::Migration[8.1]
40
40
  # def up
41
41
  # create_table :distributors do |t|
42
42
  # t.string :zipcode
@@ -61,7 +61,7 @@ module ActiveRecord
61
61
  #
62
62
  # 2. Use the #reversible method in <tt>#change</tt> method:
63
63
  #
64
- # class ReversibleMigrationExample < ActiveRecord::Migration[8.0]
64
+ # class ReversibleMigrationExample < ActiveRecord::Migration[8.1]
65
65
  # def change
66
66
  # create_table :distributors do |t|
67
67
  # t.string :zipcode
@@ -148,11 +148,10 @@ module ActiveRecord
148
148
  include ActiveSupport::ActionableError
149
149
 
150
150
  action "Run pending migrations" do
151
- ActiveRecord::Tasks::DatabaseTasks.migrate
151
+ ActiveRecord::Tasks::DatabaseTasks.migrate_all
152
152
 
153
153
  if ActiveRecord.dump_schema_after_migration
154
- connection = ActiveRecord::Tasks::DatabaseTasks.migration_connection
155
- ActiveRecord::Tasks::DatabaseTasks.dump_schema(connection.pool.db_config)
154
+ ActiveRecord::Tasks::DatabaseTasks.dump_all
156
155
  end
157
156
  end
158
157
 
@@ -247,7 +246,7 @@ module ActiveRecord
247
246
  #
248
247
  # Example of a simple migration:
249
248
  #
250
- # class AddSsl < ActiveRecord::Migration[8.0]
249
+ # class AddSsl < ActiveRecord::Migration[8.1]
251
250
  # def up
252
251
  # add_column :accounts, :ssl_enabled, :boolean, default: true
253
252
  # end
@@ -267,7 +266,7 @@ module ActiveRecord
267
266
  #
268
267
  # Example of a more complex migration that also needs to initialize data:
269
268
  #
270
- # class AddSystemSettings < ActiveRecord::Migration[8.0]
269
+ # class AddSystemSettings < ActiveRecord::Migration[8.1]
271
270
  # def up
272
271
  # create_table :system_settings do |t|
273
272
  # t.string :name
@@ -396,7 +395,7 @@ module ActiveRecord
396
395
  # $ bin/rails generate migration add_fieldname_to_tablename fieldname:string
397
396
  #
398
397
  # This will generate the file <tt>timestamp_add_fieldname_to_tablename.rb</tt>, which will look like this:
399
- # class AddFieldnameToTablename < ActiveRecord::Migration[8.0]
398
+ # class AddFieldnameToTablename < ActiveRecord::Migration[8.1]
400
399
  # def change
401
400
  # add_column :tablenames, :fieldname, :string
402
401
  # end
@@ -422,7 +421,7 @@ module ActiveRecord
422
421
  #
423
422
  # Not all migrations change the schema. Some just fix the data:
424
423
  #
425
- # class RemoveEmptyTags < ActiveRecord::Migration[8.0]
424
+ # class RemoveEmptyTags < ActiveRecord::Migration[8.1]
426
425
  # def up
427
426
  # Tag.all.each { |tag| tag.destroy if tag.pages.empty? }
428
427
  # end
@@ -435,7 +434,7 @@ module ActiveRecord
435
434
  #
436
435
  # Others remove columns when they migrate up instead of down:
437
436
  #
438
- # class RemoveUnnecessaryItemAttributes < ActiveRecord::Migration[8.0]
437
+ # class RemoveUnnecessaryItemAttributes < ActiveRecord::Migration[8.1]
439
438
  # def up
440
439
  # remove_column :items, :incomplete_items_count
441
440
  # remove_column :items, :completed_items_count
@@ -449,7 +448,7 @@ module ActiveRecord
449
448
  #
450
449
  # And sometimes you need to do something in SQL not abstracted directly by migrations:
451
450
  #
452
- # class MakeJoinUnique < ActiveRecord::Migration[8.0]
451
+ # class MakeJoinUnique < ActiveRecord::Migration[8.1]
453
452
  # def up
454
453
  # execute "ALTER TABLE `pages_linked_pages` ADD UNIQUE `page_id_linked_page_id` (`page_id`,`linked_page_id`)"
455
454
  # end
@@ -466,7 +465,7 @@ module ActiveRecord
466
465
  # <tt>Base#reset_column_information</tt> in order to ensure that the model has the
467
466
  # latest column data from after the new column was added. Example:
468
467
  #
469
- # class AddPeopleSalary < ActiveRecord::Migration[8.0]
468
+ # class AddPeopleSalary < ActiveRecord::Migration[8.1]
470
469
  # def up
471
470
  # add_column :people, :salary, :integer
472
471
  # Person.reset_column_information
@@ -528,7 +527,7 @@ module ActiveRecord
528
527
  # To define a reversible migration, define the +change+ method in your
529
528
  # migration like this:
530
529
  #
531
- # class TenderloveMigration < ActiveRecord::Migration[8.0]
530
+ # class TenderloveMigration < ActiveRecord::Migration[8.1]
532
531
  # def change
533
532
  # create_table(:horses) do |t|
534
533
  # t.column :content, :text
@@ -558,7 +557,7 @@ module ActiveRecord
558
557
  # can't execute inside a transaction though, and for these situations
559
558
  # you can turn the automatic transactions off.
560
559
  #
561
- # class ChangeEnum < ActiveRecord::Migration[8.0]
560
+ # class ChangeEnum < ActiveRecord::Migration[8.1]
562
561
  # disable_ddl_transaction!
563
562
  #
564
563
  # def up
@@ -571,6 +570,7 @@ module ActiveRecord
571
570
  class Migration
572
571
  autoload :CommandRecorder, "active_record/migration/command_recorder"
573
572
  autoload :Compatibility, "active_record/migration/compatibility"
573
+ autoload :DefaultSchemaVersionsFormatter, "active_record/migration/default_schema_versions_formatter"
574
574
  autoload :JoinTable, "active_record/migration/join_table"
575
575
  autoload :ExecutionStrategy, "active_record/migration/execution_strategy"
576
576
  autoload :DefaultStrategy, "active_record/migration/default_strategy"
@@ -747,7 +747,7 @@ module ActiveRecord
747
747
  private
748
748
  def any_schema_needs_update?
749
749
  !db_configs_in_current_env.all? do |db_config|
750
- Tasks::DatabaseTasks.schema_up_to_date?(db_config, ActiveRecord.schema_format)
750
+ Tasks::DatabaseTasks.schema_up_to_date?(db_config)
751
751
  end
752
752
  end
753
753
 
@@ -782,6 +782,11 @@ module ActiveRecord
782
782
  system("bin/rails db:test:prepare")
783
783
  end
784
784
  end
785
+
786
+ def respond_to_missing?(method, include_private = false)
787
+ return false if nearest_delegate == delegate
788
+ nearest_delegate.respond_to?(method, include_private)
789
+ end
785
790
  end
786
791
 
787
792
  def disable_ddl_transaction # :nodoc:
@@ -819,7 +824,7 @@ module ActiveRecord
819
824
  # and create the table 'apples' on the way up, and the reverse
820
825
  # on the way down.
821
826
  #
822
- # class FixTLMigration < ActiveRecord::Migration[8.0]
827
+ # class FixTLMigration < ActiveRecord::Migration[8.1]
823
828
  # def change
824
829
  # revert do
825
830
  # create_table(:horses) do |t|
@@ -838,7 +843,7 @@ module ActiveRecord
838
843
  #
839
844
  # require_relative "20121212123456_tenderlove_migration"
840
845
  #
841
- # class FixupTLMigration < ActiveRecord::Migration[8.0]
846
+ # class FixupTLMigration < ActiveRecord::Migration[8.1]
842
847
  # def change
843
848
  # revert TenderloveMigration
844
849
  #
@@ -889,7 +894,7 @@ module ActiveRecord
889
894
  # when the three columns 'first_name', 'last_name' and 'full_name' exist,
890
895
  # even when migrating down:
891
896
  #
892
- # class SplitNameMigration < ActiveRecord::Migration[8.0]
897
+ # class SplitNameMigration < ActiveRecord::Migration[8.1]
893
898
  # def change
894
899
  # add_column :users, :first_name, :string
895
900
  # add_column :users, :last_name, :string
@@ -917,7 +922,7 @@ module ActiveRecord
917
922
  # In the following example, the new column +published+ will be given
918
923
  # the value +true+ for all existing records.
919
924
  #
920
- # class AddPublishedToPosts < ActiveRecord::Migration[8.0]
925
+ # class AddPublishedToPosts < ActiveRecord::Migration[8.1]
921
926
  # def change
922
927
  # add_column :posts, :published, :boolean, default: false
923
928
  # up_only do
@@ -1170,6 +1175,10 @@ module ActiveRecord
1170
1175
  def command_recorder
1171
1176
  CommandRecorder.new(connection)
1172
1177
  end
1178
+
1179
+ def respond_to_missing?(method, include_private = false)
1180
+ execution_strategy.respond_to?(method, include_private) || super
1181
+ end
1173
1182
  end
1174
1183
 
1175
1184
  # MigrationProxy is used to defer loading of the actual migration classes
@@ -1529,7 +1538,8 @@ module ActiveRecord
1529
1538
  return if down? && !migrated.include?(migration.version.to_i)
1530
1539
  return if up? && migrated.include?(migration.version.to_i)
1531
1540
 
1532
- Base.logger.info "Migrating to #{migration.name} (#{migration.version})" if Base.logger
1541
+ message = up? ? "Migrating to" : "Reverting"
1542
+ Base.logger.info "#{message} #{migration.name} (#{migration.version})" if Base.logger
1533
1543
 
1534
1544
  ddl_transaction(migration) do
1535
1545
  migration.migrate(@direction)
@@ -48,7 +48,7 @@ module ActiveRecord
48
48
  # way of creating a namespace for tables in a shared database. By default, the prefix is the
49
49
  # empty string.
50
50
  #
51
- # If you are organising your models within modules you can add a prefix to the models within
51
+ # If you are organizing your models within modules you can add a prefix to the models within
52
52
  # a namespace by defining a singleton method in the parent module called table_name_prefix which
53
53
  # returns your chosen prefix.
54
54
 
@@ -65,7 +65,7 @@ module ActiveRecord
65
65
  # Works like +table_name_prefix=+, but appends instead of prepends (set to "_basecamp" gives "projects_basecamp",
66
66
  # "people_basecamp"). By default, the suffix is the empty string.
67
67
  #
68
- # If you are organising your models within modules, you can add a suffix to the models within
68
+ # If you are organizing your models within modules, you can add a suffix to the models within
69
69
  # a namespace by defining a singleton method in the parent module called table_name_suffix which
70
70
  # returns your chosen suffix.
71
71
 
@@ -113,17 +113,19 @@ module ActiveRecord
113
113
  # :singleton-method: implicit_order_column
114
114
  # :call-seq: implicit_order_column
115
115
  #
116
- # The name of the column records are ordered by if no explicit order clause
116
+ # The name of the column(s) records are ordered by if no explicit order clause
117
117
  # is used during an ordered finder call. If not set the primary key is used.
118
118
 
119
119
  ##
120
120
  # :singleton-method: implicit_order_column=
121
121
  # :call-seq: implicit_order_column=(column_name)
122
122
  #
123
- # Sets the column to sort records by when no explicit order clause is used
124
- # during an ordered finder call. Useful when the primary key is not an
125
- # auto-incrementing integer, for example when it's a UUID. Records are subsorted
126
- # by the primary key if it exists to ensure deterministic results.
123
+ # Sets the column(s) to sort records by when no explicit order clause is used
124
+ # during an ordered finder call. Useful for models where the primary key isn't an
125
+ # auto-incrementing integer (such as UUID).
126
+ #
127
+ # By default, records are subsorted by primary key to ensure deterministic results.
128
+ # To disable this subsort behavior, set `implicit_order_column` to `["column_name", nil]`.
127
129
 
128
130
  ##
129
131
  # :singleton-method: immutable_strings_by_default=
@@ -179,6 +181,7 @@ module ActiveRecord
179
181
  self.protected_environments = ["production"]
180
182
 
181
183
  self.ignored_columns = [].freeze
184
+ self.only_columns = [].freeze
182
185
 
183
186
  delegate :type_for_attribute, :column_for_attribute, to: :class
184
187
 
@@ -332,6 +335,12 @@ module ActiveRecord
332
335
  @ignored_columns || superclass.ignored_columns
333
336
  end
334
337
 
338
+ # The list of columns names the model should allow. Only columns are used to define
339
+ # attribute accessors, and are referenced in SQL queries.
340
+ def only_columns
341
+ @only_columns || superclass.only_columns
342
+ end
343
+
335
344
  # Sets the columns names the model should ignore. Ignored columns won't have attribute
336
345
  # accessors defined, and won't be referenced in SQL queries.
337
346
  #
@@ -364,10 +373,17 @@ module ActiveRecord
364
373
  # user = Project.create!(name: "First Project")
365
374
  # user.category # => raises NoMethodError
366
375
  def ignored_columns=(columns)
376
+ check_model_columns(@only_columns.present?)
367
377
  reload_schema_from_cache
368
378
  @ignored_columns = columns.map(&:to_s).freeze
369
379
  end
370
380
 
381
+ def only_columns=(columns)
382
+ check_model_columns(@ignored_columns.present?)
383
+ reload_schema_from_cache
384
+ @only_columns = columns.map(&:to_s).freeze
385
+ end
386
+
371
387
  def sequence_name
372
388
  if base_class?
373
389
  @sequence_name ||= reset_sequence_name
@@ -501,7 +517,7 @@ module ActiveRecord
501
517
  # when just after creating a table you want to populate it with some default
502
518
  # values, e.g.:
503
519
  #
504
- # class CreateJobLevels < ActiveRecord::Migration[8.0]
520
+ # class CreateJobLevels < ActiveRecord::Migration[8.1]
505
521
  # def up
506
522
  # create_table :job_levels do |t|
507
523
  # t.integer :id
@@ -577,6 +593,7 @@ module ActiveRecord
577
593
  child_class.reload_schema_from_cache(false)
578
594
  child_class.class_eval do
579
595
  @ignored_columns = nil
596
+ @only_columns = nil
580
597
  end
581
598
  end
582
599
 
@@ -590,7 +607,11 @@ module ActiveRecord
590
607
  end
591
608
 
592
609
  columns_hash = schema_cache.columns_hash(table_name)
593
- columns_hash = columns_hash.except(*ignored_columns) unless ignored_columns.empty?
610
+ if only_columns.present?
611
+ columns_hash = columns_hash.slice(*only_columns)
612
+ elsif ignored_columns.present?
613
+ columns_hash = columns_hash.except(*ignored_columns)
614
+ end
594
615
  @columns_hash = columns_hash.freeze
595
616
 
596
617
  _default_attributes # Precompute to cache DB-dependent attribute types
@@ -620,7 +641,8 @@ module ActiveRecord
620
641
  end
621
642
 
622
643
  def type_for_column(connection, column)
623
- type = connection.lookup_cast_type_from_column(column)
644
+ # TODO: Remove the need for a connection after we release 8.1.
645
+ type = column.fetch_cast_type(connection)
624
646
 
625
647
  if immutable_strings_by_default && type.respond_to?(:to_immutable_string)
626
648
  type = type.to_immutable_string
@@ -628,6 +650,10 @@ module ActiveRecord
628
650
 
629
651
  type
630
652
  end
653
+
654
+ def check_model_columns(columns_present)
655
+ raise ArgumentError, "You can not use both only_columns and ignored_columns in the same model." if columns_present
656
+ end
631
657
  end
632
658
  end
633
659
  end
@@ -387,6 +387,8 @@ module ActiveRecord
387
387
  generated_association_methods.module_eval <<-eoruby, __FILE__, __LINE__ + 1
388
388
  silence_redefinition_of_method :#{association_name}_attributes=
389
389
  def #{association_name}_attributes=(attributes)
390
+ association = association(:#{association_name})
391
+ deprecated_associations_api_guard(association, __method__)
390
392
  assign_nested_attributes_for_#{type}_association(:#{association_name}, attributes)
391
393
  end
392
394
  eoruby
@@ -492,6 +492,7 @@ module ActiveRecord
492
492
  becoming.instance_variable_set(:@attributes, @attributes)
493
493
  becoming.instance_variable_set(:@mutations_from_database, @mutations_from_database ||= nil)
494
494
  becoming.instance_variable_set(:@new_record, new_record?)
495
+ becoming.instance_variable_set(:@previously_new_record, previously_new_record?)
495
496
  becoming.instance_variable_set(:@destroyed, destroyed?)
496
497
  becoming.errors.copy!(errors)
497
498
  end
@@ -581,8 +582,8 @@ module ActiveRecord
581
582
  end
582
583
 
583
584
  # Equivalent to <code>update_columns(name => value)</code>.
584
- def update_column(name, value)
585
- update_columns(name => value)
585
+ def update_column(name, value, touch: nil)
586
+ update_columns(name => value, touch: touch)
586
587
  end
587
588
 
588
589
  # Updates the attributes directly in the database issuing an UPDATE SQL
@@ -596,11 +597,25 @@ module ActiveRecord
596
597
  #
597
598
  # * \Validations are skipped.
598
599
  # * \Callbacks are skipped.
599
- # * +updated_at+/+updated_on+ are not updated.
600
+ # * +updated_at+/+updated_on+ are updated if the +touch+ option is set to +true+.
600
601
  # * However, attributes are serialized with the same rules as ActiveRecord::Relation#update_all
601
602
  #
602
603
  # This method raises an ActiveRecord::ActiveRecordError when called on new
603
604
  # objects, or when at least one of the attributes is marked as readonly.
605
+ #
606
+ # ==== Parameters
607
+ #
608
+ # * <tt>:touch</tt> option - Touch the timestamp columns when updating.
609
+ # * If attribute names are passed, they are updated along with +updated_at+/+updated_on+ attributes.
610
+ #
611
+ # ==== Examples
612
+ #
613
+ # # Update a single attribute.
614
+ # user.update_columns(last_request_at: Time.current)
615
+ #
616
+ # # Update with touch option.
617
+ # user.update_columns(last_request_at: Time.current, touch: true)
618
+
604
619
  def update_columns(attributes)
605
620
  raise ActiveRecordError, "cannot update a new record" if new_record?
606
621
  raise ActiveRecordError, "cannot update a destroyed record" if destroyed?
@@ -612,6 +627,15 @@ module ActiveRecord
612
627
  verify_readonly_attribute(name) || name
613
628
  end
614
629
 
630
+ touch = attributes.delete("touch")
631
+ if touch
632
+ names = touch if touch != true
633
+ names = Array.wrap(names)
634
+ options = names.extract_options!
635
+ touch_updates = self.class.touch_attributes_with_time(*names, **options)
636
+ attributes.with_defaults!(touch_updates) unless touch_updates.empty?
637
+ end
638
+
615
639
  update_constraints = _query_constraints_hash
616
640
  attributes = attributes.each_with_object({}) do |(k, v), h|
617
641
  h[k] = @attributes.write_cast_value(k, v)
@@ -640,8 +664,15 @@ module ActiveRecord
640
664
  # This means that any other modified attributes will still be dirty.
641
665
  # Validations and callbacks are skipped. Supports the +touch+ option from
642
666
  # +update_counters+, see that for more.
667
+ #
668
+ # This method raises an ActiveRecord::ActiveRecordError when called on new
669
+ # objects, or when at least one of the attributes is marked as readonly.
670
+ #
643
671
  # Returns +self+.
644
672
  def increment!(attribute, by = 1, touch: nil)
673
+ raise ActiveRecordError, "cannot update a new record" if new_record?
674
+ raise ActiveRecordError, "cannot update a destroyed record" if destroyed?
675
+
645
676
  increment(attribute, by)
646
677
  change = public_send(attribute) - (public_send(:"#{attribute}_in_database") || 0)
647
678
  self.class.update_counters(id, attribute => change, touch: touch)
@@ -3,6 +3,7 @@
3
3
  module ActiveRecord
4
4
  # = Active Record Query Cache
5
5
  class QueryCache
6
+ # ActiveRecord::Base extends this module, so these methods are available in models.
6
7
  module ClassMethods
7
8
  # Enable the query cache within the block if Active Record is configured.
8
9
  # If it's not, it will execute the given block.
@@ -20,11 +21,15 @@ module ActiveRecord
20
21
  end
21
22
  end
22
23
 
23
- # Disable the query cache within the block if Active Record is configured.
24
- # If it's not, it will execute the given block.
24
+ # Runs the block with the query cache disabled.
25
+ #
26
+ # If the query cache was enabled before the block was executed, it is
27
+ # enabled again after it.
25
28
  #
26
- # Set <tt>dirties: false</tt> to prevent query caches on all connections from being cleared by write operations.
27
- # (By default, write operations dirty all connections' query caches in case they are replicas whose cache would now be outdated.)
29
+ # Set <tt>dirties: false</tt> to prevent query caches on all connections
30
+ # from being cleared by write operations. (By default, write operations
31
+ # dirty all connections' query caches in case they are replicas whose
32
+ # cache would now be outdated.)
28
33
  def uncached(dirties: true, &block)
29
34
  if connected? || !configurations.empty?
30
35
  connection_pool.disable_query_cache(dirties: dirties, &block)
@@ -34,22 +39,24 @@ module ActiveRecord
34
39
  end
35
40
  end
36
41
 
37
- def self.run
38
- ActiveRecord::Base.connection_handler.each_connection_pool.reject(&:query_cache_enabled).each do |pool|
39
- next if pool.db_config&.query_cache == false
40
- pool.enable_query_cache!
42
+ module ExecutorHooks # :nodoc:
43
+ def self.run
44
+ ActiveRecord::Base.connection_handler.each_connection_pool.reject(&:query_cache_enabled).each do |pool|
45
+ next if pool.db_config&.query_cache == false
46
+ pool.enable_query_cache!
47
+ end
41
48
  end
42
- end
43
49
 
44
- def self.complete(pools)
45
- pools.each do |pool|
46
- pool.disable_query_cache!
47
- pool.clear_query_cache
50
+ def self.complete(pools)
51
+ pools.each do |pool|
52
+ pool.disable_query_cache!
53
+ pool.clear_query_cache
54
+ end
48
55
  end
49
56
  end
50
57
 
51
- def self.install_executor_hooks(executor = ActiveSupport::Executor)
52
- executor.register_hook(self)
58
+ def self.install_executor_hooks(executor = ActiveSupport::Executor) # :nodoc:
59
+ executor.register_hook(ExecutorHooks)
53
60
  end
54
61
  end
55
62
  end
@@ -28,6 +28,10 @@ module ActiveRecord
28
28
  # * +database+
29
29
  # * +source_location+
30
30
  #
31
+ # WARNING: Calculating the +source_location+ of a query can be slow, so you should consider its impact if using it in a production environment.
32
+ #
33
+ # Also see {config.active_record.verbose_query_logs}[https://guides.rubyonrails.org/debugging_rails_applications.html#verbose-query-logs].
34
+ #
31
35
  # Action Controller adds default tags when loaded:
32
36
  #
33
37
  # * +controller+
@@ -65,7 +69,7 @@ module ActiveRecord
65
69
  #
66
70
  # Tag comments can be prepended to the query:
67
71
  #
68
- # ActiveRecord::QueryLogs.prepend_comment = true
72
+ # config.active_record.query_log_tags_prepend_comment = true
69
73
  #
70
74
  # For applications where the content will not change during the lifetime of
71
75
  # the request or job execution, the tags can be cached for reuse in every query:
@@ -153,11 +157,7 @@ module ActiveRecord
153
157
  end
154
158
 
155
159
  def query_source_location # :nodoc:
156
- Thread.each_caller_location do |location|
157
- frame = LogSubscriber.backtrace_cleaner.clean_frame(location)
158
- return frame if frame
159
- end
160
- nil
160
+ LogSubscriber.backtrace_cleaner.first_clean_frame
161
161
  end
162
162
 
163
163
  ActiveSupport::ExecutionContext.after_change { ActiveRecord::QueryLogs.clear_cache }
@@ -211,7 +211,7 @@ module ActiveRecord
211
211
  end
212
212
 
213
213
  def escape_sql_comment(content)
214
- # Sanitize a string to appear within a SQL comment
214
+ # Sanitize a string to appear within an SQL comment
215
215
  # For compatibility, this also surrounding "/*+", "/*", and "*/"
216
216
  # characters, possibly with single surrounding space.
217
217
  # Then follows that by replacing any internal "*/" or "/ *" with
@@ -46,8 +46,8 @@ module ActiveRecord
46
46
  # Post.find_by_sql ["SELECT title FROM posts WHERE author = ? AND created > ?", author_id, start_date]
47
47
  # Post.find_by_sql ["SELECT body FROM comments WHERE author = :user_id OR approved_by = :user_id", { :user_id => user_id }]
48
48
  #
49
- # Note that building your own SQL query string from user input may expose your application to
50
- # injection attacks (https://guides.rubyonrails.org/security.html#sql-injection).
49
+ # Note that building your own SQL query string from user input {may expose your application to
50
+ # injection attacks}[https://guides.rubyonrails.org/security.html#sql-injection].
51
51
  def find_by_sql(sql, binds = [], preparable: nil, allow_retry: false, &block)
52
52
  result = with_connection do |c|
53
53
  _query_by_sql(c, sql, binds, preparable: preparable, allow_retry: allow_retry)
@@ -55,7 +55,7 @@ module ActiveRecord
55
55
  _load_from_sql(result, &block)
56
56
  end
57
57
 
58
- # Same as <tt>#find_by_sql</tt> but perform the query asynchronously and returns an ActiveRecord::Promise.
58
+ # Same as #find_by_sql but perform the query asynchronously and returns an ActiveRecord::Promise.
59
59
  def async_find_by_sql(sql, binds = [], preparable: nil, allow_retry: false, &block)
60
60
  with_connection do |c|
61
61
  _query_by_sql(c, sql, binds, preparable: preparable, allow_retry: allow_retry, async: true)
@@ -112,7 +112,7 @@ module ActiveRecord
112
112
  end
113
113
  end
114
114
 
115
- # Same as <tt>#count_by_sql</tt> but perform the query asynchronously and returns an ActiveRecord::Promise.
115
+ # Same as #count_by_sql but perform the query asynchronously and returns an ActiveRecord::Promise.
116
116
  def async_count_by_sql(sql)
117
117
  with_connection do |c|
118
118
  c.select_value(sanitize_sql(sql), "#{name} Count", async: true).then(&:to_i)
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require "active_record"
4
3
  require "rails"
4
+ require "active_record"
5
5
  require "active_support/core_ext/object/try"
6
6
  require "active_model/railtie"
7
7
 
@@ -23,8 +23,8 @@ module ActiveRecord
23
23
  config.action_dispatch.rescue_responses.merge!(
24
24
  "ActiveRecord::RecordNotFound" => :not_found,
25
25
  "ActiveRecord::StaleObjectError" => :conflict,
26
- "ActiveRecord::RecordInvalid" => :unprocessable_entity,
27
- "ActiveRecord::RecordNotSaved" => :unprocessable_entity
26
+ "ActiveRecord::RecordInvalid" => ActionDispatch::Constants::UNPROCESSABLE_CONTENT,
27
+ "ActiveRecord::RecordNotSaved" => ActionDispatch::Constants::UNPROCESSABLE_CONTENT
28
28
  )
29
29
 
30
30
  config.active_record.use_schema_cache_dump = true
@@ -35,9 +35,12 @@ module ActiveRecord
35
35
  config.active_record.query_log_tags = [ :application ]
36
36
  config.active_record.query_log_tags_format = :legacy
37
37
  config.active_record.cache_query_log_tags = false
38
+ config.active_record.query_log_tags_prepend_comment = false
38
39
  config.active_record.raise_on_assign_to_attr_readonly = false
39
40
  config.active_record.belongs_to_required_validates_foreign_key = true
40
41
  config.active_record.generate_secure_token_on = :create
42
+ config.active_record.use_legacy_signed_id_verifier = :generate_and_verify
43
+ config.active_record.deprecated_associations_options = { mode: :warn, backtrace: false }
41
44
 
42
45
  config.active_record.queues = ActiveSupport::InheritableOptions.new
43
46
 
@@ -229,10 +232,12 @@ To keep using the current cache store, you can turn off cache versioning entirel
229
232
  :query_log_tags,
230
233
  :query_log_tags_format,
231
234
  :cache_query_log_tags,
235
+ :query_log_tags_prepend_comment,
232
236
  :sqlite3_adapter_strict_strings_by_default,
233
237
  :check_schema_cache_dump_version,
234
238
  :use_schema_cache_dump,
235
239
  :postgresql_adapter_decode_dates,
240
+ :use_legacy_signed_id_verifier,
236
241
  )
237
242
 
238
243
  configs_used_in_other_initializers.each do |k, v|
@@ -274,6 +279,13 @@ To keep using the current cache store, you can turn off cache versioning entirel
274
279
  end
275
280
  end
276
281
 
282
+ initializer "active_record.job_checkpoints" do
283
+ require "active_record/railties/job_checkpoints"
284
+ ActiveSupport.on_load(:active_job_continuable) do
285
+ prepend ActiveRecord::Railties::JobCheckpoints
286
+ end
287
+ end
288
+
277
289
  initializer "active_record.set_reloader_hooks" do
278
290
  ActiveSupport.on_load(:active_record) do
279
291
  ActiveSupport::Reloader.before_class_unload do
@@ -319,9 +331,22 @@ To keep using the current cache store, you can turn off cache versioning entirel
319
331
  end
320
332
  end
321
333
 
322
- initializer "active_record.set_signed_id_verifier_secret" do
323
- ActiveSupport.on_load(:active_record) do
324
- self.signed_id_verifier_secret ||= -> { Rails.application.key_generator.generate_key("active_record/signed_id") }
334
+ initializer "active_record.filter_attributes_as_log_parameters" do |app|
335
+ ActiveRecord::FilterAttributeHandler.new(app).enable
336
+ end
337
+
338
+ initializer "active_record.configure_message_verifiers" do |app|
339
+ ActiveRecord.message_verifiers = app.message_verifiers
340
+
341
+ use_legacy_signed_id_verifier = app.config.active_record.use_legacy_signed_id_verifier
342
+ legacy_options = { digest: "SHA256", serializer: JSON, url_safe: true }
343
+
344
+ if use_legacy_signed_id_verifier == :generate_and_verify
345
+ app.message_verifiers.prepend { |salt| legacy_options if salt == "active_record/signed_id" }
346
+ elsif use_legacy_signed_id_verifier == :verify
347
+ app.message_verifiers.rotate { |salt| legacy_options if salt == "active_record/signed_id" }
348
+ elsif use_legacy_signed_id_verifier
349
+ raise ArgumentError, "Unrecognized value for config.active_record.use_legacy_signed_id_verifier: #{use_legacy_signed_id_verifier.inspect}"
325
350
  end
326
351
  end
327
352
 
@@ -387,6 +412,10 @@ To keep using the current cache store, you can turn off cache versioning entirel
387
412
  if app.config.active_record.cache_query_log_tags
388
413
  ActiveRecord::QueryLogs.cache_query_log_tags = true
389
414
  end
415
+
416
+ if app.config.active_record.query_log_tags_prepend_comment
417
+ ActiveRecord::QueryLogs.prepend_comment = true
418
+ end
390
419
  end
391
420
  end
392
421
  end