Psych.safe_dump (Ruby 4.0 リファレンスマニュアル)

safe_dump(o, options = {}) -> StringRuby 3.1 から[permalink][rdoc][edit]

safe_dump(o, io, options = {}) -> ()

Ruby のオブジェクト o を安全に YAML ドキュメントに変換します。

Psych.dump と同様の変換を行いますが、デフォルトでは以下のクラスのオブジェクトしか変換しません。

options のキー permitted_classes を指定すると、変換を許可するクラスを追加できます。

permitted_classes に Date を渡した例

require 'psych'
require 'date'

Psych.safe_dump(Date.today, permitted_classes: [Date])

o が permitted_classes で許可されていないクラスのオブジェクトを含む場合は、 Psych::DisallowedClass 例外が発生します。

io に IO オブジェクトを指定した場合は、変換されたドキュメントがその IO に書き込まれます。指定しなかった場合は変換されたドキュメントが文字列としてメソッドの返り値となります。

options でその他に指定できる項目は Psych.dump と同じです。

[PARAM] o:: 変換するオブジェクト
[PARAM] io:: 出力先
[PARAM] options:: 出力オプション(permitted_classes を含む)
[EXCEPTION] Psych::DisallowedClass:: o が permitted_classes で許可されていないクラスのオブジェクトを含むときに発生します