Class: ActionController::Metal

Inherits:
AbstractController::Base show all
Includes:
Testing::Functional
Defined in:
actionpack/lib/action_controller/metal.rb,
actionpack/lib/action_controller/test_case.rb

Overview

:stopdoc:

Direct Known Subclasses

API, Base

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Testing::Functional

#recycle!

Methods inherited from AbstractController::Base

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

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

#initializeMetal



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

def initialize
  @_request = nil
  @_response = nil
  @_routes = nil
  super
end

Class Method Details

.action(name) ⇒ Object

Returns a Rack endpoint for the given action name.



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'actionpack/lib/action_controller/metal.rb', line 242

def self.action(name)
  if middleware_stack.any?
    middleware_stack.build(name) do |env|
      req = ActionDispatch::Request.new(env)
      res = make_response! req
      new.dispatch(name, req, res)
    end
  else
    lambda { |env|
      req = ActionDispatch::Request.new(env)
      res = make_response! req
      new.dispatch(name, req, res)
    }
  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.



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

def self.call(env)
  req = ActionDispatch::Request.new env
  action(req.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



132
133
134
# File 'actionpack/lib/action_controller/metal.rb', line 132

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

.dispatch(name, req, res) ⇒ Object

Direct dispatch to the controller. Instantiates the controller, then executes the action named name.



260
261
262
263
264
265
266
# File 'actionpack/lib/action_controller/metal.rb', line 260

def self.dispatch(name, req, res)
  if middleware_stack.any?
    middleware_stack.build(name) { |env| new.dispatch(name, req, res) }.call req.env
  else
    new.dispatch(name, req, res)
  end
end

.inherited(base) ⇒ Object

:nodoc:



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

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

.make_response!(request) ⇒ Object



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

def self.make_response!(request)
  ActionDispatch::Response.create.tap do |res|
    res.request = request
  end
end

.middlewareObject

Alias for middleware_stack.



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

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.



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

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

Instance Method Details

#controller_nameObject

Delegates to the class' controller_name



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

def controller_name
  self.class.controller_name
end

#dispatch(name, request, response) ⇒ Object

:nodoc:



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

def dispatch(name, request, response) #:nodoc:
  set_request!(request)
  set_response!(response)
  process(name)
  request.commit_flash
  to_a
end

#envObject



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

def env
  @_request.env
end

#paramsObject



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

def params
  @_params ||= request.parameters
end

#params=(val) ⇒ Object



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

def params=(val)
  @_params = val
end

#performed?Boolean

Tests if render or redirect has already happened.



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

def performed?
  response_body || response.committed?
end

#reset_sessionObject



210
211
212
# File 'actionpack/lib/action_controller/metal.rb', line 210

def reset_session
  @_request.reset_session
end

#response_body=(body) ⇒ Object



174
175
176
177
178
179
180
181
182
# File 'actionpack/lib/action_controller/metal.rb', line 174

def response_body=(body)
  body = [body] unless body.nil? || body.respond_to?(:each)
  response.reset_body!
  body.each { |part|
    next if part.empty?
    response.write part
  }
  super
end

#set_request!(request) ⇒ Object

:nodoc:



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

def set_request!(request) #:nodoc:
  @_request = request
  @_request.controller_instance = self
end

#set_response!(response) ⇒ Object

:nodoc:



197
198
199
# File 'actionpack/lib/action_controller/metal.rb', line 197

def set_response!(response) # :nodoc:
  @_response = response
end

#to_aObject

:nodoc:



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

def to_a #:nodoc:
  response.to_a
end

#url_for(string) ⇒ Object

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