CHANGELOG.md 15.4 KB
Newer Older
1 2 3 4
*   Add the touch option to ActiveRecord#increment! and decrement!

    *Hiroaki Izu*

5 6 7 8 9
*   Deprecate passing a class to the `class_name` because it eagerloads more classes than
    necessary and potentially creates circular dependencies.

    *Kir Shatrov*

10 11 12 13 14 15
*   Raise error when has_many through is defined before through association

    Fixes #26834

    *Chris Holmes*

16 17 18 19
*   Deprecate passing `name` to `indexes`.

    *Ryuta Kamizono*

20 21 22 23
*   Remove deprecated tasks: `db:test:clone`, `db:test:clone_schema`, `db:test:clone_structure`.

    *Rafel Mendonça França*

24
*   Compare deserialized values for `PostgreSQL::OID::Hstore` types when
25
    calling `ActiveRecord::Dirty#changed_in_place?`.
26 27 28 29 30

    Fixes #27502.

    *Jon Moss*

31 32
*   Raise `ArgumentError` when passing an `ActiveRecord::Base` instance to `.find`,
    `.exists?` and `.update`.
33 34 35

    *Rafael Mendonça França*

36 37 38 39 40 41
*   Respect precision option for arrays of timestamps.

    Fixes #27514.

    *Sean Griffin*

42 43 44 45
*   Optimize slow model instantiation when using STI and `store_full_sti_class = false` option.

    *Konstantin Lazarev*

46 47 48 49 50 51 52 53 54 55 56 57 58
*   Add `touch` option to counter cache modifying methods.

    Works when updating, resetting, incrementing and decrementing counters:

        # Touches `updated_at`/`updated_on`.
        Topic.increment_counter(:messages_count, 1, touch: true)
        Topic.decrement_counter(:messages_count, 1, touch: true)

        # Touches `last_discussed_at`.
        Topic.reset_counters(18, :messages, touch: :last_discussed_at)

        # Touches `updated_at` and `last_discussed_at`.
        Topic.update_counters(18, messages_count: 5, touch: %i( updated_at last_discussed_at ))
59 60 61 62 63

    Fixes #26724.

    *Jarred Trost*

64 65 66 67
*   Remove deprecated `#uniq`, `#uniq!`, and `#uniq_value`.

    *Ryuta Kamizono*

68 69 70 71
*   Remove deprecated `#insert_sql`, `#update_sql`, and `#delete_sql`.

    *Ryuta Kamizono*

72 73 74 75
*   Remove deprecated `#use_transactional_fixtures` configuration.

    *Rafael Mendonça França*

76 77 78 79
*   Remove deprecated `#raise_in_transactional_callbacks` configuration.

    *Rafael Mendonça França*

80 81 82 83
*   Remove deprecated `#load_schema_for`.

    *Rafael Mendonça França*

84
*   Remove deprecated conditions parameter from `#destroy_all` and `#delete_all`.
85 86 87

    *Rafael Mendonça França*

88 89 90 91
*   Remove deprecated support to passing arguments to `#select` when a block is provided.

    *Rafael Mendonça França*

92 93 94 95
*   Remove deprecated support to query using commas on LIMIT.

    *Rafael Mendonça França*

96 97 98 99
*   Remove deprecated support to passing a class as a value in a query.

    *Rafael Mendonça França*

100
*   Raise `ActiveRecord::IrreversibleOrderError` when using `last` with an irreversible
101 102 103 104
    order.

    *Rafael Mendonça França*

105
*   Raise when a `has_many :through` association has an ambiguous reflection name.
106 107 108

    *Rafael Mendonça França*

109
*   Raise when `ActiveRecord::Migration` is inherited from directly.
110 111 112

    *Rafael Mendonça França*

113 114 115 116 117
*   Remove deprecated `original_exception` argument in `ActiveRecord::StatementInvalid#initialize`
    and `ActiveRecord::StatementInvalid#original_exception`.

    *Rafael Mendonça França*

K
kenta-s 已提交
118
*   `#tables` and `#table_exists?` return only tables and not views.
119 120 121 122 123

    All the deprecations on those methods were removed.

    *Rafael Mendonça França*

124 125 126 127
*   Remove deprecated `name` argument from `#tables`.

    *Rafael Mendonça França*

128 129 130 131
*   Remove deprecated support to passing a column to `#quote`.

    *Rafael Mendonça França*

132 133
*   Set `:time` as a timezone aware type and remove deprecation when
    `config.active_record.time_zone_aware_types` is not explictly set.
134 135 136

    *Rafael Mendonça França*

137 138 139 140
*   Remove deprecated force reload argument in singular and collection association readers.

    *Rafael Mendonça França*

141 142 143 144 145
*   Remove deprecated `activerecord.errors.messages.restrict_dependent_destroy.one` and
    `activerecord.errors.messages.restrict_dependent_destroy.many` i18n scopes.

    *Rafael Mendonça França*

146 147 148 149 150 151 152
*   Allow passing extra flags to `db:structure:load` and `db:structure:dump`

    Introduces `ActiveRecord::Tasks::DatabaseTasks.structure_(load|dump)_flags` to customize the
    eventual commands run against the database, e.g. mysqldump/pg_dump.

    *Kir Shatrov*

R
Richard Monette 已提交
153 154
*   Notifications see frozen SQL string.

155
    Fixes #23774.
R
Richard Monette 已提交
156 157 158

    *Richard Monette*

159
*   RuntimeErrors are no longer translated to `ActiveRecord::StatementInvalid`.
R
Richard Monette 已提交
160 161 162

    *Richard Monette*

163 164 165 166
*   Change the schema cache format to use YAML instead of Marshal.

    *Kir Shatrov*

167 168 169 170 171 172 173
*   Support index length and order options using both string and symbol
    column names.

    Fixes #27243.

    *Ryuta Kamizono*

174 175 176 177
*   Raise `ActiveRecord::RangeError` when values that executed are out of range.

    *Ryuta Kamizono*

178 179 180 181 182 183
*   Raise `ActiveRecord::NotNullViolation` when a record cannot be inserted
    or updated because it would violate a not null constraint.

    *Ryuta Kamizono*

*   Emulate db trigger behaviour for after_commit :destroy, :update.
184 185 186 187 188 189 190

    Race conditions can occur when an ActiveRecord is destroyed
    twice or destroyed and updated. The callbacks should only be
    triggered once, similar to a SQL database trigger.

    *Stefan Budeanu*

191
*   Moved `DecimalWithoutScale`, `Text`, and `UnsignedInteger` from Active Model to Active Record.
192 193 194

    *Iain Beeston*

195 196 197 198 199
*   Fix `write_attribute` method to check whether an attribute is aliased or not, and
    use the aliased attribute name if needed.

    *Prathamesh Sonpatki*

200 201 202 203 204 205 206
*   Fix `read_attribute` method to check whether an attribute is aliased or not, and
    use the aliased attribute name if needed.

    Fixes #26417.

    *Prathamesh Sonpatki*

207
*   PostgreSQL & MySQL: Use big integer as primary key type for new tables.
208 209 210

    *Jon McCartie*, *Pavel Pravosud*

211 212 213 214 215 216
*   Change the type argument of `ActiveRecord::Base#attribute` to be optional.
    The default is now `ActiveRecord::Type::Value.new`, which provides no type
    casting behavior.

    *Sean Griffin*

J
Jon Moss 已提交
217
*   Don't treat unsigned integers with zerofill as signed.
218 219 220 221 222

    Fixes #27125.

    *Ryuta Kamizono*

223 224 225 226
*   Fix the uniqueness validation scope with a polymorphic association.

    *Sergey Alekseev*

227
*   Raise `ActiveRecord::RecordNotFound` from collection `*_ids` setters
228 229
    for unknown IDs with a better error message.

230 231 232 233
    Changes the collection `*_ids` setters to cast provided IDs the data
    type of the primary key set in the association, not the model
    primary key.

234 235
    *Dominic Cleal*

236 237 238 239 240
*   For PostgreSQL >= 9.4 use `pgcrypto`'s `gen_random_uuid()` instead of
    `uuid-ossp`'s UUID generation function.

    *Yuji Yaginuma*, *Yaw Boakye*

241 242 243 244
*   Introduce `Model#reload_<association>` to bring back the behavior
    of `Article.category(true)` where `category` is a singular
    association.

245 246
    The force reloading of the association reader was deprecated
    in #20888. Unfortunately the suggested alternative of
247 248 249 250 251 252 253 254
    `article.reload.category` does not expose the same behavior.

    This patch adds a reader method with the prefix `reload_` for
    singular associations. This method has the same semantics as
    passing true to the association reader used to have.

    *Yves Senn*

Y
Yves Senn 已提交
255 256 257 258 259
*   Make sure eager loading `ActiveRecord::Associations` also loads
    constants defined in `ActiveRecord::Associations::Preloader`.

    *Yves Senn*

J
Jon Moss 已提交
260 261 262 263 264 265 266
*   Allow `ActionController::Parameters`-like objects to be passed as
    values for Postgres HStore columns.

    Fixes #26904.

    *Jon Moss*

267
*   Added `stat` method to `ActiveRecord::ConnectionAdapters::ConnectionPool`.
268 269 270 271 272 273 274 275

    Example:

        ActiveRecord::Base.connection_pool.stat # =>
        { size: 15, connections: 1, busy: 1, dead: 0, idle: 0, waiting: 0, checkout_timeout: 5 }

    *Pavel Evstigneev*

276 277
*   Avoid `unscope(:order)` when `limit_value` is presented for `count`
    and `exists?`.
278 279

    If `limit_value` is presented, records fetching order is very important
V
Vipul A M 已提交
280
    for performance. We should not unscope the order in the case.
281 282 283

    *Ryuta Kamizono*

V
Vipul A M 已提交
284
*   Fix an Active Record `DateTime` field `NoMethodError` caused by incomplete
285 286 287
    datetime.

    Fixes #24195.
S
Sen-Zhang 已提交
288 289 290

    *Sen Zhang*

V
Vipul A M 已提交
291
*   Allow `slice` to take an array of methods(without the need for splatting).
292 293 294

    *Cohen Carlisle*

295 296 297 298 299 300 301
*   Improved partial writes with HABTM and has many through associations
    to fire database query only if relation has been changed.

    Fixes #19663.

    *Mehmet Emin İNAÇ*

302 303 304 305 306
*   Deprecate passing arguments and block at the same time to
    `ActiveRecord::QueryMethods#select`.

    *Prathamesh Sonpatki*

V
Vipul A M 已提交
307 308
*   Optimistic locking: Added ability to update `locking_column` value.
    Ignore optimistic locking if trying to update with new `locking_column` value.
309 310 311

    *bogdanvlviv*

V
Vipul A M 已提交
312
*   Fixed: Optimistic locking does not work well with `null` in the database.
313

314
    Fixes #26024.
315 316 317

    *bogdanvlviv*

318 319 320 321 322
*   Fixed support for case insensitive comparisons of `text` columns in
    PostgreSQL.

    *Edho Arief*

323
*   Serialize JSON attribute value `nil` as SQL `NULL`, not JSON `null`.
324 325 326

    *Trung Duc Tran*

327 328 329 330 331 332 333
*   Return `true` from `update_attribute` when the value of the attribute
    to be updated is unchanged.

    Fixes #26593.

    *Prathamesh Sonpatki*

334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
*   Always store errors details information with symbols.

    When the association is autosaved we were storing the details with
    string keys. This was creating inconsistency with other details that are
    added using the `Errors#add` method. It was also inconsistent with the
    `Errors#messages` storage.

    To fix this inconsistency we are always storing with symbols. This will
    cause a small breaking change because in those cases the details could
    be accessed as strings keys but now it can not.

    Fix #26499.

    *Rafael Mendonça França*, *Marcus Vieira*

349 350 351 352 353 354 355
*   Calling `touch` on a model using optimistic locking will now leave the model
    in a non-dirty state with no attribute changes.

    Fixes #26496.

    *Jakob Skjerning*

356 357 358 359 360
*   Using a mysql2 connection after it fails to reconnect will now have an error message
    saying the connection is closed rather than an undefined method error message.

    *Dylan Thacker-Smith*

361 362 363 364 365 366 367
*   PostgreSQL array columns will now respect the encoding of strings contained
    in the array.

    Fixes #26326.

    *Sean Griffin*

368 369 370 371 372 373 374
*   Inverse association instances will now be set before `after_find` or
    `after_initialize` callbacks are run.

    Fixes #26320.

    *Sean Griffin*

375 376 377 378 379
*   Remove unnecessarily association load when a `belongs_to` association has already been
    loaded then the foreign key is changed directly and the record saved.

    *James Coleman*

380
*   Remove standardized column types/arguments spaces in schema dump.
381 382 383

    *Tim Petricola*

384 385 386 387 388 389 390
*   Avoid loading records from database when they are already loaded using
    the `pluck` method on a collection.

    Fixes #25921.

    *Ryuta Kamizono*

391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
*   Remove text default treated as an empty string in non-strict mode for
    consistency with other types.

    Strict mode controls how MySQL handles invalid or missing values in
    data-change statements such as INSERT or UPDATE. If strict mode is not
    in effect, MySQL inserts adjusted values for invalid or missing values
    and produces warnings.

        def test_mysql_not_null_defaults_non_strict
          using_strict(false) do
            with_mysql_not_null_table do |klass|
              record = klass.new
              assert_nil record.non_null_integer
              assert_nil record.non_null_string
              assert_nil record.non_null_text
              assert_nil record.non_null_blob

              record.save!
              record.reload

              assert_equal 0,  record.non_null_integer
              assert_equal "", record.non_null_string
              assert_equal "", record.non_null_text
              assert_equal "", record.non_null_blob
            end
          end
        end

    https://dev.mysql.com/doc/refman/5.7/en/sql-mode.html#sql-mode-strict

    *Ryuta Kamizono*

423 424 425 426
*   Sqlite3 migrations to add a column to an existing table can now be
    successfully rolled back when the column was given and invalid column
    type.

427
    Fixes #26087.
428 429 430

    *Travis O'Neill*

431 432 433 434
*   Deprecate `sanitize_conditions`. Use `sanitize_sql` instead.

    *Ryuta Kamizono*

435 436 437 438 439
*   Doing count on relations that contain LEFT OUTER JOIN Arel node no longer
    force a DISTINCT. This solves issues when using count after a left_joins.

    *Maxime Handfield Lapointe*

440 441 442 443 444
*   RecordNotFound raised by association.find exposes `id`, `primary_key` and
    `model` methods to be consistent with RecordNotFound raised by Record.find.

    *Michel Pigassou*

445 446 447 448 449 450 451
*   Hashes can once again be passed to setters of `composed_of`, if all of the
    mapping methods are methods implemented on `Hash`.

    Fixes #25978.

    *Sean Griffin*

452 453 454 455
*   Fix the SELECT statement in `#table_comment` for MySQL.

    *Takeshi Akima*

456
*   Virtual attributes will no longer raise when read on models loaded from the
457
    database.
458 459 460

    *Sean Griffin*

461 462 463 464
*   Support calling the method `merge` in `scope`'s lambda.

    *Yasuhiro Sugino*

465 466 467 468
*   Fixes multi-parameter attributes conversion with invalid params.

    *Hiroyuki Ishii*

469
*   Add newline between each migration in `structure.sql`.
470 471

    Keeps schema migration inserts as a single commit, but allows for easier
472 473 474
    git diffing.

    Fixes #25504.
475 476 477

    *Grey Baker*, *Norberto Lopes*

478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
*   The flag `error_on_ignored_order_or_limit` has been deprecated in favor of
    the current `error_on_ignored_order`.

    *Xavier Noria*

*   Batch processing methods support `limit`:

        Post.limit(10_000).find_each do |post|
          # ...
        end

    It also works in `find_in_batches` and `in_batches`.

    *Xavier Noria*

493
*   Using `group` with an attribute that has a custom type will properly cast
494 495
    the hash keys after calling a calculation method like `count`.

V
Vipul A M 已提交
496
    Fixes #25595.
497 498 499

    *Sean Griffin*

500
*   Fix the generated `#to_param` method to use `omission: ''` so that
501 502 503 504 505 506
    the resulting output is actually up to 20 characters, not
    effectively 17 to leave room for the default "...".
    Also call `#parameterize` before `#truncate` and make the
    `separator: /-/` to maximize the information included in the
    output.

507
    Fixes #23635.
508 509 510

    *Rob Biedenharn*

511 512 513 514 515 516 517
*   Ensure concurrent invocations of the connection reaper cannot allocate the
    same connection to two threads.

    Fixes #25585.

    *Matthew Draper*

518 519 520 521 522 523
*   Inspecting an object with an associated array of over 10 elements no longer
    truncates the array, preventing `inspect` from looping infinitely in some
    cases.

    *Kevin McPhillips*

524
*   Removed the unused methods `ActiveRecord::Base.connection_id` and
525
    `ActiveRecord::Base.connection_id=`.
526 527 528

    *Sean Griffin*

529
*   Ensure hashes can be assigned to attributes created using `composed_of`.
530

531 532 533 534
    Fixes #25210.

    *Sean Griffin*

535 536
*   Fix logging edge case where if an attribute was of the binary type and
    was provided as a Hash.
R
Rafael Mendonça França 已提交
537

538 539
    *Jon Moss*

540 541 542 543
*   Handle JSON deserialization correctly if the column default from database
    adapter returns `''` instead of `nil`.

    *Johannes Opper*
544

545
*   Introduce `ActiveRecord::TransactionSerializationError` for catching
546 547 548 549
    transaction serialization failures or deadlocks.

    *Erol Fornoles*

V
Vipul A M 已提交
550
*   PostgreSQL: Fix `db:structure:load` silent failure on SQL error.
551

552 553
    The command line flag `-v ON_ERROR_STOP=1` should be used
    when invoking `psql` to make sure errors are not suppressed.
554 555 556 557 558 559 560 561 562 563

    Example:

        psql -v ON_ERROR_STOP=1 -q -f awesome-file.sql my-app-db

    Fixes #23818.

    *Ralin Chimev*


564
Please check [5-0-stable](https://github.com/rails/rails/blob/5-0-stable/activerecord/CHANGELOG.md) for previous changes.