Class: ActionController::Metal

Inherits:
AbstractController::Base show all
Defined in:
actionpack/lib/action_controller/metal.rb

Overview

ActionController::Metal is the simplest possible controller, providing a valid Rack interface without the additional niceties provided by ActionController::Base.

A sample metal controller might look like this:

class HelloController < ActionController::Metal
  def index
    self.response_body = "Hello World!"
  end
end

And then to route requests to your metal controller, you would add something like this to config/routes.rb:

get 'hello', to: HelloController.action(:index)

The action method returns a valid Rack application for the Rails router to dispatch to.

Rendering Helpers

ActionController::Metal by default provides no utilities for rendering views, partials, or other responses aside from explicitly calling of response_body=, content_type=, and status=. To add the render helpers you're used to having in a normal controller, you can do the following:

class HelloController < ActionController::Metal
  include ActionController::Rendering
  append_view_path "#{Rails.root}/app/views"

  def index
    render "hello/index"
  end
end

Redirection Helpers

To add redirection helpers to your metal controller, do the following:

class HelloController < ActionController::Metal
  include ActionController::Redirecting
  include Rails.application.routes.url_helpers

  def index
    redirect_to root_url
  end
end

Other Helpers

You can refer to the modules included in ActionController::Base to see other features you can bring into your metal controller.

Direct Known Subclasses

Base, Middleware

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from AbstractController::Base

abstract!, #action_methods, action_methods, #available_action?, clear_action_methods!, #controller_path, controller_path, hidden_actions, internal_methods, method_added, #process

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

Constructor Details

- (Metal) initialize



132
133
134
135
136
137
138
139
# File 'actionpack/lib/action_controller/metal.rb', line 132

def initialize
  @_headers = {"Content-Type" => "text/html"}
  @_status = 200
  @_request = nil
  @_response = nil
  @_routes = nil
  super
end

Class Method Details

+ (Object) action(name, klass = ActionDispatch::Request)

Returns a Rack endpoint for the given action name.



229
230
231
232
233
# File 'actionpack/lib/action_controller/metal.rb', line 229

def self.action(name, klass = ActionDispatch::Request)
  middleware_stack.build(name.to_s) do |env|
    new.dispatch(name, klass.new(env))
  end
end

+ (Object) call(env)

Makes the controller a Rack endpoint that runs the action in the given env's action_dispatch.request.path_parameters key.



224
225
226
# File 'actionpack/lib/action_controller/metal.rb', line 224

def self.call(env)
  action(env['action_dispatch.request.path_parameters'][:action]).call(env)
end

+ (Object) controller_name

Returns the last part of the controller's name, underscored, without the ending Controller. For instance, PostsController returns posts. Namespaces are left out, so Admin::PostsController returns posts as well.

Returns

  • string



114
115
116
# File 'actionpack/lib/action_controller/metal.rb', line 114

def self.controller_name
  @controller_name ||= name.demodulize.sub(/Controller$/, '').underscore
end

+ (Object) inherited(base)

:nodoc:



206
207
208
209
# File 'actionpack/lib/action_controller/metal.rb', line 206

def self.inherited(base) # :nodoc:
  base.middleware_stack = middleware_stack.dup
  super
end

+ (Object) middleware

Alias for middleware_stack.



218
219
220
# File 'actionpack/lib/action_controller/metal.rb', line 218

def self.middleware
  middleware_stack
end

+ (Object) use(*args, &block)

Pushes the given Rack middleware and its arguments to the bottom of the middleware stack.



213
214
215
# File 'actionpack/lib/action_controller/metal.rb', line 213

def self.use(*args, &block)
  middleware_stack.use(*args, &block)
end

Instance Method Details

- (Object) content_type



157
158
159
# File 'actionpack/lib/action_controller/metal.rb', line 157

def content_type
  headers["Content-Type"]
end

- (Object) content_type=(type)

Basic implementations for content_type=, location=, and headers are provided to reduce the dependency on the RackDelegation module in Renderer and Redirector.



153
154
155
# File 'actionpack/lib/action_controller/metal.rb', line 153

def content_type=(type)
  headers["Content-Type"] = type.to_s
end

- (Object) controller_name

Delegates to the class' controller_name



119
120
121
# File 'actionpack/lib/action_controller/metal.rb', line 119

def controller_name
  self.class.controller_name
end

- (Object) dispatch(name, request)

:nodoc:



191
192
193
194
195
196
197
# File 'actionpack/lib/action_controller/metal.rb', line 191

def dispatch(name, request) #:nodoc:
  @_request = request
  @_env = request.env
  @_env['action_controller.instance'] = self
  process(name)
  to_a
end

- (Object) env



104
105
106
# File 'actionpack/lib/action_controller/metal.rb', line 104

def env
  @_env ||= {}
end

- (Object) location



161
162
163
# File 'actionpack/lib/action_controller/metal.rb', line 161

def location
  headers["Location"]
end

- (Object) location=(url)



165
166
167
# File 'actionpack/lib/action_controller/metal.rb', line 165

def location=(url)
  headers["Location"] = url
end

- (Object) params



141
142
143
# File 'actionpack/lib/action_controller/metal.rb', line 141

def params
  @_params ||= request.parameters
end

- (Object) params=(val)



145
146
147
# File 'actionpack/lib/action_controller/metal.rb', line 145

def params=(val)
  @_params = val
end

- (Boolean) performed?



187
188
189
# File 'actionpack/lib/action_controller/metal.rb', line 187

def performed?
  response_body || (response && response.committed?)
end

- (Object) response_body=(body)



182
183
184
185
# File 'actionpack/lib/action_controller/metal.rb', line 182

def response_body=(body)
  body = [body] unless body.nil? || body.respond_to?(:each)
  super
end

- (Object) status



174
175
176
# File 'actionpack/lib/action_controller/metal.rb', line 174

def status
  @_status
end

- (Object) status=(status)



178
179
180
# File 'actionpack/lib/action_controller/metal.rb', line 178

def status=(status)
  @_status = Rack::Utils.status_code(status)
end

- (Object) to_a

:nodoc:



199
200
201
# File 'actionpack/lib/action_controller/metal.rb', line 199

def to_a #:nodoc:
  response ? response.to_a : [status, headers, response_body]
end

- (Object) url_for(string)

basic url_for that can be overridden for more robust functionality



170
171
172
# File 'actionpack/lib/action_controller/metal.rb', line 170

def url_for(string)
  string
end