Class: ActionView::Renderer

Inherits:
Object show all
Defined in:
actionview/lib/action_view/renderer/renderer.rb

Overview

This is the main entry point for rendering. It basically delegates to other objects like TemplateRenderer and PartialRenderer which actually renders the template.

The Renderer will parse the options from the render or render_body method and render a partial or a template based on the options. The TemplateRenderer and PartialRenderer objects are wrappers which do all the setup and logic necessary to render a view and a new object is created each time render is called.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(lookup_context) ⇒ Renderer

Returns a new instance of Renderer.


16
17
18
# File 'actionview/lib/action_view/renderer/renderer.rb', line 16

def initialize(lookup_context)
  @lookup_context = lookup_context
end

Instance Attribute Details

#lookup_contextObject

Returns the value of attribute lookup_context


14
15
16
# File 'actionview/lib/action_view/renderer/renderer.rb', line 14

def lookup_context
  @lookup_context
end

Instance Method Details

#cache_hitsObject

:nodoc:


59
60
61
# File 'actionview/lib/action_view/renderer/renderer.rb', line 59

def cache_hits # :nodoc:
  @cache_hits ||= {}
end

#render(context, options) ⇒ Object

Main render entry point shared by Action View and Action Controller.


21
22
23
# File 'actionview/lib/action_view/renderer/renderer.rb', line 21

def render(context, options)
  render_to_object(context, options).body
end

#render_body(context, options) ⇒ Object

Render but returns a valid Rack body. If fibers are defined, we return a streaming body that renders the template piece by piece.

Note that partials are not supported to be rendered with streaming, so in such cases, we just wrap them in an array.


41
42
43
44
45
46
47
# File 'actionview/lib/action_view/renderer/renderer.rb', line 41

def render_body(context, options)
  if options.key?(:partial)
    [render_partial(context, options)]
  else
    StreamingTemplateRenderer.new(@lookup_context).render(context, options)
  end
end

#render_partial(context, options, &block) ⇒ Object

Direct access to partial rendering.


55
56
57
# File 'actionview/lib/action_view/renderer/renderer.rb', line 55

def render_partial(context, options, &block) #:nodoc:
  render_partial_to_object(context, options, &block).body
end

#render_partial_to_object(context, options, &block) ⇒ Object

:nodoc:


67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'actionview/lib/action_view/renderer/renderer.rb', line 67

def render_partial_to_object(context, options, &block) #:nodoc:
  partial = options[:partial]
  if String === partial
    collection = collection_from_options(options)

    if collection
      # Collection + Partial
      renderer = CollectionRenderer.new(@lookup_context, options)
      renderer.render_collection_with_partial(collection, partial, context, block)
    else
      if options.key?(:object)
        # Object + Partial
        renderer = ObjectRenderer.new(@lookup_context, options)
        renderer.render_object_with_partial(options[:object], partial, context, block)
      else
        # Partial
        renderer = PartialRenderer.new(@lookup_context, options)
        renderer.render(partial, context, block)
      end
    end
  else
    collection = collection_from_object(partial) || collection_from_options(options)

    if collection
      # Collection + Derived Partial
      renderer = CollectionRenderer.new(@lookup_context, options)
      renderer.render_collection_derive_partial(collection, context, block)
    else
      # Object + Derived Partial
      renderer = ObjectRenderer.new(@lookup_context, options)
      renderer.render_object_derive_partial(partial, context, block)
    end
  end
end

#render_template(context, options) ⇒ Object

Direct access to template rendering.


50
51
52
# File 'actionview/lib/action_view/renderer/renderer.rb', line 50

def render_template(context, options) #:nodoc:
  render_template_to_object(context, options).body
end

#render_template_to_object(context, options) ⇒ Object

:nodoc:


63
64
65
# File 'actionview/lib/action_view/renderer/renderer.rb', line 63

def render_template_to_object(context, options) #:nodoc:
  TemplateRenderer.new(@lookup_context).render(context, options)
end

#render_to_object(context, options) ⇒ Object

:nodoc:


25
26
27
28
29
30
31
32
33
34
# File 'actionview/lib/action_view/renderer/renderer.rb', line 25

def render_to_object(context, options) # :nodoc:
  if options.key?(:partial)
    render_partial_to_object(context, options)
  elsif options.key?(:object)
    object = options[:object]
    AbstractRenderer::RenderedTemplate.new(object.render_in(context), object)
  else
    render_template_to_object(context, options)
  end
end