Ruby on Rails - filters in ruby on rails - ruby on rails tutorial - rails guides - rails tutorial - ruby rails
Filters
- Filters are methods that are run "before", "after" or "around" a controller action. They are inherited, so if we set any in our ApplicationController they will be run for every request your application receives.
Before Filter
- Before filters are executed before the controller action and can halt the request (and/or redirect). A common use is to verify if a user is logged in:
- Before filters are executed before the controller action and can halt the request (and/or redirect). A common use is to verify if a user is logged in:Before filters are run on requests before the request gets to the controller’s action. It can return a response itself and completely bypass the action.
- Other common uses of before filters is validating a user’s authentication before granting them access to the action designated to handle their request. I’ve also seen them used to load a resource from the database, check permissions on a resource, or manage redirects under other circumstances.
After Filter
- After filters are similar to "before" ones, but as they get executed after the action run they have access the response object that's about to be sent. So in short after filters are run after the action completes. It can modify the response. Most of the time if something is done in an after filter, it can be done in the action itself, but if there is some logic to be run after running any of a set of actions, then an after filter is a good place to do it.
- Generally, I’ve seen after and around filters used for logging.
Around Filter
- Around filters may have logic before and after the action being run. It simply yields to the action in whatever place is necessary. Note that it doesn’t need to yield to the action and may run without doing so like a before filter.
- Around filters are responsible for running their associated actions by yielding, similar to how Rack middlewares work.
- Around callbacks wrap the execution of actions. You can write an around callback in two different styles. In the first, the callback is a single chunk of code. That code is called before the action is executed. If the callback code invokes yield, the action is executed. When the action completes, the callback code continues executing. Thus, the code before the yield is like a before action callback and the code after the yield is the after action callback. If the callback code never invokes yield. the action is not run-this is the same as having a before action callback return false.
- Here's an example of the around filter:
- This will catch exception of any action and put the message in our log. We can use around filters for exception handling, setup and teardown, and a myriad of other cases.
Only and Except
- All filters can be applied to specific actions, using :only and :except:
Skipping Filter
- All filters (inherited ones too) can also be skipped for some specific actions:
- As they're inherited, filters can also be defined in a namespace "parent" controller. Say for example that you have an admin namespace, and you of course want only admin users to be able to access it. You could do something like this:
Beware that in Rails 4.x you could use before_filter along with before_action, but before_filter is currently deprecated in Rails 5.0.0 and will be removed in 5.1.