Spec-Zone.ru › Ruby on Rails 7.0

класс ActionController::Metal

Родитель:
AbstractController::Base

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.

Публичные методы класса

action(name) Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 231
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 126
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 247
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 130
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 226
def self.middleware
  middleware_stack
end

Псевдоним для middleware_stack.

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

Добавляет заданный Rack-миддлвеар и его аргументы в нижнюю часть стека миддлвеара.

Публичные методы экземпляра

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

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

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

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

reset_session() Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 206
def reset_session
  @_request.reset_session
end
response_body=(body) Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 172
def response_body=(body)
  body = [body] unless body.nil? || body.respond_to?(:each)
  response.reset_body!
  return unless body
  response.body = body
  super
end
Вызов метода суперкласса
url_for(string) Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 168
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