1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
# frozen_string_literal: true
module Parser
##
# {Parser::Diagnostic::Engine} provides a basic API for dealing with
# diagnostics by delegating them to registered consumers.
#
# @example
# buffer = Parser::Source::Buffer.new(__FILE__, source: 'foobar')
#
# consumer = lambda do |diagnostic|
# puts diagnostic.message
# end
#
# engine = Parser::Diagnostic::Engine.new(consumer)
# diagnostic = Parser::Diagnostic.new(
# :warning, :unexpected_token, { :token => 'abc' }, buffer, 1..2)
#
# engine.process(diagnostic) # => "unexpected token abc"
#
# @api public
#
# @!attribute [rw] consumer
# @return [#call(Diagnostic)]
#
# @!attribute [rw] all_errors_are_fatal
# When set to `true` any error that is encountered will result in
# {Parser::SyntaxError} being raised.
# @return [Boolean]
#
# @!attribute [rw] ignore_warnings
# When set to `true` warnings will be ignored.
# @return [Boolean]
#
class Diagnostic::Engine
attr_accessor :consumer
attr_accessor :all_errors_are_fatal
attr_accessor :ignore_warnings
##
# @param [#call(Diagnostic)] consumer
#
def initialize(consumer=nil)
@consumer = consumer
@all_errors_are_fatal = false
@ignore_warnings = false
end
##
# Processes a `diagnostic`:
# * Passes the diagnostic to the consumer, if it's not a warning when
# `ignore_warnings` is set.
# * After that, raises {Parser::SyntaxError} when `all_errors_are_fatal`
# is set to true.
#
# @param [Parser::Diagnostic] diagnostic
# @return [Parser::Diagnostic::Engine]
# @see ignore?
# @see raise?
#
def process(diagnostic)
if ignore?(diagnostic)
# do nothing
elsif @consumer
@consumer.call(diagnostic)
end
if raise?(diagnostic)
raise Parser::SyntaxError, diagnostic
end
self
end
protected
##
# Checks whether `diagnostic` should be ignored.
#
# @param [Parser::Diagnostic] diagnostic
# @return [Boolean]
#
def ignore?(diagnostic)
@ignore_warnings &&
diagnostic.level == :warning
end
##
# Checks whether `diagnostic` should be raised as an exception.
#
# @param [Parser::Diagnostic] diagnostic
# @return [Boolean]
#
def raise?(diagnostic)
(@all_errors_are_fatal &&
diagnostic.level == :error) ||
diagnostic.level == :fatal
end
end
end
|
