Class: AbstractController::Base

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

Overview

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, direct_descendants, direct_descendants, disable_clear!, inherited, native?, store_inherited, subclasses, subclasses

Methods included from ActiveSupport::Configurable

#config

Methods included from ActiveSupport::Concern

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

Class Attribute Details

.abstractObject (readonly) Also known as: abstract?

Returns the value of attribute abstract.


50
51
52
# File 'actionpack/lib/abstract_controller/base.rb', line 50

def abstract
  @abstract
end

Class Method Details

.abstract!Object

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


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

def abstract!
  @abstract = true
end

.action_methodsObject

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.


89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'actionpack/lib/abstract_controller/base.rb', line 89

def action_methods
  @action_methods ||= begin
    # All public instance methods of this class, including ancestors
    methods = (public_instance_methods(true) -
      # Except for public instance methods of Base and its ancestors
      internal_methods +
      # Be sure to include shadowed public instance methods of this class
      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.


107
108
109
# File 'actionpack/lib/abstract_controller/base.rb', line 107

def clear_action_methods!
  @action_methods = nil
end

.controller_pathObject

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


121
122
123
# File 'actionpack/lib/abstract_controller/base.rb', line 121

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

.eager_load!Object

:nodoc:


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

def eager_load! # :nodoc:
  action_methods
  nil
end

.inherited(klass) ⇒ Object

:nodoc:


59
60
61
62
63
64
65
66
# File 'actionpack/lib/abstract_controller/base.rb', line 59

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_methodsObject

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)


74
75
76
77
78
79
# File 'actionpack/lib/abstract_controller/base.rb', line 74

def internal_methods
  controller = self

  controller = controller.superclass until controller.abstract?
  controller.public_instance_methods(true)
end

.method_added(name) ⇒ Object

Refresh the cached action_methods when a new action_method is added.


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

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)

195
196
197
# File 'actionpack/lib/abstract_controller/base.rb', line 195

def self.supports_path?
  true
end

Instance Method Details

#action_methodsObject

Delegates to the class's ::action_methods.


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

def action_methods
  self.class.action_methods
end

#action_nameObject

Returns the name of the action this controller is processing.


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

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)

180
181
182
# File 'actionpack/lib/abstract_controller/base.rb', line 180

def available_action?(action_name)
  _find_action_name(action_name)
end

#controller_pathObject

Delegates to the class's ::controller_path.


161
162
163
# File 'actionpack/lib/abstract_controller/base.rb', line 161

def controller_path
  self.class.controller_path
end

#formatsObject

Returns the formats that can be processed by the controller.


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

attr_internal :formats

#inspectObject

:nodoc:


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

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)

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

def performed?
  response_body
end

#process(action, *args) ⇒ 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


147
148
149
150
151
152
153
154
155
156
157
# File 'actionpack/lib/abstract_controller/base.rb', line 147

def process(action, *args)
  @_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, *args)
end

#response_bodyObject

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


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

attr_internal :response_body