Module: Ptolemy

Defined in:
lib/ptolemy.rb,
lib/ptolemy/nodes.rb,
lib/ptolemy/parser.rb,
lib/ptolemy/version.rb,
lib/ptolemy/exceptions.rb

Defined Under Namespace

Modules: TOML Classes: ParseError, Parser

Constant Summary collapse

VERSION = 
"0.0.2"

Class Method Summary collapse

Class Method Details

.parse(data) ⇒ Hash

Parses TOML string input

Ptolemy.parse 'key = "value"'

Parameters:

  • data (String) —

    the input string

Returns:

  • (Hash) —

    the input parsed into a ruby hash



14
15
16
 
# File 'lib/ptolemy.rb', line 14

def self.parse data
  Parser.parse data
end

.parse_file(filename) ⇒ Hash

Parses data from a file containing TOML. The file should be UTF-8 encoded.

Ptolemy.parse_file 'example.toml'

Parameters:

  • filename (String) —

    full path of the file

Returns:

  • (Hash) —

    the input parsed into a ruby hash



25
26
27
28
29
30
 
# File 'lib/ptolemy.rb', line 25

def self.parse_file filename
  File.open filename, 'r:utf-8' do |file|
    # TODO: Should the check for valid UTF-8 be done over here?
    return Parser.parse file.read
  end
end