Class: ActionView::TemplateError

Inherits:
ActionViewError
  • Object
show all
Defined in:
lib/action_view/template_error.rb

Overview

The TemplateError exception is raised when the compilation of the template fails. This exception then gathers a bunch of intimate details and uses it to report a very precise exception message.

Constant Summary collapse

SOURCE_CODE_RADIUS =

:nodoc:

3

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_path, file_path, assigns, source, original_exception) ⇒ TemplateError

Returns a new instance of TemplateError.



9
10
11
12
13
14
15
 
# File 'lib/action_view/template_error.rb', line 9

def initialize(base_path, file_path, assigns, source, original_exception)
  @base_path, @assigns, @source, @original_exception =
    base_path, assigns.dup, source, original_exception
  @file_path = file_path

  remove_deprecated_assigns!
end

Instance Attribute Details

#original_exception ⇒ Object (readonly)

Returns the value of attribute original_exception.



7
8
9
 
# File 'lib/action_view/template_error.rb', line 7

def original_exception
  @original_exception
end

Instance Method Details

#backtrace ⇒ Object 



77
78
79
80
81
82
 
# File 'lib/action_view/template_error.rb', line 77

def backtrace
  [
    "#{source_location.capitalize}\n\n#{source_extract(4)}\n    " +
    clean_backtrace.join("\n    ")
  ]
end

#clean_backtrace ⇒ Object 



21
22
23
 
# File 'lib/action_view/template_error.rb', line 21

def clean_backtrace
  original_exception.clean_backtrace
end

#file_name ⇒ Object 



66
67
68
69
70
 
# File 'lib/action_view/template_error.rb', line 66

def file_name
  stripped = strip_base_path(@file_path)
  stripped.slice!(0,1) if stripped[0] == ?/
  stripped
end

#line_number ⇒ Object 



57
58
59
60
61
62
63
64
 
# File 'lib/action_view/template_error.rb', line 57

def line_number
  @line_number ||=
    if file_name
      regexp = /#{Regexp.escape File.basename(file_name)}:(\d+)/

      $1 if message =~ regexp or clean_backtrace.find { |line| line =~ regexp }
    end
end

#message ⇒ Object 



17
18
19
 
# File 'lib/action_view/template_error.rb', line 17

def message
  ActiveSupport::Deprecation.silence { original_exception.message }
end

#source_extract(indentation = 0) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/action_view/template_error.rb', line 34

def source_extract(indentation = 0)
  return unless num = line_number
  num = num.to_i

  source_code = IO.readlines(@file_path)

  start_on_line = [ num - SOURCE_CODE_RADIUS - 1, 0 ].max
  end_on_line   = [ num + SOURCE_CODE_RADIUS - 1, source_code.length].min

  indent = ' ' * indentation
  line_counter = start_on_line

  source_code[start_on_line..end_on_line].sum do |line|
    line_counter += 1
    "#{indent}#{line_counter}: #{line}"
  end
end

#sub_template_message ⇒ Object 



25
26
27
28
29
30
31
32
 
# File 'lib/action_view/template_error.rb', line 25

def sub_template_message
  if @sub_templates
    "Trace of template inclusion: " +
    @sub_templates.collect { |template| strip_base_path(template) }.join(", ")
  else
    ""
  end
end

#sub_template_of(template_path) ⇒ Object 



52
53
54
55
 
# File 'lib/action_view/template_error.rb', line 52

def sub_template_of(template_path)
  @sub_templates ||= []
  @sub_templates << template_path
end

#to_s ⇒ Object 



72
73
74
75
 
# File 'lib/action_view/template_error.rb', line 72

def to_s
  "\n\n#{self.class} (#{message}) #{source_location}:\n" +
    "#{source_extract}\n    #{clean_backtrace.join("\n    ")}\n\n"
end