Spec-Zone.ru › Ruby on Rails 8.1

class ActionController::Metal

Родительский класс:
AbstractController::Base

Контроллер действий Metal

ActionController::Metal — это максимально простой контроллер, предоставляющий корректный интерфейс Rack без дополнительных удобств, которые предоставляет ActionController::Base.

Пример контроллера Metal может выглядеть так:

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

Чтобы направлять запросы к контроллеру Metal, добавьте что-нибудь подобное в config/routes.rb:

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

Метод ::action возвращает корректное приложение Rack, которому маршрутизатор Rails может передавать запросы.

Helpers

По умолчанию ActionController::Metal не предоставляет средств для отображения представлений, частичных шаблонов и других ответов, за исключением нескольких низкоуровневых методов установки, таких как response_body=, content_type= и status=. Чтобы добавить вспомогательные методы отображения, привычные для обычного контроллера, можно сделать следующее:

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

  def index
    render "hello/index"
  end
end

Перенаправление Helpers

Чтобы добавить в контроллер Metal вспомогательные методы перенаправления, выполните следующие действия:

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

  def index
    redirect_to root_url
  end
end

Другие Helpers

Список модулей, подключённых в ActionController::Base, поможет узнать, какие ещё возможности можно добавить в контроллер Metal.

Атрибуты

request [R]

Экземпляр ActionDispatch::Request для текущего запроса.

response [R]

Экземпляр ActionDispatch::Response для текущего ответа.

Открытые методы класса

action (name) Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 315
def self.action(name)
  app = lambda { |env|
    req = ActionDispatch::Request.new(env)
    res = make_response! req
    new.dispatch(name, req, res)
  }

  if middleware_stack.any?
    middleware_stack.build(name, app)
  else
    app
  end
end

Возвращает конечную точку Rack для указанного имени действия.

controller_name () Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 130
def self.controller_name
  @controller_name ||= (name.demodulize.delete_suffix("Controller").underscore unless anonymous?)
end

Возвращает последнюю часть имени контроллера в нижнем регистре с подчёркиваниями, без окончания Controller. Например, PostsController возвращает posts. Пространства имён опускаются, поэтому Admin::PostsController также возвращает posts.

Возвращает

  • string

dispatch (name, req, res) Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 331
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

Напрямую передаёт запрос контроллеру. Создаёт экземпляр контроллера, а затем выполняет действие с именем name.

make_response! (request) Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 134
def self.make_response!(request)
  ActionDispatch::Response.new.tap do |res|
    res.request = request
  end
end
middleware () Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 310
def self.middleware
  middleware_stack
end

Стек промежуточного ПО, используемый этим контроллером.

По умолчанию используется вариант ActionDispatch::MiddlewareStack, поддерживающий следующий синтаксис:

class PostsController < ApplicationController
  use AuthenticationMiddleware, except: [:index, :show]
end

Подробнее о [стеке промежуточного ПО Rails] (guides.rubyonrails.org/rails_on_rack.html#action-dispatcher-middleware-stack) читайте в руководствах.

new () Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 210
def initialize
  @_request = nil
  @_response = nil
  @_response_body = nil
  @_routes = nil
  @_params = nil
  super
end
Вызывает метод суперкласса
use (...) Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 293
def use(...)
  middleware_stack.use(...)
end

Добавляет указанные промежуточное ПО Rack и его аргументы в конец стека промежуточного ПО.

Открытые методы экземпляра

content_type () Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 204
delegate :content_type, to: "@_response"

Делегирует вызов методу ActionDispatch::Response#content_type

content_type= () Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 192
delegate :content_type=, to: "@_response"

Делегирует вызов методу ActionDispatch::Response#content_type=

controller_name () Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 156
def controller_name
  self.class.controller_name
end

Делегирует вызов методу класса ::controller_name.

headers () Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 180
delegate :headers, to: "@_response"

Делегирует вызов методу ActionDispatch::Response#headers.

location () Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 200
delegate :location, to: "@_response"

Делегирует вызов методу ActionDispatch::Response#location

location= () Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 188
delegate :location=, to: "@_response"

Делегирует вызов методу ActionDispatch::Response#location=

media_type () Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 208
delegate :media_type, to: "@_response"

Делегирует вызов методу ActionDispatch::Response#media_type

params () Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 219
def params
  @_params ||= request.parameters
end
params= (val) Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 223
def params=(val)
  @_params = val
end
performed? () Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 245
def performed?
  response_body || response.committed?
end

Проверяет, было ли уже выполнено отображение или перенаправление.

reset_session () Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 284
def reset_session
  @_request.reset_session
end
response= (response) Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 268
def response=(response)
  set_response!(response)

  # Force `performed?` to return true:
  @_response_body = true
end

Назначает ответ и помечает его как отправленный. Дальнейшая обработка не выполняется.

response_body= (body) Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 234
def response_body=(body)
  if body
    body = [body] if body.is_a?(String)
    response.body = body
    super
  else
    response.reset_body!
  end
end
Вызывает метод суперкласса
session () Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 176
delegate :session, to: "@_request"

Экземпляр ActionDispatch::Request::Session для текущего запроса. Дополнительные сведения см. в руководстве по сессиям контроллера Active.

status () Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 196
delegate :status, to: "@_response"

Делегирует вызов методу ActionDispatch::Response#status

status= () Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 184
delegate :status=, to: "@_response"

Делегирует вызов методу ActionDispatch::Response#status=

url_for (string) Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 230
def url_for(string)
  string
end

Базовый метод url_for, который можно переопределить для более широких возможностей.

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API