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, inherited, store_inherited

Methods included from ActiveSupport::Configurable

#config

Methods included from ActiveSupport::Concern

#append_features, #class_methods, extended, #included

Class Attribute Details

+ (Object) abstract (readonly) Also known as: abstract?

Returns the value of attribute abstract



28
29
30
# File 'actionpack/lib/abstract_controller/base.rb', line 28

def abstract
  @abstract
end

Class Method Details

+ (Object) abstract!

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



33
34
35
# File 'actionpack/lib/abstract_controller/base.rb', line 33

def abstract!
  @abstract = true
end

+ (Object) 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. Finally, #hidden_actions are removed.

Returns

  • Set - A set of all methods that should be considered actions.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'actionpack/lib/abstract_controller/base.rb', line 77

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)).uniq.map { |x| x.to_s } -
      # And always exclude explicitly hidden actions
      hidden_actions.to_a

    # Clear out AS callback method pollution
    Set.new(methods.reject { |method| method =~ /_one_time_conditions/ })
  end
end

+ (Object) clear_action_methods!

action_methods are cached and there is sometimes need to refresh them. clear_action_methods! allows you to do that, so next time you run action_methods, they will be recalculated



96
97
98
# File 'actionpack/lib/abstract_controller/base.rb', line 96

def clear_action_methods!
  @action_methods = nil
end

+ (Object) controller_path

Returns the full controller name, underscored, without the ending Controller. For instance, MyApp::MyPostsController would return “my_app/my_posts” for controller_path.

Returns

  • String



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

def controller_path
  @controller_path ||= name.sub(/Controller$/, '').underscore unless anonymous?
end

+ (Object) hidden_actions

The list of hidden actions. Defaults to an empty array. This can be modified by other modules or subclasses to specify particular actions as hidden.

Returns

  • Array - An array of method names that should not be considered actions.



65
66
67
# File 'actionpack/lib/abstract_controller/base.rb', line 65

def hidden_actions
  []
end

+ (Object) inherited(klass)

:nodoc:



37
38
39
40
41
42
43
44
# File 'actionpack/lib/abstract_controller/base.rb', line 37

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

+ (Object) 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)



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

def internal_methods
  controller = self

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

+ (Object) method_added(name)

Refresh the cached action_methods when a new action_method is added.



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

def method_added(name)
  super
  clear_action_methods!
end

Instance Method Details

- (Object) action_methods

Delegates to the class' #action_methods



145
146
147
# File 'actionpack/lib/abstract_controller/base.rb', line 145

def action_methods
  self.class.action_methods
end

- (Boolean) available_action?(action_name)

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

  • TrueClass, FalseClass

Returns:

  • (Boolean)


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

def available_action?(action_name)
  method_for_action(action_name).present?
end

- (Object) controller_path

Delegates to the class' #controller_path



140
141
142
# File 'actionpack/lib/abstract_controller/base.rb', line 140

def controller_path
  self.class.controller_path
end

- (Object) process(action, *args)

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



127
128
129
130
131
132
133
134
135
136
137
# File 'actionpack/lib/abstract_controller/base.rb', line 127

def process(action, *args)
  @_action_name = action_name = action.to_s

  unless action_name = method_for_action(action_name)
    raise ActionNotFound, "The action '#{action}' could not be found for #{self.class.name}"
  end

  @_response_body = nil

  process_action(action_name, *args)
end