Module: ActionView::Template::Handlers

Included in:
ActionView::Template
Defined in:
actionview/lib/action_view/template/handlers.rb,
actionview/lib/action_view/template/handlers/erb.rb,
actionview/lib/action_view/template/handlers/raw.rb,
actionview/lib/action_view/template/handlers/html.rb,
actionview/lib/action_view/template/handlers/builder.rb,
actionview/lib/action_view/template/handlers/erb/erubi.rb

Overview

:nodoc:

Defined Under Namespace

Classes: Builder, ERB, Html, LegacyHandlerWrapper, Raw

Constant Summary collapse

@@template_handlers = 
{}
@@default_template_handlers = 
nil

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ Object 



12
13
14
15
16
17
18
 
# File 'actionview/lib/action_view/template/handlers.rb', line 12

def self.extended(base)
  base.register_default_template_handler :raw, Raw.new
  base.register_template_handler :erb, ERB.new
  base.register_template_handler :html, Html.new
  base.register_template_handler :builder, Builder.new
  base.register_template_handler :ruby, lambda { |_, source| source }
end

.extensions ⇒ Object 



23
24
25
 
# File 'actionview/lib/action_view/template/handlers.rb', line 23

def self.extensions
  @@template_extensions ||= @@template_handlers.keys
end

Instance Method Details

#handler_for_extension(extension) ⇒ Object 



85
86
87
 
# File 'actionview/lib/action_view/template/handlers.rb', line 85

def handler_for_extension(extension)
  registered_template_handler(extension) || @@default_template_handlers
end

#register_default_template_handler(extension, klass) ⇒ Object 



80
81
82
83
 
# File 'actionview/lib/action_view/template/handlers.rb', line 80

def register_default_template_handler(extension, klass)
  register_template_handler(extension, klass)
  @@default_template_handlers = klass
end

#register_template_handler(*extensions, handler) ⇒ Object

Register an object that knows how to handle template files with the given extensions. This can be used to implement new template types. The handler must respond to :call, which will be passed the template and should return the rendered template as a String.

Raises:

  • (ArgumentError) 


37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'actionview/lib/action_view/template/handlers.rb', line 37

def register_template_handler(*extensions, handler)
  params = if handler.is_a?(Proc)
    handler.parameters
  else
    handler.method(:call).parameters
  end

  unless params.find_all { |type, _| type == :req || type == :opt }.length >= 2
    ActiveSupport::Deprecation.warn <<~eowarn
    Single arity template handlers are deprecated. Template handlers must
    now accept two parameters, the view object and the source for the view object.
    Change:
      >> #{handler}.call(#{params.map(&:last).join(", ")})
    To:
      >> #{handler}.call(#{params.map(&:last).join(", ")}, source)
    eowarn
    handler = LegacyHandlerWrapper.new(handler)
  end

  raise(ArgumentError, "Extension is required") if extensions.empty?
  extensions.each do |extension|
    @@template_handlers[extension.to_sym] = handler
  end
  @@template_extensions = nil
end

#registered_template_handler(extension) ⇒ Object 



76
77
78
 
# File 'actionview/lib/action_view/template/handlers.rb', line 76

def registered_template_handler(extension)
  extension && @@template_handlers[extension.to_sym]
end

#template_handler_extensions ⇒ Object 



72
73
74
 
# File 'actionview/lib/action_view/template/handlers.rb', line 72

def template_handler_extensions
  @@template_handlers.keys.map(&:to_s).sort
end

#unregister_template_handler(*extensions) ⇒ Object

Opposite to register_template_handler.



64
65
66
67
68
69
70
 
# File 'actionview/lib/action_view/template/handlers.rb', line 64

def unregister_template_handler(*extensions)
  extensions.each do |extension|
    handler = @@template_handlers.delete extension.to_sym
    @@default_template_handlers = nil if @@default_template_handlers == handler
  end
  @@template_extensions = nil
end