CHANGELOG.md 20.5 KB
Newer Older
1 2 3 4 5 6 7
*   Foreign key related methods in the migration DSL respect
    `ActiveRecord::Base.pluralize_table_names = false`.

    Fixes #19643.

    *Mehmet Emin İNAÇ*

8 9 10 11 12 13
*   Reduce memory usage from loading types on pg.

    Fixes #19578.

    *Sean Griffin*

14 15 16 17 18 19 20
*   Add `config.active_record.warn_on_records_fetched_greater_than` option

    When set to an integer, a warning will be logged whenever a result set
    larger than the specified size is returned by a query. Fixes #16463

    *Jason Nochlin*

21 22 23 24
*   Ignore psqlrc when loading database structure.

    *Jason Weathered*

25 26
*   Fix referencing wrong table aliases while joining tables of has many through
    association (only when calling calculation methods).
27

28
    Fixes #19276.
29 30 31

    *pinglamb*

32 33 34 35 36 37 38
*   Correctly persist a serialized attribute that has been returned to
    its default value by an in-place modification.

    Fixes #19467.

    *Matthew Draper*

39 40 41 42 43 44 45 46
*   Fix generating the schema file when using PostgreSQL `BigInt[]` data type.
    Previously the `limit: 8` was not coming through, and this caused it to
    become `Int[]` data type after rebuilding from the schema.

    Fixes #19420.

    *Jake Waller*

47 48 49 50 51
*   Reuse the `CollectionAssociation#reader` cache when the foreign key is
    available prior to save.

    *Ben Woosley*

52 53 54 55 56 57 58
*   Add `config.active_record.dump_schemas` to fix `db:structure:dump`
    when using schema_search_path and PostgreSQL extensions.

    Fixes #17157.

    *Ryan Wallace*

59 60 61 62 63 64
*   Renaming `use_transactional_fixtures` to `use_transactional_tests` for clarity.

    Fixes #18864.

    *Brandon Weiss*

65 66 67 68 69
*   Increase pg gem version requirement to `~> 0.18`. Earlier versions of the
    pg gem are known to have problems with Ruby 2.2.

    *Matt Brictson*

70 71 72 73
*   Correctly dump `serial` and `bigserial`.

    *Ryuta Kamizono*

74 75 76 77
*   Fix default `format` value in `ActiveRecord::Tasks::DatabaseTasks#schema_file`.

    *James Cox*

78 79
*   Don't enroll records in the transaction if they don't have commit callbacks.
    This was causing a memory leak when creating many records inside a transaction.
80 81 82 83 84

    Fixes #15549.

    *Will Bryant*, *Aaron Patterson*

85 86 87 88 89 90 91
*   Correctly create through records when created on a has many through
    association when using `where`.

    Fixes #19073.

    *Sean Griffin*

92
*   Add `SchemaMigration.create_table` support for any unicode charsets with MySQL.
93 94 95

    *Ryuta Kamizono*

96
*   PostgreSQL no longer disables user triggers if system triggers can't be
97 98 99 100 101 102 103 104 105 106 107 108 109
    disabled. Disabling user triggers does not fulfill what the method promises.
    Rails currently requires superuser privileges for this method.

    If you absolutely rely on this behavior, consider patching
    `disable_referential_integrity`.

    *Yves Senn*

*   Restore aborted transaction state when `disable_referential_integrity` fails
    due to missing permissions.

    *Toby Ovod-Everett*, *Yves Senn*

110 111
*   In PostgreSQL, print a warning message if `disable_referential_integrity`
    fails due to missing permissions.
112 113 114

    *Andrey Nering*, *Yves Senn*

115
*   Allow a `:limit` option for MySQL bigint primary key support.
116 117 118 119 120 121 122 123 124 125 126 127 128 129

    Example:

        create_table :foos, id: :primary_key, limit: 8 do |t|
        end

        # or

        create_table :foos, id: false do |t|
          t.primary_key :id, limit: 8
        end

    *Ryuta Kamizono*

130 131 132 133 134 135 136
*   `belongs_to` will now trigger a validation error by default if the association is not present.
    You can turn this off on a per-association basis with `optional: true`.
    (Note this new default only applies to new Rails apps that will be generated with
    `config.active_record.belongs_to_required_by_default = true` in initializer.)

    *Josef Šimánek*

137
*   Fixed ActiveRecord::Relation#becomes! and changed_attributes issues for type
138
    columns.
139 140 141 142 143

    Fixes #17139.

    *Miklos Fazekas*

144 145 146 147
*   Format the time string according to the precision of the time column.

    *Ryuta Kamizono*

148
*   Allow a `:precision` option for time type columns.
149 150 151

    *Ryuta Kamizono*

152
*   Add `ActiveRecord::Base.suppress` to prevent the receiver from being saved
M
Michael Ryan 已提交
153 154 155 156 157 158
    during the given block.

    For example, here's a pattern of creating notifications when new comments
    are posted. (The notification may in turn trigger an email, a push
    notification, or just appear in the UI somewhere):

159 160 161 162 163
        class Comment < ActiveRecord::Base
          belongs_to :commentable, polymorphic: true
          after_create -> { Notification.create! comment: self,
            recipients: commentable.recipients }
        end
M
Michael Ryan 已提交
164

165 166 167 168
    That's what you want the bulk of the time. A new comment creates a new
    Notification. There may be edge cases where you don't want that, like
    when copying a commentable and its comments, in which case write a
    concern with something like this:
M
Michael Ryan 已提交
169

170 171 172 173 174 175 176
        module Copyable
          def copy_to(destination)
            Notification.suppress do
              # Copy logic that creates new comments that we do not want triggering
              # notifications.
            end
          end
M
Michael Ryan 已提交
177 178 179 180
        end

    *Michael Ryan*

181 182
*   `:time` option added for `#touch`.

H
Hyonjee Joo 已提交
183 184 185 186
    Fixes #18905.

    *Hyonjee Joo*

187
*   Deprecate passing of `start` value to `find_in_batches` and `find_each`
188 189 190 191
    in favour of `begin_at` value.

    *Vipul A M*

192 193 194 195
*   Add `foreign_key_exists?` method.

    *Tõnis Simo*

196 197 198 199
*   Use SQL COUNT and LIMIT 1 queries for `none?` and `one?` methods
    if no block or limit is given, instead of loading the entire
    collection into memory. This applies to relations (e.g. `User.all`)
    as well as associations (e.g. `account.users`)
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218

        # Before:

        users.none?
        # SELECT "users".* FROM "users"

        users.one?
        # SELECT "users".* FROM "users"

        # After:

        users.none?
        # SELECT 1 AS one FROM "users" LIMIT 1

        users.one?
        # SELECT COUNT(*) FROM "users"

    *Eugene Gilburg*

219 220 221 222 223
*   Have `enum` perform type casting consistently with the rest of Active
    Record, such as `where`.

    *Sean Griffin*

224 225 226
*   `scoping` no longer pollutes the current scope of sibling classes when using
    STI. e.x.

227 228 229
        StiOne.none.scoping do
          StiTwo.all
        end
230 231 232 233 234

    Fixes #18806.

    *Sean Griffin*

235 236 237 238 239 240 241 242
*   `remove_reference` with `foreign_key: true` removes the foreign key before
    removing the column. This fixes a bug where it was not possible to remove
    the column on MySQL.

    Fixes #18664.

    *Yves Senn*

243 244 245 246 247
*   `find_in_batches` now accepts an `:end_at` parameter that complements the `:start`
     parameter to specify where to stop batch processing.

    *Vipul A M*

248
*   Fix a rounding problem for PostgreSQL timestamp columns.
249

250 251
    If a timestamp column has a precision specified, it needs to
    format according to that.
252 253 254

    *Ryuta Kamizono*

255 256
*   Respect the database default charset for `schema_migrations` table.

257
    The charset of `version` column in `schema_migrations` table depends
258 259 260 261 262
    on the database default charset and collation rather than the encoding
    of the connection.

    *Ryuta Kamizono*

263 264
*   Raise `ArgumentError` when passing `nil` or `false` to `Relation#merge`.

265
    These are not valid values to merge in a relation, so it should warn users
266 267 268 269
    early.

    *Rafael Mendonça França*

270
*   Use `SCHEMA` instead of `DB_STRUCTURE` for specifying a structure file.
271 272 273 274 275

    This makes the db:structure tasks consistent with test:load_structure.

    *Dieter Komendera*

276 277 278 279 280 281
*   Respect custom primary keys for associations when calling `Relation#where`

    Fixes #18813.

    *Sean Griffin*

282
*   Fix several edge cases which could result in a counter cache updating
283 284 285 286 287 288
    twice or not updating at all for `has_many` and `has_many :through`.

    Fixes #10865.

    *Sean Griffin*

289 290 291 292 293 294 295 296 297
*   Foreign keys added by migrations were given random, generated names. This
    meant a different `structure.sql` would be generated every time a developer
    ran migrations on their machine.

    The generated part of foreign key names is now a hash of the table name and
    column name, which is consistent every time you run the migration.

    *Chris Sinjakli*

298 299 300 301 302 303 304 305 306 307 308 309
*   Validation errors would be raised for parent records when an association
    was saved when the parent had `validate: false`. It should not be the
    responsibility of the model to validate an associated object unless the
    object was created or modified by the parent.

    This fixes the issue by skipping validations if the parent record is
    persisted, not changed, and not marked for destruction.

    Fixes #17621.

    *Eileen M. Uchitelle, Aaron Patterson*

310 311 312 313
*   Fix n+1 query problem when eager loading nil associations (fixes #18312)

    *Sammy Larbi*

314
*   Change the default error message from `can't be blank` to `must exist` for
315 316
    the presence validator of the `:required` option on `belongs_to`/`has_one`
    associations.
317 318 319

    *Henrik Nygren*

320 321
*   Fixed ActiveRecord::Relation#group method when an argument is an SQL
    reserved key word:
322

Y
Yves Senn 已提交
323 324 325 326
    Example:

        SplitTest.group(:key).count
        Property.group(:value).count
327 328 329

    *Bogdan Gusiev*

330 331 332 333 334 335 336 337 338 339
*   Added the `#or` method on ActiveRecord::Relation, allowing use of the OR
    operator to combine WHERE or HAVING clauses.

    Example:

        Post.where('id = 1').or(Post.where('id = 2'))
        # => SELECT * FROM posts WHERE (id = 1) OR (id = 2)

    *Sean Griffin*, *Matthew Draper*, *Gael Muller*, *Olivier El Mekki*

340 341 342 343 344 345 346
*   Don't define autosave association callbacks twice from
    `accepts_nested_attributes_for`.

    Fixes #18704.

    *Sean Griffin*

347 348 349 350 351 352 353 354
*   Integer types will no longer raise a `RangeError` when assigning an
    attribute, but will instead raise when going to the database.

    Fixes several vague issues which were never reported directly. See the
    commit message from the commit which added this line for some examples.

    *Sean Griffin*

355
*   Values which would error while being sent to the database (such as an
356
    ASCII-8BIT string with invalid UTF-8 bytes on SQLite3), no longer error on
357 358 359 360 361 362 363
    assignment. They will still error when sent to the database, but you are
    given the ability to re-assign it to a valid value.

    Fixes #18580.

    *Sean Griffin*

364 365
*   Don't remove join dependencies in `Relation#exists?`

366
    Fixes #18632.
367 368 369

    *Sean Griffin*

370 371 372 373 374 375
*   Invalid values assigned to a JSON column are assumed to be `nil`.

    Fixes #18629.

    *Sean Griffin*

376 377 378 379 380 381
*   Add `ActiveRecord::Base#accessed_fields`, which can be used to quickly
    discover which fields were read from a model when you are looking to only
    select the data you need from the database.

    *Sean Griffin*

382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
*   Introduce the `:if_exists` option for `drop_table`.

    Example:

        drop_table(:posts, if_exists: true)

    That would execute:

        DROP TABLE IF EXISTS posts

    If the table doesn't exist, `if_exists: false` (the default) raises an
    exception whereas `if_exists: true` does nothing.

    *Cody Cutrer*, *Stefan Kanev*, *Ryuta Kamizono*

397 398 399 400
*   Don't run SQL if attribute value is not changed for update_attribute method.

    *Prathamesh Sonpatki*

401
*   `time` columns can now get affected by `time_zone_aware_attributes`. If you have
402
    set `config.time_zone` to a value other than `'UTC'`, they will be treated
403
    as in that time zone by default in Rails 5.1. If this is not the desired
404 405 406 407 408 409 410
    behavior, you can set

        ActiveRecord::Base.time_zone_aware_types = [:datetime]

    A deprecation warning will be emitted if you have a `:time` column, and have
    not explicitly opted out.

Y
Yves Senn 已提交
411
    Fixes #3145.
412 413 414

    *Sean Griffin*

415 416 417 418 419 420 421 422 423
*   Tests now run after_commit callbacks. You no longer have to declare
    `uses_transaction ‘test name’` to test the results of an after_commit.

    after_commit callbacks run after committing a transaction whose parent
    is not `joinable?`: un-nested transactions, transactions within test cases,
    and transactions in `console --sandbox`.

    *arthurnn*, *Ravil Bayramgalin*, *Matthew Draper*

424 425 426 427 428
*   `nil` as a value for a binary column in a query no longer logs as
    "<NULL binary data>", and instead logs as just "nil".

    *Sean Griffin*

429 430 431 432 433 434 435
*   `attribute_will_change!` will no longer cause non-persistable attributes to
    be sent to the database.

    Fixes #18407.

    *Sean Griffin*

436 437
*   Remove support for the `protected_attributes` gem.

438
    *Carlos Antonio da Silva*, *Roberto Miranda*
439

440
*   Fix accessing of fixtures having non-string labels like Fixnum.
441 442 443

    *Prathamesh Sonpatki*

444
*   Remove deprecated support to preload instance-dependent associations.
445 446 447

    *Yves Senn*

448 449 450 451
*   Remove deprecated support for PostgreSQL ranges with exclusive lower bounds.

    *Yves Senn*

452
*   Remove deprecation when modifying a relation with cached Arel.
453 454 455 456
    This raises an `ImmutableRelation` error instead.

    *Yves Senn*

Y
Yves Senn 已提交
457 458
*   Added `ActiveRecord::SecureToken` in order to encapsulate generation of
    unique tokens for attributes in a model using `SecureRandom`.
459 460 461

    *Roberto Miranda*

462 463 464 465 466 467 468 469 470
*   Change the behavior of boolean columns to be closer to Ruby's semantics.

    Before this change we had a small set of "truthy", and all others are "falsy".

    Now, we have a small set of "falsy" values and all others are "truthy" matching
    Ruby's semantics.

    *Rafael Mendonça França*

471 472 473 474
*   Deprecate `ActiveRecord::Base.errors_in_transactional_callbacks=`.

    *Rafael Mendonça França*

475
*   Change transaction callbacks to not swallow errors.
476

477 478
    Before this change any errors raised inside a transaction callback
    were getting rescued and printed in the logs.
479

480
    Now these errors are not rescued anymore and just bubble up, as the other callbacks.
481 482 483

    *Rafael Mendonça França*

484 485 486 487
*   Remove deprecated `sanitize_sql_hash_for_conditions`.

    *Rafael Mendonça França*

488 489 490 491
*   Remove deprecated `Reflection#source_macro`.

    *Rafael Mendonça França*

492 493 494 495
*   Remove deprecated `symbolized_base_class` and `symbolized_sti_name`.

    *Rafael Mendonça França*

496 497 498 499
*   Remove deprecated `ActiveRecord::Base.disable_implicit_join_references=`.

    *Rafael Mendonça França*

500
*   Remove deprecated access to connection specification using a string accessor.
501 502 503 504 505

    Now all strings will be handled as a URL.

    *Rafael Mendonça França*

506 507 508 509
*   Change the default `null` value for `timestamps` to `false`.

    *Rafael Mendonça França*

510 511 512 513
*   Return an array of pools from `connection_pools`.

    *Rafael Mendonça França*

514 515 516 517
*   Return a null column from `column_for_attribute` when no column exists.

    *Rafael Mendonça França*

518 519 520 521
*   Remove deprecated `serialized_attributes`.

    *Rafael Mendonça França*

522 523 524 525
*   Remove deprecated automatic counter caches on `has_many :through`.

    *Rafael Mendonça França*

526 527 528 529 530 531 532 533 534
*   Change the way in which callback chains can be halted.

    The preferred method to halt a callback chain from now on is to explicitly
    `throw(:abort)`.
    In the past, returning `false` in an ActiveRecord `before_` callback had the
    side effect of halting the callback chain.
    This is not recommended anymore and, depending on the value of the
    `config.active_support.halt_callback_chains_on_return_false` option, will
    either not work at all or display a deprecation warning.
535 536 537

    *claudiob*

538
*   Clear query cache on rollback.
Y
Yves Senn 已提交
539

540
    *Florian Weingarten*
Y
Yves Senn 已提交
541

542
*   Fix setting of foreign_key for through associations when building a new record.
543 544 545 546 547

    Fixes #12698.

    *Ivan Antropov*

548
*   Improve dumping of the primary key. If it is not a default primary key,
549 550 551 552 553 554
    correctly dump the type and options.

    Fixes #14169, #16599.

    *Ryuta Kamizono*

555 556 557 558 559 560 561 562 563 564 565
*   Format the datetime string according to the precision of the datetime field.

    Incompatible to rounding behavior between MySQL 5.6 and earlier.

    In 5.5, when you insert `2014-08-17 12:30:00.999999` the fractional part
    is ignored. In 5.6, it's rounded to `2014-08-17 12:30:01`:

    http://bugs.mysql.com/bug.php?id=68760

    *Ryuta Kamizono*

566
*   Allow a precision option for MySQL datetimes.
567 568 569

    *Ryuta Kamizono*

570
*   Fixed automatic `inverse_of` for models nested in a module.
571 572 573

    *Andrew McCloud*

574 575 576
*   Change `ActiveRecord::Relation#update` behavior so that it can
    be called without passing ids of the records to be updated.

577
    This change allows updating multiple records returned by
578 579 580 581 582 583 584 585 586 587 588 589
    `ActiveRecord::Relation` with callbacks and validations.

        # Before
        # ArgumentError: wrong number of arguments (1 for 2)
        Comment.where(group: 'expert').update(body: "Group of Rails Experts")

        # After
        # Comments with group expert updated with body "Group of Rails Experts"
        Comment.where(group: 'expert').update(body: "Group of Rails Experts")

    *Prathamesh Sonpatki*

590 591 592 593 594 595
*   Fix `reaping_frequency` option when the value is a string.

    This usually happens when it is configured using `DATABASE_URL`.

    *korbin*

596 597 598 599 600 601 602 603 604 605 606 607 608
*   Fix error message when trying to create an associated record and the foreign
    key is missing.

    Before this fix the following exception was being raised:

        NoMethodError: undefined method `val' for #<Arel::Nodes::BindParam:0x007fc64d19c218>

    Now the message is:

        ActiveRecord::UnknownAttributeError: unknown attribute 'foreign_key' for Model.

    *Rafael Mendonça França*

609 610 611 612 613 614 615
*   Fix change detection problem for PostgreSQL bytea type and
    `ArgumentError: string contains null byte` exception with pg-0.18.

    Fixes #17680.

    *Lars Kanis*

616 617 618 619
*   When a table has a composite primary key, the `primary_key` method for
    SQLite3 and PostgreSQL adapters was only returning the first field of the key.
    Ensures that it will return nil instead, as Active Record doesn't support
    composite primary keys.
620 621 622 623 624

    Fixes #18070.

    *arthurnn*

625
*   `validates_size_of` / `validates_length_of` do not count records
626 627 628 629 630 631
    which are `marked_for_destruction?`.

    Fixes #7247.

    *Yves Senn*

632 633 634 635 636 637
*   Ensure `first!` and friends work on loaded associations.

    Fixes #18237.

    *Sean Griffin*

638 639 640 641 642 643
*   `eager_load` preserves readonly flag for associations.

    Closes #15853.

    *Takashi Kokubun*

644
*   Provide `:touch` option to `save()` to accommodate saving without updating
645 646
    timestamps.

647
    Fixes #18202.
648 649 650

    *Dan Olson*

651
*   Provide a more helpful error message when an unsupported class is passed to
652
    `serialize`.
653

654
    Fixes #18224.
655 656 657

    *Sean Griffin*

658 659 660 661 662 663 664 665 666
*   Add bigint primary key support for MySQL.

    Example:

        create_table :foos, id: :bigint do |t|
        end

    *Ryuta Kamizono*

667
*   Support for any type of primary key.
R
Ryuta Kamizono 已提交
668 669 670 671 672

    Fixes #14194.

    *Ryuta Kamizono*

673 674 675 676
*   Dump the default `nil` for PostgreSQL UUID primary key.

    *Ryuta Kamizono*

677 678 679 680 681 682
*   Add a `:foreign_key` option to `references` and associated migration
    methods. The model and migration generators now use this option, rather than
    the `add_foreign_key` form.

    *Sean Griffin*

683 684 685 686 687
*   Don't raise when writing an attribute with an out-of-range datetime passed
    by the user.

    *Grey Baker*

688 689 690 691 692
*   Replace deprecated `ActiveRecord::Tasks::DatabaseTasks#load_schema` with
    `ActiveRecord::Tasks::DatabaseTasks#load_schema_for`.

    *Yves Senn*

693
*   Fix bug with 'ActiveRecord::Type::Numeric' that caused negative values to
694 695
    be marked as having changed when set to the same negative value.

Y
Yves Senn 已提交
696
    Closes #18161.
697 698 699

    *Daniel Fox*

700 701 702 703 704 705 706
*   Introduce `force: :cascade` option for `create_table`. Using this option
    will recreate tables even if they have dependent objects (like foreign keys).
    `db/schema.rb` now uses `force: :cascade`. This makes it possible to
    reload the schema when foreign keys are in place.

    *Matthew Draper*, *Yves Senn*

707 708 709 710 711 712 713 714
*   `db:schema:load` and `db:structure:load` no longer purge the database
    before loading the schema. This is left for the user to do.
    `db:test:prepare` will still purge the database.

    Closes #17945.

    *Yves Senn*

Y
Yves Senn 已提交
715
*   Fix undesirable RangeError by `Type::Integer`. Add `Type::UnsignedInteger`.
716 717 718

    *Ryuta Kamizono*

719 720 721 722
*   Add `foreign_type` option to `has_one` and `has_many` association macros.

    This option enables to define the column name of associated object's type for polymorphic associations.

723
    *Ulisses Almeida*, *Kassio Borges*
724

725 726 727 728 729
*   Remove deprecated behavior allowing nested arrays to be passed as query
    values.

    *Melanie Gilman*

730 731 732 733 734
*   Deprecate passing a class as a value in a query. Users should pass strings
    instead.

    *Melanie Gilman*

735 736 737 738 739
*   `add_timestamps` and `remove_timestamps` now properly reversible with
    options.

    *Noam Gagliardi-Rabinovich*

740 741 742 743 744 745 746
*   `ActiveRecord::ConnectionAdapters::ColumnDumper#column_spec` and
    `ActiveRecord::ConnectionAdapters::ColumnDumper#prepare_column_options` no
    longer have a `types` argument. They should access
    `connection#native_database_types` directly.

    *Yves Senn*

747
Please check [4-2-stable](https://github.com/rails/rails/blob/4-2-stable/activerecord/CHANGELOG.md) for previous changes.