Class: Glossarist::Validation::Rules::AsciidocXrefRule

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

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

#category ⇒ Object 



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

def category = :references

#check(context) ⇒ Object 



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

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

  context.references.each do |ref|
    next unless ref.is_a?(BibliographicReference)
    next if context.bibliography_index.resolve?(ref.anchor)

    issues << issue(
      "unresolved bibliography reference <<#{ref.anchor}>>",
      code: code, severity: severity,
      location: fname,
      suggestion: "add '#{ref.anchor}' as a source, " \
                  "or verify it exists in bibliography.yaml"
    )
  end

  issues
end

#code ⇒ Object 



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

def code = "GLS-102"

#scope ⇒ Object 



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

def scope = :concept

#severity ⇒ Object 



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

def severity = "warning"