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.



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/action_view/template.rb', line 199

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.



195
196
197
 
# File 'lib/action_view/template.rb', line 195

def format
  @format
end

#frozen_string_literal ⇒ Object

Returns the value of attribute frozen_string_literal.



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

def frozen_string_literal
  @frozen_string_literal
end

#handler ⇒ Object (readonly)

Returns the value of attribute handler.



194
195
196
 
# File 'lib/action_view/template.rb', line 194

def handler
  @handler
end

#identifier ⇒ Object (readonly)

Returns the value of attribute identifier.



194
195
196
 
# File 'lib/action_view/template.rb', line 194

def identifier
  @identifier
end

#variable ⇒ Object (readonly)

Returns the value of attribute variable.



195
196
197
 
# File 'lib/action_view/template.rb', line 195

def variable
  @variable
end

#variant ⇒ Object (readonly)

Returns the value of attribute variant.



195
196
197
 
# File 'lib/action_view/template.rb', line 195

def variant
  @variant
end

#virtual_path ⇒ Object (readonly)

Returns the value of attribute virtual_path.



195
196
197
 
# File 'lib/action_view/template.rb', line 195

def virtual_path
  @virtual_path
end

Class Method Details

.mime_types_implementation=(implementation) ⇒ Object 



184
185
186
187
188
189
190
191
 
# File 'lib/action_view/template.rb', line 184

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.



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/action_view/template.rb', line 321

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 



300
301
302
 
# File 'lib/action_view/template.rb', line 300

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.



223
224
225
226
227
228
229
 
# File 'lib/action_view/template.rb', line 223

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.



387
388
389
 
# File 'lib/action_view/template.rb', line 387

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

#marshal_load(array) ⇒ Object

:nodoc:



391
392
393
394
 
# File 'lib/action_view/template.rb', line 391

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

#method_name ⇒ Object

:nodoc:



396
397
398
399
400
401
402
 
# File 'lib/action_view/template.rb', line 396

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.



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/action_view/template.rb', line 271

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
      result = view._run(method_name, self, locals, OutputBuffer.new, add_to_stack: add_to_stack, has_strict_locals: strict_locals?, &block)
      result.is_a?(OutputBuffer) ? result.to_s : result
    end
  end
rescue => e
  handle_render_error(view, e)
end

#short_identifier ⇒ Object 



296
297
298
 
# File 'lib/action_view/template.rb', line 296

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

#source ⇒ Object 



304
305
306
 
# File 'lib/action_view/template.rb', line 304

def source
  @source.to_s
end

#spot(location) ⇒ Object

:nodoc:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/action_view/template.rb', line 231

def spot(location) # :nodoc:
  node_id = RubyVM::AbstractSyntaxTree.node_id_for_backtrace_location(location)
  found =
    if RubyVM::InstructionSequence.compile("").to_a[4][:parser] == :prism
      require "prism"

      if Prism::VERSION >= "1.0.0"
        result = Prism.parse(compiled_source).value
        result.breadth_first_search { |node| node.node_id == node_id }
      end
    else
      node = RubyVM::AbstractSyntaxTree.parse(compiled_source, keep_script_lines: true)
      find_node_by_id(node, node_id)
    end

  ErrorHighlight.spot(found) if found
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 accepts 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.



366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/action_view/template.rb', line 366

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) 


380
381
382
 
# File 'lib/action_view/template.rb', line 380

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) 


261
262
263
 
# File 'lib/action_view/template.rb', line 261

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.



251
252
253
254
255
256
257
 
# File 'lib/action_view/template.rb', line 251

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 



292
293
294
 
# File 'lib/action_view/template.rb', line 292

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