Class: Glossarist::Validation::Rules::CitationCompletenessRule

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

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

#category ⇒ Object 



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

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

  concept.localizations.flat_map(&:all_sources).each_with_index do |source, idx|
    origin = source.origin
    next unless origin

    ref = origin.ref
    if ref.nil? || (ref.source.nil? && ref.id.nil?)
      issues << issue(
        "source #{idx + 1} has empty origin (no ref source or id)",
        code: "GLS-304", severity: severity,
        location: fname,
        suggestion: "Add at minimum an origin.ref with source or id",
      )
    end
  end

  issues
end

#code ⇒ Object 



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

def code = "GLS-304"

#scope ⇒ Object 



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

def scope = :concept

#severity ⇒ Object 



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

def severity = "warning"