toml-rb 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d550c310fb16cc57d0bd5f2b5ca269d300c79268
-  data.tar.gz: e5be2acd18c3ee096743c749c59ef893f1f96058
+  metadata.gz: d7c6222b73b280deabe97bc55a0eee9224412f76
+  data.tar.gz: b48c90b9abef1ab81ffb5051be7a575ed9b6383f
 SHA512:
-  metadata.gz: 2d3c00589a249387ead32123e022bb1387a39f887e9f155111b94d6e782ab29d50ecf1b5e5d464b6cec811a05f76505f35abe1b65c9a831b2eae6bfcd60f8c80
-  data.tar.gz: 6ff8631b538415e1f7806298dbc216beb952d05b944b478bad5281a78b5b393afdaacee4e3c8782e068d9f39a5d4b23ed7e545a6a7fc78a6ab491085a9d489d2
+  metadata.gz: 0bfb79b2cd16c3291d315d94d52be611d581c6a2e7eaca967f9d838af3fc56250f377ebbf2126a11e1153318fe642b16479c2895dcc75366274c8c3ef7623c07
+  data.tar.gz: 236b967fa06c531cf2a50cca3ea22a69ea4ae9bad978ceba75fd43c381c32b7b49b10796f7c150c9d96dede5decd2c36f6c7c3b1e0332c34a2d24b906199cc55

data/README.md

@@ -8,7 +8,7 @@ toml-rb
 
 A [TOML](https://github.com/mojombo/toml) parser using [Citrus](http://mjackson.github.io/citrus) library.
 
-TOML specs supported: `0.3.1`
+TOML specs supported: `0.4.0`
 
 Installation
 ------------

data/init.rb

@@ -4,6 +4,7 @@ ROOT = File.dirname(File.expand_path(__FILE__))
 
 require "#{ROOT}/lib/toml/string"
 require "#{ROOT}/lib/toml/table_array"
+require "#{ROOT}/lib/toml/inline_table"
 require "#{ROOT}/lib/toml/keyvalue"
 require "#{ROOT}/lib/toml/keygroup"
 require "#{ROOT}/lib/toml/parser"

data/lib/toml/dumper.rb

@@ -41,7 +41,7 @@ module TOML
         end
       end
 
-      return simple_pairs, nested_pairs, table_array_pairs
+      [simple_pairs, nested_pairs, table_array_pairs]
     end
 
     def dump_simple_pairs(simple_pairs)

data/lib/toml/grammars/document.citrus

@@ -15,6 +15,24 @@ grammar Document
   end
 
   rule keyvalue
-    (space? key space? '=' space? v:(primitive | array) comment?) <Keyvalue>
+    (space? key space? '=' space? v:(toml_values) comment?) <Keyvalue>
   end
+
+  rule inline_table
+    (space? '{' (keyvalue (',' keyvalue)*)? space? '}' ) <InlineTable>
+  end
+
+  rule inline_table_array
+    ("[" indent? (hash_array)* ","? indent? comment? indent? "]" indent?) <InlineTableArray>
+  end
+
+  rule hash_array
+    comment | (inline_table ("," indent? (inline_table | comment))*)
+  end
+
+  rule toml_values
+    primitive | inline_table_array | inline_table | array
+  end
+
+
 end

data/lib/toml/grammars/primitive.citrus

@@ -72,7 +72,7 @@ grammar Primitive
   end
 
   rule integer
-    (sign? [0-9]+) { to_str.to_i }
+    (sign? [0-9_]+) { to_str.to_i }
   end
 
   rule sign
@@ -104,7 +104,7 @@ grammar Primitive
   end
 
   rule bare_key
-    [a-zA-Z_] [a-zA-Z_0-9_-]*
+    [a-zA-Z_] [a-zA-Z0-9_-]*
   end
 
   rule quoted_key

data/lib/toml/inline_table.rb

@@ -0,0 +1,15 @@
+module InlineTable
+  def value
+    keyvalue_pairs = captures[:keyvalue].map(&:value)
+
+    Hash[keyvalue_pairs.map { |kv| [kv.key, kv.value] }]
+  end
+end
+
+module InlineTableArray
+  def value
+    tables = captures[:hash_array].map { |x| x.captures[:inline_table] }
+
+    tables.flatten.map(&:value)
+  end
+end

data/lib/toml/keyvalue.rb

@@ -2,6 +2,8 @@ module TOML
   class ValueOverwriteError < StandardError; end
 
   class Keyvalue
+    attr_reader :key, :value
+
     def initialize(key, value)
       @key, @value = key, value
     end
@@ -13,7 +15,7 @@ module TOML
     end
 
     def accept_visitor(parser)
-      parser.visit_keyvalue(self)
+      parser.visit_keyvalue self
     end
   end
 end

data/lib/toml/parser.rb

@@ -24,11 +24,15 @@ module TOML
     end
 
     def visit_keygroup(keygroup)
-      @current = keygroup.navigate_keys(@hash, @symbolize_keys)
+      @current = keygroup.navigate_keys @hash, @symbolize_keys
     end
 
     def visit_keyvalue(keyvalue)
-      keyvalue.assign(@current, @symbolize_keys)
+      keyvalue.assign @current, @symbolize_keys
+    end
+
+    def visit_inline_table(inline_table)
+      inline_table.assign @current, @symbolize_keys
     end
   end
 end

data/test/example-v0.4.0.toml

@@ -0,0 +1,244 @@
+################################################################################
+## Comment
+
+# Speak your mind with the hash symbol. They go from the symbol to the end of
+# the line.
+
+
+################################################################################
+## Table
+
+# Tables (also known as hash tables or dictionaries) are collections of
+# key/value pairs. They appear in square brackets on a line by themselves.
+
+[table]
+
+key = "value" # Yeah, you can do this.
+
+# Nested tables are denoted by table names with dots in them. Name your tables
+# whatever crap you please, just don't use #, ., [ or ].
+
+[table.subtable]
+
+key = "another value"
+
+# You don't need to specify all the super-tables if you don't want to. TOML
+# knows how to do it for you.
+
+# [x] you
+# [x.y] don't
+# [x.y.z] need these
+[x.y.z.w] # for this to work
+
+
+################################################################################
+## Inline Table
+
+# Inline tables provide a more compact syntax for expressing tables. They are
+# especially useful for grouped data that can otherwise quickly become verbose.
+# Inline tables are enclosed in curly braces `{` and `}`. No newlines are
+# allowed between the curly braces unless they are valid within a value.
+
+[table.inline]
+
+name = { first = "Tom", last = "Preston-Werner" }
+point = { x = 1, y = 2 }
+
+
+################################################################################
+## String
+
+# There are four ways to express strings: basic, multi-line basic, literal, and
+# multi-line literal. All strings must contain only valid UTF-8 characters.
+
+[string.basic]
+
+basic = "I'm a string. \"You can quote me\". Name\tJos\u00E9\nLocation\tSF."
+
+[string.multiline]
+
+# The following strings are byte-for-byte equivalent:
+key1 = "One\nTwo"
+key2 = """One\nTwo"""
+key3 = """
+One
+Two"""
+
+[string.multiline.continued]
+
+# The following strings are byte-for-byte equivalent:
+key1 = "The quick brown fox jumps over the lazy dog."
+
+key2 = """
+The quick brown \
+
+
+  fox jumps over \
+    the lazy dog."""
+
+key3 = """\
+       The quick brown \
+       fox jumps over \
+       the lazy dog.\
+       """
+
+[string.literal]
+
+# What you see is what you get.
+winpath  = 'C:\Users\nodejs\templates'
+winpath2 = '\\ServerX\admin$\system32\'
+quoted   = 'Tom "Dubs" Preston-Werner'
+regex    = '<\i\c*\s*>'
+
+
+[string.literal.multiline]
+
+regex2 = '''I [dw]on't need \d{2} apples'''
+lines  = '''
+The first newline is
+trimmed in raw strings.
+   All other whitespace
+   is preserved.
+'''
+
+
+################################################################################
+## Integer
+
+# Integers are whole numbers. Positive numbers may be prefixed with a plus sign.
+# Negative numbers are prefixed with a minus sign.
+
+[integer]
+
+key1 = +99
+key2 = 42
+key3 = 0
+key4 = -17
+
+[integer.underscores]
+
+# For large numbers, you may use underscores to enhance readability. Each
+# underscore must be surrounded by at least one digit.
+key1 = 1_000
+key2 = 5_349_221
+key3 = 1_2_3_4_5     # valid but inadvisable
+
+
+################################################################################
+## Float
+
+# A float consists of an integer part (which may be prefixed with a plus or
+# minus sign) followed by a fractional part and/or an exponent part.
+
+[float.fractional]
+
+key1 = +1.0
+key2 = 3.1415
+key3 = -0.01
+
+[float.exponent]
+
+key1 = 5e+22
+key2 = 1e6
+key3 = -2E-2
+
+[float.both]
+
+key = 6.626e-34
+
+[float.underscores]
+
+key1 = 9_224_617.445_991_228_313
+key2 = 1e1_000
+
+
+################################################################################
+## Boolean
+
+# Booleans are just the tokens you're used to. Always lowercase.
+
+[boolean]
+
+True = true
+False = false
+
+
+################################################################################
+## Datetime
+
+# Datetimes are RFC 3339 dates.
+
+[datetime]
+
+key1 = 1979-05-27T07:32:00Z
+key2 = 1979-05-27T00:32:00-07:00
+key3 = 1979-05-27T00:32:00.999999-07:00
+
+
+################################################################################
+## Array
+
+# Arrays are square brackets with other primitives inside. Whitespace is
+# ignored. Elements are separated by commas. Data types may not be mixed.
+
+[array]
+
+key1 = [ 1, 2, 3 ]
+key2 = [ "red", "yellow", "green" ]
+key3 = [ [ 1, 2 ], [3, 4, 5] ]
+key4 = [ [ 1, 2 ], ["a", "b", "c"] ] # this is ok
+
+# Arrays can also be multiline. So in addition to ignoring whitespace, arrays
+# also ignore newlines between the brackets.  Terminating commas are ok before
+# the closing bracket.
+
+key5 = [
+  1, 2, 3
+]
+key6 = [
+  1,
+  2, # this is ok
+]
+
+
+################################################################################
+## Array of Tables
+
+# These can be expressed by using a table name in double brackets. Each table
+# with the same double bracketed name will be an element in the array. The
+# tables are inserted in the order encountered.
+
+[[products]]
+
+name = "Hammer"
+sku = 738594937
+
+[[products]]
+
+[[products]]
+
+name = "Nail"
+sku = 284758393
+color = "gray"
+
+
+# You can create nested arrays of tables as well.
+
+[[fruit]]
+  name = "apple"
+
+  [fruit.physical]
+    color = "red"
+    shape = "round"
+
+  [[fruit.variety]]
+    name = "red delicious"
+
+  [[fruit.variety]]
+    name = "granny smith"
+
+[[fruit]]
+  name = "banana"
+
+  [[fruit.variety]]
+    name = "plantain"

data/test/grammar_test.rb

@@ -83,17 +83,26 @@ class GrammarTest < Test::Unit::TestCase
   def test_integer
     match = Document.parse('26', root: :number)
     assert_equal(26, match.value)
+
+    match = Document.parse('1_200_000_999', root: :number)
+    assert_equal(1_200_000_999, match.value)
   end
 
   def test_float
     match = Document.parse('1.69', root: :number)
     assert_equal(1.69, match.value)
 
+    match = Document.parse('1_000.69', root: :number)
+    assert_equal(1000.69, match.value)
+
     match = Document.parse('1e6', root: :number)
     assert_equal(1e6, match.value)
 
     match = Document.parse('1.02e-46', root: :number)
     assert_equal(1.02e-46, match.value)
+
+    match = Document.parse('+1e4_000_000', root: :number)
+    assert_equal(1e4_000_000, match.value)
   end
 
   def test_signed_numbers
@@ -135,6 +144,10 @@ class GrammarTest < Test::Unit::TestCase
 
     match = Document.parse('[ ["hey", "TOML"], [2,4] ]', root: :array)
     assert_equal([%w(hey TOML), [2, 4]], match.value)
+
+    match = Document.parse('[ { one = 1 }, { two = 2, three = 3} ]',
+                           root: :inline_table_array)
+    assert_equal([{ 'one' => 1 }, { 'two' => 2, 'three' => 3 }], match.value)
   end
 
   def test_multiline_array
@@ -162,6 +175,17 @@ class GrammarTest < Test::Unit::TestCase
     assert_equal(Time.utc(1986, 8, 28, 18, 15, 0.123), match.value)
   end
 
+  def test_inline_table
+    match = Document.parse('{ }', root: :inline_table)
+    assert_equal({}, match.value)
+
+    match = Document.parse('{ simple = true, params = 2 }', root: :inline_table)
+    assert_equal({ 'simple' => true, 'params' => 2 }, match.value)
+
+    match = Document.parse('{ nest = { hard = true } }', root: :inline_table)
+    assert_equal({ 'nest' => { 'hard' => true } }, match.value)
+  end
+
   private
 
   # Creates all the alternatives of valid indentations to test

data/test/toml_examples.rb

@@ -1,77 +1,98 @@
 class TomlExamples
-  def self.example_v_0_3_1
+  def self.example_v_0_4_0
     {
-      'Table' => {
-        'key' => 'value'
-      },
-      'dog' => {
-        'tater' => {
-          'type' => 'pug'
+      "table" => {
+        "key" => "value",
+        "subtable" => {
+          "key" => "another value"
+        },
+        "inline" => {
+          "name" => {
+            "first" => "Tom",
+            "last" => "Preston-Werner"
+          },
+          "point" => {
+            "x" => 1,
+            "y" => 2
+          }
         }
       },
-      'x' => {
-        'y' => {
-          'z' => {
-            'w' => {}
+      "x" => {
+        "y" => {
+          "z" => {
+            "w" => {}
           }
         }
       },
-      'String' => {
-        'basic' => "I'm a string. \"You can quote me\". Name\tJos\\u00E9\nLocation\tSF.",
-        'Multiline' => {
-          'key1' => "One\nTwo",
-          'key2' => "One\nTwo",
-          'key3' => "One\nTwo"
+      "string" => {
+        "basic" => {
+          "basic" => "I'm a string. \"You can quote me\". Name\tJos\\u00E9\nLocation\tSF."
         },
-        'Multilined' => {
-          'Singleline' => {
-            'key1' => 'The quick brown fox jumps over the lazy dog.',
-            'key2' => 'The quick brown fox jumps over the lazy dog.',
-            'key3' => 'The quick brown fox jumps over the lazy dog.'
+        "multiline" => {
+          "key1" => "One\nTwo",
+          "key2" => "One\nTwo",
+          "key3" => "One\nTwo",
+          "continued" => {
+            "key1" => "The quick brown fox jumps over the lazy dog.",
+            "key2" => "The quick brown fox jumps over the lazy dog.",
+            "key3" => "The quick brown fox jumps over the lazy dog."
           }
         },
-        'Literal' => {
-          'winpath' => 'C:\\Users\nodejs\templates',
-          'winpath2' => "\\\\ServerX\\admin$\\system32\\",
-          'quoted' => 'Tom "Dubs" Preston-Werner',
-          'regex' => '<\i\c*\s*>',
-          'Multiline' => {
-            "regex2" => "I [dw]on't need \\d{2} apples",
-            "lines" => "The first newline is\ntrimmed in raw strings.\n   All other whitespace\n   is preserved.\n"
+        "literal" => {
+          "winpath" => "C:\\Users\\nodejs\\templates",
+          "winpath2" => "\\\\ServerX\\admin$\\system32\\",
+          "quoted" => "Tom\"Dubs\"Preston-Werner",
+          "regex" => "<\\i\\c*\\s*>",
+          "multiline" => {
+            "regex2" => "I[
+                dw
+            ]on'tneed\\d{
+                2
+            }apples",
+            "lines" => "Thefirstnewlineis\ntrimmedinrawstrings.\nAllotherwhitespace\nispreserved.\n"
           }
         }
       },
-      "Integer" => {
+      "integer" => {
         "key1" => 99,
         "key2" => 42,
         "key3" => 0,
-        "key4" => -17
+        "key4" => -17,
+        "underscores" => {
+          "key1" => 1000,
+          "key2" => 5349221,
+          "key3" => 12345
+        }
       },
-      "Float" => {
+      "float" => {
         "fractional" => {
           "key1" => 1.0,
           "key2" => 3.1415,
           "key3" => -0.01
         },
-        "both" => {
-          "key" => 6.626e-34
-        },
         "exponent" => {
           "key1" => 5.0e+22,
           "key2" => 1000000.0,
           "key3" => -0.02
+        },
+        "both" => {
+          "key" => 6.626e-34
+        },
+        "underscores" => {
+          "key1" => 9224617.445991227,
+          "key2" => 1e1_000
         }
       },
-      "Booleans" => {
+      "boolean" => {
         "True" => true,
         "False" => false
       },
-      "Datetime" => {
+      "datetime" => {
         "key1" => Time.utc(1979, 05, 27, 07, 32, 0),
         "key2" => Time.new(1979, 05, 27, 00, 32, 0, '-07:00'),
         "key3" => Time.new(1979, 05, 27, 00, 32, 0.999999, '-07:00')
       },
-      "Array" => {
+      "array" => {
         "key1" => [1, 2, 3],
         "key2" => %w(red yellow green),
         "key3" => [[1, 2], [3, 4, 5]],

data/test/toml_test.rb

@@ -2,10 +2,10 @@ require_relative 'helper'
 require_relative 'toml_examples'
 
 class TomlTest < Test::Unit::TestCase
-  def test_file_v_0_3_1
-    path = File.join(File.dirname(__FILE__), 'example-v0.3.1.toml')
+  def test_file_v_0_4_0
+    path = File.join(File.dirname(__FILE__), 'example-v0.4.0.toml')
     parsed = TOML.load_file(path)
-    hash = TomlExamples.example_v_0_3_1
+    hash = TomlExamples.example_v_0_4_0
 
     assert_equal hash['Array'], parsed['Array']
     assert_equal hash['Booleans'], parsed['Booleans']

data/toml-rb.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'toml-rb'
-  s.version     = '0.2.1'
+  s.version     = '0.3.0'
   s.date        = Time.now.strftime('%Y-%m-%d')
   s.summary     = 'TOML parser in ruby, for ruby.'
   s.description = 'A TOML parser using Citrus parsing library. '

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: toml-rb
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Emiliano Mancuso
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-05 00:00:00.000000000 Z
+date: 2015-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citrus
@@ -48,6 +48,7 @@ files:
 - lib/toml/grammars/document.citrus
 - lib/toml/grammars/helper.citrus
 - lib/toml/grammars/primitive.citrus
+- lib/toml/inline_table.rb
 - lib/toml/keygroup.rb
 - lib/toml/keyvalue.rb
 - lib/toml/parser.rb
@@ -55,7 +56,7 @@ files:
 - lib/toml/table_array.rb
 - test/dumper_test.rb
 - test/errors_test.rb
-- test/example-v0.3.1.toml
+- test/example-v0.4.0.toml
 - test/example.toml
 - test/grammar_test.rb
 - test/hard_example.toml

data/test/example-v0.3.1.toml

@@ -1,180 +0,0 @@
-# Comment
-# I am a comment. Hear me roar. Roar.
-
-# Table
-# Tables (also known as hash tables or dictionaries) are collections of key/value pairs.
-# They appear in square brackets on a line by themselves.
-
-[Table]
-
-key = "value" # Yeah, you can do this.
-
-# Nested tables are denoted by table names with dots in them. Name your tables whatever crap you please, just don't use #, ., [ or ].
-
-[dog.tater]
-type = "pug"
-
-# You don't need to specify all the super-tables if you don't want to. TOML knows how to do it for you.
-
-# [x] you
-# [x.y] don't
-# [x.y.z] need these
-[x.y.z.w] # for this to work
-
-# String
-# There are four ways to express strings: basic, multi-line basic, literal, and multi-line literal.
-# All strings must contain only valid UTF-8 characters.
-
-[String]
-basic = "I'm a string. \"You can quote me\". Name\tJos\u00E9\nLocation\tSF."
-
-[String.Multiline]
-
-# The following strings are byte-for-byte equivalent:
-key1 = "One\nTwo"
-key2 = """One\nTwo"""
-key3 = """
-One
-Two"""
-
-[String.Multilined.Singleline]
-
-# The following strings are byte-for-byte equivalent:
-key1 = "The quick brown fox jumps over the lazy dog."
-
-key2 = """
-The quick brown \
-
-
-  fox jumps over \
-    the lazy dog."""
-
-key3 = """\
-       The quick brown \
-       fox jumps over \
-       the lazy dog.\
-       """
-
-[String.Literal]
-
-# What you see is what you get.
-winpath  = 'C:\Users\nodejs\templates'
-winpath2 = '\\ServerX\admin$\system32\'
-quoted   = 'Tom "Dubs" Preston-Werner'
-regex    = '<\i\c*\s*>'
-
-[String.Literal.Multiline]
-
-regex2 = '''I [dw]on't need \d{2} apples'''
-lines  = '''
-The first newline is
-trimmed in raw strings.
-   All other whitespace
-   is preserved.
-'''
-
-# Integer
-# Integers are whole numbers. Positive numbers may be prefixed with a plus sign.
-# Negative numbers are prefixed with a minus sign.
-
-[Integer]
-key1 = +99
-key2 = 42
-key3 = 0
-key4 = -17
-
-# Float
-# A float consists of an integer part (which may be prefixed with a plus or minus sign)
-# followed by a fractional part and/or an exponent part.
-
-[Float.fractional]
-
-# fractional
-key1 = +1.0
-key2 = 3.1415
-key3 = -0.01
-
-[Float.exponent]
-
-# exponent
-key1 = 5e+22
-key2 = 1e6
-key3 = -2E-2
-
-[Float.both]
-
-# both
-key = 6.626e-34
-
-# Boolean
-# Booleans are just the tokens you're used to. Always lowercase.
-
-[Booleans]
-True = true
-False = false
-
-# Datetime
-# Datetimes are RFC 3339 dates.
-
-[Datetime]
-key1 = 1979-05-27T07:32:00Z
-key2 = 1979-05-27T00:32:00-07:00
-key3 = 1979-05-27T00:32:00.999999-07:00
-
-# Array
-# Arrays are square brackets with other primitives inside. Whitespace is ignored. Elements are separated by commas. Data types may not be mixed.
-
-[Array]
-key1 = [ 1, 2, 3 ]
-key2 = [ "red", "yellow", "green" ]
-key3 = [ [ 1, 2 ], [3, 4, 5] ]
-key4 = [ [ 1, 2 ], ["a", "b", "c"] ] # this is ok
-
-#Arrays can also be multiline. So in addition to ignoring whitespace, arrays also ignore newlines between the brackets.
-# Terminating commas are ok before the closing bracket.
-
-key5 = [
-  1, 2, 3
-]
-key6 = [
-  1,
-  2, # this is ok
-]
-
-# Array of Tables
-# These can be expressed by using a table name in double brackets.
-# Each table with the same double bracketed name will be an element in the array.
-# The tables are inserted in the order encountered.
-
-[[products]]
-name = "Hammer"
-sku = 738594937
-
-[[products]]
-
-[[products]]
-name = "Nail"
-sku = 284758393
-color = "gray"
-
-
-# You can create nested arrays of tables as well.
-
-[[fruit]]
-  name = "apple"
-
-  [fruit.physical]
-    color = "red"
-    shape = "round"
-
-  [[fruit.variety]]
-    name = "red delicious"
-
-  [[fruit.variety]]
-    name = "granny smith"
-
-[[fruit]]
-  name = "banana"
-
-  [[fruit.variety]]
-    name = "plantain"