module TomlRB

Public: Returns a TomlRB string from a Ruby Hash.

hash - Ruby Hash to be dumped into TomlRB

Examples

TomlRB.dump(title: 'TomlRB dump')
# => "simple = true\n"

hash = {
  "title"=>"wow!",
  "awesome"=> {
    "you"=>true,
    "others"=>false
  }
}

TomlRB.dump(hash)
# => "title = \"wow!\"\n[awesome]\nothers = false\nyou = true\n"

Returns a TomlRB string representing the hash.

# File lib/toml-rb.rb, line 81
def self.dump(hash)
  Dumper.new(hash).toml_str
end

Public: Returns a hash from a TomlRB file.

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

:symbolize_keys - true|false (optional).

Examples

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

TomlRB.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 ParseError if the content has invalid TomlRB. Raises Errno::ENOENT if the file cannot be found. Raises Errno::EACCES if the file cannot be accessed.

# File lib/toml-rb.rb, line 54
def self.load_file(path, options = {})
  TomlRB.parse(File.read(path), options)
end

Public: Returns a hash from TomlRB content.

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

:symbolize_keys - true|false (optional).

Examples

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

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

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

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

Returns a Ruby hash representation of the content according to TomlRB spec. Raises ValueOverwriteError if a key is overwritten. Raises ParseError if the content has invalid TomlRB.

# File lib/toml-rb.rb, line 29
def self.parse(content, options = {})
  Parser.new(content, options).hash
end