Class: Glossarist::Validation::Rules::BibliographyYamlRule

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

def applicable?(context)
  context.gcr?
end

#category ⇒ Object 



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

def category = :structure

#check(context) ⇒ Object 



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

def check(context)
  bib_content = context.read_zip_file("bibliography.yaml")
  return [] unless bib_content

  begin
    V3::BibliographyFile.from_yaml(bib_content)
  rescue StandardError => e
    return [issue(
      "bibliography.yaml is invalid YAML: #{e.message}",
      code: code, severity: severity,
      location: "bibliography.yaml",
      suggestion: "Fix YAML syntax errors in bibliography.yaml",
    )]
  end

  []
end

#code ⇒ Object 



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

def code = "GLS-020-YAML"

#scope ⇒ Object 



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

def scope = :collection

#severity ⇒ Object 



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

def severity = "error"