Class: Glossarist::Validation::Rules::RelatedConceptRule

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

Constant Summary collapse

VALID_TYPES = 
Glossarist::GlossaryDefinition::RELATED_CONCEPT_TYPES

Instance Method Summary collapse

Methods inherited from Base

inherited

Instance Method Details

#applicable?(context) ⇒ Boolean

Returns:

  • (Boolean) 


14
15
16
 
# File 'lib/glossarist/validation/rules/related_concept_rule.rb', line 14

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

#category ⇒ Object 



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

def category = :schema

#check(context) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/glossarist/validation/rules/related_concept_rule.rb', line 18

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

  (concept.related || []).each_with_index do |rel, idx|
    unless VALID_TYPES.include?(rel.type)
      issues << issue(
        "related concept #{idx + 1} has invalid type '#{rel.type}'",
        code: code, severity: severity,
        location: fname,
        suggestion: "Use one of: #{VALID_TYPES.join(', ')}",
      )
    end
  end

  issues
end

#code ⇒ Object 



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

def code = "GLS-200"

#scope ⇒ Object 



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

def scope = :concept

#severity ⇒ Object 



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

def severity = "error"