модуль ActionController::Renderers

Константы

RENDERERS: Множество, содержащее имена рендереров, соответствующие доступным процедурам рендеринга. Значения по умолчанию — :json, :js, :xml.

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

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

# File actionpack/lib/action_controller/metal/renderers.rb, line 90
def self._render_with_renderer_method_name(key)
  "_render_with_renderer_#{key}"
end

add(key, &block) Показать исходный код

# File actionpack/lib/action_controller/metal/renderers.rb, line 74
def self.add(key, &block)
  define_method(_render_with_renderer_method_name(key), &block)
  RENDERERS << key.to_sym
end

Добавляет новый рендер для вызова в действиях контроллера. Рендер вызывается, передавая его имя в качестве параметра AbstractController::Rendering#render. Для создания рендера передайте ему имя и блок. Блок принимает два аргумента: первый — значение, связанное с его ключом, а второй — оставшуюся хэш-таблицу опций, переданных в render.

Создайте рендер csv:

ActionController::Renderers.add :csv do |obj, options|
  filename = options[:filename] || 'data'
  str = obj.respond_to?(:to_csv) ? obj.to_csv : obj.to_s
  send_data str, type: Mime[:csv],
    disposition: "attachment; filename=#{filename}.csv"
end

Обратите внимание, что мы использовали Mime для типа mime csv, так как он поставляется с Rails. Для пользовательского рендера вам необходимо зарегистрировать тип mime с Mime::Type.register.

Для использования рендера csv в действии контроллера:

def show
  @csvable = Csvable.find(params[:id])
  respond_to do |format|
    format.html
    format.csv { render csv: @csvable, filename: @csvable.name }
  end
end

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

# File actionpack/lib/action_controller/metal/renderers.rb, line 84
def self.remove(key)
  RENDERERS.delete(key.to_sym)
  method_name = _render_with_renderer_method_name(key)
  remove_method(method_name) if method_defined?(method_name)
end

Этот метод является обратным методу add.

Для удаления рендера csv:

ActionController::Renderers.remove(:csv)

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

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

# File actionpack/lib/action_controller/metal/renderers.rb, line 145
def _render_to_body_with_renderer(options)
  _renderers.each do |name|
    if options.key?(name)
      _process_options(options)
      method_name = Renderers._render_with_renderer_method_name(name)
      return send(method_name, options.delete(name), options)
    end
  end
  nil
end

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

# File actionpack/lib/action_controller/metal/renderers.rb, line 141
def render_to_body(options)
  _render_to_body_with_renderer(options) || super
end

Вызывается render в AbstractController::Rendering, который задаёт возвращаемое значение в качестве response_body.

Если рендер не найден, super возвращает управление методу ActionView::Rendering.render_to_body, если он присутствует.

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