1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Commit graph

5 commits

Author SHA1 Message Date
Genadi Samokovarov
feaaa7576a Refactor after the most recent code review 2019-04-19 14:15:41 +09:00
Genadi Samokovarov
1820b19705 Tweak the ActionableError docs a bit 2019-04-19 14:15:41 +09:00
Genadi Samokovarov
963fef7b37 Simplify the ActionableError.{dispatch,action} boundries 2019-04-19 14:15:23 +09:00
Genadi Samokovarov
a3110fe20b Drop the ambiguous ActiveSupport::ActionableError#=== check 2019-04-19 14:15:22 +09:00
Genadi Samokovarov
45f1c7a3e1 Introduce Actionable Errors
Actionable errors let's you dispatch actions from Rails' error pages. This
can help you save time if you have a clear action for the resolution of
common development errors.

The de-facto example are pending migrations. Every time pending migrations
are found, a middleware raises an error. With actionable errors, you can
run the migrations right from the error page. Other examples include Rails
plugins that need to run a rake task to setup themselves. They can now
raise actionable errors to run the setup straight from the error pages.

Here is how to define an actionable error:

```ruby
class PendingMigrationError < MigrationError #:nodoc:
  include ActiveSupport::ActionableError

  action "Run pending migrations" do
    ActiveRecord::Tasks::DatabaseTasks.migrate
  end
end
```

To make an error actionable, include the `ActiveSupport::ActionableError`
module and invoke the `action` class macro to define the action. An action
needs a name and a procedure to execute. The name is shown as the name of a
button on the error pages. Once clicked, it will invoke the given
procedure.
2019-04-19 14:14:06 +09:00