Spec-Zone.ru › Ruby on Rails 5.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 может передавать запросы.

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

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.

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

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

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

call(env) Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 233
def self.call(env)
  req = ActionDispatch::Request.new env
  action(req.path_parameters[:action]).call(env)
end

Превращает контроллер в конечную точку Rack, которая выполняет действие в ключе env заданного action_dispatch.request.path_parameters.

controller_name() Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 132
def self.controller_name
  @controller_name ||= name.demodulize.sub(/Controller$/, '').underscore
end

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

Возвращает

  • string

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

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

new() Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 152
def initialize
  @_request = nil
  @_response = nil
  @_routes = nil
  super
end
Вызывает метод родительского класса
use(*args, &block) Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 222
def self.use(*args, &block)
  middleware_stack.use(*args, &block)
end

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

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

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

Делегирует классу controller_name

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

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

reset_session() Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 208
def reset_session
  @_request.reset_session
end
response_body=(body) Показать исходный код
# 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!
  return unless body
  response.body = body
  super
end
Вызывает метод родительского класса
url_for(string) Показать исходный код
# File actionpack/lib/action_controller/metal.rb, line 170
def url_for(string)
  string
end

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

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

Spec-Zone.ru

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