Class: ActionView::Template

Inherits:
Object
  • Object
show all
Extended by:
Handlers, ActiveSupport::Autoload
Defined in:
lib/action_view/template.rb,
lib/action_view/template/html.rb,
lib/action_view/template/text.rb,
lib/action_view/template/error.rb,
lib/action_view/template/types.rb,
lib/action_view/template/inline.rb,
lib/action_view/template/sources.rb,
lib/action_view/template/handlers.rb,
lib/action_view/template/raw_file.rb,
lib/action_view/template/renderable.rb,
lib/action_view/template/handlers/erb.rb,
lib/action_view/template/sources/file.rb,
lib/action_view/template/handlers/erb/erubi.rb

Overview

:nodoc:

Direct Known Subclasses

Inline

Defined Under Namespace

Modules: Handlers, Sources Classes: Error, HTML, Inline, RawFile, Renderable, SimpleType, Text

Constant Summary collapse

STRICT_LOCALS_REGEX = 
/\#\s+locals:\s+\((.*)\)/
NONE = 
Object.new
Types =

:nodoc:

SimpleType

Instance Attribute Summary collapse

Class Method 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, unregister_template_handler

Constructor Details

#initialize(source, identifier, handler, locals:, format: nil, variant: nil, virtual_path: nil) ⇒ Template

Returns a new instance of Template.



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/action_view/template.rb', line 186

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
  @strict_local_keys = nil
  @type              = nil
end

Instance Attribute Details

#format ⇒ Object (readonly)

Returns the value of attribute format.



182
183
184
 
# File 'lib/action_view/template.rb', line 182

def format
  @format
end

#frozen_string_literal ⇒ Object

Returns the value of attribute frozen_string_literal.



167
168
169
 
# File 'lib/action_view/template.rb', line 167

def frozen_string_literal
  @frozen_string_literal
end

#handler ⇒ Object (readonly)

Returns the value of attribute handler.



181
182
183
 
# File 'lib/action_view/template.rb', line 181

def handler
  @handler
end

#identifier ⇒ Object (readonly)

Returns the value of attribute identifier.



181
182
183
 
# File 'lib/action_view/template.rb', line 181

def identifier
  @identifier
end

#variable ⇒ Object (readonly)

Returns the value of attribute variable.



182
183
184
 
# File 'lib/action_view/template.rb', line 182

def variable
  @variable
end

#variant ⇒ Object (readonly)

Returns the value of attribute variant.



182
183
184
 
# File 'lib/action_view/template.rb', line 182

def variant
  @variant
end

#virtual_path ⇒ Object (readonly)

Returns the value of attribute virtual_path.



182
183
184
 
# File 'lib/action_view/template.rb', line 182

def virtual_path
  @virtual_path
end

Class Method Details

.mime_types_implementation=(implementation) ⇒ Object 



171
172
173
174
175
176
177
178
 
# File 'lib/action_view/template.rb', line 171

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

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.



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/action_view/template.rb', line 297

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 ⇒ Object 



276
277
278
 
# File 'lib/action_view/template.rb', line 276

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

#locals ⇒ Object

The locals this template has been or will be compiled for, or nil if this is a strict locals template.



210
211
212
213
214
215
216
 
# File 'lib/action_view/template.rb', line 210

def locals
  if strict_locals?
    nil
  else
    @locals
  end
end

#marshal_dump ⇒ Object

Exceptions are marshalled when using the parallel test runner with DRb, so we need to ensure that references to the template object can be marshalled as well. This means forgoing the marshalling of the compiler mutex and instantiating that again on unmarshalling.



363
364
365
 
# File 'lib/action_view/template.rb', line 363

def marshal_dump # :nodoc:
  [ @source, @identifier, @handler, @compiled, @locals, @virtual_path, @format, @variant ]
end

#marshal_load(array) ⇒ Object

:nodoc:



367
368
369
370
 
# File 'lib/action_view/template.rb', line 367

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

#method_name ⇒ Object

:nodoc:



372
373
374
375
376
377
378
 
# File 'lib/action_view/template.rb', line 372

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

#render(view, locals, buffer = nil, implicit_locals: [], add_to_stack: true, &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.



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/action_view/template.rb', line 248

def render(view, locals, buffer = nil, implicit_locals: [], add_to_stack: true, &block)
  instrument_render_template do
    compile!(view)

    if strict_locals? && @strict_local_keys && !implicit_locals.empty?
      locals_to_ignore = implicit_locals - @strict_local_keys
      locals.except!(*locals_to_ignore)
    end

    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 ⇒ Object 



272
273
274
 
# File 'lib/action_view/template.rb', line 272

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

#source ⇒ Object 



280
281
282
 
# File 'lib/action_view/template.rb', line 280

def source
  @source.to_s
end

#spot(location) ⇒ Object

:nodoc:



218
219
220
221
222
223
224
 
# File 'lib/action_view/template.rb', line 218

def spot(location) # :nodoc:
  ast = RubyVM::AbstractSyntaxTree.parse(compiled_source, keep_script_lines: true)
  node_id = RubyVM::AbstractSyntaxTree.node_id_for_backtrace_location(location)
  node = find_node_by_id(ast, node_id)

  ErrorHighlight.spot(node)
end

#strict_locals! ⇒ Object

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.



342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/action_view/template.rb', line 342

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? ⇒ Boolean

Returns whether a template is using strict locals.

Returns:

  • (Boolean) 


356
357
358
 
# File 'lib/action_view/template.rb', line 356

def strict_locals?
  strict_locals!
end

#supports_streaming? ⇒ Boolean

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

Returns:

  • (Boolean) 


238
239
240
 
# File 'lib/action_view/template.rb', line 238

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

#translate_location(backtrace_location, spot) ⇒ Object

Translate an error location returned by ErrorHighlight to the correct source location inside the template.



228
229
230
231
232
233
234
 
# File 'lib/action_view/template.rb', line 228

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 ⇒ Object 



268
269
270
 
# File 'lib/action_view/template.rb', line 268

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