Class: AbstractController::Base
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
|
|
Instance Chain:
|
|
Inherits: | Object |
Defined in: | actionpack/lib/abstract_controller/base.rb |
Overview
Base
is a low-level API. Nobody should be using it directly, and subclasses (like ::ActionController::Base
) are expected to provide their own render
method, since rendering means different things depending on the context.
Class Attribute Summary
-
.abstract?
readonly
Alias for .abstract.
-
.supports_path? ⇒ Boolean
readonly
Returns true if the given controller is capable of rendering a path.
Class Method Summary
- .abstract (also: .abstract?) readonly
-
.abstract!
Define a controller as abstract.
-
.action_methods
A list of method names that should be considered actions.
-
.clear_action_methods!
action_methods are cached and there is sometimes a need to refresh them.
-
.controller_path
Returns the full controller name, underscored, without the ending Controller.
-
.internal_methods
A list of all internal methods for a controller.
-
.method_added(name)
Refresh the cached action_methods when a new action_method is added.
- .eager_load! Internal use only
- .inherited(klass) Internal use only
::ActiveSupport::DescendantsTracker
- Extended
Instance Attribute Summary
-
#action_name
rw
Returns the name of the action this controller is processing.
-
#formats
rw
Returns the formats that can be processed by the controller.
-
#performed? ⇒ Boolean
readonly
Tests if a response body is set.
-
#response_body
rw
Returns the body of the HTTP response sent by the controller.
Instance Method Summary
-
#action_methods
Delegates to the class’s .action_methods.
-
#available_action?(action_name) ⇒ Boolean
Returns true if a method for the action is available and can be dispatched, false otherwise.
-
#controller_path
Delegates to the class’s .controller_path.
-
#process(action)
Calls the action going through the entire Action Dispatch stack.
-
#_find_action_name(action_name)
private
Takes an action name and returns the name of the method that will handle the action.
-
#_handle_action_missing(*args)
private
If the action name was not found, but a method called “action_missing” was found, #method_for_action will return “_handle_action_missing”.
-
#_valid_action_name?(action_name) ⇒ Boolean
private
Checks if the action name is valid and returns false otherwise.
-
#action_method?(name) ⇒ Boolean
private
Returns true if the name can be considered an action because it has a method defined in the controller.
-
#method_for_action(action_name)
private
Takes an action name and returns the name of the method that will handle the action.
-
#process_action
private
Call the action.
-
#send_action
private
Actually call the method associated with the action.
- #inspect Internal use only
::ActiveSupport::Configurable
- Included
#config | Reads and writes attributes from a configuration OrderedOptions. |
Class Attribute Details
.abstract? (readonly)
Alias for .abstract.
# File 'actionpack/lib/abstract_controller/base.rb', line 55
alias_method :abstract?, :abstract
.supports_path? ⇒ Boolean
(readonly)
Returns true if the given controller is capable of rendering a path. A subclass of Base
may return false. An Email controller for example does not support paths, only full URLs.
# File 'actionpack/lib/abstract_controller/base.rb', line 200
def self.supports_path? true end
Class Method Details
.abstract (readonly) Also known as: .abstract?
[ GitHub ]# File 'actionpack/lib/abstract_controller/base.rb', line 54
attr_reader :abstract
.abstract!
Define a controller as abstract. See internal_methods for more details.
# File 'actionpack/lib/abstract_controller/base.rb', line 58
def abstract! @abstract = true end
.action_methods
A list of method names that should be considered actions. This includes all public instance methods on a controller, less any internal methods (see internal_methods), adding back in any methods that are internal, but still exist on the class itself.
#### Returns
-
Set
- A set of all methods that should be considered actions.
# File 'actionpack/lib/abstract_controller/base.rb', line 97
def action_methods @action_methods ||= begin # All public instance methods of this class, including ancestors except for # public instance methods of Base and its ancestors. methods = public_instance_methods(true) - internal_methods # Be sure to include shadowed public instance methods of this class. methods.concat(public_instance_methods(false)) methods.map!(&:to_s) methods.to_set end end
.clear_action_methods!
action_methods are cached and there is sometimes a need to refresh them. .clear_action_methods!
allows you to do that, so next time you run action_methods, they will be recalculated.
# File 'actionpack/lib/abstract_controller/base.rb', line 112
def clear_action_methods! @action_methods = nil end
.controller_path
Returns the full controller name, underscored, without the ending Controller.
class MyApp::MyPostsController < AbstractController::Base
end
MyApp::MyPostsController.controller_path # => "my_app/my_posts"
#### Returns
# File 'actionpack/lib/abstract_controller/base.rb', line 127
def controller_path @controller_path ||= name.delete_suffix("Controller").underscore unless anonymous? end
.eager_load!
# File 'actionpack/lib/abstract_controller/base.rb', line 137
def eager_load! # :nodoc: action_methods nil end
.inherited(klass)
# File 'actionpack/lib/abstract_controller/base.rb', line 62
def inherited(klass) # :nodoc: # Define the abstract ivar on subclasses so that we don't get uninitialized ivar # warnings unless klass.instance_variable_defined?(:@abstract) klass.instance_variable_set(:@abstract, false) end super end
.internal_methods
A list of all internal methods for a controller. This finds the first abstract superclass of a controller, and gets a list of all public instance methods on that abstract class. Public instance methods of a controller would normally be considered action methods, so methods declared on abstract classes are being removed. (ActionController::Metal and ::ActionController::Base
are defined as abstract)
# File 'actionpack/lib/abstract_controller/base.rb', line 77
def internal_methods controller = self methods = [] until controller.abstract? methods += controller.public_instance_methods(false) controller = controller.superclass end controller.public_instance_methods(true) - methods end
.method_added(name)
Refresh the cached action_methods when a new action_method is added.
# File 'actionpack/lib/abstract_controller/base.rb', line 132
def method_added(name) super clear_action_methods! end
Instance Attribute Details
#action_name (rw)
Returns the name of the action this controller is processing.
# File 'actionpack/lib/abstract_controller/base.rb', line 44
attr_internal :action_name
#formats (rw)
Returns the formats that can be processed by the controller.
# File 'actionpack/lib/abstract_controller/base.rb', line 48
attr_internal :formats
#performed? ⇒ Boolean
(readonly)
Tests if a response body is set. Used to determine if the #process_action callback needs to be terminated in Callbacks
.
# File 'actionpack/lib/abstract_controller/base.rb', line 193
def performed? response_body end
#response_body (rw)
Returns the body of the HTTP response sent by the controller.
# File 'actionpack/lib/abstract_controller/base.rb', line 40
attr_internal :response_body
Instance Method Details
#_find_action_name(action_name) (private)
Takes an action name and returns the name of the method that will handle the action.
It checks if the action name is valid and returns false otherwise.
See method_for_action for more information.
#### Parameters
-
#action_name - An action name to find a method name for
#### Returns
-
string
- The name of the method that handles the action -
false - No valid method name could be found.
Raise ActionNotFound
.
# File 'actionpack/lib/abstract_controller/base.rb', line 258
def _find_action_name(action_name) _valid_action_name?(action_name) && method_for_action(action_name) end
#_handle_action_missing(*args) (private)
If the action name was not found, but a method called “action_missing” was found, #method_for_action will return “_handle_action_missing”. This method calls #action_missing
with the current action name.
# File 'actionpack/lib/abstract_controller/base.rb', line 238
def _handle_action_missing(*args) action_missing(@_action_name, *args) end
#_valid_action_name?(action_name) ⇒ Boolean
(private)
Checks if the action name is valid and returns false otherwise.
# File 'actionpack/lib/abstract_controller/base.rb', line 295
def _valid_action_name?(action_name) !action_name.to_s.include? File::SEPARATOR end
#action_method?(name) ⇒ Boolean
(private)
Returns true if the name can be considered an action because it has a method defined in the controller.
#### Parameters
-
name
- The name of an action to be tested
# File 'actionpack/lib/abstract_controller/base.rb', line 215
def action_method?(name) self.class.action_methods.include?(name) end
#action_methods
Delegates to the class’s .action_methods.
# File 'actionpack/lib/abstract_controller/base.rb', line 172
def action_methods self.class.action_methods end
#available_action?(action_name) ⇒ Boolean
Returns true if a method for the action is available and can be dispatched, false otherwise.
Notice that action_methods.include?("foo")
may return false and available_action?("foo")
returns true because this method considers actions that are also available through other means, for example, implicit render ones.
#### Parameters
-
#action_name - The name of an action to be tested
# File 'actionpack/lib/abstract_controller/base.rb', line 187
def available_action?(action_name) _find_action_name(action_name) end
#controller_path
Delegates to the class’s .controller_path.
# File 'actionpack/lib/abstract_controller/base.rb', line 167
def controller_path self.class.controller_path end
#inspect
# File 'actionpack/lib/abstract_controller/base.rb', line 204
def inspect # :nodoc: "#<#{self.class.name}:#{'%#016x' % (object_id << 1)}>" end
#method_for_action(action_name) (private)
Takes an action name and returns the name of the method that will handle the action. In normal cases, this method returns the same name as it receives. By default, if #method_for_action
receives a name that is not an action, it will look for an #action_missing
method and return “_handle_action_missing” if one is found.
Subclasses may override this method to add additional conditions that should be considered an action. For instance, an HTTP controller with a template matching the action name is considered to exist.
If you override this method to handle additional cases, you may also provide a method (like _handle_method_missing
) to handle the case.
If none of these conditions are true, and method_for_action
returns nil
, an ActionNotFound
exception will be raised.
#### Parameters
-
#action_name - An action name to find a method name for
#### Returns
-
string
- The name of the method that handles the action -
nil
- No method name could be found.
# File 'actionpack/lib/abstract_controller/base.rb', line 286
def method_for_action(action_name) if action_method?(action_name) action_name elsif respond_to?(:action_missing, true) "_handle_action_missing" end end
#process(action)
Calls the action going through the entire Action Dispatch stack.
The actual method that is called is determined by calling #method_for_action. If no method can handle the action, then an ActionNotFound
error is raised.
#### Returns
-
self
# File 'actionpack/lib/abstract_controller/base.rb', line 154
def process(action, ...) @_action_name = action.to_s unless action_name = _find_action_name(@_action_name) raise ActionNotFound.new("The action '#{action}' could not be found for #{self.class.name}", self, action) end @_response_body = nil process_action(action_name, ...) end
#process_action (private)
Call the action. Override this in a subclass to modify the behavior around processing an action. This, and not #process, is the intended way to override action dispatching.
Notice that the first argument is the method to be dispatched which is not necessarily the same as the action name.
# File 'actionpack/lib/abstract_controller/base.rb', line 225
def process_action(...) send_action(...) end
#send_action (private)
Actually call the method associated with the action. Override this method if you wish to change how action methods are called, not to add additional behavior around it. For example, you would override #send_action
if you want to inject arguments into the method.
# File 'actionpack/lib/abstract_controller/base.rb', line 233
alias send_action send