Skip to Content Skip to Search

module AbstractController::Rendering

Inherits From

Constants

DEFAULT_PROTECTED_INSTANCE_VARIABLES

%i(@_action_name @_response_body @_formats @_prefixes)

Public instance methods

render(*args, &block)

Normalizes arguments and options, and then delegates to render_to_body and sticks the result in self.response_body.

Supported options depend on the underlying render_to_body implementation.

Source code GitHub 
# File actionpack/lib/abstract_controller/rendering.rb, line 27
def render(*args, &block)
  options = _normalize_render(*args, &block)
  rendered_body = render_to_body(options)
  if options[:html]
    _set_html_content_type
  else
    _set_rendered_content_type rendered_format
  end
  _set_vary_header
  self.response_body = rendered_body
end

render_to_body(options = {})

Performs the actual template rendering.

Source code GitHub 
# File actionpack/lib/abstract_controller/rendering.rb, line 51
def render_to_body(options = {})
end

render_to_string(*args, &block)

Similar to render, but only returns the rendered template as a string, instead of setting self.response_body.

If a component extends the semantics of response_body (as ActionController extends it to be anything that responds to the method each), this method needs to be overridden in order to still return a string.

Source code GitHub 
# File actionpack/lib/abstract_controller/rendering.rb, line 45
def render_to_string(*args, &block)
  options = _normalize_render(*args, &block)
  render_to_body(options)
end

rendered_format()

Returns Content-Type of rendered content.

Source code GitHub 
# File actionpack/lib/abstract_controller/rendering.rb, line 55
def rendered_format
  Mime[:text]
end

view_assigns()

This method should return a hash with assigns. You can overwrite this configuration per controller.

Source code GitHub 
# File actionpack/lib/abstract_controller/rendering.rb, line 63
def view_assigns
  variables = instance_variables - _protected_ivars

  variables.each_with_object({}) do |name, hash|
    hash[name.slice(1, name.length)] = instance_variable_get(name)
  end
end

Private instance methods

_normalize_args(action = nil, options = {})

Normalize args by converting render "foo" to render action: "foo" and render "foo/bar" to render file: "foo/bar".

Source code GitHub 
# File actionpack/lib/abstract_controller/rendering.rb, line 74
def _normalize_args(action = nil, options = {}) # :doc:
  if action.respond_to?(:permitted?)
    if action.permitted?
      action
    else
      raise ArgumentError, "render parameters are not permitted"
    end
  elsif action.is_a?(Hash)
    action
  else
    options
  end
end

_normalize_options(options)

Normalize options.

Source code GitHub 
# File actionpack/lib/abstract_controller/rendering.rb, line 89
def _normalize_options(options) # :doc:
  options
end

_process_options(options)

Process extra options.

Source code GitHub 
# File actionpack/lib/abstract_controller/rendering.rb, line 94
def _process_options(options) # :doc:
  options
end

Definition files