Fixes #23643. [ci skip]
36 KiB
DO NOT READ THIS FILE ON GITHUB, GUIDES ARE PUBLISHED ON http://guides.rubyonrails.org.
Ruby on Rails 5.0 Release Notes
Highlights in Rails 5.0:
- Action Cable
- Rails API
- Active Record Attributes API
- Test Runner
- Exclusive use of
rails
CLI over Rake - Sprockets 3
- Turbolinks 5
- Ruby 2.2.2+ required
These release notes cover only the major changes. To learn about various bug fixes and changes, please refer to the change logs or check out the list of commits in the main Rails repository on GitHub.
Upgrading to Rails 5.0
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.2 in case you haven't and make sure your application still runs as expected before attempting an update to Rails 5.0. A list of things to watch out for when upgrading is available in the Upgrading Ruby on Rails guide.
Major Features
Action Cable
ToDo...
Rails API
ToDo...
Active Record attributes API
ToDo...
Test Runner
ToDo...
Railties
Please refer to the Changelog for detailed changes.
Removals
-
Removed debugger support, use byebug instead.
debugger
is not supported by Ruby 2.2. (commit) -
Removed deprecated
test:all
andtest:all:db
tasks. (commit) -
Removed deprecated
Rails::Rack::LogTailer
. (commit) -
Removed deprecated
RAILS_CACHE
constant. (commit) -
Removed deprecated
serve_static_assets
configuration. (commit) -
Removed the documentation tasks
doc:app
,doc:rails
, anddoc:guides
. (commit) -
Removed
Rack::ContentLength
middleware from the default stack. (Commit)
Deprecations
-
Deprecated
config.static_cache_control
in favor ofconfig.public_file_server.headers
. (Pull Request) -
Deprecated
config.serve_static_files
in favor ofconfig.public_file_server.enabled
. (Pull Request) -
Deprecated the tasks in the
rails
task namespace in favor of theapp
namespace. (e.g.rails:update
andrails:template
tasks is renamed toapp:update
andapp:template
.) (Pull Request)
Notable changes
-
Added Rails test runner
bin/rails test
. (Pull Request) -
Newly generated applications and plugins get a
README.md
in Markdown. (commit, Pull Request) -
Added
bin/rails restart
task to restart your Rails app by touchingtmp/restart.txt
. (Pull Request) -
Added
bin/rails initializers
task to print out all defined initializers in the order they are invoked by Rails. (Pull Request) -
Added
bin/rails dev:cache
to enable or disable caching in development mode. (Pull Request) -
Added
bin/update
script to update the development environment automatically. (Pull Request) -
Proxy Rake tasks through
bin/rails
. (Pull Request, Pull Request) -
New applications are generated with the evented file system monitor enabled on Linux and Mac OS X. The feature can be opted out by passing
--skip-listen
to the generator. (commit, commit) -
Generate applications with an option to log to STDOUT in production using the environment variable
RAILS_LOG_TO_STDOUT
. (Pull Request) -
Enable HSTS with IncludeSudomains header for new applications. (Pull Request)
-
The application generator writes a new file
config/spring.rb
, which tells Spring to watch additional common files. (commit)
Action Pack
Please refer to the Changelog for detailed changes.
Removals
-
Removed
ActionDispatch::Request::Utils.deep_munge
. (commit) -
Removed
ActionController::HideActions
. (Pull Request) -
Removed
respond_to
andrespond_with
placeholder methods, this functionality has been extracted to the responders gem. (commit) -
Removed deprecated assertion files. (commit)
-
Removed deprecated usage of string keys in URL helpers. (commit)
-
Removed deprecated
only_path
option on*_path
helpers. (commit) -
Removed deprecated
NamedRouteCollection#helpers
. (commit) -
Removed deprecated support to define routes with
:to
option that doesn't contain#
. (commit) -
Removed deprecated
ActionDispatch::Response#to_ary
. (commit) -
Removed deprecated
ActionDispatch::Request#deep_munge
. (commit) -
Removed deprecated
ActionDispatch::Http::Parameters#symbolized_path_parameters
. (commit) -
Removed deprecated option
use_route
in controller tests. (commit) -
Removed
assigns
andassert_template
. Both methods have been extracted into the rails-controller-testing gem. (Pull Request)
Deprecations
-
Deprecated all
*_filter
callbacks in favor of*_action
callbacks. (Pull Request) -
Deprecated
*_via_redirect
integration test methods. Usefollow_redirect!
manually after the request call for the same behavior. (Pull Request) -
Deprecated
AbstractController#skip_action_callback
in favor of individual skip_callback methods. (Pull Request) -
Deprecated
:nothing
option forrender
method. (Pull Request) -
Deprecated passing first parameter as
Hash
and default status code forhead
method. (Pull Request) -
Deprecated using strings or symbols for middleware class names. Use class names instead. (commit)
-
Deprecated accessing mime types via constants (eg.
Mime::HTML
). Use the subscript operator with a symbol instead (eg.Mime[:html]
). (Pull Request) -
Deprecated
redirect_to :back
in favor ofredirect_back
, which accepts a requiredfallback_location
argument, thus eliminating the possibility of aRedirectBackError
. (Pull Request) -
ActionDispatch::IntegrationTest
andActionController::TestCase
deprecate positional arguments in favor of keyword arguments. (Pull Request)
Notable changes
-
Added
ActionController::Renderer
to render arbitrary templates outside controller actions. (Pull Request) -
Migrating to keyword arguments syntax in
ActionController::TestCase
andActionDispatch::Integration
HTTP request methods. (Pull Request) -
Added
http_cache_forever
to Action Controller, so we can cache a response that never gets expired. (Pull Request) -
Provide friendlier access to request variants. (Pull Request)
-
For actions with no corresponding templates, render
head :no_content
instead of raising an error. (Pull Request) -
Added the ability to override default form builder for a controller. (Pull Request)
-
Added support for API only apps.
ActionController::API
is added as a replacement ofActionController::Base
for this kind of applications. (Pull Request) -
Make
ActionController::Parameters
no longer inherits fromHashWithIndifferentAccess
. (Pull Request) -
Make it easier to opt in to
config.force_ssl
andconfig.ssl_options
by making them less dangerous to try and easier to disable. (Pull Request) -
Added the ability of returning arbitrary headers to
ActionDispatch::Static
. (Pull Request) -
Changed the
protect_from_forgery
prepend default tofalse
. (commit) -
ActionController::TestCase
will be moved to its own gem in Rails 5.1. UseActionDispatch::IntegrationTest
instead. (commit) -
Rails will only generate "weak", instead of strong ETags. (Pull Request)
-
Controller actions without an explicit
render
call and with no corresponding templates will renderhead :no_content
implicitly instead of raising an error. (Pull Request 1, 2) -
Added an option for per-form CSRF tokens. (Pull Request)
-
Added request encoding and response parsing to integration tests. (Pull Request)
-
Update default rendering policies when the controller action did not explicitly indicate a response. (Pull Request)
Action View
Please refer to the Changelog for detailed changes.
Removals
-
Removed deprecated
AbstractController::Base::parent_prefixes
. (commit) -
Removed
ActionView::Helpers::RecordTagHelper
, this functionality has been extracted to the record_tag_helper gem. (Pull Request) -
Removed
:rescue_format
option fortranslate
helper since it's no longer supported by I18n. (Pull Request)
Notable Changes
-
Changed the default template handler from
ERB
toRaw
. (commit) -
Collection rendering can cache and fetches multiple partials. (Pull Request, commit)
-
Added wildcard matching to explicit dependencies. (Pull Request)
-
Make
disable_with
the default behavior for submit tags. Disables the button on submit to prevent double submits. (Pull Request) -
Collection rendering can cache and fetch multiple partials at once. (Pull Request)
Action Mailer
Please refer to the Changelog for detailed changes.
Removals
-
Removed deprecated
*_path
helpers in email views. (commit) -
Removed deprecated
deliver
anddeliver!
methods. (commit)
Notable changes
-
Template lookup now respects default locale and I18n fallbacks. (commit)
-
Added
_mailer
suffix to mailers created via generator, following the same naming convention used in controllers and jobs. (Pull Request) -
Added
assert_enqueued_emails
andassert_no_enqueued_emails
. (Pull Request) -
Added
config.action_mailer.deliver_later_queue_name
configuration to set the mailer queue name. (Pull Request) -
Added support for fragment caching in Action Mailer views. Added new config option
config.action_mailer.perform_caching
to determine whether your templates should perform caching or not. (Pull Request)
Active Record
Please refer to the Changelog for detailed changes.
Removals
-
Removed deprecated behavior allowing nested arrays to be passed as query values. (Pull Request)
-
Removed deprecated
ActiveRecord::Tasks::DatabaseTasks#load_schema
. This method was replaced byActiveRecord::Tasks::DatabaseTasks#load_schema_for
. (commit) -
Removed deprecated
serialized_attributes
. (commit) -
Removed deprecated automatic counter caches on
has_many :through
. (commit) -
Removed deprecated
sanitize_sql_hash_for_conditions
. (commit) -
Removed deprecated
Reflection#source_macro
. (commit) -
Removed deprecated
symbolized_base_class
andsymbolized_sti_name
. (commit) -
Removed deprecated
ActiveRecord::Base.disable_implicit_join_references=
. (commit) -
Removed deprecated access to connection specification using a string accessor. (commit)
-
Removed deprecated support to preload instance-dependent associations. (commit)
-
Removed deprecated support for PostgreSQL ranges with exclusive lower bounds. (commit)
-
Removed deprecation when modifying a relation with cached Arel. This raises an
ImmutableRelation
error instead. (commit) -
Removed
ActiveRecord::Serialization::XmlSerializer
from core. This feature has been extracted into the activemodel-serializers-xml gem. (Pull Request) -
Removed support for the legacy
mysql
database adapter from core. It will live on in a separate gem for now, but most users should just usemysql2
. -
Removed support for the
protected_attributes
gem. (commit) -
Removed support for PostgreSQL versions below 9.1. (Pull Request)
Deprecations
-
Deprecated passing a class as a value in a query. Users should pass strings instead. (Pull Request)
-
Deprecated returning
false
as a way to halt Active Record callback chains. The recommended way is tothrow(:abort)
. (Pull Request) -
Deprecated
ActiveRecord::Base.errors_in_transactional_callbacks=
. (commit) -
Deprecated
Relation#uniq
useRelation#distinct
instead. (commit) -
Deprecated the PostgreSQL
:point
type in favor of a new one which will returnPoint
objects instead of anArray
(Pull Request) -
Deprecated force association reload by passing a truthy argument to association method. (Pull Request)
-
Deprecated the keys for association
restrict_dependent_destroy
errors in favor of new key names. (Pull Request) -
Synchronize behavior of
#tables
. (Pull Request) -
Deprecated
SchemaCache#tables
,SchemaCache#table_exists?
andSchemaCache#clear_table_cache!
in favor of their new data source counterparts. (Pull Request) -
Deprecated
connection.tables
on the SQLite3 and MySQL adapters. (Pull Request) -
Deprecated passing arguments to
#tables
- the#tables
method of some adapters (mysql2, sqlite3) would return both tables and views while others (postgresql) just return tables. To make their behavior consistent,#tables
will return only tables in the future. (Pull Request) -
Deprecated
table_exists?
- The#table_exists?
method would check both tables and views. To make their behavior consistent with#tables
,#table_exists?
will check only tables in the future. (Pull Request) -
Deprecate sending the
offset
argument tofind_nth
. Please use theoffset
method on relation instead. (Pull Request) -
Deprecated
{insert|update|delete}_sql
inDatabaseStatements
. Use the{insert|update|delete}
public methods instead. (Pull Request)
Notable changes
-
Added a
foreign_key
option toreferences
while creating the table. (commit) -
New attributes API. (commit)
-
Added
:enum_prefix
/:enum_suffix
option toenum
definition. (Pull Request) -
Added
#cache_key
toActiveRecord::Relation
. (Pull Request) -
Require
belongs_to
by default. (Pull Request) - Deprecaterequired
option in favor ofoptional
forbelongs_to
-
Changed the default
null
value fortimestamps
tofalse
. (commit) -
Added
ActiveRecord::SecureToken
in order to encapsulate generation of unique tokens for attributes in a model usingSecureRandom
. (Pull Request) -
Added
:if_exists
option fordrop_table
. (Pull Request) -
Added
ActiveRecord::Base#accessed_fields
, which can be used to quickly discover which fields were read from a model when you are looking to only select the data you need from the database. (commit) -
Added the
#or
method onActiveRecord::Relation
, allowing use of the OR operator to combine WHERE or HAVING clauses. (commit) -
Added
:time
option added for#touch
. (Pull Request) -
Added
ActiveRecord::Base.suppress
to prevent the receiver from being saved during the given block. (Pull Request) -
belongs_to
will now trigger a validation error by default if the association is not present. You can turn this off on a per-association basis withoptional: true
. (Pull Request) -
Added
config.active_record.dump_schemas
to configure the behavior ofdb:structure:dump
. (Pull Request) -
Added
config.active_record.warn_on_records_fetched_greater_than
option. (Pull Request) -
Added a native JSON data type support in MySQL. (Pull Request)
-
Added support for dropping indexes concurrently in PostgreSQL. (Pull Request)
-
Added
#views
and#view_exists?
methods on connection adapters. (Pull Request) -
Added
ActiveRecord::Base.ignored_columns
to make some columns invisible from Active Record. (Pull Request) -
Added
connection.data_sources
andconnection.data_source_exists?
. These methods determine what relations can be used to back Active Record models (usually tables and views). (Pull Request) -
Allow fixtures files to set the model class in the YAML file itself. (Pull Request)
-
Added ability to default to
uuid
as primary key when generating database migrations. (Pull Request) -
Added
ActiveRecord::Relation#left_joins
andActiveRecord::Relation#left_outer_joins
. (Pull Request) -
Added
after_{create,update,delete}_commit
callbacks. (Pull Request) -
Version the API presented to migration classes, so we can change parameter defaults without breaking existing migrations, or forcing them to be rewritten through a deprecation cycle. (Pull Request)
-
ApplicationRecord
is a new superclass for all app models, analogous to app controllers subclassingApplicationController
instead ofActionController::Base
. This gives apps a single spot to configure app-wide model behavior. (Pull Request) -
Added ActiveRecord
#second_to_last
and#third_to_last
methods. (Pull Request) -
Added ability to annotate database objects (tables, columns, indexes) with comments stored in database metadata for PostgreSQL & MySQL. (Pull Request)
Active Model
Please refer to the Changelog for detailed changes.
Removals
-
Removed deprecated
ActiveModel::Dirty#reset_#{attribute}
andActiveModel::Dirty#reset_changes
. (Pull Request) -
Removed XML serialization. This feature has been extracted into the activemodel-serializers-xml gem. (Pull Request)
Deprecations
-
Deprecated returning
false
as a way to halt Active Model andActiveModel::Validations
callback chains. The recommended way is tothrow(:abort)
. (Pull Request) -
Deprecated
ActiveModel::Errors#get
,ActiveModel::Errors#set
andActiveModel::Errors#[]=
methods that have inconsistent behavior. (Pull Request) -
Deprecated the
:tokenizer
option forvalidates_length_of
, in favor of plain Ruby. (Pull Request) -
Deprecated
ActiveModel::Errors#add_on_empty
andActiveModel::Errors#add_on_blank
with no replacement. (Pull Request)
Notable changes
-
Added
ActiveModel::Errors#details
to determine what validator has failed. (Pull Request) -
Extracted
ActiveRecord::AttributeAssignment
toActiveModel::AttributeAssignment
allowing to use it for any object as an includable module. (Pull Request) -
Added
ActiveModel::Dirty#[attr_name]_previously_changed?
andActiveModel::Dirty#[attr_name]_previous_change
to improve access to recorded changes after the model has been saved. (Pull Request) -
Validate multiple contexts on
valid?
andinvalid?
at once. (Pull Request)
Active Job
Please refer to the Changelog for detailed changes.
Notable changes
-
ActiveJob::Base.deserialize
delegates to the job class. this allows jobs to attach arbitrary metadata when they get serialized and read it back when they get performed. (Pull Request) -
A generated job now inherits from
app/jobs/application_job.rb
by default. (Pull Request) -
Allow
DelayedJob
,Sidekiq
,qu
,que
, andqueue_classic
to report the job id back toActiveJob::Base
asprovider_job_id
. (Pull Request, Pull Request, commit) -
Implement a simple
AsyncJob
processor and associatedAsyncAdapter
that queue jobs to aconcurrent-ruby
thread pool. (Pull Request) -
Change the default adapter from inline to async. It's a better default as tests will then not mistakenly come to rely on behavior happening synchronously. (commit)
Active Support
Please refer to the Changelog for detailed changes.
Removals
-
Removed deprecated
ActiveSupport::JSON::Encoding::CircularReferenceError
. (commit) -
Removed deprecated methods
ActiveSupport::JSON::Encoding.encode_big_decimal_as_string=
andActiveSupport::JSON::Encoding.encode_big_decimal_as_string
. (commit) -
Removed deprecated
ActiveSupport::SafeBuffer#prepend
. (commit) -
Removed deprecated methods from
Kernel
.silence_stderr
,silence_stream
,capture
andquietly
. (commit) -
Removed deprecated
active_support/core_ext/big_decimal/yaml_conversions
file. (commit) -
Removed deprecated methods
ActiveSupport::Cache::Store.instrument
andActiveSupport::Cache::Store.instrument=
. (commit) -
Removed deprecated
Class#superclass_delegating_accessor
. UseClass#class_attribute
instead. (Pull Request) -
Removed deprecated
ThreadSafe::Cache
. UseConcurrent::Map
instead. (Pull Request)
Deprecations
-
Deprecated
MissingSourceFile
in favor ofLoadError
. (commit) -
Deprecated
alias_method_chain
in favour ofModule#prepend
introduced in Ruby 2.0. (Pull Request) -
Deprecated
ActiveSupport::Concurrency::Latch
in favor ofConcurrent::CountDownLatch
from concurrent-ruby. (Pull Request) -
Deprecated
:prefix
option ofnumber_to_human_size
with no replacement. (Pull Request) -
Deprecated
Module#qualified_const_
in favour of the builtinModule#const_
methods. (Pull Request) -
Deprecated passing string to define callback. (Pull Request)
-
Deprecated
ActiveSupport::Cache::Store#namespaced_key
,ActiveSupport::Cache::MemCachedStore#escape_key
, andActiveSupport::Cache::FileStore#key_file_path
. Usenormalize_key
instead.Deprecated
ActiveSupport::Cache::LocaleCache#set_cache_value
in favor ofwrite_cache_value
. (Pull Request) -
Deprecated passing arguments to
assert_nothing_raised
. (Pull Request) -
Deprecated
Module.local_constants
in favor ofModule.constants(false)
. (Pull Request)
Notable changes
-
Added
#verified
and#valid_message?
methods toActiveSupport::MessageVerifier
. (Pull Request) -
Changed the way in which callback chains can be halted. The preferred method to halt a callback chain from now on is to explicitly
throw(:abort)
. (Pull Request) -
New config option
config.active_support.halt_callback_chains_on_return_false
to specify whether ActiveRecord, ActiveModel and ActiveModel::Validations callback chains can be halted by returningfalse
in a 'before' callback. (Pull Request) -
Changed the default test order from
:sorted
to:random
. (commit) -
Added
#on_weekend?
,#on_weekday?
,#next_weekday
,#prev_weekday
methods toDate
,Time
, andDateTime
. (Pull Request) -
Added
same_time
option to#next_week
and#prev_week
forDate
,Time
, andDateTime
. (Pull Request) -
Added
#prev_day
and#next_day
counterparts to#yesterday
and#tomorrow
forDate
,Time
, andDateTime
. (Pull Request) -
Added
SecureRandom.base58
for generation of random base58 strings. (commit) -
Added
file_fixture
toActiveSupport::TestCase
. It provides a simple mechanism to access sample files in your test cases. (Pull Request) -
Added
#without
onEnumerable
andArray
to return a copy of an enumerable without the specified elements. (Pull Request) -
Added
ActiveSupport::ArrayInquirer
andArray#inquiry
. (Pull Request) -
Added
ActiveSupport::TimeZone#strptime
to allow parsing times as if from a given timezone. (commit) -
Added
Integer#positive?
andInteger#negative?
query methods in the vein ofFixnum#zero?
. (commit) -
Added a bang version to
ActiveSupport::OrderedOptions
get methods which will raise anKeyError
if the value is.blank?
. (Pull Request) -
Added
Time.days_in_year
to return the number of days in the given year, or the current year if no argument is provided. (commit) -
Added an evented file watcher to asynchronously detect changes in the application source code, routes, locales, etc. (Pull Request)
-
Added thread_m/cattr_accessor/reader/writer suite of methods for declaring class and module variables that live per-thread. (Pull Request)
-
Added
Array#second_to_last
andArray#third_to_last
methods. (Pull Request) -
Added
#on_weekday?
method toDate
,Time
, andDateTime
. (Pull Request) -
Publish
ActiveSupport::Executor
andActiveSupport::Reloader
APIs to allow components and libraries to manage, and participate in, the execution of application code, and the application reloading process. (Pull Request) -
ActiveSupport::Duration
now supports ISO8601 formatting and parsing. (Pull Request)
Credits
See the full list of contributors to Rails for the many people who spent many hours making Rails, the stable and robust framework it is. Kudos to all of them.