Class: AbstractController::Base

Inherits:
Object
  • Object
show all
Extended by:
ActiveSupport::DescendantsTracker
Includes:
ActiveSupport::Configurable
Defined in:
actionpack/lib/abstract_controller/base.rb

Overview

# Abstract Controller Base

AbstractController::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.

Direct Known Subclasses

ActionController::Metal, ActionMailer::Base

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ActiveSupport::DescendantsTracker

clear, descendants, descendants, disable_clear!, reject!, subclasses

Methods included from ActiveSupport::Configurable

#config

Methods included from ActiveSupport::Concern

#append_features, #class_methods, extended, #included, #prepend_features, #prepended

Class Attribute Details

.abstract ⇒ Object (readonly) Also known as: abstract?

Returns the value of attribute abstract.



54
55
56
 
# File 'actionpack/lib/abstract_controller/base.rb', line 54

def abstract
  @abstract
end

Class Method Details

.abstract! ⇒ Object

Define a controller as abstract. See internal_methods for more details.



58
59
60
 
# File 'actionpack/lib/abstract_controller/base.rb', line 58

def abstract!
  @abstract = true
end

.action_methods ⇒ Object

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.



97
98
99
100
101
102
103
104
105
106
107
 
# 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! ⇒ Object

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.



112
113
114
 
# File 'actionpack/lib/abstract_controller/base.rb', line 112

def clear_action_methods!
  @action_methods = nil
end

.controller_path ⇒ Object

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

  • ‘String`



127
128
129
 
# File 'actionpack/lib/abstract_controller/base.rb', line 127

def controller_path
  @controller_path ||= name.delete_suffix("Controller").underscore unless anonymous?
end

.eager_load! ⇒ Object

:nodoc:



137
138
139
140
 
# File 'actionpack/lib/abstract_controller/base.rb', line 137

def eager_load! # :nodoc:
  action_methods
  nil
end

.inherited(klass) ⇒ Object

:nodoc:



62
63
64
65
66
67
68
69
 
# 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 ⇒ Object

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)



77
78
79
80
81
82
83
84
85
86
87
 
# 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) ⇒ Object

Refresh the cached action_methods when a new action_method is added.



132
133
134
135
 
# File 'actionpack/lib/abstract_controller/base.rb', line 132

def method_added(name)
  super
  clear_action_methods!
end

.supports_path? ⇒ Boolean

Returns true if the given controller is capable of rendering a path. A subclass of ‘AbstractController::Base` may return false. An Email controller for example does not support paths, only full URLs.

Returns:

  • (Boolean) 


200
201
202
 
# File 'actionpack/lib/abstract_controller/base.rb', line 200

def self.supports_path?
  true
end

Instance Method Details

#action_methods ⇒ Object

Delegates to the class’s ::action_methods.



172
173
174
 
# File 'actionpack/lib/abstract_controller/base.rb', line 172

def action_methods
  self.class.action_methods
end

#action_name ⇒ Object

Returns the name of the action this controller is processing.



44
 
# File 'actionpack/lib/abstract_controller/base.rb', line 44

attr_internal :action_name

#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

Returns:

  • (Boolean) 


187
188
189
 
# File 'actionpack/lib/abstract_controller/base.rb', line 187

def available_action?(action_name)
  _find_action_name(action_name)
end

#controller_path ⇒ Object

Delegates to the class’s ::controller_path.



167
168
169
 
# File 'actionpack/lib/abstract_controller/base.rb', line 167

def controller_path
  self.class.controller_path
end

#formats ⇒ Object

Returns the formats that can be processed by the controller.



48
 
# File 'actionpack/lib/abstract_controller/base.rb', line 48

attr_internal :formats

#inspect ⇒ Object

:nodoc:



204
205
206
 
# File 'actionpack/lib/abstract_controller/base.rb', line 204

def inspect # :nodoc:
  "#<#{self.class.name}:#{'%#016x' % (object_id << 1)}>"
end

#performed? ⇒ Boolean

Tests if a response body is set. Used to determine if the ‘process_action` callback needs to be terminated in AbstractController::Callbacks.

Returns:

  • (Boolean) 


193
194
195
 
# File 'actionpack/lib/abstract_controller/base.rb', line 193

def performed?
  response_body
end

#process(action) ⇒ Object

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 AbstractController::ActionNotFound error is raised.

#### Returns

  • ‘self`



154
155
156
157
158
159
160
161
162
163
164
 
# 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

#response_body ⇒ Object

Returns the body of the HTTP response sent by the controller.



40
 
# File 'actionpack/lib/abstract_controller/base.rb', line 40

attr_internal :response_body