2013-07-11 08:18:06 -04:00
require 'active_support/concern'
require 'active_support/core_ext/class/attribute'
2009-02-24 20:25:21 -05:00
module AbstractController
2009-12-12 19:48:34 -05:00
class DoubleRenderError < Error
DEFAULT_MESSAGE = " Render and/or redirect were called multiple times in this action. Please note that you may only call render OR redirect, and at most once per action. Also note that neither redirect nor render terminate execution of the action, so if you want to exit an action after redirecting, you need to do something like \" redirect_to(...) and return \" . "
def initialize ( message = nil )
super ( message || DEFAULT_MESSAGE )
end
end
2013-07-05 08:34:39 -04:00
module Rendering
2013-07-12 07:01:10 -04:00
extend ActiveSupport :: Concern
2013-07-11 08:18:06 -04:00
2013-09-02 17:05:42 -04:00
included do
class_attribute :protected_instance_variables
self . protected_instance_variables = [ ]
end
2013-09-03 08:57:33 -04:00
# Normalize arguments, options and then delegates render_to_body and
# sticks the result in self.response_body.
# :api: public
def render ( * args , & block )
end
2013-07-05 08:34:39 -04:00
# 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
def render_to_string ( * args , & block )
2013-09-03 08:57:33 -04:00
options = _normalize_render ( * args , & block )
render_to_body ( options )
2013-07-05 08:34:39 -04:00
end
# Raw rendering of a template.
2013-07-19 06:02:09 -04:00
# :api: public
2013-09-03 08:57:33 -04:00
def render_to_body ( options = { } )
_process_options ( options )
_render_template ( options )
2013-07-05 08:34:39 -04:00
end
2013-08-01 20:27:28 -04:00
# Return Content-Type of rendered content
# :api: public
def rendered_format
2013-09-03 08:58:46 -04:00
Mime :: TEXT
2013-08-01 20:27:28 -04:00
end
2013-09-02 17:06:14 -04:00
DEFAULT_PROTECTED_INSTANCE_VARIABLES = %w(
@_action_name @_response_body @_formats @_prefixes @_config
@_view_context_class @_view_renderer @_lookup_context
)
2013-07-05 08:34:39 -04:00
# This method should return a hash with assigns.
# You can overwrite this configuration per controller.
# :api: public
def view_assigns
2013-07-11 08:18:06 -04:00
hash = { }
2013-09-02 17:05:42 -04:00
variables = instance_variables
variables -= protected_instance_variables
2013-09-02 17:06:14 -04:00
variables -= DEFAULT_PROTECTED_INSTANCE_VARIABLES
2013-09-02 17:05:42 -04:00
variables . each { | name | hash [ name [ 1 .. - 1 ] ] = instance_variable_get ( name ) }
2013-07-11 08:18:06 -04:00
hash
2013-07-05 08:34:39 -04:00
end
# Normalize args by converting render "foo" to render :action => "foo" and
# render "foo/bar" to render :file => "foo/bar".
# :api: plugin
def _normalize_args ( action = nil , options = { } )
options
end
# Normalize options.
# :api: plugin
def _normalize_options ( options )
options
end
# Process extra options.
# :api: plugin
def _process_options ( options )
options
end
2013-09-03 08:57:33 -04:00
# Normalize args and options.
# :api: private
def _normalize_render ( * args , & block )
options = _normalize_args ( * args , & block )
_normalize_options ( options )
options
end
2013-07-05 08:34:39 -04:00
end
2013-09-03 09:03:56 -04:00
# Basic rendering implements the most minimal rendering layer.
# It only supports rendering :text and :nothing. Passing any other option will
# result in `UnsupportedOperationError` exception. For more functionality like
# different formats, layouts etc. you should use `ActionView` gem.
module BasicRendering
extend ActiveSupport :: Concern
# Render text or nothing (empty string) to response_body
# :api: public
def render ( * args , & block )
super ( * args , & block )
opts = args . first
if opts . has_key? ( :text ) && opts [ :text ] . present?
self . response_body = opts [ :text ]
elsif opts . has_key? ( :nothing ) && opts [ :nothing ]
self . response_body = " "
else
raise UnsupportedOperationError
end
end
class UnsupportedOperationError < StandardError
def initialize
super " Unsupported render operation. BasicRendering supports only :text and :nothing options. For more, you need to include ActionView. "
end
end
end
2010-01-31 21:32:28 -05:00
end