Skip to content

jm/toml

Folders and files

NameName
Last commit message
Last commit date

Latest commit

e8b11e2 · Dec 1, 2021
Jun 1, 2021
Oct 16, 2014
Jun 1, 2021
Oct 19, 2013
Feb 17, 2014
Jun 1, 2021
Jan 25, 2014
Feb 24, 2013
Jun 1, 2021
Oct 16, 2014
Jun 9, 2020

Repository files navigation

TOML

A Ruby parser for TOML, built on parslet.

This is far superior to YAML and JSON because it doesn't suck. Really it doesn't.

Gem Version

Usage

Install this library:

gem "toml", "~> 0.3.0"
gem install "toml"

It's simple, really.

content = <<-TOML

# Hello, this is an example.
[things]
other = "things"
what = 900000

TOML

parser = TOML::Parser.new(content).parsed
# => { "things" => { "other" => "things", "what" => 900000 } }

You can also use the same API as YAML if you'd like:

TOML.load("thing = 9")
# => {"thing" => 9}

TOML.load_file("my_file.toml")
# => {"whatever" => "keys"}

In case a syntax error occurs, the parser will raise a Parslet::ParseFailed exception.

There's also a beta feature for generating a TOML file from a Ruby hash. Please note this will likely not give beautiful output right now.

hash = {
  "integer" => 1,
  "float" => 3.14159,
  "true" => true,
  "false" => false,
  "string" => "hi",
  "array" => [[1], [2], [3]],
  "key" => {
    "group" => {
      "value" => "lol"
    }
  }
}
doc = TOML::Generator.new(hash).body
# doc will be a string containing a proper TOML document.

Contributors

Written by Jeremy McAnally (@jm) and Dirk Gadsden (@dirk) based on TOML from Tom Preston-Werner (@mojombo).