class AbstractController::Base - actionpack-4.2.3 Documentation

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

### Attributes

abstract[R]
abstract?[R]

### Public Class Methods

abstract!() click to toggle source

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

    # File lib/abstract_controller/base.rb, line 34
    def abstract!
      @abstract = true
    end

action_methods() click to toggle source

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.

    # File lib/abstract_controller/base.rb, line 78
    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

clear_action_methods!() click to toggle source

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

    # File lib/abstract_controller/base.rb, line 97
    def clear_action_methods!
      @action_methods = nil
    end

controller_path() click to toggle source

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`

    # File lib/abstract_controller/base.rb, line 107
    def controller_path
      @controller_path ||= name.sub(/Controller$/, '').underscore unless anonymous?
    end

hidden_actions() click to toggle source

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.

    # File lib/abstract_controller/base.rb, line 66
    def hidden_actions
      []
    end

internal_methods() click to toggle source

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 lib/abstract_controller/base.rb, line 53
    def internal_methods
      controller = self

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

method_added(name) click to toggle source

Refresh the cached ::action_methods when a new action_method is added.

Calls superclass method

    # File lib/abstract_controller/base.rb, line 112
    def method_added(name)
      super
      clear_action_methods!
    end

supports_path?() click to toggle source

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.

    # File lib/abstract_controller/base.rb, line 171
    def self.supports_path?
      true
    end

### Public Instance Methods

action_methods() click to toggle source

Delegates to the class' action_methods

    # File lib/abstract_controller/base.rb, line 146
    def action_methods
      self.class.action_methods
    end

available_action?(action_name) click to toggle source

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`

    # File lib/abstract_controller/base.rb, line 163
    def available_action?(action_name)
      _find_action_name(action_name).present?
    end

controller_path() click to toggle source

Delegates to the class' controller_path

    # File lib/abstract_controller/base.rb, line 141
    def controller_path
      self.class.controller_path
    end

process(action, *args) click to toggle source

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`

    # File lib/abstract_controller/base.rb, line 128
    def process(action, *args)
      @_action_name = action.to_s

      unless action_name = _find_action_name(@_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

### Private Instance Methods

_find_action_name(action_name) click to toggle source

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

    # File lib/abstract_controller/base.rb, line 229
    def _find_action_name(action_name)
      _valid_action_name?(action_name) && method_for_action(action_name)
    end

_handle_action_missing(*args) click to toggle source

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 lib/abstract_controller/base.rb, line 211
    def _handle_action_missing(*args)
      action_missing(@_action_name, *args)
    end

_valid_action_name?(action_name) click to toggle source

Checks if the action name is valid and returns false otherwise.

    # File lib/abstract_controller/base.rb, line 265
    def _valid_action_name?(action_name)
      !action_name.to_s.include? File::SEPARATOR
    end

action_method?(name) click to toggle source

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

#### Returns¶ ↑

- `TrueClass`, `FalseClass`

:api: private

    # File lib/abstract_controller/base.rb, line 187
    def action_method?(name)
      self.class.action_methods.include?(name)
    end

method_for_action(action_name) click to toggle source

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 AbstractController::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 lib/abstract_controller/base.rb, line 256
    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(method_name, *args) click to toggle source

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 lib/abstract_controller/base.rb, line 197
    def process_action(method_name, *args)
      send_action(method_name, *args)
    end