toon-fu

TOON (Token-Oriented Object Notation) encoder for Ruby, versioned by the spec it implements: the gem's MAJOR.MINOR is the TOON spec version it speaks.

TOON is a compact, readable encoding of the JSON data model for LLM prompts: indentation instead of braces, quotes only where needed, and tables for arrays of uniform objects. toon-fu is written from the specification and runs the spec's reference fixtures as its conformance suite — every encode fixture of the spec version it implements passes.

Every Ruby TOON gem on RubyGems was published in late 2025 and stopped at spec 1.2, three major versions behind. They leave strings starting with # or + unquoted, which a current reader takes for a comment or a number, and shift dates by a day east of Greenwich. toon-fu tracks the spec: its version is the spec version, and a daily check flags a newer spec.

Yes, we know:

_{xkcd #927 "Standards" by Randall Munroe, CC BY-NC 2.5.}

Add it to your Gemfile:

gem "toon-fu"

In a plain script: gem install toon-fu and require "toon_fu". To pin the spec version, see Versioning.

ToonFu.encode({users: [{id: 1, name: "Ada", role: "admin"}, {id: 2, name: "Bob", role: "user"}]})

users[2]{id,name,role}:
  1,Ada,admin
  2,Bob,user

Arrays of uniform objects become tables that declare their fields once. Everything else reads like YAML:

{order: {id: 7, tags: ["new", "paid"], customer: {name: "Ada"}}}.to_toon

order:
  id: 7
  tags[2]: new,paid
  customer:
    name: Ada

to_toon is available on Hash, Array, String, Symbol, Integer, Float, true, false, nil, Set, Time and Date once toon_fu is loaded.

• delimiter: — "," (default), "\t" or "|". Tab usually costs the fewest tokens.
• indent_size: — spaces per nesting level, default 2.

ToonFu.encode(data, delimiter: "\t")
encoder = ToonFu::Encoder.new(delimiter: "|") # reuse for many documents
encoder.encode(data)

Define as_toon to return plain data; it wins over every built-in mapping:

Money = Struct.new(:cents, :currency) do
  include ToonFu::Encodable # optional: adds #to_toon

  def as_toon = {amount: cents / 100.0, currency:}
end

ToonFu.encode({price: Money.new(1999, "EUR")})
# price:
#   amount: 19.99
#   currency: EUR

Any other value raises ToonFu::Error:

ToonFu.encode({at: Object.new})
# ToonFu::Error: cannot encode Object; convert it first or define #as_toon

For ActiveRecord models, pass record.as_json (or define as_toon).

Everything else raises ToonFu::Error — including a Struct or Data without as_toon, circular references, and nesting too deep for the stack.

The only one that passes every spec fixture: toon-fu passes all 179 encode fixtures; the table compares the 154 that use default options, which every gem can run.

The Ruby TOON encoders with more than 10,000 downloads, measured by benchmark/run.rb on Ruby 3.4.10 (2026-09-24). Spec fixtures are the spec's own encode fixtures that use default options. Speed is the geometric mean of encodes per second over five workloads — tables of 100 and 1000 rows, nested objects, a list of mixed objects, strings needing quotes — relative to toon-fu.

What falls through the gaps:

• sorbet-toon, toon-ruby — #tag and +1 go out unquoted, so a current reader sees a comment and a number; arrays of objects with nested columns lose their table form; no keyed tables. Unknown objects slip through instead of raising: toon-ruby writes null, sorbet-toon "#<Foo:0x…>". toon-ruby also moves a Date a day back east of Greenwich.
• toon_my_json, toon-format — output a TOON reader cannot read: the table header on its own line, a [2,] length, rows at the wrong depth, nested objects in cells as broken text; toon_my_json also writes false as null. They do less work, and it shows in both columns.

Rerun it:

BUNDLE_GEMFILE=benchmark/Gemfile bundle install
BUNDLE_GEMFILE=benchmark/Gemfile bundle exec ruby benchmark/run.rb

To see where toon-fu itself spends time and allocates, profile one workload (CPU by stackprof, allocation sites by memory_profiler):

BUNDLE_GEMFILE=benchmark/Gemfile bundle exec ruby benchmark/profile.rb "table, 1000 rows"

The gem version tracks the TOON specification it implements:

• MAJOR.MINOR is the spec version: X.Y.Z speaks TOON X.Y.
• PATCH is the gem's own: fixes and improvements within the same dialect.

Pin the spec line with gem "toon-fu", "~> X.Y.0": it takes our fixes and keeps you on the dialect you speak. The gem badge above shows the current release; the spec-drift badge turns red when a newer spec is released and toon-fu has not caught up yet.

Release notes: GitHub releases.

git clone --recurse-submodules git@github.com:hoblin/toon-fu.git
cd toon-fu
bundle install
bundle exec rspec        # unit specs + the spec's conformance fixtures
bundle exec standardrb   # lint

The TOON spec is a git submodule at spec/toon-spec, pinned to its release tag; the fixtures run from there.

1. Bump lib/toon_fu/version.rb in a pull request and merge it.
2. git tag vX.Y.Z && git push origin vX.Y.Z on main.
3. Approve the release deployment in Actions.

The release workflow checks the tag matches the version, runs CI, and publishes to RubyGems via trusted publishing.

MIT