Class: Glossarist::Validation::Rules::DefinitionContentRule

Inherits:
Base
  • Object
show all
Defined in:
lib/glossarist/validation/rules/definition_content_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/definition_content_rule.rb', line 12

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

#category ⇒ Object 



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

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

  concept.localizations.each do |l10n|
    lang = l10n.language_code || "unknown"
    (l10n.data&.definition || []).each_with_index do |d, idx|
      if d.content.nil? || d.content.strip.empty?
        issues << issue(
          "definition #{idx + 1} has empty content",
          code: code, severity: severity,
          location: "#{fname}/#{lang}",
          suggestion: "Add definition text or remove the empty entry",
        )
      end
    end
  end

  issues
end

#code ⇒ Object 



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

def code = "GLS-300"

#scope ⇒ Object 



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

def scope = :concept

#severity ⇒ Object 



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

def severity = "warning"