Class: ActionView::Template

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

Overview

Action View Renderable Template for objects that respond to #render_in

Direct Known Subclasses

Inline

Defined Under Namespace

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

Instance Attribute 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

Methods included from ActiveSupport::Autoload

autoload, autoload_at, autoload_under, autoloads, eager_autoload, eager_load!, extended

Constructor Details

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

Returns a new instance of Template.


120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# File 'actionview/lib/action_view/template.rb', line 120

def initialize(source, identifier, handler, locals:, format: nil, variant: nil, virtual_path: nil)
  @source            = source
  @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
end

Instance Attribute Details

#formatObject (readonly)

Returns the value of attribute format


118
119
120
# File 'actionview/lib/action_view/template.rb', line 118

def format
  @format
end

#handlerObject (readonly)

Returns the value of attribute handler


117
118
119
# File 'actionview/lib/action_view/template.rb', line 117

def handler
  @handler
end

#identifierObject (readonly)

Returns the value of attribute identifier


117
118
119
# File 'actionview/lib/action_view/template.rb', line 117

def identifier
  @identifier
end

#localsObject (readonly)

Returns the value of attribute locals


118
119
120
# File 'actionview/lib/action_view/template.rb', line 118

def locals
  @locals
end

#variableObject (readonly)

Returns the value of attribute variable


118
119
120
# File 'actionview/lib/action_view/template.rb', line 118

def variable
  @variable
end

#variantObject (readonly)

Returns the value of attribute variant


118
119
120
# File 'actionview/lib/action_view/template.rb', line 118

def variant
  @variant
end

#virtual_pathObject (readonly)

Returns the value of attribute virtual_path


118
119
120
# File 'actionview/lib/action_view/template.rb', line 118

def virtual_path
  @virtual_path
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.


186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'actionview/lib/action_view/template.rb', line 186

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

#inspectObject


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

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

#marshal_dumpObject

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.


226
227
228
# File 'actionview/lib/action_view/template.rb', line 226

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

#marshal_load(array) ⇒ Object

:nodoc:


230
231
232
233
# File 'actionview/lib/action_view/template.rb', line 230

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

#render(view, locals, buffer = ActionView::OutputBuffer.new, 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.


151
152
153
154
155
156
157
158
# File 'actionview/lib/action_view/template.rb', line 151

def render(view, locals, buffer = ActionView::OutputBuffer.new, add_to_stack: true, &block)
  instrument_render_template do
    compile!(view)
    view._run(method_name, self, locals, buffer, add_to_stack: add_to_stack, &block)
  end
rescue => e
  handle_render_error(view, e)
end

#short_identifierObject


164
165
166
# File 'actionview/lib/action_view/template.rb', line 164

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

#sourceObject


172
173
174
# File 'actionview/lib/action_view/template.rb', line 172

def source
  @source.to_s
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)

141
142
143
# File 'actionview/lib/action_view/template.rb', line 141

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

#typeObject


160
161
162
# File 'actionview/lib/action_view/template.rb', line 160

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