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 AbstractController::Rendering
  include ActionView::Layouts
  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, extended, #included

Constructor Details

#initializeMetal

Returns a new instance of Metal



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

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

Class Method Details

.action(name, klass = ActionDispatch::Request) ⇒ Object

Returns a Rack endpoint for the given action name.



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

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

.call(env) ⇒ Object

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



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

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

.controller_nameObject

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



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

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

.inherited(base) ⇒ Object

:nodoc:



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

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

.middlewareObject

Alias for middleware_stack.



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

def self.middleware
  middleware_stack
end

.use(*args, &block) ⇒ Object

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



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

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

Instance Method Details

#_status_codeObject



236
237
238
# File 'actionpack/lib/action_controller/metal.rb', line 236

def _status_code
  @_status
end

#content_typeObject



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

def content_type
  headers["Content-Type"]
end

#content_type=(type) ⇒ Object

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



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

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

#controller_nameObject

Delegates to the class' controller_name



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

def controller_name
  self.class.controller_name
end

#dispatch(name, request) ⇒ Object

:nodoc:



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

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

#envObject



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

def env
  @_env ||= {}
end

#locationObject



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

def location
  headers["Location"]
end

#location=(url) ⇒ Object



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

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

#paramsObject



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

def params
  @_params ||= request.parameters
end

#params=(val) ⇒ Object



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

def params=(val)
  @_params = val
end

#performed?Boolean

Returns:

  • (Boolean)


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

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

#response_body=(body) ⇒ Object



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

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

#statusObject



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

def status
  @_status
end

#status=(status) ⇒ Object



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

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

#to_aObject

:nodoc:



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

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

#url_for(string) ⇒ Object

basic url_for that can be overridden for more robust functionality



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

def url_for(string)
  string
end