CHANGELOG.md 18.2 KB
Newer Older
1 2 3 4 5 6 7
*   Correctly create through records when created on a has many through
    association when using `where`.

    Fixes #19073.

    *Sean Griffin*

8 9 10 11
*   Add `SchemaMigration.create_table` support any unicode charsets for MySQL.

    *Ryuta Kamizono*

12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
*   PostgreSQL, no longer disables user triggers if system triggers can't be
    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*

*   PostgreSQL, print warning message if `disable_referential_integrity` fails
    due to missing permissions.

    *Andrey Nering*, *Yves Senn*

31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
*   Allow `:limit` option for MySQL bigint primary key support.

    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*

46 47 48 49 50 51 52
*   `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*

53 54
*   Fixed ActiveRecord::Relation#becomes! and changed_attributes issues for type
    column.
55 56 57 58 59

    Fixes #17139.

    *Miklos Fazekas*

60 61 62 63
*   Format the time string according to the precision of the time column.

    *Ryuta Kamizono*

64 65 66 67
*   Allow `:precision` option for time type columns.

    *Ryuta Kamizono*

68
*   Add `ActiveRecord::Base.suppress` to prevent the receiver from being saved
M
Michael Ryan 已提交
69 70 71 72 73 74
    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):

75 76 77 78 79
        class Comment < ActiveRecord::Base
          belongs_to :commentable, polymorphic: true
          after_create -> { Notification.create! comment: self,
            recipients: commentable.recipients }
        end
M
Michael Ryan 已提交
80 81 82 83 84 85

    That's what you want the bulk of the time. New comment creates a new
    Notification. But there may well be off cases, like copying a commentable
    and its comments, where you don't want that. So you'd have a concern
    something like this:

86 87 88 89 90 91 92
        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 已提交
93 94 95 96
        end

    *Michael Ryan*

97 98
*   `:time` option added for `#touch`.

H
Hyonjee Joo 已提交
99 100 101 102
    Fixes #18905.

    *Hyonjee Joo*

103 104 105 106 107
*   Deprecated passing of `start` value to `find_in_batches` and `find_each`
    in favour of `begin_at` value.

    *Vipul A M*

108 109 110 111
*   Add `foreign_key_exists?` method.

    *Tõnis Simo*

112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
*   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 to memory.
    This applies to relations (e.g. `User.all`) as well as associations (e.g. `account.users`)

        # 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*

134 135 136 137 138
*   Have `enum` perform type casting consistently with the rest of Active
    Record, such as `where`.

    *Sean Griffin*

139 140 141
*   `scoping` no longer pollutes the current scope of sibling classes when using
    STI. e.x.

142 143 144
        StiOne.none.scoping do
          StiTwo.all
        end
145 146 147 148 149

    Fixes #18806.

    *Sean Griffin*

150 151 152 153 154 155 156 157
*   `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*

158 159 160 161 162
*   `find_in_batches` now accepts an `:end_at` parameter that complements the `:start`
     parameter to specify where to stop batch processing.

    *Vipul A M*

163 164 165 166 167 168 169
*   Fix rounding problem for PostgreSQL timestamp column.

    If timestamp column have the precision, it need to format according to
    the precision of timestamp column.

    *Ryuta Kamizono*

170 171 172 173 174 175 176 177
*   Respect the database default charset for `schema_migrations` table.

    The charset of `version` column in `schema_migrations` table is depend
    on the database default charset and collation rather than the encoding
    of the connection.

    *Ryuta Kamizono*

178 179 180 181 182 183 184
*   Raise `ArgumentError` when passing `nil` or `false` to `Relation#merge`.

    These are not valid values to merge in a relation so it should warn the users
    early.

    *Rafael Mendonça França*

185
*   Use `SCHEMA` instead of `DB_STRUCTURE` for specifying structure file.
186 187 188 189 190

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

    *Dieter Komendera*

191 192 193 194 195 196
*   Respect custom primary keys for associations when calling `Relation#where`

    Fixes #18813.

    *Sean Griffin*

197 198 199 200 201 202 203
*   Fixed several edge cases which could result in a counter cache updating
    twice or not updating at all for `has_many` and `has_many :through`.

    Fixes #10865.

    *Sean Griffin*

204 205 206 207 208 209 210 211 212
*   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*

213 214 215 216 217 218 219 220 221 222 223 224
*   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*

225 226 227 228
*   Fix n+1 query problem when eager loading nil associations (fixes #18312)

    *Sammy Larbi*

229 230 231 232 233
*   Change the default error message from `can't be blank` to `must exist` for
    the presence validator of the `:required` option on `belongs_to`/`has_one` associations.

    *Henrik Nygren*

234 235
*   Fixed ActiveRecord::Relation#group method when argument is SQL reserved key word:

Y
Yves Senn 已提交
236 237 238 239
    Example:

        SplitTest.group(:key).count
        Property.group(:value).count
240 241 242

    *Bogdan Gusiev*

243 244 245 246 247 248 249 250 251 252
*   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*

253 254 255 256 257 258 259
*   Don't define autosave association callbacks twice from
    `accepts_nested_attributes_for`.

    Fixes #18704.

    *Sean Griffin*

260 261 262 263 264 265 266 267
*   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*

268
*   Values which would error while being sent to the database (such as an
269
    ASCII-8BIT string with invalid UTF-8 bytes on SQLite3), no longer error on
270 271 272 273 274 275 276
    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*

277 278
*   Don't remove join dependencies in `Relation#exists?`

279
    Fixes #18632.
280 281 282

    *Sean Griffin*

283 284 285 286 287 288
*   Invalid values assigned to a JSON column are assumed to be `nil`.

    Fixes #18629.

    *Sean Griffin*

289 290 291 292 293 294
*   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*

295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
*   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*

310 311 312 313
*   Don't run SQL if attribute value is not changed for update_attribute method.

    *Prathamesh Sonpatki*

314
*   `time` columns can now get affected by `time_zone_aware_attributes`. If you have
315
    set `config.time_zone` to a value other than `'UTC'`, they will be treated
316
    as in that time zone by default in Rails 5.1. If this is not the desired
317 318 319 320 321 322 323
    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 已提交
324
    Fixes #3145.
325 326 327

    *Sean Griffin*

328 329 330 331 332 333 334 335 336
*   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*

337 338 339 340 341
*   `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*

342 343 344 345 346 347 348
*   `attribute_will_change!` will no longer cause non-persistable attributes to
    be sent to the database.

    Fixes #18407.

    *Sean Griffin*

349 350
*   Remove support for the `protected_attributes` gem.

351
    *Carlos Antonio da Silva*, *Roberto Miranda*
352

353
*   Fix accessing of fixtures having non-string labels like Fixnum.
354 355 356

    *Prathamesh Sonpatki*

357
*   Remove deprecated support to preload instance-dependent associations.
358 359 360

    *Yves Senn*

361 362 363 364
*   Remove deprecated support for PostgreSQL ranges with exclusive lower bounds.

    *Yves Senn*

365 366 367 368 369
*   Remove deprecation when modifying a relation with cached arel.
    This raises an `ImmutableRelation` error instead.

    *Yves Senn*

Y
Yves Senn 已提交
370 371
*   Added `ActiveRecord::SecureToken` in order to encapsulate generation of
    unique tokens for attributes in a model using `SecureRandom`.
372 373 374

    *Roberto Miranda*

375 376 377 378 379 380 381 382 383
*   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*

384 385 386 387
*   Deprecate `ActiveRecord::Base.errors_in_transactional_callbacks=`.

    *Rafael Mendonça França*

388
*   Change transaction callbacks to not swallow errors.
389

390 391
    Before this change any errors raised inside a transaction callback
    were getting rescued and printed in the logs.
392

393
    Now these errors are not rescued anymore and just bubble up, as the other callbacks.
394 395 396

    *Rafael Mendonça França*

397 398 399 400
*   Remove deprecated `sanitize_sql_hash_for_conditions`.

    *Rafael Mendonça França*

401 402 403 404
*   Remove deprecated `Reflection#source_macro`.

    *Rafael Mendonça França*

405 406 407 408
*   Remove deprecated `symbolized_base_class` and `symbolized_sti_name`.

    *Rafael Mendonça França*

409 410 411 412
*   Remove deprecated `ActiveRecord::Base.disable_implicit_join_references=`.

    *Rafael Mendonça França*

413
*   Remove deprecated access to connection specification using a string accessor.
414 415 416 417 418

    Now all strings will be handled as a URL.

    *Rafael Mendonça França*

419 420 421 422
*   Change the default `null` value for `timestamps` to `false`.

    *Rafael Mendonça França*

423 424 425 426
*   Return an array of pools from `connection_pools`.

    *Rafael Mendonça França*

427 428 429 430
*   Return a null column from `column_for_attribute` when no column exists.

    *Rafael Mendonça França*

431 432 433 434
*   Remove deprecated `serialized_attributes`.

    *Rafael Mendonça França*

435 436 437 438
*   Remove deprecated automatic counter caches on `has_many :through`.

    *Rafael Mendonça França*

439 440 441 442 443 444 445 446 447
*   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.
448 449 450

    *claudiob*

451
*   Clear query cache on rollback.
Y
Yves Senn 已提交
452

453
    *Florian Weingarten*
Y
Yves Senn 已提交
454

455 456 457 458 459 460
*   Fixed setting of foreign_key for through associations while building of new record.

    Fixes #12698.

    *Ivan Antropov*

461 462 463 464 465 466 467
*   Improve a dump of the primary key support. If it is not a default primary key,
    correctly dump the type and options.

    Fixes #14169, #16599.

    *Ryuta Kamizono*

468 469 470 471 472 473 474 475 476 477 478
*   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*

479 480 481 482
*   Allow precision option for MySQL datetimes.

    *Ryuta Kamizono*

483 484 485 486
*   Fixed automatic inverse_of for models nested in module.

    *Andrew McCloud*

487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
*   Change `ActiveRecord::Relation#update` behavior so that it can
    be called without passing ids of the records to be updated.

    This change allows to update multiple records returned by
    `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*

503 504 505 506 507 508
*   Fix `reaping_frequency` option when the value is a string.

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

    *korbin*

509 510 511 512 513 514 515 516 517 518 519 520 521
*   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*

522 523 524 525
*   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.
526 527 528 529 530

    Fixes #18070.

    *arthurnn*

531 532 533 534 535 536 537
*   `validates_size_of` / `validates_length_of` do not count records,
    which are `marked_for_destruction?`.

    Fixes #7247.

    *Yves Senn*

538 539 540 541 542 543
*   Ensure `first!` and friends work on loaded associations.

    Fixes #18237.

    *Sean Griffin*

544 545 546 547 548 549
*   `eager_load` preserves readonly flag for associations.

    Closes #15853.

    *Takashi Kokubun*

550
*   Provide `:touch` option to `save()` to accommodate saving without updating
551 552
    timestamps.

553
    Fixes #18202.
554 555 556

    *Dan Olson*

557
*   Provide a more helpful error message when an unsupported class is passed to
558
    `serialize`.
559

560
    Fixes #18224.
561 562 563

    *Sean Griffin*

564 565 566 567 568 569 570 571 572
*   Add bigint primary key support for MySQL.

    Example:

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

    *Ryuta Kamizono*

R
Ryuta Kamizono 已提交
573 574 575 576 577 578
*   Support for any type primary key.

    Fixes #14194.

    *Ryuta Kamizono*

579 580 581 582
*   Dump the default `nil` for PostgreSQL UUID primary key.

    *Ryuta Kamizono*

583 584 585 586 587 588
*   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*

589 590 591 592 593
*   Don't raise when writing an attribute with an out-of-range datetime passed
    by the user.

    *Grey Baker*

594 595 596 597 598
*   Replace deprecated `ActiveRecord::Tasks::DatabaseTasks#load_schema` with
    `ActiveRecord::Tasks::DatabaseTasks#load_schema_for`.

    *Yves Senn*

599 600 601
*   Fixes bug with 'ActiveRecord::Type::Numeric' that causes negative values to
    be marked as having changed when set to the same negative value.

Y
Yves Senn 已提交
602
    Closes #18161.
603 604 605

    *Daniel Fox*

606 607 608 609 610 611 612
*   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*

613 614 615 616 617 618 619 620
*   `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 已提交
621
*   Fix undesirable RangeError by `Type::Integer`. Add `Type::UnsignedInteger`.
622 623 624

    *Ryuta Kamizono*

625 626 627 628
*   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.

629
    *Ulisses Almeida*, *Kassio Borges*
630

631 632 633 634 635
*   Remove deprecated behavior allowing nested arrays to be passed as query
    values.

    *Melanie Gilman*

636 637 638 639 640
*   Deprecate passing a class as a value in a query. Users should pass strings
    instead.

    *Melanie Gilman*

641 642 643 644 645
*   `add_timestamps` and `remove_timestamps` now properly reversible with
    options.

    *Noam Gagliardi-Rabinovich*

646 647 648 649 650 651 652
*   `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*

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