CHANGELOG.md 35.2 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
*   Add migration history to schema.rb dump.
    Loading schema.rb with full migration history
    restores the exact list of migrations that created
    that schema (including names and fingerprints). This
    avoids possible mistakes caused by assuming all
    migrations with a lower version have been run when
    loading schema.rb. Old schema.rb files without migration
    history but with the :version setting still work as before.

    *Josh Susser*

J
Josh Susser 已提交
14 15 16 17 18 19 20
*   Add metadata columns to schema_migrations table.
    New columns are: migrated_at (timestamp),
    fingerprint (md5 hash of migration source), and
    name (filename minus version and extension)
    
    *Josh Susser*

21 22 23 24 25 26 27 28 29
*   Add STI support to init and building associations.
    Allows you to do BaseClass.new(:type => "SubClass") as well as
    parent.children.build(:type => "SubClass") or parent.build_child
    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*

30 31 32 33
*   Observers was extracted from Active Record as `rails-observers` gem.

    *Rafael Mendonça França*

34 35
*   Ensure that associations take a symbol argument. *Steve Klabnik*

36
*   Fix dirty attribute checks for `TimeZoneConversion` with nil and blank
37 38 39 40 41
    datetime attributes. Setting a nil datetime to a blank string should not
    result in a change being flagged. Fix #8310

    *Alisdair McDiarmid*

42 43 44 45 46
*   Prevent mass assignment to the type column of polymorphic associations when using `build`
    Fix #8265

    *Yves Senn*

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

52 53 54 55 56 57
*   Fix postgresql adapter to handle BC timestamps correctly

        HistoryEvent.create!(:name => "something", :occured_at => Date.new(0) - 5.years)

    *Bogdan Gusiev*

58 59 60 61 62
*   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*

63 64
*   Don't change STI type when calling `ActiveRecord::Base#becomes`.
    Add `ActiveRecord::Base#becomes!` with the previous behavior.
65

66
    See #3023 for more information.
67 68 69

    *Thomas Hollstegge*

J
Jarek Radosz 已提交
70 71 72 73 74 75 76 77
*   `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*

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

80
    Example:
81 82 83

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

84
    *Yves Senn*
85

86
*   Do not create useless database transaction when building `has_one` association.
87

88 89 90 91 92 93 94
    Example:

        User.has_one :profile
        User.new.build_profile

    *Bogdan Gusiev*

95
*   `:counter_cache` option for `has_many` associations to support custom named counter caches.
96 97 98 99
    Fix #7993

    *Yves Senn*

100 101 102 103 104 105 106
*   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*

107 108 109 110
*   Raise an `ArgumentError` when passing an invalid option to `add_index`.

    *Rafael Mendonça França*

111 112 113 114
*   Fix `find_in_batches` crashing when IDs are strings and start option is not specified.

    *Alexis Bernard*

115 116 117 118
*   `AR::Base#attributes_before_type_cast` now returns unserialized values for serialized attributes.

    *Nikita Afanasenko*

119
*   Use query cache/uncache when using `DATABASE_URL`.
120 121 122 123
    Fix #6951.

    *kennyj*

124 125 126 127 128
*   Added `#none!` method for mutating `ActiveRecord::Relation` objects to a NullRelation.
    It acts like `#none` but modifies relation in place.

    *Juanjo Bazán*

129 130 131 132
*   Fix bug where `update_columns` and `update_column` would not let you update the primary key column.

    *Henrik Nyh*

133 134 135 136 137
*   The `create_table` method raises an `ArgumentError` when the primary key column is redefined.
    Fix #6378

    *Yves Senn*

138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
*   `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*

161 162 163 164
*   Small binary fields use the `VARBINARY` MySQL type, instead of `TINYBLOB`.

    *Victor Costan*

165 166 167 168
*   Decode URI encoded attributes on database connection URLs.

    *Shawn Veader*

169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
*   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.

193 194 195 196 197 198 199 200 201 202 203
    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.
204 205 206

    *Jon Leighton*

207
*   Fix bug with presence validation of associations. Would incorrectly add duplicated errors
208 209 210 211
    when the association was blank. Bug introduced in 1fab518c6a75dac5773654646eb724a59741bc13.

    *Scott Willson*

212
*   Fix bug where sum(expression) returns string '0' for no matching records.
213 214 215 216
    Fixes #7439

    *Tim Macfarlane*

217 218 219 220
*   PostgreSQL adapter correctly fetches default values when using multiple schemas and domains in a db. Fixes #7914

    *Arturo Pie*

221 222 223 224
*   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
225

226 227 228 229 230
        User.order(:name, email: :desc)
        # SELECT "users".* FROM "users" ORDER BY "users"."name" ASC, "users"."email" DESC

    *Tima Maslyuchenko*

231 232 233 234 235 236 237 238 239 240 241 242
*   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*

243 244 245 246 247
*   The postgres adapter now supports tables with capital letters.
    Fix #5920

    *Yves Senn*

248 249
*   `CollectionAssociation#count` returns `0` without querying if the
    parent record is not persisted.
250 251 252

    Before:

253
        person.pets.count
254 255 256 257 258
        # SELECT COUNT(*) FROM "pets" WHERE "pets"."person_id" IS NULL
        # => 0

    After:

259
        person.pets.count
260 261 262 263 264
        # fires without sql query
        # => 0

    *Francesco Rodriguez*

265 266 267 268 269
*   Fix `reset_counters` crashing on `has_many :through` associations.
    Fix #7822.

    *lulalala*

J
Jon Leighton 已提交
270 271 272 273 274 275 276 277 278 279 280
*   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).

281 282 283 284
    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 已提交
285 286
    *Jon Leighton*

287 288 289 290
*   Allow before and after validations to take an array of lifecycle events

    *John Foley*

291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
*   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*

326 327 328 329 330 331 332 333 334 335
*   `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
336
    used it (ex. `AR::Base.new`, `AR::Base.create`, `AR::Base#update_attributes`, etc).
337 338 339

    *Guillermo Iguaran*

340 341 342 343 344 345 346 347 348 349 350 351 352 353
*   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 已提交
354

355 356 357
*   Fix creation of through association models when using `collection=[]`
    on a `has_many :through` association from an unsaved model.
    Fix #7661.
358 359 360

    *Ernie Miller*

K
kennyj 已提交
361
*   Explain only normal CRUD sql (select / update / insert / delete).
362 363
    Fix problem that explains unexplainable sql.
    Closes #7544 #6458.
K
kennyj 已提交
364 365 366

    *kennyj*

M
Matt Jones 已提交
367 368 369 370 371 372
*   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*

373
*   Accept belongs_to (including polymorphic) association keys in queries.
374 375 376

    The following queries are now equivalent:

377 378
        Post.where(author: author)
        Post.where(author_id: author)
379

380 381
        PriceEstimate.where(estimate_of: treasure)
        PriceEstimate.where(estimate_of_type: 'Treasure', estimate_of_id: treasure)
382 383 384

    *Peter Brown*

385 386 387 388 389
*   Use native `mysqldump` command instead of `structure_dump` method
    when dumping the database structure to a sql file. Fixes #5547.

    *kennyj*

390
*   PostgreSQL inet and cidr types are converted to `IPAddr` objects.
391

392 393 394 395 396 397 398 399
    *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|
400
          t.integer :int_array, array: true
401
          # integer[]
402
          t.integer :int_array, array: true, length: 2
403
          # smallint[]
404
          t.string :string_array, array: true, length: 30
405
          # char varying(30)[]
406
        end
407

408
    This respects any other migration detail (limits, defaults, etc).
X
Xavier Noria 已提交
409
    Active Record will serialize and deserialize the array columns on
410 411 412 413 414 415 416 417
    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
418
    parsing PostgreSQL's array representation.
419 420 421

    *Dan McClain*

422 423
*   Attribute predicate methods, such as `article.title?`, will now raise
    `ActiveModel::MissingAttributeError` if the attribute being queried for
424
    truthiness was not read from the database, instead of just returning `false`.
425 426 427

    *Ernie Miller*

428 429 430 431
*   `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*
432

433 434 435
*   Map interval with precision to string datatype in PostgreSQL. Fixes #7518.

    *Yves Senn*
436

437 438 439
*   Fix eagerly loading associations without primary keys. Fixes #4976.

    *Kelley Reynolds*
440

441 442 443 444 445 446
*   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 已提交
447
*   Fix bug when calling `store_accessor` multiple times.
448 449 450 451 452 453 454 455 456
    Fixes #7532.

    *Matt Jones*

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

    *Matt Jones*

457 458 459 460
*   Fix `ActiveRecord::Relation#pluck` when columns or tables are reserved words.

    *Ian Lesperance*

461
*   Allow JSON columns to be created in PostgreSQL and properly encoded/decoded.
462 463 464 465
    to/from database.

    *Dickson S. Guedes*

466
*   Fix time column type casting for invalid time string values to correctly return `nil`.
467 468 469

    *Adam Meehan*

470
*   Allow to pass Symbol or Proc into `:limit` option of #accepts_nested_attributes_for.
M
Mikhail Dieterle 已提交
471 472 473

    *Mikhail Dieterle*

474
*   ActiveRecord::SessionStore has been extracted from Active Record as `activerecord-session_store`
475 476 477
    gem. Please read the `README.md` file on the gem for the usage.

    *Prem Sichanugrist*
478

479 480 481 482 483 484
*   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*

485 486 487 488
*   `serialized_attributes` and `_attr_readonly` become class method only. Instance reader methods are deprecated.

    *kennyj*

489 490 491 492 493
*   Round usec when comparing timestamp attributes in the dirty tracking.
    Fixes #6975.

    *kennyj*

494
*   Use inversed parent for first and last child of `has_many` association.
495 496 497

    *Ravil Bayramgalin*

498
*   Fix `Column.microseconds` and `Column.fast_string_to_time` to avoid converting
499 500 501 502 503
    timestamp seconds to a float, since it occasionally results in inaccuracies
    with microsecond-precision times. Fixes #7352.

    *Ari Pollak*

504 505 506
*   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.

507
    *Christian Seiler*
508

509 510 511 512
*   Raise `ArgumentError` if list of attributes to change is empty in `update_all`.

    *Roman Shatsov*

513 514 515 516 517
*   Fix AR#create to return an unsaved record when AR::RecordInvalid is
    raised. Fixes #3217.

    *Dave Yeu*

518 519
*   Fixed table name prefix that is generated in engines for namespaced models.

520 521
    *Wojciech Wnętrzak*

522
*   Make sure `:environment` task is executed before `db:schema:load` or `db:structure:load`.
R
Rafael Mendonça França 已提交
523 524 525 526
    Fixes #4772.

    *Seamus Abshere*

527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
*   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*

547
*   Add CollectionProxy#scope.
J
Jon Leighton 已提交
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564

    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*

565
*   Add `Relation#load`.
J
Jon Leighton 已提交
566 567 568 569 570 571 572 573 574 575 576 577 578 579

    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*

580 581 582 583 584 585 586 587 588
*   `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*

589
*   `Model.all` now returns an `ActiveRecord::Relation`, rather than an
590
    array of records. Use `Relation#to_a` if you really want an array.
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606

    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*

607 608 609 610 611 612 613
*   `: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
614
    :through`.
615 616 617

    *Jon Leighton*

618 619 620 621 622 623 624 625 626 627 628
*   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*

629 630 631
*   The migration generator now creates a join table with (commented) indexes every time
    the migration name contains the word `join_table`:

632
        rails g migration create_join_table_for_artists_and_musics artist_id:index music_id
633 634 635

    *Aleksey Magusev*

636 637
*   Add `add_reference` and `remove_reference` schema statements. Aliases, `add_belongs_to`
    and `remove_belongs_to` are acceptable. References are reversible.
638

639
    Examples:
640 641 642

        # Create a user_id column
        add_reference(:products, :user)
643
        # Create a supplier_id, supplier_type columns and appropriate index
644 645 646 647 648 649
        add_reference(:products, :supplier, polymorphic: true, index: true)
        # Remove polymorphic reference
        remove_reference(:products, :supplier, polymorphic: true)

    *Aleksey Magusev*

650 651 652 653 654 655 656
*   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*

657 658
*   `ActiveRecord::Relation#inspect` now makes it clear that you are
    dealing with a `Relation` object rather than an array:.
659

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

663
        User.where(age: 30).to_a.inspect
664
        # => [#<User ...>, #<User ...>]
665

666 667 668
    The number of records displayed will be limited to 10.

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

670
*   Add `collation` and `ctype` support to PostgreSQL. These are available for PostgreSQL 8.4 or later.
671 672
    Example:

673 674 675 676 677 678 679 680 681
        development:
          adapter: postgresql
          host: localhost
          database: rails_development
          username: foo
          password: bar
          encoding: UTF8
          collation: ja_JP.UTF8
          ctype: ja_JP.UTF8
682 683 684

    *kennyj*

685 686 687 688 689 690 691
*   Changed validates_presence_of on an association so that children objects
    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 已提交
692 693 694 695
*   `FinderMethods#exists?` now returns `false` with the `false` argument.

    *Egor Lynko*

696 697 698 699 700 701 702 703 704 705 706 707
*   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|
            t.timestamps :precision => 0
          end
        end

    *Tony Schneider*

708
*   Allow `ActiveRecord::Relation#pluck` to accept multiple columns. Returns an
709
    array of arrays containing the typecasted values:
710 711 712 713 714 715 716

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

    *Jeroen van Ingen & Carlos Antonio da Silva*

717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
*   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*

749
*   Move HABTM validity checks to `ActiveRecord::Reflection`. One side effect of
750 751 752 753 754 755
    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*

756
*   Added `stored_attributes` hash which contains the attributes stored using
757
    `ActiveRecord::Store`. This allows you to retrieve the list of attributes
758
    you've defined.
759

760 761 762 763 764 765 766
       class User < ActiveRecord::Base
         store :settings, accessors: [:color, :homepage]
       end

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

    *Joost Baaij & Carlos Antonio da Silva*
767

768 769 770 771 772 773
*   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*

774 775 776
*   Add uuid datatype support to PostgreSQL adapter.

    *Konstantin Shabanov*
777

778
*   Added `ActiveRecord::Migration.check_pending!` that raises an error if
779 780 781
    migrations are pending.

    *Richard Schneeman*
782

783 784 785 786 787
*   Added `#destroy!` which acts like `#destroy` but will raise an
    `ActiveRecord::RecordNotDestroyed` exception instead of returning `false`.

    *Marc-André Lafortune*

788 789 790 791 792 793 794 795 796 797 798 799 800
*   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>]
        person.pets.delete(2, 3) # => [#<Pet id: 2>, #<Pet id: 3>]

    *Francesco Rodriguez*

801 802 803 804 805 806 807 808 809 810
*   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
811
        `find_or_create_by(...)` or where(...).first_or_create`
812
      * `find_or_create_by_...!` can be rewritten using
813
        `find_or_create_by!(...) or `where(...).first_or_create!`
814 815

    The implementation of the deprecated dynamic finders has been moved
816
    to the `activerecord-deprecated_finders` gem. See below for details.
817 818 819 820 821 822 823

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

824
        Post.find(:all, conditions: { comments_count: 10 }, limit: 5)
825 826 827 828 829 830 831

    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:

832
        Post.all.merge(where: { comments_count: 10 }, limit: 5)
833 834 835 836

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

837
    `Relation#merge` now accepts a hash of
838 839 840 841
    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:

842 843 844
      * `:conditions` becomes `:where`.
      * `:include` becomes `:includes`.
      * `:extend` becomes `:extending`.
845 846

    The code to implement the deprecated features has been moved out to
847
    the `activerecord-deprecated_finders` gem. This gem is a dependency
848 849 850 851 852 853 854
    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 已提交
855 856 857 858
*   It's not possible anymore to destroy a model marked as read only.

    *Johannes Barre*

859
*   Added ability to ActiveRecord::Relation#from to accept other ActiveRecord::Relation objects.
860 861 862 863 864 865

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

    *Radoslav Stankov*

866 867 868 869 870 871
*   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*
872

873 874 875 876 877 878
*   `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*

879
*   Added default order to `first` to assure consistent results among
880
    different database engines. Introduced `take` as a replacement to
881 882 883 884
    the old behavior of `first`.

    *Marcelo Silveira*

885
*   Added an `:index` option to automatically create indexes for references
886 887 888 889 890 891 892
    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|
893
        t.references :person, index: true
894 895 896 897 898 899 900 901 902 903 904
      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.

905
    *Joshua Wood*
906

907 908 909 910 911 912 913
*   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*

914 915 916 917 918 919 920 921 922 923
*   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 已提交
924 925 926 927 928
*   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 已提交
929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
*   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*

960 961 962 963 964 965 966 967 968 969
*   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 已提交
970

971 972 973 974 975 976 977 978 979 980 981
*   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

982
      2) add config.active_record.use_schema_cache_dump = true in config/production.rb. BTW, true is default.
983 984 985

      3) boot rails.
      RAILS_ENV=production bundle exec rails server
986
      => use db/schema_cache.dump
987 988 989 990 991 992 993

      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*

994
*   Added support for partial indices to PostgreSQL adapter.
995 996 997 998

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

999
        add_index(:accounts, :code, where: 'active')
1000

1001
        Generates
1002

1003
        CREATE INDEX index_accounts_on_code ON accounts(code) WHERE active
1004 1005 1006

    *Marcelo Silveira*

1007
*   Implemented ActiveRecord::Relation#none method.
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017

    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
1018
    object pattern for the Relation class.
1019

1020 1021 1022
    *Juanjo Bazán*

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

1025 1026
    The `:restrict` option is renamed to `:restrict_with_exception` to
    make this distinction explicit.
1027

1028
    *Manoj Kumar & Jon Leighton*
1029

1030
*   Added `create_join_table` migration helper to create HABTM join tables.
1031 1032 1033

        create_join_table :products, :categories
        # =>
1034 1035 1036
        # create_table :categories_products, id: false do |td|
        #   td.integer :product_id,  null: false
        #   td.integer :category_id, null: false
1037 1038 1039 1040
        # end

    *Rafael Mendonça França*

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

1044 1045
    *Aaron Paterson*

1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
*   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.

1056 1057 1058 1059
    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:
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075

        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:

        Post.where(comments: { name: 'foo' })
        Post.where('comments.name' => 'foo')
        Post.order('comments.name')

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

1076
    *Jon Leighton*
1077

1078
*   Support for the `schema_info` table has been dropped. Please
1079 1080
    switch to `schema_migrations`.

1081 1082 1083
    *Aaron Patterson*

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

1086 1087
    *Aaron Patterson*

1088 1089
*   PostgreSQL hstore records can be created.

1090 1091
    *Aaron Patterson*

1092 1093
*   PostgreSQL hstore types are automatically deserialized from the database.

1094 1095
    *Aaron Patterson*

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