Module: TOML

Defined in:

lib/toml.rb,
lib/toml/parser.rb,
lib/toml/keygroup.rb,
lib/toml/keyvalue.rb

Defined Under Namespace

Classes: Keygroup, Keyvalue, Parser, ValueOverwriteError

Class Method Summary

• .load_file(path, options = {}) ⇒ Object

  Public: Returns a hash from a TOML file.

• .parse(content, options = {}) ⇒ Object

  Public: Returns a hash from TOML content.

Class Method Details

.load_file(path, options = {}) ⇒ Object

Public: Returns a hash from a TOML file.

path - TOML File path options - The Hash options used to refine the parser (default: {}):

:symbolize_keys - true|false (optional).

Examples

TOML.load_file('/tmp/simple.toml')
# => {"group"=>{}}

TOML.load_file('/tmp/simple.toml', symbolize_keys: true)
# => {group: {}}

Returns a Ruby hash representation of the content. Raises ValueOverwriteError if a key is overwritten Raises Errno::ENOENT if the file cannot be found. Raises Errno::EACCES if the file cannot be accessed.

# File 'lib/toml.rb', line 53

def self.load_file(path, options = {})
  TOML.parse(File.read(path), options)
end

.parse(content, options = {}) ⇒ Object

Public: Returns a hash from TOML content.

content - TOML string to be parsed. options - The Hash options used to refine the parser (default: {}):

:symbolize_keys - true|false (optional).

Examples

TOML.parse('[group]')
# => {"group"=>{}}

TOML.parse('title = "TOML parser"')
# => {"title"=>"TOML parser"}

TOML.parse('[group]', symbolize_keys: true)
# => {group: {}}

TOML.parse('title = "TOML parser"', symbolize_keys: true)
# => {title: "TOML parser"}

Returns a Ruby hash representation of the content according to TOML spec. Raises ValueOverwriteError if a key is overwritten

# File 'lib/toml.rb', line 29

def self.parse(content, options = {})
  Parser.new(content, options).hash
end