Class: PDK::Validate::YAML::Syntax

Inherits:
BaseValidator show all
Defined in:
lib/pdk/validate/yaml/syntax.rb

Constant Summary collapse

IGNORE_DOTFILES = 
false
YAML_WHITELISTED_CLASSES = 
[Symbol].freeze

Constants inherited from BaseValidator

BaseValidator::ALLOW_EMPTY_TARGETS, BaseValidator::INVOKE_STYLE

Class Method Summary collapse

Methods inherited from BaseValidator

allow_empty_targets?, cmd_path, ignore_dotfiles?, ignore_pathspec, parse_options, parse_targets, process_invalid, process_skipped

Class Method Details

.create_spinner(targets = [], options = {}) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/pdk/validate/yaml/syntax.rb', line 29

def self.(targets = [], options = {})
  require 'pdk/cli/util'

  return unless PDK::CLI::Util.interactive?
  options = options.merge(PDK::CLI::Util.)

  exec_group = options[:exec_group]
  @spinner = if exec_group
               exec_group.((targets), options)
             else
               require 'pdk/cli/util/spinner'

               TTY::Spinner.new("[:spinner] #{(targets)}", options)
             end
  @spinner.auto_spin
end

.invoke(report, options = {}) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/pdk/validate/yaml/syntax.rb', line 54

def self.invoke(report, options = {})
  targets, skipped, invalid = parse_targets(options)

  process_skipped(report, skipped)
  process_invalid(report, invalid)

  return 0 if targets.empty?

  return_val = 0
  (targets, options)

  PDK.logger.debug(_('Validating yaml content of %{parsed_targets}') % { parsed_targets: targets.to_s })

  targets.each do |target|
    next unless File.file?(target)

    unless File.readable?(target)
      report.add_event(
        file:     target,
        source:   name,
        state:    :failure,
        severity: 'error',
        message:  _('Could not be read.'),
      )
      return_val = 1
      next
    end

    begin
      ::YAML.safe_load(File.read(target), YAML_WHITELISTED_CLASSES, [], true)

      report.add_event(
        file:     target,
        source:   name,
        state:    :passed,
        severity: 'ok',
      )
    rescue Psych::SyntaxError => e
      report.add_event(
        file:     target,
        source:   name,
        state:    :failure,
        severity: 'error',
        line:     e.line,
        column:   e.column,
        message:  _('%{problem} %{context}') % {
          problem: e.problem,
          context: e.context,
        },
      )
      return_val = 1
    rescue Psych::DisallowedClass => e
      report.add_event(
        file:     target,
        source:   name,
        state:    :failure,
        severity: 'error',
        message:  _('Unsupported class: %{message}') % {
          message: e.message,
        },
      )
      return_val = 1
    end
  end

  (return_val)
  return_val
end

.name ⇒ Object 



10
11
12
 
# File 'lib/pdk/validate/yaml/syntax.rb', line 10

def self.name
  'yaml-syntax'
end

.pattern ⇒ Object 



14
15
16
17
18
19
20
21
 
# File 'lib/pdk/validate/yaml/syntax.rb', line 14

def self.pattern
  [
    '**/*.yaml',
    '*.yaml',
    '**/*.yml',
    '*.yml',
  ]
end

.spinner_text(_targets = []) ⇒ Object 



23
24
25
26
27
 
# File 'lib/pdk/validate/yaml/syntax.rb', line 23

def self.(_targets = [])
  _('Checking YAML syntax (%{targets}).') % {
    targets: pattern,
  }
end

.stop_spinner(exit_code) ⇒ Object 



46
47
48
49
50
51
52
 
# File 'lib/pdk/validate/yaml/syntax.rb', line 46

def self.(exit_code)
  if exit_code.zero? && @spinner
    @spinner.success
  elsif @spinner
    @spinner.error
  end
end