Class: AppMap::Service::Validator::Violation

Inherits:
Object
  • Object
show all
Defined in:
lib/appmap/service/validator/violation.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(level:, message:, setting:, filename:, detailed_message:, help_urls:) ⇒ Violation

Returns a new instance of Violation.



33
34
35
36
37
38
39
40
 
# File 'lib/appmap/service/validator/violation.rb', line 33

def initialize(level:, message:, setting:, filename:, detailed_message:, help_urls:)
  @level = level
  @setting = setting
  @filename = filename
  @message = message
  @detailed_message = detailed_message
  @help_urls = help_urls
end

Instance Attribute Details

#detailed_message ⇒ Object (readonly)

Returns the value of attribute detailed_message.



7
8
9
 
# File 'lib/appmap/service/validator/violation.rb', line 7

def detailed_message
  @detailed_message
end

#filename ⇒ Object (readonly)

Returns the value of attribute filename.



7
8
9
 
# File 'lib/appmap/service/validator/violation.rb', line 7

def filename
  @filename
end

#help_urls ⇒ Object (readonly)

Returns the value of attribute help_urls.



7
8
9
 
# File 'lib/appmap/service/validator/violation.rb', line 7

def help_urls
  @help_urls
end

#level ⇒ Object (readonly)

Returns the value of attribute level.



7
8
9
 
# File 'lib/appmap/service/validator/violation.rb', line 7

def level
  @level
end

#message ⇒ Object (readonly)

Returns the value of attribute message.



7
8
9
 
# File 'lib/appmap/service/validator/violation.rb', line 7

def message
  @message
end

#setting ⇒ Object (readonly)

Returns the value of attribute setting.



7
8
9
 
# File 'lib/appmap/service/validator/violation.rb', line 7

def setting
  @setting
end

Class Method Details

.error(message:, setting: nil, filename: nil, detailed_message: nil, help_urls: nil) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
 
# File 'lib/appmap/service/validator/violation.rb', line 10

def error(message:, setting: nil, filename: nil, detailed_message: nil, help_urls: nil)
  self.new(
    level: :error,
    message: message,
    setting: setting,
    filename: filename,
    detailed_message: detailed_message,
    help_urls: help_urls
  )
end

.warning(message:, setting: nil, filename: nil, detailed_message: nil, help_urls: nil) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/appmap/service/validator/violation.rb', line 21

def warning(message:, setting: nil, filename: nil, detailed_message: nil, help_urls: nil)
  self.new(
    level: :warning,
    message: message,
    setting: setting,
    filename: filename,
    detailed_message: detailed_message,
    help_urls: help_urls
  )
end

Instance Method Details

#error? ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/appmap/service/validator/violation.rb', line 48

def error?
  @level == :error
end

#to_h ⇒ Object 



42
43
44
45
46
 
# File 'lib/appmap/service/validator/violation.rb', line 42

def to_h
  instance_variables.each_with_object({}) do |var, hash|
    hash[var.to_s.delete("@")] = self.instance_variable_get(var)
  end.compact
end

#warning? ⇒ Boolean

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/appmap/service/validator/violation.rb', line 52

def warning?
  @level == :warning
end