This documents the upgrade from Rails 4.2 to 5.2 through four parts: Backend, Frontend, Infrascture and Checkboxes
Run rake command rails app:update, it creates a set of new configration files for active storage, action cable, content security policy etc. As we dont use these features, the default ones from code generation are kept.
This rake task also adds changes into environment config files. old configuration lines have been migrated and new ones are added using the default.
- replace
before_actiontobefore_filter - replace string condition with proc in model validation
- DB migrations needs to include Rails version
- read file url rather than file object for validting if the file exists
- replace
values_atwithslice - explictly set
belongs_to_required_by_defaultto false for model relations - replace
state_machinewithstate_machines-activerecord, which is maintained for Rails 5.2 - replace
before_last_save, which is depreciated in Rails 5.2, within_database - explicitly skip CSRF check for document and photos uploading API calls
- update models to inherit from ApplicationRecord
- update css attributes to use new foundation modal
- explicitly disable hover effect by using
data-disable-hover
- view helper
iconneeds two params
- upgrade ruby from 2.3 to 2.5
- upgrade node from from 5.12 to 10.13
- install yarn for css precompile
- install
postgresql94-devel.x86_64for new postgres gem - install bunlder and passenger from ruby 2.5 gem
- install new nginx module by
passenger-install-nginx-module - set config to new ruby path
passenger_root /home/ec2-user/.rvm/gems/ruby-2.5.3/gems/passenger-5.3.7;
passenger_ruby /home/ec2-user/.rvm/gems/ruby-2.5.3/wrappers/ruby;
- From Ruby on Rails 5.0 onwards, Ruby 2.2.2+ is the only supported Ruby version. Make sure you are on Ruby 2.2.2 version or greater, before you proceed.
-
In Rails 4.2, an Active Record model inherits from ActiveRecord::Base. In Rails 5.0, all models inherit from ApplicationRecord.
-
ApplicationRecord is a new superclass for all app models, analogous to app controllers subclassing ApplicationController instead of ActionController::Base. This gives apps a single spot to configure app-wide model behavior.
-
When upgrading from Rails 4.2 to Rails 5.0, you need to create an application_record.rb file in app/models/ and add the following content, then make sure that all your models inherit from it.
class ApplicationRecord < ActiveRecord::Base
self.abstract_class = true
end
- Not applicable
In Rails 4.2, when a 'before' callback returns false in Active Record and Active Model, then the entire callback chain is halted. In other words, successive 'before' callbacks are not executed, and neither is the action wrapped in callbacks.
In Rails 5.0, returning false in an Active Record or Active Model callback will not have this side effect of halting the callback chain. Instead, callback chains must be explicitly halted by calling throw(:abort).
When you upgrade from Rails 4.2 to Rails 5.0, returning false in those kind of callbacks will still halt the callback chain, but you will receive a deprecation warning about this upcoming change.
When you are ready, you can opt into the new behavior and remove the deprecation warning by adding the following configuration to your config/application.rb:
ActiveSupport.halt_callback_chains_on_return_false = false
Note that this option will not affect Active Support callbacks since they never halted the chain when any value was returned.
See #17227 for more details.
- Updated
In Rails 4.2, an Active Job inherits from ActiveJob::Base. In Rails 5.0, this behavior has changed to now inherit from ApplicationJob.
When upgrading from Rails 4.2 to Rails 5.0, you need to create an application_job.rb file in app/jobs/ and add the following content:
class ApplicationJob < ActiveJob::Base
end
Then make sure that all your job classes inherit from it.
- Not applicable
assigns and assert_template have been extracted to the rails-controller-testing gem. To continue using these methods in your controller tests, add gem 'rails-controller-testing' to your Gemfile.
If you are using Rspec for testing, please see the extra configuration required in the gem's documentation.
- Not applicable
If you are using ActionDispatch::Http::UploadedFile in your tests to upload files, you will need to change to use the similar Rack::Test::UploadedFile class instead.
See #26404 for more details.
- No action needed
Autoloading is now disabled after booting in the production environment by default.
Eager loading the application is part of the boot process, so top-level constants are fine and are still autoloaded, no need to require their files.
Constants in deeper places only executed at runtime, like regular method bodies, are also fine because the file defining them will have been eager loaded while booting.
For the vast majority of applications this change needs no action. But in the very rare event that your application needs autoloading while running in production mode, set Rails.application.config.enable_dependency_loading to true.
- Not applicable
ActiveModel::Serializers::Xml has been extracted from Rails to the activemodel-serializers-xml gem. To continue using XML serialization in your application, add gem 'activemodel-serializers-xml' to your Gemfile.
- Not applicable
Rails 5 removes support for the legacy mysql database adapter. Most users should be able to use mysql2 instead. It will be converted to a separate gem when we find someone to maintain it.
- Upgraded to Ruby 2.5.3 to keep using debugger
debugger is not supported by Ruby 2.2 which is required by Rails 5. Use byebug instead.
- No action needed
Rails 5 adds the ability to run tasks and tests through bin/rails instead of rake. Generally these changes are in parallel with rake, but some were ported over altogether.
To use the new test runner simply type bin/rails test.
rake dev:cache is now rails dev:cache.
Run bin/rails to see the list of commands available.
- No action needed
Calling params in your application will now return an object instead of a hash. If your parameters are already permitted, then you will not need to make any changes. If you are using map and other methods that depend on being able to read the hash regardless of permitted? you will need to upgrade your application to first permit and then convert to a hash.
params.permit([:proceed_to, :return_to]).to_h
- No actio needed
protect_from_forgery defaults to prepend: false which means that it will be inserted into the callback chain at the point in which you call it in your application. If you want protect_from_forgery to always run first, then you should change your application to use protect_from_forgery prepend: true.
- Not action needed
Files without a template handler in their extension will be rendered using the raw handler. Previously Rails would render files using the ERB template handler.
If you do not want your file to be handled via the raw handler, you should add an extension to your file that can be parsed by the appropriate template handler.
- No action needed
You can now use wildcard matching for your template dependencies. For example, if you were defining your templates as such:
<% # Template Dependency: recordings/threads/events/subscribers_changed %>
<% # Template Dependency: recordings/threads/events/completed %>
<% # Template Dependency: recordings/threads/events/uncompleted %>
You can now just call the dependency once with a wildcard.
<% # Template Dependency: recordings/threads/events/* %>
- No action needed
content_tag_for and div_for have been removed in favor of just using content_tag. To continue using the older methods, add the record_tag_helper gem to your Gemfile:
gem 'record_tag_helper', '~> 1.0'
See #18411 for more details.
- No action needed
The protected_attributes gem is no longer supported in Rails 5.
- No action needed
The activerecord-deprecated_finders gem is no longer supported in Rails 5.
- Not applicable
When tests are run in your application, the default order is now :random instead of :sorted. Use the following config option to set it back to :sorted.
# config/environments/test.rb
Rails.application.configure do
config.active_support.test_order = :sorted
end
- Not applicable
If you include ActionController::Live in another module that is included in your controller, then you should also extend the module with ActiveSupport::Concern. Alternatively, you can use the self.included hook to include ActionController::Live directly to the controller once the StreamingSupport is included.
This means that if your application used to have its own streaming module, the following code would break in production mode:
# This is a work-around for streamed controllers performing authentication with Warden/Devise.
# See https://github.com/plataformatec/devise/issues/2332
# Authenticating in the router is another solution as suggested in that issue
class StreamingSupport
include ActionController::Live # this won't work in production for Rails 5
# extend ActiveSupport::Concern # unless you uncomment this line.
def process(name)
super(name)
rescue ArgumentError => e
if e.message == 'uncaught throw :warden'
throw :warden
else
raise e
end
end
end
- fixed the validation
belongs_to will now trigger a validation error by default if the association is not present.
This can be turned off per-association with optional: true.
This default will be automatically configured in new applications. If existing application want to add this feature it will need to be turned on in an initializer.
config.active_record.belongs_to_required_by_default = true
- Nice to have
Rails 5 now supports per-form CSRF tokens to mitigate against code-injection attacks with forms created by JavaScript. With this option turned on, forms in your application will each have their own CSRF token that is specified to the action and method for that form.
config.action_controller.per_form_csrf_tokens = true
- Nice to have
You can now configure your application to check if the HTTP Origin header should be checked against the site's origin as an additional CSRF defense. Set the following in your config to true:
config.action_controller.forgery_protection_origin_check = true
- Not needed yet
The default mailer queue name is mailers. This configuration option allows you to globally change the queue name. Set the following in your config:
config.action_mailer.deliver_later_queue_name = :new_queue_name
4.20.5 Support Fragment Caching in Action Mailer Views
Set config.action_mailer.perform_caching in your config to determine whether your Action Mailer views should support caching.
config.action_mailer.perform_caching = true
- No action need
If you're using schema_search_path or other PostgreSQL extensions, you can control how the schema is dumped. Set to :all to generate all dumps, or to :schema_search_path to generate from schema search path.
config.active_record.dump_schemas = :all
- Nice to have
Set the following in your config to enable HSTS when using subdomains:
config.ssl_options = { hsts: { subdomains: true } }
- Not applicable
When using Ruby 2.4, you can preserve the timezone of the receiver when calling to_time.
ActiveSupport.to_time_preserves_timezone = false
- Not applicable
In Rails 5.0, how JSON/JSONB attributes are serialized and deserialized changed. Now, if you set a column equal to a String, Active Record will no longer turn that string into a Hash, and will instead only return the string. This is not limited to code interacting with models, but also affects :default column settings in db/schema.rb. It is recommended that you do not set columns equal to a String, but pass a Hash instead, which will be converted to and from a JSON string automatically.