Class: Canon::Formatters::YamlFormatter

Inherits:
Object
  • Object
show all
Defined in:
lib/canon/formatters/yaml_formatter.rb

Overview

YAML formatter for canonicalization

Class Method Summary collapse

Class Method Details

.format(yaml) ⇒ Object 



10
11
12
13
 
# File 'lib/canon/formatters/yaml_formatter.rb', line 10

def self.format(yaml)
  parsed = parse(yaml)
  sort_yaml_keys(parsed).to_yaml
end

.parse(yaml) ⇒ Object 



15
16
17
18
19
20
21
22
 
# File 'lib/canon/formatters/yaml_formatter.rb', line 15

def self.parse(yaml)
  # Validate before parsing
  Canon::Validators::YamlValidator.validate!(yaml)
  # Return as-is if already parsed
  return yaml if yaml.is_a?(Hash) || yaml.is_a?(Array)

  YAML.safe_load(yaml, permitted_classes: [Symbol, Date, Time])
end

.sort_yaml_keys(obj) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/canon/formatters/yaml_formatter.rb', line 24

def self.sort_yaml_keys(obj)
  case obj
  when Hash
    obj.transform_values { |v| sort_yaml_keys(v) }
      .sort.to_h
  when Array
    obj.map { |item| sort_yaml_keys(item) }
  else
    obj
  end
end