Class: Glossarist::Validation::Rules::LocalityCompletenessRule

Inherits:
Base
  • Object
show all
Defined in:
lib/glossarist/validation/rules/locality_completeness_rule.rb

Instance Method Summary collapse

Methods inherited from Base

inherited

Instance Method Details

#applicable?(context) ⇒ Boolean

Returns:

  • (Boolean) 


12
13
14
 
# File 'lib/glossarist/validation/rules/locality_completeness_rule.rb', line 12

def applicable?(context)
  context.concept.localizations&.any?
end

#category ⇒ Object 



8
 
# File 'lib/glossarist/validation/rules/locality_completeness_rule.rb', line 8

def category = :quality

#check(context) ⇒ Object 



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
 
# File 'lib/glossarist/validation/rules/locality_completeness_rule.rb', line 16

def check(context)
  concept = context.concept
  fname = context.file_name
  issues = []

  all_origins(concept).each_with_index do |origin, idx|
    next unless origin
    next unless origin.locality

    loc = origin.locality
    if loc.type.nil? || loc.type.to_s.strip.empty?
      issues << issue(
        "source #{idx + 1} locality has no type",
        location: fname,
        suggestion: "Add locality type (e.g. 'clause')",
      )
    end

    if loc.reference_from.nil? || loc.reference_from.to_s.strip.empty?
      issues << issue(
        "source #{idx + 1} locality has no reference_from",
        location: fname,
        suggestion: "Add locality.reference_from (e.g. '3.1.3.10')",
      )
    end
  end

  issues
end

#code ⇒ Object 



7
 
# File 'lib/glossarist/validation/rules/locality_completeness_rule.rb', line 7

def code = "GLS-308"

#scope ⇒ Object 



10
 
# File 'lib/glossarist/validation/rules/locality_completeness_rule.rb', line 10

def scope = :concept

#severity ⇒ Object 



9
 
# File 'lib/glossarist/validation/rules/locality_completeness_rule.rb', line 9

def severity = "warning"