class ActionController::Metal

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

Action Controller 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, к которому следует перенаправить.

Вспомогательные методы отображения

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

Вспомогательные методы перенаправления

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

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

  def index
    redirect_to root_url
  end
end

Другие вспомогательные методы

Вы можете обратиться к модулям, включённым в ActionController::Base, чтобы увидеть другие функции, которые вы можете добавить в свой контроллер metal.

Атрибуты

request[R]

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

response[R]

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

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

action(name) Показать исходный код

# File actionpack/lib/action_controller/metal.rb, line 289
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 305
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 284
def self.middleware
  middleware_stack
end

Стек middleware, используемый этим контроллером.

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

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

Подробнее о стеке middleware Rails см. в руководстве Rails middleware stack.

new() Показать исходный код

# File actionpack/lib/action_controller/metal.rb, line 185
def initialize
  @_request = nil
  @_response = nil
  @_response_body = nil
  @_routes = nil
  @_params = nil
  super
end

Вызывает метод суперкласса

use(...) Показать исходный код

# File actionpack/lib/action_controller/metal.rb, line 267
def use(...)
  middleware_stack.use(...)
end

Добавляет заданный middleware Rack и его аргументы в низ стека middleware.

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

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.

params() Показать исходный код

# File actionpack/lib/action_controller/metal.rb, line 194
def params
  @_params ||= request.parameters
end

params=(val) Показать исходный код

# File actionpack/lib/action_controller/metal.rb, line 198
def params=(val)
  @_params = val
end

performed?() Показать исходный код

# File actionpack/lib/action_controller/metal.rb, line 220
def performed?
  response_body || response.committed?
end

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

reset_session() Показать исходный код

# File actionpack/lib/action_controller/metal.rb, line 258
def reset_session
  @_request.reset_session
end

response=(response) Показать исходный код

# File actionpack/lib/action_controller/metal.rb, line 242
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 209
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 Controller Session.

url_for(string) Показать исходный код

# File actionpack/lib/action_controller/metal.rb, line 205
def url_for(string)
  string
end

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