Usage & API

The public API lives at the module root (github.com/go-ruby-yaml/yaml). It is Ruby-shaped but Go-idiomatic: Dump / Load mirror Psych's Psych.dump / Psych.load, while the surface follows Go conventions — an explicit error, value types, no global state.

Status: implemented

The library is built and importable as github.com/go-ruby-yaml/yaml, bound into rbgo as a native module; see Roadmap.

Install

go get github.com/go-ruby-yaml/yaml

Worked example

s, _ := yaml.Dump(map[string]any{"a": 1, "b": []any{2, 3}})
// "---\na: 1\nb:\n- 2\n- 3\n"

v, _ := yaml.Load("--- &a [1, 2]\n*a\n")   // shared via alias
v, _  = yaml.SafeLoad("--- !ruby/object:Foo {}")  // refused: error

Shape

// Dump emits Psych-compatible YAML for a Ruby value graph.
func Dump(v Value) (string, error)

// Load parses YAML into the full Ruby value graph (Psych.load).
func Load(s string) (Value, error)

// SafeLoad parses only the safe scalar/collection subset,
// refusing arbitrary !ruby/object: instantiation.
func SafeLoad(s string) (Value, error)

MRI conformance

Correctness is defined by reference Ruby. A differential oracle runs a wide corpus through both the system ruby and this library and compares the results byte-for-byte — not approximated from memory. The oracle tests skip themselves where ruby is not on PATH (e.g. the qemu arch lanes), so the cross-arch builds still validate the library.

Relationship to Ruby

go-ruby-yaml/yaml is standalone and reusable, and is the backend bound into go-embedded-ruby by rbgo as a native module — the same way go-ruby-regexp and go-ruby-erb are bound. The dependency runs the other way: this library has no dependency on the Ruby runtime.