Module: Canon::YamlParsing

Defined in:
lib/canon/yaml_parsing.rb

Overview

The only place canon talks to a YAML engine. All string loads go through safe_load here (see XmlParsing for the XML equivalent); YAML.dump stays on Psych everywhere — canonical output bytes are canon's product and the writers differ.

Class Method Summary collapse

Class Method Details

.dump(obj) ⇒ Object

Psych::safe_load semantics. yeptris is safe-by-default plain data with Symbol/Date/Time built in (aliases resolve), so the permitted-class list is inherently satisfied; parse failures are normalized to Psych::SyntaxError so canon's rescues hold on both engines. Canon always resolves anchors (aliases: true at every call site) — a canonicalizer treats anchors as content: yeptris resolves them unconditionally, so :true keeps both engines behavior-identical. Serialize a Ruby object graph to YAML. yeptris 0.6.5+'s emitter is byte-identical to Psych across canon's dump corpus (nil/Time/special-float/block-scalar/key-type families — yeptris#290/#300 closed) with header: true supplying the "---" document start Psych emits; Psych serves when yeptris is inactive (CANON_YAML_BACKEND=psych forces it for dumps as for loads).



28
29
30
31
32
33
34
 
# File 'lib/canon/yaml_parsing.rb', line 28

def dump(obj)
  if YamlBackend.yeptris?
    ::Yeptris::YAML.dump(obj, header: true)
  else
    YAML.dump(obj)
  end
end

.safe_load(yaml, permitted_classes: [Symbol, Date, Time], aliases: true) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/canon/yaml_parsing.rb', line 36

def safe_load(yaml, permitted_classes: [Symbol, Date, Time],
              aliases: true)
  if YamlBackend.yeptris?
    begin
      ::Yeptris::YAML.load(yaml)
    rescue ::Yeptris::ParseError => e
      raise Psych::SyntaxError.new(nil, 0, 0, 0, e.message, "")
    end
  else
    YAML.safe_load(yaml, permitted_classes: permitted_classes,
                         aliases: aliases)
  end
end