Class: ActionView::Template

Inherits:
Object show all
Extended by:
Handlers, ActiveSupport::Autoload
Defined in:
actionview/lib/action_view/template.rb,
actionview/lib/action_view/template/text.rb,
actionview/lib/action_view/template/error.rb,
actionview/lib/action_view/template/types.rb,
actionview/lib/action_view/template/handlers.rb,
actionview/lib/action_view/template/handlers/erb.rb

Overview

Action View Template Handlers

Defined Under Namespace

Modules: Handlers Classes: Error, Text, Types

Constant Summary collapse

Finalizer =

This finalizer is needed (and exactly with a proc inside another proc) otherwise templates leak in development.

proc do |method_name, mod|
  proc do
    mod.module_eval do
      remove_possible_method method_name
    end
  end
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Handlers

extended, extensions, handler_for_extension, register_default_template_handler, register_template_handler, registered_template_handler, template_handler_extensions

Methods included from ActiveSupport::Autoload

autoload, autoload_at, autoload_under, autoloads, eager_autoload, eager_load!, extended

Constructor Details

#initialize(source, identifier, handler, details) ⇒ Template

Returns a new instance of Template


113
114
115
116
117
118
119
120
121
122
123
124
125
126
# File 'actionview/lib/action_view/template.rb', line 113

def initialize(source, identifier, handler, details)
  format = details[:format] || (handler.default_format if handler.respond_to?(:default_format))

  @source            = source
  @identifier        = identifier
  @handler           = handler
  @compiled          = false
  @original_encoding = nil
  @locals            = details[:locals] || []
  @virtual_path      = details[:virtual_path]
  @updated_at        = details[:updated_at] || Time.now
  @formats           = Array(format).map { |f| f.respond_to?(:ref) ? f.ref : f  }
  @compile_mutex     = Mutex.new
end

Instance Attribute Details

#formatsObject

Returns the value of attribute formats


99
100
101
# File 'actionview/lib/action_view/template.rb', line 99

def formats
  @formats
end

#handlerObject (readonly)

Returns the value of attribute handler


101
102
103
# File 'actionview/lib/action_view/template.rb', line 101

def handler
  @handler
end

#identifierObject (readonly)

Returns the value of attribute identifier


101
102
103
# File 'actionview/lib/action_view/template.rb', line 101

def identifier
  @identifier
end

#localsObject

Returns the value of attribute locals


99
100
101
# File 'actionview/lib/action_view/template.rb', line 99

def locals
  @locals
end

#original_encodingObject (readonly)

Returns the value of attribute original_encoding


101
102
103
# File 'actionview/lib/action_view/template.rb', line 101

def original_encoding
  @original_encoding
end

#sourceObject (readonly)

Returns the value of attribute source


101
102
103
# File 'actionview/lib/action_view/template.rb', line 101

def source
  @source
end

#updated_atObject (readonly)

Returns the value of attribute updated_at


101
102
103
# File 'actionview/lib/action_view/template.rb', line 101

def updated_at
  @updated_at
end

#virtual_pathObject

Returns the value of attribute virtual_path


99
100
101
# File 'actionview/lib/action_view/template.rb', line 99

def virtual_path
  @virtual_path
end

Instance Method Details

#encode!Object

This method is responsible for properly setting the encoding of the source. Until this point, we assume that the source is BINARY data. If no additional information is supplied, we assume the encoding is the same as Encoding.default_external.

The user can also specify the encoding via a comment on the first line of the template (# encoding: NAME-OF-ENCODING). This will work with any template engine, as we process out the encoding comment before passing the source on to the template engine, leaving a blank line in its stead.


186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
# File 'actionview/lib/action_view/template.rb', line 186

def encode!
  return unless source.encoding == Encoding::BINARY

  # Look for # encoding: *. If we find one, we'll encode the
  # String in that encoding, otherwise, we'll use the
  # default external encoding.
  if source.sub!(/\A#{ENCODING_FLAG}/, '')
    encoding = magic_encoding = $1
  else
    encoding = Encoding.default_external
  end

  # Tag the source with the default external encoding
  # or the encoding specified in the file
  source.force_encoding(encoding)

  # If the user didn't specify an encoding, and the handler
  # handles encodings, we simply pass the String as is to
  # the handler (with the default_external tag)
  if !magic_encoding && @handler.respond_to?(:handles_encoding?) && @handler.handles_encoding?
    source
  # Otherwise, if the String is valid in the encoding,
  # encode immediately to default_internal. This means
  # that if a handler doesn't handle encodings, it will
  # always get Strings in the default_internal
  elsif source.valid_encoding?
    source.encode!
  # Otherwise, since the String is invalid in the encoding
  # specified, raise an exception
  else
    raise WrongEncodingError.new(source, encoding)
  end
end

#inspectObject


172
173
174
# File 'actionview/lib/action_view/template.rb', line 172

def inspect
  @inspect ||= defined?(Rails.root) ? identifier.sub("#{Rails.root}/", '') : identifier
end

#refresh(view) ⇒ Object

Receives a view object and return a template similar to self by using @virtual_path.

This method is useful if you have a template object but it does not contain its source anymore since it was already compiled. In such cases, all you need to do is to call refresh passing in the view object.

Notice this method raises an error if the template to be refreshed does not have a virtual path set (true just for inline templates).


161
162
163
164
165
166
167
168
169
170
# File 'actionview/lib/action_view/template.rb', line 161

def refresh(view)
  raise "A template needs to have a virtual path in order to be refreshed" unless @virtual_path
  lookup  = view.lookup_context
  pieces  = @virtual_path.split("/")
  name    = pieces.pop
  partial = !!name.sub!(/^_/, "")
  lookup.disable_cache do
    lookup.find_template(name, [ pieces.join('/') ], partial, @locals)
  end
end

#render(view, locals, buffer = nil, &block) ⇒ Object

Render a template. If the template was not compiled yet, it is done exactly before rendering.

This method is instrumented as “!render_template.action_view”. Notice that we use a bang in this instrumentation because you don't want to consume this in production. This is only slow if it's being listened to.


140
141
142
143
144
145
146
147
# File 'actionview/lib/action_view/template.rb', line 140

def render(view, locals, buffer=nil, &block)
  instrument("!render_template") do
    compile!(view)
    view.send(method_name, locals, buffer, &block)
  end
rescue Exception => e
  handle_render_error(view, e)
end

#supports_streaming?Boolean

Returns if the underlying handler supports streaming. If so, a streaming buffer may be passed when it start rendering.

Returns:

  • (Boolean)

130
131
132
# File 'actionview/lib/action_view/template.rb', line 130

def supports_streaming?
  handler.respond_to?(:supports_streaming?) && handler.supports_streaming?
end

#typeObject


149
150
151
# File 'actionview/lib/action_view/template.rb', line 149

def type
  @type ||= Types[@formats.first] if @formats.first
end