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_name, assigns, source, original_exception) ⇒ TemplateError

Returns a new instance of TemplateError.



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

def initialize(base_path, file_name, assigns, source, original_exception)
  @base_path, @assigns, @source, @original_exception = 
    base_path, assigns, source, original_exception
  @file_name = file_name
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 



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

def backtrace
  [ 
    "On line ##{line_number} of #{file_name}\n\n#{source_extract(4)}\n    " + 
    original_exception.clean_backtrace.join("\n    ")
  ]
end

#file_name ⇒ Object 



58
59
60
61
 
# File 'lib/action_view/template_error.rb', line 58

def file_name
  stripped = strip_base_path(@file_name)
  stripped[0] == ?/ ? stripped[1..-1] : stripped
end

#line_number ⇒ Object 



48
49
50
51
52
53
54
55
56
 
# File 'lib/action_view/template_error.rb', line 48

def line_number
  if file_name
    regexp = /#{Regexp.escape File.basename(file_name)}:(\d+)/
    [@original_exception.message, @original_exception.clean_backtrace].flatten.each do |line|
      return $1.to_i if regexp =~ line
    end
  end
  0
end

#message ⇒ Object 



15
16
17
 
# File 'lib/action_view/template_error.rb', line 15

def message
  original_exception.message
end

#source_extract(indention = 0) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/action_view/template_error.rb', line 28

def source_extract(indention = 0)
  source_code = IO.readlines(@file_name)
  
  start_on_line = [ line_number - SOURCE_CODE_RADIUS - 1, 0 ].max
  end_on_line   = [ line_number + SOURCE_CODE_RADIUS - 1, source_code.length].min

  line_counter = start_on_line
  extract = source_code[start_on_line..end_on_line].collect do |line| 
    line_counter += 1
    "#{' ' * indention}#{line_counter}: " + line
  end

  extract.join
end

#sub_template_message ⇒ Object 



19
20
21
22
23
24
25
26
 
# File 'lib/action_view/template_error.rb', line 19

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(file_name) ⇒ Object 



43
44
45
46
 
# File 'lib/action_view/template_error.rb', line 43

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

#to_s ⇒ Object 



63
64
65
66
67
68
 
# File 'lib/action_view/template_error.rb', line 63

def to_s
  "\n\n#{self.class} (#{message}) on line ##{line_number} of #{file_name}:\n" + 
  source_extract + "\n    " +
  original_exception.clean_backtrace.join("\n    ") +
  "\n\n"
end