Class: ActionController::Renderer

Inherits:
Object
  • Object
show all
Defined in:
actionpack/lib/action_controller/renderer.rb

Overview

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)
    

Constant Summary collapse

DEFAULTS =
{
  http_host: "example.org",
  https: false,
  method: "get",
  script_name: "",
  input: ""
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(controller, env, defaults) ⇒ Renderer

Accepts a custom Rack environment to render templates in. It will be merged with the default Rack environment defined by ActionController::Renderer::DEFAULTS.


65
66
67
68
69
# File 'actionpack/lib/action_controller/renderer.rb', line 65

def initialize(controller, env, defaults)
  @controller = controller
  @defaults = defaults
  @env = normalize_keys defaults, env
end

Instance Attribute Details

#controllerObject (readonly)

Returns the value of attribute controller


37
38
39
# File 'actionpack/lib/action_controller/renderer.rb', line 37

def controller
  @controller
end

#defaultsObject (readonly)

Returns the value of attribute defaults


37
38
39
# File 'actionpack/lib/action_controller/renderer.rb', line 37

def defaults
  @defaults
end

Class Method Details

.for(controller, env = {}, defaults = DEFAULTS.dup) ⇒ Object

Create a new renderer instance for a specific controller class.


48
49
50
# File 'actionpack/lib/action_controller/renderer.rb', line 48

def self.for(controller, env = {}, defaults = DEFAULTS.dup)
  new(controller, env, defaults)
end

Instance Method Details

#new(env = {}) ⇒ Object

Create a new renderer for the same controller but with a new env.


53
54
55
# File 'actionpack/lib/action_controller/renderer.rb', line 53

def new(env = {})
  self.class.new controller, env, defaults
end

#render(*args) ⇒ Object

Render templates with any options from ActionController::Base#render_to_string.

The primary options are:

  • :partial - See ActionView::PartialRenderer for details.

  • :file - Renders an explicit template file. Add :locals to pass in, if so desired. It shouldn’t be used directly with unsanitized user input due to lack of validation.

  • :inline - Renders an ERB template string.

  • :plain - Renders provided text and sets the content type as text/plain.

  • :html - Renders the provided HTML safe string, otherwise performs HTML escape on the string first. Sets the content type as text/html.

  • :json - Renders the provided hash or object in JSON. You don't need to call .to_json on the object you want to render.

  • :body - Renders provided text and sets content type of text/plain.

If no options hash is passed or if :update is specified, then:

If an object responding to `render_in` is passed, `render_in` is called on the object, passing in the current view context.

Otherwise, a partial is rendered using the second parameter as the locals hash.


91
92
93
94
95
96
97
98
99
100
101
# File 'actionpack/lib/action_controller/renderer.rb', line 91

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

#with_defaults(defaults) ⇒ Object

Create a new renderer for the same controller but with new defaults.


58
59
60
# File 'actionpack/lib/action_controller/renderer.rb', line 58

def with_defaults(defaults)
  self.class.new controller, @env, self.defaults.merge(defaults)
end