class ActionView::Template

Action View Template

def self.finalize_compiled_template_methods

def self.finalize_compiled_template_methods
  ActiveSupport::Deprecation.warn "ActionView::Template.finalize_compiled_template_methods is deprecated and has no effect"
end

def self.finalize_compiled_template_methods=(_)

def self.finalize_compiled_template_methods=(_)
  ActiveSupport::Deprecation.warn "ActionView::Template.finalize_compiled_template_methods= is deprecated and has no effect"
end

def compile(mod)

regardless of the original source encoding.
In general, this means that templates will be UTF-8 inside of Rails,
encode the source into Encoding.default_internal.
Otherwise, after we figure out the correct encoding, we then

specifying the encoding. For instance, ERB supports <%# encoding: %>
the template engine to support additional mechanisms for
String to the engine without further processing. This allows
If the template engine handles encodings, we send the encoded

the encoding of the compiled template.
Among other things, this method is responsible for properly setting
def compile(mod)
  source = encode!
  code = @handler.call(self, source)
  # Make sure that the resulting String to be eval'd is in the
  # encoding of the code
  original_source = source
  source = +<<-end_src
    def #{method_name}(local_assigns, output_buffer)
      @virtual_path = #{@virtual_path.inspect};#{locals_code};#{code}
    end
  end_src
  # Make sure the source is in the encoding of the returned code
  source.force_encoding(code.encoding)
  # In case we get back a String from a handler that is not in
  # BINARY or the default_internal, encode it to the default_internal
  source.encode!
  # Now, validate that the source we got back from the template
  # handler is valid in the default_internal. This is for handlers
  # that handle encoding but screw up
  unless source.valid_encoding?
    raise WrongEncodingError.new(source, Encoding.default_internal)
  end
  begin
    mod.module_eval(source, identifier, 0)
  rescue SyntaxError
    # Account for when code in the template is not syntactically valid; e.g. if we're using
    # ERB and the user writes <%= foo( %>, attempting to call a helper `foo` and interpolate
    # the result into the template, but missing an end parenthesis.
    raise SyntaxErrorInTemplate.new(self, original_source)
  end
end

def compile!(view)

just once and removes the source after it is compiled.
Compile a template. This method ensures a template is compiled
def compile!(view)
  return if @compiled
  # Templates can be used concurrently in threaded environments
  # so compilation and any instance variable modification must
  # be synchronized
  @compile_mutex.synchronize do
    # Any thread holding this lock will be compiling the template needed
    # by the threads waiting. So re-check the @compiled flag to avoid
    # re-compilation
    return if @compiled
    mod = view.compiled_method_container
    instrument("!compile_template") do
      compile(mod)
    end
    @compiled = true
  end
end

def encode!

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

the same as Encoding.default_external.
If no additional information is supplied, we assume the encoding is
source. Until this point, we assume that the source is BINARY data.
This method is responsible for properly setting the encoding of the
def encode!
  source = self.source
  return source 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

def formats; Array(format); end

def formats; Array(format); end

def formats=(_); end

def formats=(_); end

def handle_render_error(view, e)

def handle_render_error(view, e)
  if e.is_a?(Template::Error)
    e.sub_template_of(self)
    raise e
  else
    raise Template::Error.new(self)
  end
end

def identifier_method_name

def identifier_method_name
  short_identifier.tr("^a-z_", "_")
end

def initialize(source, identifier, handler, format: nil, variant: nil, locals: nil, virtual_path: nil, updated_at: nil)

def initialize(source, identifier, handler, format: nil, variant: nil, locals: nil, virtual_path: nil, updated_at: nil)
  unless locals
    ActiveSupport::Deprecation.warn "ActionView::Template#initialize requires a locals parameter"
    locals = []
  end
  @source            = source
  @identifier        = identifier
  @handler           = handler
  @compiled          = false
  @locals            = locals
  @virtual_path      = virtual_path
  @variable = if @virtual_path
    base = @virtual_path[-1] == "/" ? "" : ::File.basename(@virtual_path)
    base =~ /\A_?(.*?)(?:\.\w+)*\z/
    $1.to_sym
  end
  if updated_at
    ActiveSupport::Deprecation.warn "ActionView::Template#updated_at is deprecated"
    @updated_at        = updated_at
  else
    @updated_at        = Time.now
  end
  @format            = format
  @variant           = variant
  @compile_mutex     = Mutex.new
end

def inspect

def inspect
  "#<#{self.class.name} #{short_identifier} locals=#{@locals.inspect}>"
end

def instrument(action, &block) # :doc:

:doc:
def instrument(action, &block) # :doc:
  ActiveSupport::Notifications.instrument("#{action}.action_view", instrument_payload, &block)
end

def instrument_payload

def instrument_payload
  { virtual_path: @virtual_path, identifier: @identifier }
end

def instrument_render_template(&block)

def instrument_render_template(&block)
  ActiveSupport::Notifications.instrument("!render_template.action_view", instrument_payload, &block)
end

def locals=(_); end

def locals=(_); end

def locals_code

def locals_code
  # Only locals with valid variable names get set directly. Others will
  # still be available in local_assigns.
  locals = @locals - Module::RUBY_RESERVED_KEYWORDS
  locals = locals.grep(/\A@?(?![A-Z0-9])(?:[[:alnum:]_]|[^\0-\177])+\z/)
  # Assign for the same variable is to suppress unused variable warning
  locals.each_with_object(+"") { |key, code| code << "#{key} = local_assigns[:#{key}]; #{key} = #{key};" }
end

def marshal_dump # :nodoc:

:nodoc:
the marshalling of the compiler mutex and instantiating that again on unmarshalling.
to ensure that references to the template object can be marshalled as well. This means forgoing
Exceptions are marshalled when using the parallel test runner with DRb, so we need
def marshal_dump # :nodoc:
  [ @source, @identifier, @handler, @compiled, @locals, @virtual_path, @updated_at, @format, @variant ]
end

def marshal_load(array) # :nodoc:

:nodoc:
def marshal_load(array) # :nodoc:
  @source, @identifier, @handler, @compiled, @locals, @virtual_path, @updated_at, @format, @variant = *array
  @compile_mutex = Mutex.new
end

def method_name

def method_name
  @method_name ||= begin
    m = +"_#{identifier_method_name}__#{@identifier.hash}_#{__id__}"
    m.tr!("-", "_")
    m
  end
end

def refresh(_); self; end

def refresh(_); self; end

def render(view, locals, buffer = ActionView::OutputBuffer.new, &block)

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

exactly before rendering.
Render a template. If the template was not compiled yet, it is done
def render(view, locals, buffer = ActionView::OutputBuffer.new, &block)
  instrument_render_template do
    compile!(view)
    view._run(method_name, self, locals, buffer, &block)
  end
rescue => e
  handle_render_error(view, e)
end

def short_identifier

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

def source

def source
  @source.to_s
end

def supports_streaming?

a streaming buffer *may* be passed when it starts rendering.
Returns whether the underlying handler supports streaming. If so,
def supports_streaming?
  handler.respond_to?(:supports_streaming?) && handler.supports_streaming?
end

def type

def type
  @type ||= Types[format]
end

def variants; [variant]; end

def variants; [variant]; end

def variants=(_); end

def variants=(_); end

def virtual_path=(_); end

def virtual_path=(_); end