4_1_release_notes.md 14.1 KB
Newer Older
1 2 3 4 5
Ruby on Rails 4.1 Release Notes
===============================

Highlights in Rails 4.1:

6
* Variants
7
* Action View extracted from Action Pack
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30

These release notes cover only the major changes. To know about various bug
fixes and changes, please refer to the change logs or check out the
[list of commits](https://github.com/rails/rails/commits/master) in the main
Rails repository on GitHub.

--------------------------------------------------------------------------------

Upgrading to Rails 4.1
----------------------

If you're upgrading an existing application, it's a great idea to have good test
coverage before going in. You should also first upgrade to Rails 4.0 in case you
haven't and make sure your application still runs as expected before attempting
an update to Rails 4.1. A list of things to watch out for when upgrading is
available in the
[Upgrading to Rails](upgrading_ruby_on_rails.html#upgrading-from-rails-4-0-to-rails-4-1)
guide.


Major Features
--------------

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

  We often want to render different html/json/xml templates for phones,
  tablets, and desktop browsers. Variants make it easy.

  The request variant is a specialization of the request format, like :tablet,
  :phone, or :desktop.

  You can set the variant in a before_action:

  ```ruby
    request.variant = :tablet if request.user_agent =~ /iPad/
  ```

  Respond to variants in the action just like you respond to formats:

  ```ruby
    respond_to do |format|
      format.html do |html|
        html.tablet # renders app/views/projects/show.html+tablet.erb
        html.phone { extra_setup; render ... }
      end
    end
  ```

  Provide separate templates for each format and variant:

  ```
    app/views/projects/show.html.erb
    app/views/projects/show.html+tablet.erb
    app/views/projects/show.html+phone.erb
  ```
63 64 65 66 67 68 69 70 71 72 73 74

Documentation
-------------


Railties
--------

Please refer to the
[Changelog](https://github.com/rails/rails/blob/4-1-stable/railties/CHANGELOG.md)
for detailed changes.

75 76
### Removals

77
* Removed `update:application_controller` rake task.
78

79
* Removed deprecated `Rails.application.railties.engines`.
80

81
* Removed deprecated `threadsafe!` from Rails Config.
82

83 84
* Removed deprecated `ActiveRecord::Generators::ActiveModel#update_attributes` in
  favor of `ActiveRecord::Generators::ActiveModel#update`
85

86
* Removed deprecated `config.whiny_nils` option
87

88 89
* Removed deprecated rake tasks for running tests: `rake test:uncommitted` and
  `rake test:recent`.
90

91 92
### Notable changes

93 94 95
* `BACKTRACE` environment variable to show unfiltered backtraces for test
  failures. ([Commit](https://github.com/rails/rails/commit/84eac5dab8b0fe9ee20b51250e52ad7bfea36553))

96
* Exposed `MiddlewareStack#unshift` to environment configuration. ([Pull Request](https://github.com/rails/rails/pull/12479))
97

98 99 100 101 102 103 104 105 106 107

Action Mailer
-------------

Please refer to the
[Changelog](https://github.com/rails/rails/blob/4-1-stable/actionmailer/CHANGELOG.md)
for detailed changes.

### Notable changes

108 109
* Instrument the generation of Action Mailer messages. The time it takes to
  generate a message is written to the log. ([Pull Request](https://github.com/rails/rails/pull/12556))
110

111 112 113 114 115 116 117 118

Active Model
------------

Please refer to the
[Changelog](https://github.com/rails/rails/blob/4-1-stable/activemodel/CHANGELOG.md)
for detailed changes.

119 120 121 122 123
### Deprecations

* Deprecate `Validator#setup`. This should be done manually now in the
  validator's constructor. ([Commit](https://github.com/rails/rails/commit/7d84c3a2f7ede0e8d04540e9c0640de7378e9b3a))

124 125
### Notable changes

126 127 128
* Added new API methods `reset_changes` and `changes_applied` to
  `ActiveModel::Dirty` that control changes state.

129 130 131 132 133 134 135 136

Active Support
--------------

Please refer to the
[Changelog](https://github.com/rails/rails/blob/4-1-stable/activesupport/CHANGELOG.md)
for detailed changes.

137 138 139

### Removals

140
* Removed deprecated `String#encoding_aware?` core extensions (`core_ext/string/encoding`).
141

142
* Removed deprecated `Module#local_constant_names` in favor of `Module#local_constants`.
143

144
* Removed deprecated `DateTime.local_offset` in favor of `DateTime.civil_from_fromat`.
145

146
* Removed deprecated `Logger` core extensions (`core_ext/logger.rb`).
147

148
* Removed deprecated `Time#time_with_datetime_fallback`, `Time#utc_time` and
149 150
  `Time#local_time` in favor of `Time#utc` and `Time#local`.

151
* Removed deprecated `Hash#diff` with no replacement.
152

153
* Removed deprecated `Date#to_time_in_current_zone` in favor of `Date#in_time_zone`.
154

155
* Removed deprecated `Proc#bind` with no replacement.
156

157
* Removed deprecated `Array#uniq_by` and `Array#uniq_by!`, use native
158 159
  `Array#uniq` and `Array#uniq!` instead.

160
* Removed deprecated `ActiveSupport::BasicObject`, use
161 162
  `ActiveSupport::ProxyObject` instead.

163
* Removed deprecated `BufferedLogger`, use `ActiveSupport::Logger` instead.
164

165
* Removed deprecated `assert_present` and `assert_blank` methods, use `assert
166 167 168 169 170 171 172 173
  object.blank?` and `assert object.present?` instead.

### Deprecations

* Deprecated `Numeric#{ago,until,since,from_now}`, the user is expected to
  explicitly convert the value into an AS::Duration, i.e. `5.ago` => `5.seconds.ago`
  ([Pull Request](https://github.com/rails/rails/pull/12389))

174 175
### Notable changes

176 177 178 179
* Added `ActiveSupport::Testing::TimeHelpers#travel` and `#travel_to`. These
  methods change current time to the given time or time difference by stubbing
  `Time.now` and
  `Date.today`. ([Pull Request](https://github.com/rails/rails/pull/12824))
180 181 182 183 184

* Added `Numeric#in_milliseconds`, like `1.hour.in_milliseconds`, so we can feed
  them to JavaScript functions like
  `getTime()`. ([Commit](https://github.com/rails/rails/commit/423249504a2b468d7a273cbe6accf4f21cb0e643))

185
* Added `Date#middle_of_day`, `DateTime#middle_of_day` and `Time#middle_of_day`
186 187 188 189
  methods. Also added `midday`, `noon`, `at_midday`, `at_noon` and
  `at_middle_of_day` as
  aliases. ([Pull Request](https://github.com/rails/rails/pull/10879))

190
* Added `String#remove(pattern)` as a short-hand for the common pattern of
191 192
  `String#gsub(pattern,'')`. ([Commit](https://github.com/rails/rails/commit/5da23a3f921f0a4a3139495d2779ab0d3bd4cb5f))

193
* Removed 'cow' => 'kine' irregular inflection from default
194
  inflections. ([Commit](https://github.com/rails/rails/commit/c300dca9963bda78b8f358dbcb59cabcdc5e1dc9))
195 196 197 198 199 200 201 202

Action Pack
-----------

Please refer to the
[Changelog](https://github.com/rails/rails/blob/4-1-stable/actionpack/CHANGELOG.md)
for detailed changes.

203 204
### Removals

205 206
* Removed deprecated Rails application fallback for integration testing, set
  `ActionDispatch.test_app` instead.
207

208
* Removed deprecated `page_cache_extension` config.
209

210
* Removed deprecated constants from Action Controller:
211

212 213 214 215 216 217 218
      ActionController::AbstractRequest  => ActionDispatch::Request
      ActionController::Request          => ActionDispatch::Request
      ActionController::AbstractResponse => ActionDispatch::Response
      ActionController::Response         => ActionDispatch::Response
      ActionController::Routing          => ActionDispatch::Routing
      ActionController::Integration      => ActionDispatch::Integration
      ActionController::IntegrationTest  => ActionDispatch::IntegrationTest
219

220 221
### Notable changes

222 223 224
* Take a hash with options inside array in
  `#url_for`. ([Pull Request](https://github.com/rails/rails/pull/9599))

225
* Added `session#fetch` method fetch behaves similarly to
226 227 228 229
  [Hash#fetch](http://www.ruby-doc.org/core-1.9.3/Hash.html#method-i-fetch),
  with the exception that the returned value is always saved into the
  session. ([Pull Request](https://github.com/rails/rails/pull/12692))

230
* Separated Action View completely from Action
231 232
  Pack. ([Pull Request](https://github.com/rails/rails/pull/11032))

233 234 235 236 237 238 239 240

Active Record
-------------

Please refer to the
[Changelog](https://github.com/rails/rails/blob/4-1-stable/activerecord/CHANGELOG.md)
for detailed changes.

241 242
### Removals

243
* Removed deprecated nil-passing to the following `SchemaCache` methods:
244 245
  `primary_keys`, `tables`, `columns` and `columns_hash`.

246
* Removed deprecated block filter from `ActiveRecord::Migrator#migrate`.
247

248
* Removed deprecated String constructor from `ActiveRecord::Migrator`.
249

250
* Removed deprecated `scope` use without passing a callable object.
251

252 253
* Removed deprecated `transaction_joinable=` in favor of `begin_transaction`
  with `d:joinable` option.
254

255
* Removed deprecated `decrement_open_transactions`.
256

257
* Removed deprecated `increment_open_transactions`.
258

259 260
* Removed deprecated `PostgreSQLAdapter#outside_transaction?`
  methodd. You can use `#transaction_open?` instead.
261

262
* Removed deprecated `ActiveRecord::Fixtures.find_table_name` in favor of
263 264 265 266
  `ActiveRecord::Fixtures.default_fixture_model_name`.

* Removed deprecated `columns_for_remove` from `SchemaStatements`.

267
* Removed deprecated `SchemaStatements#distinct`.
268

269
* Moved deprecated `ActiveRecord::TestCase` into the rails test
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
  suite. The class is no longer public and is only used for internal
  Rails tests.

* Removed support for deprecated option `:restrict` for `:dependent`
  in associations.

* Removed support for deprecated `delete_sql` in associations.

* Removed support for deprecated `insert_sql` in associations.

* Removed support for deprecated `finder_sql` in associations.

* Removed support for deprecated `counter_sql` in associations.

* Removed deprecated method `type_cast_code` from Column.

* Removed deprecated options `delete_sql` and `insert_sql` from HABTM
  association.

* Removed deprecated options `finder_sql` and `counter_sql` from
  collection association.

292
* Removed deprecated `ActiveRecord::Base#connection` method.
293 294
  Make sure to access it via the class.

295
* Removed deprecation warning for `auto_explain_threshold_in_seconds`.
296

297
* Removed deprecated `:distinct` option from `Relation#count`.
298 299 300 301 302 303 304 305 306 307

* Removed deprecated methods `partial_updates`, `partial_updates?` and
  `partial_updates=`.

* Removed deprecated method `scoped`

* Removed deprecated method `default_scopes?`

* Remove implicit join references that were deprecated in 4.0.

308
* Removed `activerecord-deprecated_finders` as a dependency
309

310
* Usage of `implicit_readonly` is being removed. Please use `readonly` method
311 312 313 314 315
  explicitly to mark records as
  `readonly. ([Pull Request](https://github.com/rails/rails/pull/10769))

### Deprecations

316
* Deprecated `quoted_locking_column` method, which isn't used anywhere.
317

318
* Deprecated the delegation of Array bang methods for associations.
319 320 321 322
  To use them, instead first call `#to_a` on the association to access the
  array to be acted
  on. ([Pull Request](https://github.com/rails/rails/pull/12129))

323
* Deprecated `ConnectionAdapters::SchemaStatements#distinct`,
324 325
  as it is no longer used by internals. ([Pull Request](https://github.com/rails/rails/pull/10556))

326 327
### Notable changes

328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
* Added `ActiveRecord::Base.to_param` for convenient "pretty" URLs derived from
  a model's attribute or
  method. ([Pull Request](https://github.com/rails/rails/pull/12891))

* Added `ActiveRecord::Base.no_touching`, which allows ignoring touch on
  models. ([Pull Request](https://github.com/rails/rails/pull/12772))

* Unify boolean type casting for `MysqlAdapter` and `Mysql2Adapter`.
  `type_cast` will return `1` for `true` and `0` for `false`. ([Pull Request](https://github.com/rails/rails/pull/12425))

* `.unscope` now removes conditions specified in
  `default_scope`. ([Commit](https://github.com/rails/rails/commit/94924dc32baf78f13e289172534c2e71c9c8cade))

* Added `ActiveRecord::QueryMethods#rewhere` which will overwrite an existing,
  named where condition. ([Commit](https://github.com/rails/rails/commit/f950b2699f97749ef706c6939a84dfc85f0b05f2))

344
* Extended `ActiveRecord::Base#cache_key` to take an optional list of timestamp
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
  attributes of which the highest will be used. ([Commit](https://github.com/rails/rails/commit/e94e97ca796c0759d8fcb8f946a3bbc60252d329))

* Added `ActiveRecord::Base#enum` for declaring enum attributes where the values
  map to integers in the database, but can be queried by
  name. ([Commit](https://github.com/rails/rails/commit/db41eb8a6ea88b854bf5cd11070ea4245e1639c5))

* Type cast json values on write, so that the value is consistent with reading
  from the database. ([Pull Request](https://github.com/rails/rails/pull/12643))

* Type cast hstore values on write, so that the value is consistent
  with reading from the database. ([Commit](https://github.com/rails/rails/commit/5ac2341fab689344991b2a4817bd2bc8b3edac9d))

* Make `next_migration_number` accessible for third party
  generators. ([Pull Request](https://github.com/rails/rails/pull/12407))

* Calling `update_attributes` will now throw an `ArgumentError` whenever it
  gets a `nil` argument. More specifically, it will throw an error if the
  argument that it gets passed does not respond to to
  `stringify_keys`. ([Pull Request](https://github.com/rails/rails/pull/9860))

* `CollectionAssociation#first`/`#last` (e.g. `has_many`) use a `LIMIT`ed
  query to fetch results rather than loading the entire
  collection. ([Pull Request](https://github.com/rails/rails/pull/12137))

* `inspect` on Active Record model classes does not initiate a new
  connection. This means that calling `inspect`, when the database is missing,
  will no longer raise an exception. ([Pull Request](https://github.com/rails/rails/pull/11014))

373
* Removed column restrictions for `count`, let the database raise if the SQL is
374 375 376 377 378 379 380 381 382
  invalid. ([Pull Request](https://github.com/rails/rails/pull/10710))

* Rails now automatically detects inverse associations. If you do not set the
  `:inverse_of` option on the association, then Active Record will guess the
  inverse association based on heuristics. ([Pull Request](https://github.com/rails/rails/pull/10886))

* Handle aliased attributes in ActiveRecord::Relation. When using symbol keys,
  ActiveRecord will now translate aliased attribute names to the actual column
  name used in the database. ([Pull Request](https://github.com/rails/rails/pull/7839))
383

384 385 386 387
* The ERB in fixture files is no longer evaluated in the context of the main
  object. Helper methods used by multiple fixtures should be defined on modules
  included in `ActiveRecord::FixtureSet.context_class`. ([Pull Request](https://github.com/rails/rails/pull/13022))

388 389 390 391 392 393 394
Credits
-------

See the
[full list of contributors to Rails](http://contributors.rubyonrails.org/) for
the many people who spent many hours making Rails, the stable and robust
framework it is. Kudos to all of them.