ActionController::Renderer
allows you to render arbitrary templates without requirement of being in controller actions.
You get a concrete renderer class by invoking ActionController::Base#renderer. For example:
ApplicationController.renderer
It allows you to call method render
directly.
ApplicationController.renderer.render template: '...'
You can use this shortcut in a controller, instead of the previous example:
ApplicationController.render template: '...'
render
allows you to use the same options that you can use when rendering in a controller. For example:
FooController.render :action, locals: { ... }, assigns: { ... }
The template will be rendered in a Rack environment which is accessible through ActionController::Renderer#env. You can set it up in two ways:
-
by changing renderer defaults, like
ApplicationController.renderer.defaults # => hash with default Rack environment
-
by initializing an instance of renderer by passing it a custom environment.
ApplicationController.renderer.new(method: 'post', https: true)
- F
- N
- R
- W
Constants
DEFAULTS | = | { http_host: "example.org", https: false, method: "get", script_name: "", input: "" }.freeze |
RACK_KEY_TRANSLATION | = | { http_host: "HTTP_HOST", https: "HTTPS", method: "REQUEST_METHOD", script_name: "SCRIPT_NAME", input: "rack.input" } |
Attributes
[R] | controller | |
[R] | defaults |
Class Public methods
for(controller, env = {}, defaults = DEFAULTS.dup) Link
Create a new renderer instance for a specific controller class.
new(controller, env, defaults) Link
Accepts a custom Rack environment to render templates in. It will be merged with the default Rack environment defined by ActionController::Renderer::DEFAULTS
.
Instance Public methods
new(env = {}) Link
Create a new renderer for the same controller but with a new env.
render(*args) Link
Renders a template to a string, just like ActionController::Rendering#render_to_string
.
# File actionpack/lib/action_controller/renderer.rb, line 72 def render(*args) raise "missing controller" unless controller request = ActionDispatch::Request.new @env request.routes = controller._routes instance = controller.new instance.set_request! request instance.set_response! controller.make_response!(request) instance.render_to_string(*args) end