How to use XML to Ruby
- Paste a representative XML sample, ideally one with all the optional fields filled in.
- Set the name of the root type, and decide whether you want helper code as well or types only.
- Copy the generated Ruby code into your project.
About XML to Ruby
Writing model classes by hand for a big XML payload is dull, and it is where typos creep in. Paste a sample here and the generator works out the structure: which fields exist, which are objects, which are arrays and what type each value has. The output is Dry::Struct classes with Dry::Types, with from_dynamic and to_dynamic helpers.
XML is first converted to JSON the same way as in our XML to JSON tool: attributes get an @_ prefix and text content next to attributes is called #text. The Ruby types are generated from that result. The generated code is verbose because it validates types at runtime, which Ruby itself does not do.
Using the generated code
Add the dry-struct gem and call Root.from_json!(text).
Optional attributes are declared with the optional type and may be nil.