mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
45f1c7a3e1
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.
115 lines
3.3 KiB
Ruby
115 lines
3.3 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
#--
|
|
# Copyright (c) 2004-2019 David Heinemeier Hansson
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining
|
|
# a copy of this software and associated documentation files (the
|
|
# "Software"), to deal in the Software without restriction, including
|
|
# without limitation the rights to use, copy, modify, merge, publish,
|
|
# distribute, sublicense, and/or sell copies of the Software, and to
|
|
# permit persons to whom the Software is furnished to do so, subject to
|
|
# the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be
|
|
# included in all copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
#++
|
|
|
|
require "active_support"
|
|
require "active_support/rails"
|
|
require "active_support/core_ext/module/attribute_accessors"
|
|
|
|
require "action_pack"
|
|
require "rack"
|
|
|
|
module Rack
|
|
autoload :Test, "rack/test"
|
|
end
|
|
|
|
module ActionDispatch
|
|
extend ActiveSupport::Autoload
|
|
|
|
class IllegalStateError < StandardError
|
|
end
|
|
|
|
eager_autoload do
|
|
autoload_under "http" do
|
|
autoload :ContentSecurityPolicy
|
|
autoload :Request
|
|
autoload :Response
|
|
end
|
|
end
|
|
|
|
autoload_under "middleware" do
|
|
autoload :HostAuthorization
|
|
autoload :RequestId
|
|
autoload :Callbacks
|
|
autoload :Cookies
|
|
autoload :ActionableExceptions
|
|
autoload :DebugExceptions
|
|
autoload :DebugLocks
|
|
autoload :DebugView
|
|
autoload :ExceptionWrapper
|
|
autoload :Executor
|
|
autoload :Flash
|
|
autoload :PublicExceptions
|
|
autoload :Reloader
|
|
autoload :RemoteIp
|
|
autoload :ShowExceptions
|
|
autoload :SSL
|
|
autoload :Static
|
|
end
|
|
|
|
autoload :Journey
|
|
autoload :MiddlewareStack, "action_dispatch/middleware/stack"
|
|
autoload :Routing
|
|
|
|
module Http
|
|
extend ActiveSupport::Autoload
|
|
|
|
autoload :Cache
|
|
autoload :Headers
|
|
autoload :MimeNegotiation
|
|
autoload :Parameters
|
|
autoload :ParameterFilter
|
|
autoload :Upload
|
|
autoload :UploadedFile, "action_dispatch/http/upload"
|
|
autoload :URL
|
|
end
|
|
|
|
module Session
|
|
autoload :AbstractStore, "action_dispatch/middleware/session/abstract_store"
|
|
autoload :CookieStore, "action_dispatch/middleware/session/cookie_store"
|
|
autoload :MemCacheStore, "action_dispatch/middleware/session/mem_cache_store"
|
|
autoload :CacheStore, "action_dispatch/middleware/session/cache_store"
|
|
end
|
|
|
|
mattr_accessor :test_app
|
|
|
|
autoload_under "testing" do
|
|
autoload :Assertions
|
|
autoload :Integration
|
|
autoload :IntegrationTest, "action_dispatch/testing/integration"
|
|
autoload :TestProcess
|
|
autoload :TestRequest
|
|
autoload :TestResponse
|
|
autoload :AssertionResponse
|
|
end
|
|
|
|
autoload :SystemTestCase, "action_dispatch/system_test_case"
|
|
end
|
|
|
|
autoload :Mime, "action_dispatch/http/mime_type"
|
|
|
|
ActiveSupport.on_load(:action_view) do
|
|
ActionView::Base.default_formats ||= Mime::SET.symbols
|
|
ActionView::Template::Types.delegate_to Mime
|
|
end
|