Action View Template

# File actionview/lib/action_view/template.rb, line 127
def initialize(source, identifier, handler, locals:, format: nil, variant: nil, virtual_path: nil)
  @source            = source.dup
  @identifier        = identifier
  @handler           = handler
  @compiled          = false
  @locals            = locals
  @virtual_path      = virtual_path

  @variable = if @virtual_path
    base = @virtual_path.end_with?("/") ? "" : ::File.basename(@virtual_path)
    base =~ /\A_?(.*?)(?:\.\w+)*\z/
    $1.to_sym
  end

  @format            = format
  @variant           = variant
  @compile_mutex     = Mutex.new
  @strict_locals     = NONE
  @type              = nil
end

# File actionview/lib/action_view/template.rb, line 231
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!(LEADING_ENCODING_REGEXP, "")
    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

# File actionview/lib/action_view/template.rb, line 210
def inspect
  "#<#{self.class.name} #{short_identifier} locals=#{locals.inspect}>"
end

# File actionview/lib/action_view/template.rb, line 105
eager_autoload do
  autoload :Error
  autoload :RawFile
  autoload :Renderable
  autoload :Handlers
  autoload :HTML
  autoload :Inline
  autoload :Sources
  autoload :Text
  autoload :Types
end

# File actionview/lib/action_view/template.rb, line 150
def locals
  if strict_locals?
    nil
  else
    @locals
  end
end

# File actionview/lib/action_view/template.rb, line 188
def render(view, locals, buffer = nil, add_to_stack: true, &block)
  instrument_render_template do
    compile!(view)
    if buffer
      view._run(method_name, self, locals, buffer, add_to_stack: add_to_stack, has_strict_locals: strict_locals?, &block)
      nil
    else
      view._run(method_name, self, locals, OutputBuffer.new, add_to_stack: add_to_stack, has_strict_locals: strict_locals?, &block)&.to_s
    end
  end
rescue => e
  handle_render_error(view, e)
end

# File actionview/lib/action_view/template.rb, line 206
def short_identifier
  @short_identifier ||= defined?(Rails.root) ? identifier.delete_prefix("#{Rails.root}/") : identifier
end

# File actionview/lib/action_view/template.rb, line 214
def source
  @source.to_s
end

# File actionview/lib/action_view/template.rb, line 276
def strict_locals!
  if @strict_locals == NONE
    self.source.sub!(STRICT_LOCALS_REGEX, "")
    @strict_locals = $1

    return if @strict_locals.nil? # Magic comment not found

    @strict_locals = "**nil" if @strict_locals.blank?
  end

  @strict_locals
end

# File actionview/lib/action_view/template.rb, line 290
def strict_locals?
  strict_locals!
end

# File actionview/lib/action_view/template.rb, line 178
def supports_streaming?
  handler.respond_to?(:supports_streaming?) && handler.supports_streaming?
end

# File actionview/lib/action_view/template.rb, line 168
def translate_location(backtrace_location, spot)
  if handler.respond_to?(:translate_location)
    handler.translate_location(spot, backtrace_location, encode!)
  else
    spot
  end
end

# File actionview/lib/action_view/template.rb, line 202
def type
  @type ||= Types[format]
end

# File actionview/lib/action_view/template.rb, line 471
def instrument(action, &block) # :doc:
  ActiveSupport::Notifications.instrument("#{action}.action_view", instrument_payload, &block)
end