Class: Cuprum::Rails::Action

Inherits:

Command

• Object
• Command
• Cuprum::Rails::Action

Extended by:

Forwardable

Defined in:

lib/cuprum/rails/action.rb

Overview

Abstract command that implement a controller action.

Direct Known Subclasses

Cuprum::Rails::Actions::Middleware::Associations::Query, Cuprum::Rails::Actions::Middleware::Resources::Query, Cuprum::Rails::Actions::ResourceAction

Instance Attribute Summary

• #options ⇒ Hash<Symbol, Object> readonly

  Additional options for the action.

• #repository ⇒ Cuprum::Collections::Repository readonly

  The repository containing the data collections for the application or scope.

• #request ⇒ Cuprum::Rails::Request readonly

  The formatted request.

Instance Method Summary

• #call(request: , repository: nil, **options) ⇒ Cuprum::Result

  Performs the controller action.

• #params ⇒ Hash<String, Object>

  The request parameters.

Instance Attribute Details

#options ⇒ Hash<Symbol, Object> (readonly)

Returns additional options for the action.

Returns:

• (Hash<Symbol, Object>) —

  additional options for the action.

# File 'lib/cuprum/rails/action.rb', line 32

def options
  @options
end

#repository ⇒ Cuprum::Collections::Repository (readonly)

Returns the repository containing the data collections for the application or scope.

Returns:

• (Cuprum::Collections::Repository) —

  the repository containing the data collections for the application or scope.

# File 'lib/cuprum/rails/action.rb', line 36

def repository
  @repository
end

#request ⇒ Cuprum::Rails::Request (readonly)

Returns the formatted request.

Returns:

• (Cuprum::Rails::Request) —

  the formatted request.

# File 'lib/cuprum/rails/action.rb', line 39

def request
  @request
end

Instance Method Details

#call(request: , repository: nil, **options) ⇒ Cuprum::Result

Performs the controller action.

Subclasses should implement a #process method with the :request keyword, which accepts an ActionDispatch::Request instance.

Parameters:

• request (ActionDispatch::Request) (defaults to: ) —

  the Rails request.

• repository (Cuprum::Collections::Repository) (defaults to: nil) —

  the repository containing the data collections for the application or scope.

• options (Hash<Symbol, Object>) —

  additional options for the action.

Returns:

• (Cuprum::Result) —

  the result of the action.

# File 'lib/cuprum/rails/action.rb', line 14

#params ⇒ Hash<String, Object>

Returns the request parameters.

Returns:

• (Hash<String, Object>) —

  the request parameters.

# File 'lib/cuprum/rails/action.rb', line 29

def_delegators :@request, :params