Action View Template

Action View Template Handlers

Action View Text Template

Namespace
Methods
E
I
M
N
R
S
T
Constants
Finalizer = proc do |method_name, mod| proc do mod.module_eval do remove_possible_method method_name end end end
 

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

Attributes
[RW] formats
[R] handler
[R] identifier
[RW] locals
[R] original_encoding
[R] source
[R] updated_at
[RW] virtual_path
Class Public methods
new(source, identifier, handler, details)
# File actionpack/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 Public methods
encode!()

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.

# File actionpack/lib/action_view/template.rb, line 192
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
inspect()
# File actionpack/lib/action_view/template.rb, line 178
def inspect
  @inspect ||= defined?(Rails.root) ? identifier.sub("#{Rails.root}/", '') : identifier
end
mime_type()
# File actionpack/lib/action_view/template.rb, line 149
def mime_type
  message = 'Template#mime_type is deprecated and will be removed in Rails 4.1. Please use type method instead.'
  ActiveSupport::Deprecation.warn message
  @mime_type ||= Mime::Type.lookup_by_extension(@formats.first.to_s) if @formats.first
end
refresh(view)

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).

# File actionpack/lib/action_view/template.rb, line 167
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)

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.

# File actionpack/lib/action_view/template.rb, line 140
def render(view, locals, buffer=nil, &block)
  ActiveSupport::Notifications.instrument("!render_template.action_view", virtual_path: @virtual_path, identifier: @identifier) do
    compile!(view)
    view.send(method_name, locals, buffer, &block)
  end
rescue Exception => e
  handle_render_error(view, e)
end
supports_streaming?()

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

# File actionpack/lib/action_view/template.rb, line 130
def supports_streaming?
  handler.respond_to?(:supports_streaming?) && handler.supports_streaming?
end
type()
# File actionpack/lib/action_view/template.rb, line 155
def type
  @type ||= Types[@formats.first] if @formats.first
end