Action View Template
- MODULE ActionView::Template::Handlers
- MODULE ActionView::Template::Sources
- E
- I
- L
- M
- N
- R
- S
- T
Constants
| NONE | = | Object.new |
| STRICT_LOCALS_REGEX | = | /\#\s+locals:\s+\((.*)\)/ |
Attributes
| [R] | format | |
| [RW] | frozen_string_literal | |
| [R] | handler | |
| [R] | identifier | |
| [R] | variable | |
| [R] | variant | |
| [R] | virtual_path |
Class Public methods
mime_types_implementation=(implementation) Link
Source: show
# File actionview/lib/action_view/template.rb, line 124 def mime_types_implementation=(implementation) # This method isn't thread-safe, but it's not supposed # to be called after initialization if self::Types != implementation remove_const(:Types) const_set(:Types, implementation) end end
new(source, identifier, handler, locals:, format: nil, variant: nil, virtual_path: nil) Link
Source: show
# File actionview/lib/action_view/template.rb, line 139 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
Instance Public methods
encode!() Link
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.
Source: show
# File actionview/lib/action_view/template.rb, line 243 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
inspect() Link
Source: show
# File actionview/lib/action_view/template.rb, line 222 def inspect "#<#{self.class.name} #{short_identifier} locals=#{locals.inspect}>" end
local_assigns Link
Returns a hash with the defined local variables.
Given this sub template rendering:
<%= render "shared/header", { headline: "Welcome", person: person } %>
You can use local_assigns in the sub templates to access the local variables:
local_assigns[:headline] # => "Welcome"
Source: show
# 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 :Types autoload :Sources autoload :Text autoload :Types end
locals() Link
The locals this template has been or will be compiled for, or nil if this is a strict locals template.
Source: show
# File actionview/lib/action_view/template.rb, line 162 def locals if strict_locals? nil else @locals end end
render(view, locals, buffer = nil, add_to_stack: true, &block) Link
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.
Source: show
# File actionview/lib/action_view/template.rb, line 200 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
short_identifier() Link
Source: show
# File actionview/lib/action_view/template.rb, line 218 def short_identifier @short_identifier ||= defined?(Rails.root) ? identifier.delete_prefix("#{Rails.root}/") : identifier end
source() Link
Source: show
# File actionview/lib/action_view/template.rb, line 226 def source @source.to_s end
strict_locals!() Link
This method is responsible for marking a template as having strict locals which means the template can only accept the locals defined in a magic comment. For example, if your template acceps the locals title and comment_count, add the following to your template file:
<%# locals: (title: "Default title", comment_count: 0) %>
Strict locals are useful for validating template arguments and for specifying defaults.
Source: show
# File actionview/lib/action_view/template.rb, line 288 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
strict_locals?() Link
Returns whether a template is using strict locals.
Source: show
# File actionview/lib/action_view/template.rb, line 302 def strict_locals? strict_locals! end
supports_streaming?() Link
Returns whether the underlying handler supports streaming. If so, a streaming buffer may be passed when it starts rendering.
Source: show
# File actionview/lib/action_view/template.rb, line 190 def supports_streaming? handler.respond_to?(:supports_streaming?) && handler.supports_streaming? end
translate_location(backtrace_location, spot) Link
Translate an error location returned by ErrorHighlight to the correct source location inside the template.
Source: show
# File actionview/lib/action_view/template.rb, line 180 def translate_location(backtrace_location, spot) if handler.respond_to?(:translate_location) handler.translate_location(spot, backtrace_location, encode!) || spot else spot end end
type() Link
Source: show
# File actionview/lib/action_view/template.rb, line 214 def type @type ||= Types[format] end