CHANGELOG.md 42.3 KB
Newer Older
1
## Rails 4.0.0 (unreleased) ##
R
Rafael Mendonça França 已提交
2

3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
*   Relation#merge now only overwrites where values on the LHS of the
    merge. Consider:

        left  = Person.where(age: [13, 14, 15])
        right = Person.where(age: [13, 14]).where(age: [14, 15])

    `left` results in the following SQL:

        WHERE age IN (13, 14, 15)

    `right` results in the following SQL:

        WHERE age IN (13, 14) AND age IN (14, 15)

    Previously, `left.merge(right)` would result in all but the last
    condition being removed:

        WHERE age IN (14, 15)

    Now it results in the LHS condition(s) for `age` being removed, but
    the RHS remains as it is:

        WHERE age IN (13, 14) AND age IN (14, 15)

    *Jon Leighton*

29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
*   Fix handling of dirty time zone aware attributes

    Previously, when `time_zone_aware_attributes` were enabled, after
    changing a datetime or timestamp attribute and then changing it back
    to the original value, `changed_attributes` still tracked the
    attribute as changed. This caused `[attribute]_changed?` and
    `changed?` methods to return true incorrectly.

    Example:

        in_time_zone 'Paris' do
          order = Order.new
          original_time = Time.local(2012, 10, 10)
          order.shipped_at = original_time
          order.save
          order.changed? # => false

          # changing value
          order.shipped_at = Time.local(2013, 1, 1)
          order.changed? # => true

          # reverting to original value
          order.shipped_at = original_time
          order.changed? # => false, used to return true
        end

    *Lilibeth De La Cruz*

57 58 59 60 61 62 63 64 65
*   When `#count` is used in conjunction with `#uniq` we perform `count(:distinct => true)`.
    Fix #6865.

    Example:

      relation.uniq.count # => SELECT COUNT(DISTINCT *)

    *Yves Senn + Kaspar Schiess*

B
bUg 已提交
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
*   PostgreSQL ranges type support. Includes: int4range, int8range,
    numrange, tsrange, tstzrange, daterange

    Ranges can be created with inclusive and exclusive bounds.

    Example:

        create_table :Room do |t|
          t.daterange :availability
        end

        Room.create(availability: (Date.today..Float::INFINITY))
        Room.first.availability # => Wed, 19 Sep 2012..Infinity

    One thing to note: Range class does not support exclusive lower
    bound.

    *Alexander Grebennik*

W
wangjohn 已提交
85 86 87 88 89
*   Added a state instance variable to each transaction. Will allow other objects
    to know whether a transaction has been committed or rolled back.

    *John Wang*

90 91 92 93 94 95 96 97 98 99 100
*   Collection associations `#empty?` always respects builded records.
    Fix #8879.

    Example:

        widget = Widget.new
        widget.things.build
        widget.things.empty? # => false

    *Yves Senn*

101 102 103 104
*   Remove support for parsing YAML parameters from request.

    *Aaron Patterson*

105
*   Support for PostgreSQL's `ltree` data type.
106 107 108

    *Rob Worley*

109
*   Fix undefined method `to_i` when calling `new` on a scope that uses an
110 111
    Array; Fix FloatDomainError when setting integer column to NaN.
    Fixes #8718, #8734, #8757.
112

113
    *Jason Stirk + Tristan Harward*
114 115

*   Rename `update_attributes` to `update`, keep `update_attributes` as an alias for `update` method.
116 117 118
    This is a soft-deprecation for `update_attributes`, although it will still work without any
    deprecation message in 4.0 is recommended to start using `update` since `update_attributes` will be
    deprecated and removed in future versions of Rails.
119

120 121
    *Amparo Luna + Guillermo Iguaran*

122
*   `after_commit` and `after_rollback` now validate the `:on` option and raise an `ArgumentError`
123
    if it is not one of `:create`, `:destroy` or `:update`
124 125 126

    *Pascal Friederich*

127 128 129 130 131 132 133 134 135 136 137 138 139
*   Improve ways to write `change` migrations, making the old `up` & `down` methods no longer necessary.

    * The methods `drop_table` and `remove_column` are now reversible, as long as the necessary information is given.
      The method `remove_column` used to accept multiple column names; instead use `remove_columns` (which is not revertible).
      The method `change_table` is also reversible, as long as its block doesn't call `remove`, `change` or `change_default`

    * New method `reversible` makes it possible to specify code to be run when migrating up or down.
      See the [Guide on Migration](https://github.com/rails/rails/blob/master/guides/source/migrations.md#using-the-reversible-method)

    * New method `revert` will revert a whole migration or the given block.
      If migrating down, the given migration / block is run normally.
      See the [Guide on Migration](https://github.com/rails/rails/blob/master/guides/source/migrations.md#reverting-previous-migrations)

140 141
    Attempting to revert the methods `execute`, `remove_columns` and `change_column` will now
    raise an `IrreversibleMigration` instead of actually executing them without any output.
142 143 144

    *Marc-André Lafortune*

145 146 147 148 149
*   Serialized attributes can be serialized in integer columns.
    Fix #8575.

    *Rafael Mendonça França*

150
*   Keep index names when using `alter_table` with sqlite3.
151
    Fix #3489.
152 153 154

    *Yves Senn*

155
*   Add ability for postgresql adapter to disable user triggers in `disable_referential_integrity`.
156
    Fix #5523.
157 158 159

    *Gary S. Weaver*

160 161 162 163 164
*   Added support for `validates_uniqueness_of` in PostgreSQL array columns.
    Fixes #8075.

    *Pedro Padron*

165 166 167 168
*   Allow int4range and int8range columns to be created in PostgreSQL and properly convert to/from database.

    *Alexey Vasiliev aka leopard*

169 170 171 172
*   Do not log the binding values for binary columns.

    *Matthew M. Boedicker*

173 174 175 176 177
*   Fix counter cache columns not updated when replacing `has_many :through`
    associations.

    *Matthew Robertson*

178 179 180 181 182
*   Recognize migrations placed in directories containing numbers and 'rb'.
    Fix #8492

    *Yves Senn*

183 184 185 186 187 188 189
*   Add `ActiveRecord::Base.cache_timestamp_format` class attribute to control
    the format of the timestamp value in the cache key.
    This allows users to improve the precision of the cache key.
    Fixes #8195.

    *Rafael Mendonça França*

190 191 192 193
*   Add `:nsec` date format. This can be used to improve the precision of cache key.

    *Jamie Gaskins*

194 195 196 197 198 199 200 201
*   Session variables can be set for the `mysql`, `mysql2`, and `postgresql` adapters
    in the `variables: <hash>` parameter in `database.yml`. The key-value pairs of this
    hash will be sent in a `SET key = value` query on new database connections. See also:
    http://dev.mysql.com/doc/refman/5.0/en/set-statement.html
    http://www.postgresql.org/docs/8.3/static/sql-set.html

    *Aaron Stone*

202
*   Allow `Relation#where` with no arguments to be chained with new `not` query method.
203 204 205

    Example:

206
        Developer.where.not(name: 'Aaron')
207 208 209

    *Akira Matsuda*

210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
*   Unscope `update_column(s)` query to ignore default scope.

    When applying `default_scope` to a class with a where clause, using
    `update_column(s)` could generate a query that would not properly update
    the record due to the where clause from the `default_scope` being applied
    to the update query.

        class User < ActiveRecord::Base
          default_scope where(active: true)
        end

        user = User.first
        user.active = false
        user.save!

        user.update_column(:active, true) # => false

    In this situation we want to skip the default_scope clause and just
    update the record based on the primary key. With this change:

        user.update_column(:active, true) # => true

    Fixes #8436.

    *Carlos Antonio da Silva*

C
Carlos Antonio da Silva 已提交
236 237
*   SQLite adapter no longer corrupts binary data if the data contains `%00`.

S
Steve Klabnik 已提交
238 239
    *Chris Feist*

C
Carlos Antonio da Silva 已提交
240 241
*   Fix performance problem with `primary_key` method in PostgreSQL adapter when having many schemas.
    Uses `pg_constraint` table instead of `pg_depend` table which has many records in general.
242 243 244 245
    Fix #8414

    *kennyj*

246 247 248 249 250 251
*   Do not instantiate intermediate Active Record objects when eager loading.
    These records caused `after_find` to run more than expected.
    Fix #3313

    *Yves Senn*

252
*   Add STI support to init and building associations.
253 254
    Allows you to do `BaseClass.new(type: "SubClass")` as well as
    `parent.children.build(type: "SubClass")` or `parent.build_child`
255 256 257 258 259 260
    to initialize an STI subclass. Ensures that the class name is a
    valid class and that it is in the ancestors of the super class
    that the association is expecting.

    *Jason Rush*

261 262 263 264
*   Observers was extracted from Active Record as `rails-observers` gem.

    *Rafael Mendonça França*

265 266
*   Ensure that associations take a symbol argument. *Steve Klabnik*

267
*   Fix dirty attribute checks for `TimeZoneConversion` with nil and blank
268 269 270 271 272
    datetime attributes. Setting a nil datetime to a blank string should not
    result in a change being flagged. Fix #8310

    *Alisdair McDiarmid*

273 274 275 276 277
*   Prevent mass assignment to the type column of polymorphic associations when using `build`
    Fix #8265

    *Yves Senn*

278 279 280 281 282
*   Deprecate calling `Relation#sum` with a block. To perform a calculation over
    the array result of the relation, use `to_a.sum(&block)`.

    *Carlos Antonio da Silva*

283 284
*   Fix postgresql adapter to handle BC timestamps correctly

285
        HistoryEvent.create!(name: "something", occured_at: Date.new(0) - 5.years)
286 287 288

    *Bogdan Gusiev*

289 290 291 292 293
*   When running migrations on Postgresql, the `:limit` option for `binary` and `text` columns is silently dropped.
    Previously, these migrations caused sql exceptions, because Postgresql doesn't support limits on these types.

    *Victor Costan*

294 295
*   Don't change STI type when calling `ActiveRecord::Base#becomes`.
    Add `ActiveRecord::Base#becomes!` with the previous behavior.
296

297
    See #3023 for more information.
298 299 300

    *Thomas Hollstegge*

J
Jarek Radosz 已提交
301 302 303 304 305 306 307 308
*   `rename_index` can be used inside a `change_table` block.

        change_table :accounts do |t|
          t.rename_index :user_id, :account_id
        end

    *Jarek Radosz*

309
*   `#pluck` can be used on a relation with `select` clause. Fix #7551
310

311
    Example:
312 313 314

        Topic.select([:approved, :id]).order(:id).pluck(:id)

315
    *Yves Senn*
316

317
*   Do not create useless database transaction when building `has_one` association.
318

319 320 321 322 323 324 325
    Example:

        User.has_one :profile
        User.new.build_profile

    *Bogdan Gusiev*

326
*   `:counter_cache` option for `has_many` associations to support custom named counter caches.
327 328 329 330
    Fix #7993

    *Yves Senn*

331 332 333 334 335 336 337
*   Deprecate the possibility to pass a string as third argument of `add_index`.
    Pass `unique: true` instead.

        add_index(:users, :organization_id, unique: true)

    *Rafael Mendonça França*

338 339 340 341
*   Raise an `ArgumentError` when passing an invalid option to `add_index`.

    *Rafael Mendonça França*

342 343 344 345
*   Fix `find_in_batches` crashing when IDs are strings and start option is not specified.

    *Alexis Bernard*

346 347 348 349
*   `AR::Base#attributes_before_type_cast` now returns unserialized values for serialized attributes.

    *Nikita Afanasenko*

350
*   Use query cache/uncache when using `DATABASE_URL`.
351 352 353 354
    Fix #6951.

    *kennyj*

355 356 357 358 359
*   Added `#none!` method for mutating `ActiveRecord::Relation` objects to a NullRelation.
    It acts like `#none` but modifies relation in place.

    *Juanjo Bazán*

360 361 362 363
*   Fix bug where `update_columns` and `update_column` would not let you update the primary key column.

    *Henrik Nyh*

364 365 366 367 368
*   The `create_table` method raises an `ArgumentError` when the primary key column is redefined.
    Fix #6378

    *Yves Senn*

369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
*   `ActiveRecord::AttributeMethods#[]` raises `ActiveModel::MissingAttributeError`
    error if the given attribute is missing. Fixes #5433.

        class Person < ActiveRecord::Base
          belongs_to :company
        end

        # Before:
        person = Person.select('id').first
        person[:name]       # => nil
        person.name         # => ActiveModel::MissingAttributeError: missing_attribute: name
        person[:company_id] # => nil
        person.company      # => nil

        # After:
        person = Person.select('id').first
        person[:name]       # => ActiveModel::MissingAttributeError: missing_attribute: name
        person.name         # => ActiveModel::MissingAttributeError: missing_attribute: name
        person[:company_id] # => ActiveModel::MissingAttributeError: missing_attribute: company_id
        person.company      # => ActiveModel::MissingAttributeError: missing_attribute: company_id

    *Francesco Rodriguez*

392 393 394 395
*   Small binary fields use the `VARBINARY` MySQL type, instead of `TINYBLOB`.

    *Victor Costan*

396 397 398 399
*   Decode URI encoded attributes on database connection URLs.

    *Shawn Veader*

400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
*   Add `find_or_create_by`, `find_or_create_by!` and
    `find_or_initialize_by` methods to `Relation`.

    These are similar to the `first_or_create` family of methods, but
    the behaviour when a record is created is slightly different:

        User.where(first_name: 'Penélope').first_or_create

    will execute:

        User.where(first_name: 'Penélope').create

    Causing all the `create` callbacks to execute within the context of
    the scope. This could affect queries that occur within callbacks.

        User.find_or_create_by(first_name: 'Penélope')

    will execute:

        User.create(first_name: 'Penélope')

    Which obviously does not affect the scoping of queries within
    callbacks.

424 425 426 427 428 429 430 431 432 433 434
    The `find_or_create_by` version also reads better, frankly.

    If you need to add extra attributes during create, you can do one of:

        User.create_with(active: true).find_or_create_by(first_name: 'Jon')
        User.find_or_create_by(first_name: 'Jon') { |u| u.active = true }

    The `first_or_create` family of methods have been nodoc'ed in favour
    of this API. They may be deprecated in the future but their
    implementation is very small and it's probably not worth putting users
    through lots of annoying deprecation warnings.
435 436 437

    *Jon Leighton*

438
*   Fix bug with presence validation of associations. Would incorrectly add duplicated errors
439 440 441 442
    when the association was blank. Bug introduced in 1fab518c6a75dac5773654646eb724a59741bc13.

    *Scott Willson*

443
*   Fix bug where sum(expression) returns string '0' for no matching records.
444 445 446 447
    Fixes #7439

    *Tim Macfarlane*

448 449 450 451
*   PostgreSQL adapter correctly fetches default values when using multiple schemas and domains in a db. Fixes #7914

    *Arturo Pie*

452 453 454 455
*   Learn ActiveRecord::QueryMethods#order work with hash arguments

    When symbol or hash passed we convert it to Arel::Nodes::Ordering.
    If we pass invalid direction(like name: :DeSc) ActiveRecord::QueryMethods#order will raise an exception
456

457 458 459 460 461
        User.order(:name, email: :desc)
        # SELECT "users".* FROM "users" ORDER BY "users"."name" ASC, "users"."email" DESC

    *Tima Maslyuchenko*

462 463 464 465 466 467 468 469 470 471 472 473
*   Rename `ActiveRecord::Fixtures` class to `ActiveRecord::FixtureSet`.
    Instances of this class normally hold a collection of fixtures (records)
    loaded either from a single YAML file, or from a file and a folder
    with the same name.  This change make the class name singular and makes
    the class easier to distinguish from the modules like
    `ActiveRecord::TestFixtures`, which operates on multiple fixture sets,
    or `DelegatingFixtures`, `::Fixtures`, etc.,
    and from the class `ActiveRecord::Fixture`, which corresponds to a single
    fixture.

    *Alexey Muranov*

474 475 476 477 478
*   The postgres adapter now supports tables with capital letters.
    Fix #5920

    *Yves Senn*

479 480
*   `CollectionAssociation#count` returns `0` without querying if the
    parent record is not persisted.
481 482 483

    Before:

484
        person.pets.count
485 486 487 488 489
        # SELECT COUNT(*) FROM "pets" WHERE "pets"."person_id" IS NULL
        # => 0

    After:

490
        person.pets.count
491 492 493 494 495
        # fires without sql query
        # => 0

    *Francesco Rodriguez*

496 497 498 499 500
*   Fix `reset_counters` crashing on `has_many :through` associations.
    Fix #7822.

    *lulalala*

J
Jon Leighton 已提交
501 502 503 504 505 506 507 508 509 510 511
*   Support for partial inserts.

    When inserting new records, only the fields which have been changed
    from the defaults will actually be included in the INSERT statement.
    The other fields will be populated by the database.

    This is more efficient, and also means that it will be safe to
    remove database columns without getting subsequent errors in running
    app processes (so long as the code in those processes doesn't
    contain any references to the removed column).

512 513 514 515
    The `partial_updates` configuration option is now renamed to
    `partial_writes` to reflect the fact that it now impacts both inserts
    and updates.

J
Jon Leighton 已提交
516 517
    *Jon Leighton*

518 519 520 521
*   Allow before and after validations to take an array of lifecycle events

    *John Foley*

522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
*   Support for specifying transaction isolation level

    If your database supports setting the isolation level for a transaction, you can set
    it like so:

        Post.transaction(isolation: :serializable) do
          # ...
        end

    Valid isolation levels are:

    * `:read_uncommitted`
    * `:read_committed`
    * `:repeatable_read`
    * `:serializable`

    You should consult the documentation for your database to understand the
    semantics of these different levels:

    * http://www.postgresql.org/docs/9.1/static/transaction-iso.html
    * https://dev.mysql.com/doc/refman/5.0/en/set-transaction.html

    An `ActiveRecord::TransactionIsolationError` will be raised if:

    * The adapter does not support setting the isolation level
    * You are joining an existing open transaction
    * You are creating a nested (savepoint) transaction

    The mysql, mysql2 and postgresql adapters support setting the transaction
    isolation level. However, support is disabled for mysql versions below 5,
    because they are affected by a bug (http://bugs.mysql.com/bug.php?id=39170)
    which means the isolation level gets persisted outside the transaction.

    *Jon Leighton*

557 558 559 560 561 562 563 564 565 566
*   `ActiveModel::ForbiddenAttributesProtection` is included by default
    in Active Record models. Check the docs of `ActiveModel::ForbiddenAttributesProtection`
    for more details.

    *Guillermo Iguaran*

*   Remove integration between Active Record and
    `ActiveModel::MassAssignmentSecurity`, `protected_attributes` gem
    should be added to use `attr_accessible`/`attr_protected`. Mass
    assignment options has been removed from all the AR methods that
567
    used it (ex. `AR::Base.new`, `AR::Base.create`, `AR::Base#update_attributes`, etc).
568 569 570

    *Guillermo Iguaran*

571 572 573 574 575 576 577 578 579 580 581 582 583 584
*   Fix the return of querying with an empty hash.
    Fix #6971.

        User.where(token: {})

    Before:

        #=> SELECT * FROM users;

    After:

        #=> SELECT * FROM users WHERE 1 = 2;

    *Damien Mathieu*
D
Damien Mathieu 已提交
585

586 587 588
*   Fix creation of through association models when using `collection=[]`
    on a `has_many :through` association from an unsaved model.
    Fix #7661.
589 590 591

    *Ernie Miller*

K
kennyj 已提交
592
*   Explain only normal CRUD sql (select / update / insert / delete).
593 594
    Fix problem that explains unexplainable sql.
    Closes #7544 #6458.
K
kennyj 已提交
595 596 597

    *kennyj*

M
Matt Jones 已提交
598 599 600 601 602 603
*   You can now override the generated accessor methods for stored attributes
    and reuse the original behavior with `read_store_attribute` and `write_store_attribute`,
    which are counterparts to `read_attribute` and `write_attribute`.

    *Matt Jones*

604
*   Accept `belongs_to` (including polymorphic) association keys in queries.
605 606 607

    The following queries are now equivalent:

608 609
        Post.where(author: author)
        Post.where(author_id: author)
610

611 612
        PriceEstimate.where(estimate_of: treasure)
        PriceEstimate.where(estimate_of_type: 'Treasure', estimate_of_id: treasure)
613 614 615

    *Peter Brown*

616 617 618 619 620
*   Use native `mysqldump` command instead of `structure_dump` method
    when dumping the database structure to a sql file. Fixes #5547.

    *kennyj*

621
*   PostgreSQL inet and cidr types are converted to `IPAddr` objects.
622

623 624 625 626 627 628 629 630
    *Dan McClain*

*   PostgreSQL array type support. Any datatype can be used to create an
    array column, with full migration and schema dumper support.

    To declare an array column, use the following syntax:

        create_table :table_with_arrays do |t|
631
          t.integer :int_array, array: true
632
          # integer[]
633
          t.integer :int_array, array: true, length: 2
634
          # smallint[]
635
          t.string :string_array, array: true, length: 30
636
          # char varying(30)[]
637
        end
638

639
    This respects any other migration detail (limits, defaults, etc).
X
Xavier Noria 已提交
640
    Active Record will serialize and deserialize the array columns on
641 642 643 644 645 646 647 648
    their way to and from the database.

    One thing to note: PostgreSQL does not enforce any limits on the
    number of elements, and any array can be multi-dimensional. Any
    array that is multi-dimensional must be rectangular (each sub array
    must have the same number of elements as its siblings).

    If the `pg_array_parser` gem is available, it will be used when
649
    parsing PostgreSQL's array representation.
650 651 652

    *Dan McClain*

653 654
*   Attribute predicate methods, such as `article.title?`, will now raise
    `ActiveModel::MissingAttributeError` if the attribute being queried for
655
    truthiness was not read from the database, instead of just returning `false`.
656 657 658

    *Ernie Miller*

659 660 661 662
*   `ActiveRecord::SchemaDumper` uses Ruby 1.9 style hash, which means that the
    schema.rb file will be generated using this new syntax from now on.

    *Konstantin Shabanov*
663

664 665 666
*   Map interval with precision to string datatype in PostgreSQL. Fixes #7518.

    *Yves Senn*
667

668 669 670
*   Fix eagerly loading associations without primary keys. Fixes #4976.

    *Kelley Reynolds*
671

672 673 674 675 676 677
*   Rails now raise an exception when you're trying to run a migration that has an invalid
    file name. Only lower case letters, numbers, and '_' are allowed in migration's file name.
    Please see #7419 for more details.

    *Jan Bernacki*

M
Matt Jones 已提交
678
*   Fix bug when calling `store_accessor` multiple times.
679 680 681 682 683 684 685 686 687
    Fixes #7532.

    *Matt Jones*

*   Fix store attributes that show the changes incorrectly.
    Fixes #7532.

    *Matt Jones*

688 689 690 691
*   Fix `ActiveRecord::Relation#pluck` when columns or tables are reserved words.

    *Ian Lesperance*

692
*   Allow JSON columns to be created in PostgreSQL and properly encoded/decoded.
693 694 695 696
    to/from database.

    *Dickson S. Guedes*

697
*   Fix time column type casting for invalid time string values to correctly return `nil`.
698 699 700

    *Adam Meehan*

701
*   Allow to pass Symbol or Proc into `:limit` option of #accepts_nested_attributes_for.
M
Mikhail Dieterle 已提交
702 703 704

    *Mikhail Dieterle*

705
*   ActiveRecord::SessionStore has been extracted from Active Record as `activerecord-session_store`
706 707 708
    gem. Please read the `README.md` file on the gem for the usage.

    *Prem Sichanugrist*
709

710 711 712 713 714 715
*   Fix `reset_counters` when there are multiple `belongs_to` association with the
    same foreign key and one of them have a counter cache.
    Fixes #5200.

    *Dave Desrochers*

716 717 718 719
*   `serialized_attributes` and `_attr_readonly` become class method only. Instance reader methods are deprecated.

    *kennyj*

720 721 722 723 724
*   Round usec when comparing timestamp attributes in the dirty tracking.
    Fixes #6975.

    *kennyj*

725
*   Use inversed parent for first and last child of `has_many` association.
726 727 728

    *Ravil Bayramgalin*

729
*   Fix `Column.microseconds` and `Column.fast_string_to_time` to avoid converting
730 731 732 733 734
    timestamp seconds to a float, since it occasionally results in inaccuracies
    with microsecond-precision times. Fixes #7352.

    *Ari Pollak*

735 736 737
*   Fix AR#dup to nullify the validation errors in the dup'ed object. Previously the original
    and the dup'ed object shared the same errors.

738
    *Christian Seiler*
739

740 741 742 743
*   Raise `ArgumentError` if list of attributes to change is empty in `update_all`.

    *Roman Shatsov*

744 745 746 747 748
*   Fix AR#create to return an unsaved record when AR::RecordInvalid is
    raised. Fixes #3217.

    *Dave Yeu*

749 750
*   Fixed table name prefix that is generated in engines for namespaced models.

751 752
    *Wojciech Wnętrzak*

753
*   Make sure `:environment` task is executed before `db:schema:load` or `db:structure:load`.
R
Rafael Mendonça França 已提交
754 755 756 757
    Fixes #4772.

    *Seamus Abshere*

758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
*   Allow Relation#merge to take a proc.

    This was requested by DHH to allow creating of one's own custom
    association macros.

    For example:

        module Commentable
          def has_many_comments(extra)
            has_many :comments, -> { where(:foo).merge(extra) }
          end
        end

        class Post < ActiveRecord::Base
          extend Commentable
          has_many_comments -> { where(:bar) }
        end

    *Jon Leighton*

778
*   Add CollectionProxy#scope.
J
Jon Leighton 已提交
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795

    This can be used to get a Relation from an association.

    Previously we had a #scoped method, but we're deprecating that for
    AR::Base, so it doesn't make sense to have it here.

    This was requested by DHH, to facilitate code like this:

        Project.scope.order('created_at DESC').page(current_page).tagged_with(@tag).limit(5).scoping do
          @topics      = @project.topics.scope
          @todolists   = @project.todolists.scope
          @attachments = @project.attachments.scope
          @documents   = @project.documents.scope
        end

    *Jon Leighton*

796
*   Add `Relation#load`.
J
Jon Leighton 已提交
797 798 799 800 801 802 803 804 805 806 807 808 809 810

    This method explicitly loads the records and then returns `self`.

    Rather than deciding between "do I want an array or a relation?",
    most people are actually asking themselves "do I want to eager load
    or lazy load?" Therefore, this method provides a way to explicitly
    eager-load without having to switch from a `Relation` to an array.

    Example:

        @posts = Post.where(published: true).load

    *Jon Leighton*

811 812 813 814 815 816 817 818 819
*   `Relation#order`: make new order prepend old one.

        User.order("name asc").order("created_at desc")
        # SELECT * FROM users ORDER BY created_at desc, name asc

    This also affects order defined in `default_scope` or any kind of associations.

    *Bogdan Gusiev*

820
*   `Model.all` now returns an `ActiveRecord::Relation`, rather than an
821
    array of records. Use `Relation#to_a` if you really want an array.
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837

    In some specific cases, this may cause breakage when upgrading.
    However in most cases the `ActiveRecord::Relation` will just act as a
    lazy-loaded array and there will be no problems.

    Note that calling `Model.all` with options (e.g.
    `Model.all(conditions: '...')` was already deprecated, but it will
    still return an array in order to make the transition easier.

    `Model.scoped` is deprecated in favour of `Model.all`.

    `Relation#all` still returns an array, but is deprecated (since it
    would serve no purpose if we made it return a `Relation`).

    *Jon Leighton*

838 839 840 841 842 843 844
*   `:finder_sql` and `:counter_sql` options on collection associations
    are deprecated. Please transition to using scopes.

    *Jon Leighton*

*   `:insert_sql` and `:delete_sql` options on `has_and_belongs_to_many`
    associations are deprecated. Please transition to using `has_many
845
    :through`.
846 847 848

    *Jon Leighton*

849 850 851 852 853 854 855 856 857 858 859
*   Added `#update_columns` method which updates the attributes from
    the passed-in hash without calling save, hence skipping validations and
    callbacks. `ActiveRecordError` will be raised when called on new objects
    or when at least one of the attributes is marked as read only.

        post.attributes # => {"id"=>2, "title"=>"My title", "body"=>"My content", "author"=>"Peter"}
        post.update_columns(title: 'New title', author: 'Sebastian') # => true
        post.attributes # => {"id"=>2, "title"=>"New title", "body"=>"My content", "author"=>"Sebastian"}

    *Sebastian Martinez + Rafael Mendonça França*

860 861 862
*   The migration generator now creates a join table with (commented) indexes every time
    the migration name contains the word `join_table`:

863
        rails g migration create_join_table_for_artists_and_musics artist_id:index music_id
864 865 866

    *Aleksey Magusev*

867 868
*   Add `add_reference` and `remove_reference` schema statements. Aliases, `add_belongs_to`
    and `remove_belongs_to` are acceptable. References are reversible.
869

870
    Examples:
871 872 873

        # Create a user_id column
        add_reference(:products, :user)
874
        # Create a supplier_id, supplier_type columns and appropriate index
875 876 877 878 879 880
        add_reference(:products, :supplier, polymorphic: true, index: true)
        # Remove polymorphic reference
        remove_reference(:products, :supplier, polymorphic: true)

    *Aleksey Magusev*

881 882 883 884 885 886 887
*   Add `:default` and `:null` options to `column_exists?`.

        column_exists?(:testings, :taggable_id, :integer, null: false)
        column_exists?(:testings, :taggable_type, :string, default: 'Photo')

    *Aleksey Magusev*

888 889
*   `ActiveRecord::Relation#inspect` now makes it clear that you are
    dealing with a `Relation` object rather than an array:.
890

891
        User.where(age: 30).inspect
892
        # => <ActiveRecord::Relation [#<User ...>, #<User ...>, ...]>
B
Brian Cardarella 已提交
893

894
        User.where(age: 30).to_a.inspect
895
        # => [#<User ...>, #<User ...>]
896

897 898 899
    The number of records displayed will be limited to 10.

    *Brian Cardarella, Jon Leighton & Damien Mathieu*
B
Brian Cardarella 已提交
900

901
*   Add `collation` and `ctype` support to PostgreSQL. These are available for PostgreSQL 8.4 or later.
902 903
    Example:

904 905 906 907 908 909 910 911 912
        development:
          adapter: postgresql
          host: localhost
          database: rails_development
          username: foo
          password: bar
          encoding: UTF8
          collation: ja_JP.UTF8
          ctype: ja_JP.UTF8
913 914 915

    *kennyj*

916
*   Changed `validates_presence_of` on an association so that children objects
917 918 919 920 921 922
    do not validate as being present if they are marked for destruction. This
    prevents you from saving the parent successfully and thus putting the parent
    in an invalid state.

    *Nick Monje & Brent Wheeldon*

E
Egor Lynko 已提交
923 924 925 926
*   `FinderMethods#exists?` now returns `false` with the `false` argument.

    *Egor Lynko*

927 928 929 930 931 932
*   Added support for specifying the precision of a timestamp in the postgresql
    adapter. So, instead of having to incorrectly specify the precision using the
    `:limit` option, you may use `:precision`, as intended. For example, in a migration:

        def change
          create_table :foobars do |t|
933
            t.timestamps precision: 0
934 935 936 937 938
          end
        end

    *Tony Schneider*

939
*   Allow `ActiveRecord::Relation#pluck` to accept multiple columns. Returns an
940
    array of arrays containing the typecasted values:
941 942 943 944 945 946 947

        Person.pluck(:id, :name)
        # SELECT people.id, people.name FROM people
        # [[1, 'David'], [2, 'Jeremy'], [3, 'Jose']]

    *Jeroen van Ingen & Carlos Antonio da Silva*

948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
*   Improve the derivation of HABTM join table name to take account of nesting.
    It now takes the table names of the two models, sorts them lexically and
    then joins them, stripping any common prefix from the second table name.

    Some examples:

        Top level models (Category <=> Product)
        Old: categories_products
        New: categories_products

        Top level models with a global table_name_prefix (Category <=> Product)
        Old: site_categories_products
        New: site_categories_products

        Nested models in a module without a table_name_prefix method (Admin::Category <=> Admin::Product)
        Old: categories_products
        New: categories_products

        Nested models in a module with a table_name_prefix method (Admin::Category <=> Admin::Product)
        Old: categories_products
        New: admin_categories_products

        Nested models in a parent model (Catalog::Category <=> Catalog::Product)
        Old: categories_products
        New: catalog_categories_products

        Nested models in different parent models (Catalog::Category <=> Content::Page)
        Old: categories_pages
        New: catalog_categories_content_pages

    *Andrew White*

980
*   Move HABTM validity checks to `ActiveRecord::Reflection`. One side effect of
981 982 983 984 985 986
    this is to move when the exceptions are raised from the point of declaration
    to when the association is built. This is consistant with other association
    validity checks.

    *Andrew White*

987
*   Added `stored_attributes` hash which contains the attributes stored using
988
    `ActiveRecord::Store`. This allows you to retrieve the list of attributes
989
    you've defined.
990

991 992 993 994 995 996 997
       class User < ActiveRecord::Base
         store :settings, accessors: [:color, :homepage]
       end

       User.stored_attributes[:settings] # [:color, :homepage]

    *Joost Baaij & Carlos Antonio da Silva*
998

999 1000 1001 1002 1003 1004
*   PostgreSQL default log level is now 'warning', to bypass the noisy notice
    messages. You can change the log level using the `min_messages` option
    available in your config/database.yml.

    *kennyj*

1005 1006 1007
*   Add uuid datatype support to PostgreSQL adapter.

    *Konstantin Shabanov*
1008

1009
*   Added `ActiveRecord::Migration.check_pending!` that raises an error if
1010 1011 1012
    migrations are pending.

    *Richard Schneeman*
1013

1014 1015 1016 1017 1018
*   Added `#destroy!` which acts like `#destroy` but will raise an
    `ActiveRecord::RecordNotDestroyed` exception instead of returning `false`.

    *Marc-André Lafortune*

1019 1020 1021 1022 1023 1024 1025 1026 1027
*   Added support to `CollectionAssociation#delete` for passing `fixnum`
    or `string` values as record ids. This finds the records responding
    to the `id` and executes delete on them.

        class Person < ActiveRecord::Base
          has_many :pets
        end

        person.pets.delete("1") # => [#<Pet id: 1>]
1028
        person.pets.delete(2, 3) # => [#<Pet id: 2>, #<Pet id: 3>]
1029 1030 1031

    *Francesco Rodriguez*

1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
*   Deprecated most of the 'dynamic finder' methods. All dynamic methods
    except for `find_by_...` and `find_by_...!` are deprecated. Here's
    how you can rewrite the code:

      * `find_all_by_...` can be rewritten using `where(...)`
      * `find_last_by_...` can be rewritten using `where(...).last`
      * `scoped_by_...` can be rewritten using `where(...)`
      * `find_or_initialize_by_...` can be rewritten using
        `where(...).first_or_initialize`
      * `find_or_create_by_...` can be rewritten using
1042
        `find_or_create_by(...)` or where(...).first_or_create`
1043
      * `find_or_create_by_...!` can be rewritten using
1044
        `find_or_create_by!(...) or `where(...).first_or_create!`
1045 1046

    The implementation of the deprecated dynamic finders has been moved
1047
    to the `activerecord-deprecated_finders` gem. See below for details.
1048 1049 1050 1051 1052 1053 1054

    *Jon Leighton*

*   Deprecated the old-style hash based finder API. This means that
    methods which previously accepted "finder options" no longer do. For
    example this:

1055
        Post.find(:all, conditions: { comments_count: 10 }, limit: 5)
1056 1057 1058 1059 1060 1061 1062

    Should be rewritten in the new style which has existed since Rails 3:

        Post.where(comments_count: 10).limit(5)

    Note that as an interim step, it is possible to rewrite the above as:

1063
        Post.all.merge(where: { comments_count: 10 }, limit: 5)
1064 1065 1066 1067

    This could save you a lot of work if there is a lot of old-style
    finder usage in your application.

1068
    `Relation#merge` now accepts a hash of
1069 1070 1071 1072
    options, but they must be identical to the names of the equivalent
    finder method. These are mostly identical to the old-style finder
    option names, except in the following cases:

1073 1074
      * `:conditions` becomes `:where`.
      * `:include` becomes `:includes`.
1075 1076

    The code to implement the deprecated features has been moved out to
1077
    the `activerecord-deprecated_finders` gem. This gem is a dependency
1078 1079 1080 1081 1082 1083 1084
    of Active Record in Rails 4.0. It will no longer be a dependency
    from Rails 4.1, but if your app relies on the deprecated features
    then you can add it to your own Gemfile. It will be maintained by
    the Rails core team until Rails 5.0 is released.

    *Jon Leighton*

J
Johannes Barre 已提交
1085 1086 1087 1088
*   It's not possible anymore to destroy a model marked as read only.

    *Johannes Barre*

1089
*   Added ability to ActiveRecord::Relation#from to accept other ActiveRecord::Relation objects.
1090 1091 1092 1093 1094 1095

      Record.from(subquery)
      Record.from(subquery, :a)

    *Radoslav Stankov*

1096 1097 1098 1099 1100 1101
*   Added custom coders support for ActiveRecord::Store. Now you can set
    your custom coder like this:

        store :settings, accessors: [ :color, :homepage ], coder: JSON

    *Andrey Voronkov*
1102

1103 1104 1105 1106 1107 1108
*   `mysql` and `mysql2` connections will set `SQL_MODE=STRICT_ALL_TABLES` by
    default to avoid silent data loss. This can be disabled by specifying
    `strict: false` in your `database.yml`.

    *Michael Pearson*

1109
*   Added default order to `first` to assure consistent results among
1110
    different database engines. Introduced `take` as a replacement to
1111 1112 1113 1114
    the old behavior of `first`.

    *Marcelo Silveira*

1115
*   Added an `:index` option to automatically create indexes for references
1116 1117 1118 1119 1120 1121 1122
    and belongs_to statements in migrations.

    The `references` and `belongs_to` methods now support an `index`
    option that receives either a boolean value or an options hash
    that is identical to options available to the add_index method:

      create_table :messages do |t|
1123
        t.references :person, index: true
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
      end

      Is the same as:

      create_table :messages do |t|
        t.references :person
      end
      add_index :messages, :person_id

    Generators have also been updated to use the new syntax.

1135
    *Joshua Wood*
1136

1137 1138 1139 1140 1141 1142 1143
*   Added bang methods for mutating `ActiveRecord::Relation` objects.
    For example, while `foo.where(:bar)` will return a new object
    leaving `foo` unchanged, `foo.where!(:bar)` will mutate the foo
    object

    *Jon Leighton*

1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
*   Added `#find_by` and `#find_by!` to mirror the functionality
    provided by dynamic finders in a way that allows dynamic input more
    easily:

        Post.find_by name: 'Spartacus', rating: 4
        Post.find_by "published_at < ?", 2.weeks.ago
        Post.find_by! name: 'Spartacus'

    *Jon Leighton*

G
Guillermo Iguaran 已提交
1154 1155 1156 1157 1158
*   Added ActiveRecord::Base#slice to return a hash of the given methods with
    their names as keys and returned values as values.

    *Guillermo Iguaran*

J
Jon Leighton 已提交
1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
*   Deprecate eager-evaluated scopes.

    Don't use this:

        scope :red, where(color: 'red')
        default_scope where(color: 'red')

    Use this:

        scope :red, -> { where(color: 'red') }
        default_scope { where(color: 'red') }

    The former has numerous issues. It is a common newbie gotcha to do
    the following:

        scope :recent, where(published_at: Time.now - 2.weeks)

    Or a more subtle variant:

        scope :recent, -> { where(published_at: Time.now - 2.weeks) }
        scope :recent_red, recent.where(color: 'red')

    Eager scopes are also very complex to implement within Active
    Record, and there are still bugs. For example, the following does
    not do what you expect:

        scope :remove_conditions, except(:where)
        where(...).remove_conditions # => still has conditions

    *Jon Leighton*

1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
*   Remove IdentityMap

    IdentityMap has never graduated to be an "enabled-by-default" feature, due
    to some inconsistencies with associations, as described in this commit:

       https://github.com/rails/rails/commit/302c912bf6bcd0fa200d964ec2dc4a44abe328a6

    Hence the removal from the codebase, until such issues are fixed.

    *Carlos Antonio da Silva*
C
Carlos Antonio da Silva 已提交
1200

1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
*   Added the schema cache dump feature.

    `Schema cache dump` feature was implemetend. This feature can dump/load internal state of `SchemaCache` instance
    because we want to boot rails more quickly when we have many models.

    Usage notes:

      1) execute rake task.
      RAILS_ENV=production bundle exec rake db:schema:cache:dump
      => generate db/schema_cache.dump

1212
      2) add config.active_record.use_schema_cache_dump = true in config/production.rb. BTW, true is default.
1213 1214 1215

      3) boot rails.
      RAILS_ENV=production bundle exec rails server
1216
      => use db/schema_cache.dump
1217 1218 1219 1220 1221 1222 1223

      4) If you remove clear dumped cache, execute rake task.
      RAILS_ENV=production bundle exec rake db:schema:cache:clear
      => remove db/schema_cache.dump

    *kennyj*

1224
*   Added support for partial indices to PostgreSQL adapter.
1225 1226 1227 1228

    The `add_index` method now supports a `where` option that receives a
    string with the partial index criteria.

1229
        add_index(:accounts, :code, where: 'active')
1230

1231
        Generates
1232

1233
        CREATE INDEX index_accounts_on_code ON accounts(code) WHERE active
1234 1235 1236

    *Marcelo Silveira*

1237
*   Implemented ActiveRecord::Relation#none method.
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247

    The `none` method returns a chainable relation with zero records
    (an instance of the NullRelation class).

    Any subsequent condition chained to the returned relation will continue
    generating an empty relation and will not fire any query to the database.

    *Juanjo Bazán*

*   Added the `ActiveRecord::NullRelation` class implementing the null
1248
    object pattern for the Relation class.
1249

1250 1251 1252
    *Juanjo Bazán*

*   Added new `dependent: :restrict_with_error` option. This will add
1253
    an error to the model, rather than raising an exception.
1254

1255 1256
    The `:restrict` option is renamed to `:restrict_with_exception` to
    make this distinction explicit.
1257

1258
    *Manoj Kumar & Jon Leighton*
1259

1260
*   Added `create_join_table` migration helper to create HABTM join tables.
1261 1262 1263

        create_join_table :products, :categories
        # =>
1264 1265 1266
        # create_table :categories_products, id: false do |td|
        #   td.integer :product_id,  null: false
        #   td.integer :category_id, null: false
1267 1268 1269 1270
        # end

    *Rafael Mendonça França*

1271
*   The primary key is always initialized in the @attributes hash to `nil` (unless
1272
    another value has been specified).
1273

1274 1275
    *Aaron Paterson*

1276 1277 1278 1279 1280 1281 1282 1283 1284 1285
*   In previous releases, the following would generate a single query with
    an `OUTER JOIN comments`, rather than two separate queries:

        Post.includes(:comments)
            .where("comments.name = 'foo'")

    This behaviour relies on matching SQL string, which is an inherently
    flawed idea unless we write an SQL parser, which we do not wish to
    do.

1286 1287 1288 1289
    Therefore, it is now deprecated.

    To avoid deprecation warnings and for future compatibility, you must
    explicitly state which tables you reference, when using SQL snippets:
1290 1291 1292 1293 1294 1295 1296 1297

        Post.includes(:comments)
            .where("comments.name = 'foo'")
            .references(:comments)

    Note that you do not need to explicitly specify references in the
    following cases, as they can be automatically inferred:

1298 1299 1300
        Post.includes(:comments).where(comments: { name: 'foo' })
        Post.includes(:comments).where('comments.name' => 'foo')
        Post.includes(:comments).order('comments.name')
1301

1302
    You do not need to worry about this unless you are doing eager
1303 1304 1305
    loading. Basically, don't worry unless you see a deprecation warning
    or (in future releases) an SQL error due to a missing JOIN.

1306
    *Jon Leighton*
1307

1308
*   Support for the `schema_info` table has been dropped. Please
1309 1310
    switch to `schema_migrations`.

1311 1312 1313
    *Aaron Patterson*

*   Connections *must* be closed at the end of a thread. If not, your
1314 1315
    connection pool can fill and an exception will be raised.

1316 1317
    *Aaron Patterson*

1318 1319
*   PostgreSQL hstore records can be created.

1320 1321
    *Aaron Patterson*

1322 1323
*   PostgreSQL hstore types are automatically deserialized from the database.

1324 1325
    *Aaron Patterson*

X
Xavier Noria 已提交
1326
Please check [3-2-stable](https://github.com/rails/rails/blob/3-2-stable/activerecord/CHANGELOG.md) for previous changes.