Module: AbstractController::Rendering
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Included In:
::ActionController::Base,
::ActionMailer::Base,
::ActionView::TestCase::TestController,
Rails::ApplicationController,
Rails::InfoController,
Rails::MailersController,
Rails::WelcomeController
| |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::ActiveSupport::Concern
|
|
Instance Chain:
self,
::ActionView::ViewPaths
|
|
Defined in: | actionpack/lib/abstract_controller/rendering.rb |
Constant Summary
-
DEFAULT_PROTECTED_INSTANCE_VARIABLES =
# File 'actionpack/lib/abstract_controller/rendering.rb', line 57Set.new %w( @_action_name @_response_body @_formats @_prefixes @_config @_view_context_class @_view_renderer @_lookup_context @_routes @_db_runtime ).map(&:to_sym)
::ActionView::ViewPaths - Attributes & Methods
Class Method Summary
::ActiveSupport::Concern - Extended
Instance Attribute Summary
::ActionView::ViewPaths - Included
Instance Method Summary
-
#_normalize_args(action = nil, options = {})
Normalize args by converting render “foo” to render
:action
=> “foo” and render “foo/bar” to render:file
=> “foo/bar”. -
#_normalize_options(options)
Normalize options.
-
#_normalize_render(*args, &block)
Normalize args and options.
-
#_process_format(format, options = {})
Process the rendered format.
-
#_process_options(options)
Process extra options.
-
#render(*args, &block)
Normalize arguments, options and then delegates render_to_body and sticks the result in self.response_body.
-
#render_to_body(options = {})
Performs the actual template rendering.
-
#render_to_string(*args, &block)
Raw rendering of a template to a string.
-
#rendered_format
Returns Content-Type of rendered content :api: public.
-
#view_assigns
This method should return a hash with assigns.
::ActionView::ViewPaths - Included
#append_view_path, #details_for_lookup, | |
#lookup_context | LookupContext is the object responsible to hold all information required to lookup templates, i.e. view paths and details. |
#prepend_view_path, #template_exists? |
Class Attribute Details
._view_paths (rw)
[ GitHub ]# File 'actionview/lib/action_view/view_paths.rb', line 8
class_attribute :_view_paths
._view_paths? ⇒ Boolean
(rw)
[ GitHub ]
# File 'actionview/lib/action_view/view_paths.rb', line 8
class_attribute :_view_paths
Instance Attribute Details
#_view_paths (rw)
[ GitHub ]# File 'actionview/lib/action_view/view_paths.rb', line 8
class_attribute :_view_paths
#_view_paths? ⇒ Boolean
(rw)
[ GitHub ]
# File 'actionview/lib/action_view/view_paths.rb', line 8
class_attribute :_view_paths
Instance Method Details
#_normalize_args(action = nil, options = {})
Normalize args by converting render “foo” to render :action
=> “foo” and render “foo/bar” to render :file
=> “foo/bar”. :api: plugin
# File 'actionpack/lib/abstract_controller/rendering.rb', line 79
def _normalize_args(action=nil, ={}) 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 end end
#_normalize_options(options)
Normalize options. :api: plugin
# File 'actionpack/lib/abstract_controller/rendering.rb', line 95
def ( ) end
#_normalize_render(*args, &block)
Normalize args and options. :api: private
# File 'actionpack/lib/abstract_controller/rendering.rb', line 112
def _normalize_render(*args, &block) = _normalize_args(*args, &block) #TODO: remove defined? when we restore AP <=> AV dependency if defined?(request) && request && request.variant.present? [:variant] = request.variant end ( ) end
#_process_format(format, options = {})
Process the rendered format. :api: private
# File 'actionpack/lib/abstract_controller/rendering.rb', line 107
def _process_format(format, = {}) end
#_process_options(options)
Process extra options. :api: plugin
# File 'actionpack/lib/abstract_controller/rendering.rb', line 101
def ( ) end
#render(*args, &block)
Normalize arguments, options and then delegates render_to_body and sticks the result in self.response_body. :api: public
# File 'actionpack/lib/abstract_controller/rendering.rb', line 23
def render(*args, &block) = _normalize_render(*args, &block) self.response_body = render_to_body( ) _process_format(rendered_format, ) if rendered_format self.response_body end
#render_to_body(options = {})
Performs the actual template rendering. :api: public
# File 'actionpack/lib/abstract_controller/rendering.rb', line 48
def render_to_body( = {}) end
#render_to_string(*args, &block)
Raw rendering of a template to a string.
It is similar to render, except that it does not set the response_body and it should be guaranteed to always return a string.
If a component extends the semantics of response_body (as Action Controller extends it to be anything that responds to the method each), this method needs to be overridden in order to still return a string. :api: plugin
# File 'actionpack/lib/abstract_controller/rendering.rb', line 41
def render_to_string(*args, &block) = _normalize_render(*args, &block) render_to_body( ) end
#rendered_format
Returns Content-Type of rendered content :api: public
# File 'actionpack/lib/abstract_controller/rendering.rb', line 53
def rendered_format Mime::TEXT end
#view_assigns
This method should return a hash with assigns. You can overwrite this configuration per controller. :api: public
# File 'actionpack/lib/abstract_controller/rendering.rb', line 66
def view_assigns protected_vars = _protected_ivars variables = instance_variables variables.reject! { |s| protected_vars.include? s } variables.each_with_object({}) { |name, hash| hash[name.slice(1, name.length)] = instance_variable_get(name) } end