toml-rb 0.1.2 → 0.1.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODJhZWQzOTUxMzkwMDc3ODIxYzM0Zjg4ZTMwODU3YjY2NmM2Y2E4Mg==
+    ZTg0ZGY1MTk0NzM3MjAxZThkZjRhNWU2MGMxODM2OTBhMTkwZTJiYQ==
   data.tar.gz: !binary |-
-    NGQ4MmM2NDE2MmY3NGNhODM2ZDBiYmE5MmQ4YTk0MzZlYTU4ZjY3Zg==
+    YTgwMDkwYzQ5ZDExNTJlYjJjMWZkZjFjOTU4MzY5N2I5MWI3MWQ2Zg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MWNjN2JhYTBhMDQ0ZDgzMDU1ZjVkMWQzY2Y2MDE0MmRjNmZiOGUwZjFkNzA2
-    M2RhMTBhMjgyMjQwMTE5ZmJlMzZjYmI1MzRjZTNiYWU3MzE4NjY4YmQzOWVh
-    ZDkzZTYxNjhhY2EwNzQ5YzQ2NzdmYjYzYTMwYmU0Y2E0OTVjZTg=
+    YjYyYTczYjRhZGFlMzg2MjU0NjdjZDZkOWE2ZDQ2YmUxNjVlNTUxMDMxNTY5
+    ZGIxZDgyZjU3YmQ4MjYwMjgwZjVhN2NjMGNjZTBlNGQ3OWU3M2U5MzdiMzM3
+    NTJhNjI0ZjQxZWQ1YjQ5NTMzZjY3NGYxYWNmNWU3NzlmYjQxZGE=
   data.tar.gz: !binary |-
-    ZjA1MWEwMWY2YzA5OTNkYWE2MjFjNDNiNWY2ZmYyZGI5ZWM1Y2FhOTA1MGI2
-    M2I5ZjkxZmI1MTRjMzkxOGEyYmEyYzc4MGM0OTI1N2MyMjM2ZjJlYTU4MGQ4
-    OWQxYWJlZDhkNTVmYzBkNWE0OTFjMTAzMjFmYThiNGVhZjY2NzY=
+    NjY3ODY1MDA4Y2M5ZWE1ZWZhNGE2ZGQ3ZjkxMjBmODVkM2EzNDRiNjc2ZTE4
+    Mjk4ZGYzZmZhNjhjMjE0MDMxODk3NTg1MDM5MTkyYzgyMGQ0Y2MyZGE0M2Ji
+    MzEyNzYwZjQzZTU5NTE1YTc4NDNhMTkxYTg4ZWRhNGY3ZmNkMmY=

data/README.md

@@ -11,8 +11,8 @@ Installation
 
     $ gem install toml-rb
 
-Usage
------
+Parser Usage
+------------
 
 ```ruby
 require 'toml'
@@ -30,12 +30,37 @@ stream = <<-EOS
     others = false
 EOS
 TOML.parse(stream)
+# => {"title"=>"wow!", "awesome"=>{"you"=>true, "others"=>false}}
 
 # You want symbols as your keys? No problem!
 TOML.load_file(path, symbolize_keys: true) 
 # Works the same for TOML.parse
 ```
 
+Dumper Usage
+------------
+
+```ruby
+require 'toml'
+
+# Simple example
+TOML.dump( simple: true)
+# => "simple = true\n"
+
+
+# Complex example
+hash = { 
+    "title"=>"wow!", 
+    "awesome"=> {
+        "you"=>true, 
+        "others"=>false
+    }
+}
+
+TOML.dump(hash)
+# => "title = \"wow!\"\n[awesome]\nothers = false\nyou = true\n"
+```
+
 Contributing
 ------------
 

data/lib/toml.rb

@@ -1,4 +1,4 @@
-require_relative "../init"
+require_relative '../init'
 
 module TOML
 
@@ -62,15 +62,23 @@ module TOML
   #
   # Examples
   #
-  #   TOML.dump({title: "TOML dump"})
-  #   # => TODO:
+  #   TOML.dump(title: 'TOML dump')
+  #   # => "simple = true\n"
   #
-  #   TOML.parse('title = "TOML parser"')
-  #   # => 
+  #   hash = {
+  #     "title"=>"wow!",
+  #     "awesome"=> {
+  #       "you"=>true,
+  #       "others"=>false
+  #     }
+  #   }
+  #
+  #   TOML.dump(hash)
+  #   # => "title = \"wow!\"\n[awesome]\nothers = false\nyou = true\n"
   #
   #
   # Returns a TOML string representing the hash.
   def self.dump(hash)
-    Dumper.new(hash)
+    Dumper.new(hash).toml_str
   end
 end

data/lib/toml/dumper.rb

@@ -3,7 +3,7 @@ module TOML
     attr_reader :toml_str
 
     def initialize(hash)
-      @toml_str = ""
+      @toml_str = ''
 
       visit(hash, '')
     end
@@ -22,12 +22,12 @@ module TOML
       @toml_str += "[#{prefix}]\n" unless prefix.empty? || simple_pairs.empty?
 
       # First add simple pairs, under the prefix
-      simple_pairs.each do |pair|
-        @toml_str << "#{pair[0].to_s} = #{to_toml(pair[1])}\n"
+      simple_pairs.each do |key, val|
+        @toml_str << "#{key.to_s} = #{to_toml(val)}\n"
       end
 
-      nested_pairs.each do |pair|
-        visit(pair[1], prefix.empty? ? pair[0].to_s : [prefix, pair[0]].join('.'))
+      nested_pairs.each do |key, val|
+        visit(val, prefix.empty? ? key.to_s : [prefix, key].join('.'))
       end
     end
 

data/lib/toml/grammars/helper.citrus

@@ -12,6 +12,6 @@ grammar Helper
   end
 
   rule line_break
-    "\n" | "\r\n"
+    ("\n" | "\r\n") { nil }
   end
 end

data/lib/toml/keygroup.rb

@@ -13,12 +13,16 @@ module TOML
 
       hash
     end
+
+    def accept_visitor(parser)
+      parser.visit_keygroup(self)
+    end
   end
 end
 
-# Used in toml.citrus
+# Used in document.citrus
 module Keygroup
   def value
-    TOML::Keygroup.new(nested_keys.to_s.split("."))
+    TOML::Keygroup.new(nested_keys.to_s.split('.'))
   end
 end

data/lib/toml/keyvalue.rb

@@ -7,15 +7,18 @@ module TOML
     end
 
     def assign(hash, symbolize_keys = false)
-      raise ValueOverwriteError if hash[@key]
-
       key = symbolize_keys ? @key.to_sym : @key
+      raise ValueOverwriteError if hash[key]
       hash[key] = @value
     end
+
+    def accept_visitor(parser)
+      parser.visit_keyvalue(self)
+    end
   end
 end
 
-# Used in toml.citrus
+# Used in document.citrus
 module Keyvalue
   def value
     TOML::Keyvalue.new(key.value, v.value)

data/lib/toml/parser.rb

@@ -5,15 +5,20 @@ module TOML
     def initialize(content, options = {})
       @hash = {}
       @current = @hash
+      @symbolize_keys = options[:symbolize_keys]
 
       parsed = Document.parse(content)
-      parsed.matches.map(&:value).compact.each do |match|
-        if match.is_a? Keygroup
-          @current = match.navigate_keys(@hash, options[:symbolize_keys])
-        elsif match.is_a? Keyvalue
-          match.assign(@current, options[:symbolize_keys])
-        end
-      end
+      parsed.matches.map(&:value).compact.each { |m| m.accept_visitor(self) }
+    end
+
+    # Read about the Visitor pattern
+    # http://en.wikipedia.org/wiki/Visitor_pattern
+    def visit_keygroup(keygroup)
+      @current = keygroup.navigate_keys(@hash, @symbolize_keys)
+    end
+
+    def visit_keyvalue(keyvalue)
+      keyvalue.assign(@current, @symbolize_keys)
     end
   end
 end

data/lib/toml/string.rb

@@ -5,15 +5,15 @@ module TomlString
     s = 0
     o = []
     while s < aux.length
-      if aux[s] == "\\"
+      if aux[s] == '\\'
         s += 1
         case aux[s]
-        when "t" then o << "\t"
-        when "n" then o << "\n"
-        when "\\" then o << "\\"
+        when 't' then o << "\t"
+        when 'n' then o << "\n"
+        when '\\' then o << '\\'
         when '"' then o << '"'
-        when "r" then o << "\r"
-        when "0" then o << "\0"
+        when 'r' then o << "\r"
+        when '0' then o << "\0"
         else
           o << '\\' << aux[s]
         end

data/test/dumper_test.rb

@@ -4,45 +4,43 @@ class DumperTest < Test::Unit::TestCase
 
   def test_dump_empty
     dumped = TOML.dump({})
-    assert_equal('', dumped.toml_str)
+    assert_equal('', dumped)
   end
 
   def test_dump_types
     dumped = TOML.dump(string: %q(TOML "dump"))
-    assert_equal("string = \"TOML \\\"dump\\\"\"\n", dumped.toml_str)
+    assert_equal("string = \"TOML \\\"dump\\\"\"\n", dumped)
 
     dumped = TOML.dump(float: -13.24)
-    assert_equal("float = -13.24\n", dumped.toml_str)
+    assert_equal("float = -13.24\n", dumped)
 
     dumped = TOML.dump(int: 1234)
-    assert_equal("int = 1234\n", dumped.toml_str)
+    assert_equal("int = 1234\n", dumped)
 
     dumped = TOML.dump(true: true)
-    assert_equal("true = true\n", dumped.toml_str)
+    assert_equal("true = true\n", dumped)
 
     dumped = TOML.dump(false: false)
-    assert_equal("false = false\n", dumped.toml_str)
+    assert_equal("false = false\n", dumped)
 
-    dumped = TOML.dump(array: [1,2,3])
-    assert_equal("array = [1, 2, 3]\n", dumped.toml_str)
+    dumped = TOML.dump(array: [1, 2, 3])
+    assert_equal("array = [1, 2, 3]\n", dumped)
 
-    dumped = TOML.dump(array: [[1,2], ["weird", "one"]])
-    assert_equal("array = [[1, 2], [\"weird\", \"one\"]]\n", dumped.toml_str)
+    dumped = TOML.dump(array: [[1, 2], ['weird', 'one']])
+    assert_equal("array = [[1, 2], [\"weird\", \"one\"]]\n", dumped)
 
-    dumped = TOML.dump(datetime: Time.utc(1986,8,28,15,15))
-    assert_equal("datetime = 1986-08-28T15:15:00Z\n", dumped.toml_str)
+    dumped = TOML.dump(datetime: Time.utc(1986, 8, 28, 15, 15))
+    assert_equal("datetime = 1986-08-28T15:15:00Z\n", dumped)
   end
 
   def test_dump_nested_attributes
     hash = {nested: {hash: { deep: true}}}
     dumped = TOML.dump(hash)
-    assert_equal("[nested.hash]\ndeep = true\n",
-                 dumped.toml_str)
+    assert_equal("[nested.hash]\ndeep = true\n", dumped)
 
     hash[:nested].merge!(other: 12)
     dumped = TOML.dump(hash)
-    assert_equal("[nested]\nother = 12\n[nested.hash]\ndeep = true\n",
-                 dumped.toml_str)
+    assert_equal("[nested]\nother = 12\n[nested.hash]\ndeep = true\n", dumped)
 
     hash[:nested].merge!(nest: {again: 'it never ends'})
     dumped = TOML.dump(hash)
@@ -53,6 +51,6 @@ class DumperTest < Test::Unit::TestCase
             "[nested.nest]\n" +
             "again = \"it never ends\"\n"
 
-    assert_equal(toml, dumped.toml_str)
+    assert_equal(toml, dumped)
   end
 end

data/test/grammar_test.rb

@@ -1,9 +1,9 @@
-require_relative "helper"
+require_relative 'helper'
 
 class GrammarTest < Test::Unit::TestCase
 
   def test_comment
-    match = Document.parse(" # A comment", root: :comment)
+    match = Document.parse(' # A comment', root: :comment)
     assert_equal(nil, match.value)
   end
 
@@ -11,11 +11,12 @@ class GrammarTest < Test::Unit::TestCase
     indentation_alternatives_for('[akey]') do |str|
       match = Document.parse(str, root: :keygroup)
       assert_equal(TOML::Keygroup, match.value.class)
-      assert_equal(['akey'], match.value.instance_variable_get("@nested_keys"))
+      assert_equal(['akey'], match.value.instance_variable_get('@nested_keys'))
     end
 
     match = Document.parse('[owner.emancu]', root: :keygroup)
-    assert_equal(['owner', 'emancu'], match.value.instance_variable_get("@nested_keys"))
+    assert_equal(['owner', 'emancu'],
+                 match.value.instance_variable_get('@nested_keys'))
   end
 
   def test_keyvalue
@@ -24,14 +25,14 @@ class GrammarTest < Test::Unit::TestCase
       assert_equal(TOML::Keyvalue, match.value.class)
 
       keyvalue = match.value
-      assert_equal('key', keyvalue.instance_variable_get("@key"))
-      assert_equal('value', keyvalue.instance_variable_get("@value"))
+      assert_equal('key', keyvalue.instance_variable_get('@key'))
+      assert_equal('value', keyvalue.instance_variable_get('@value'))
     end
   end
 
   def test_string
     match = Document.parse('"TOML-Example, should work."', root: :string)
-    assert_equal("TOML-Example, should work.", match.value)
+    assert_equal('TOML-Example, should work.', match.value)
   end
 
   def test_special_characters
@@ -39,7 +40,7 @@ class GrammarTest < Test::Unit::TestCase
     assert_equal("\0 \" \t \n \r", match.value)
 
     match = Document.parse('"C:\\Documents\\virus.exe"', root: :string)
-    assert_equal("C:\\Documents\\virus.exe", match.value)
+    assert_equal('C:\\Documents\\virus.exe', match.value)
   end
 
   def test_bool
@@ -76,11 +77,12 @@ class GrammarTest < Test::Unit::TestCase
 
   def test_expressions_with_comments
     match = Document.parse('[shouldwork] # with comment', root: :keygroup)
-    assert_equal(['shouldwork'], match.value.instance_variable_get("@nested_keys"))
+    assert_equal(['shouldwork'],
+                 match.value.instance_variable_get('@nested_keys'))
 
     match = Document.parse('works = true # with comment', root: :keyvalue).value
-    assert_equal("works", match.instance_variable_get("@key"))
-    assert_equal(true, match.instance_variable_get("@value"))
+    assert_equal('works', match.instance_variable_get('@key'))
+    assert_equal(true, match.instance_variable_get('@value'))
   end
 
   def test_array
@@ -88,25 +90,25 @@ class GrammarTest < Test::Unit::TestCase
     assert_equal([], match.value)
 
     match = Document.parse('[ 2, 4]', root: :array)
-    assert_equal([2,4], match.value)
+    assert_equal([2, 4], match.value)
 
     match = Document.parse('[ 2.4, 4.72]', root: :array)
-    assert_equal([2.4,4.72], match.value)
+    assert_equal([2.4, 4.72], match.value)
 
     match = Document.parse('[ "hey", "TOML"]', root: :array)
-    assert_equal(["hey","TOML"], match.value)
+    assert_equal(['hey', 'TOML'], match.value)
 
     match = Document.parse('[ ["hey", "TOML"], [2,4] ]', root: :array)
-    assert_equal([["hey","TOML"], [2,4]], match.value)
+    assert_equal([['hey', 'TOML'], [2, 4]], match.value)
 
     multiline_array = "[ \"hey\",\n   \"ho\",\n\t \"lets\", \"go\",\n ]"
     match = Document.parse(multiline_array, root: :array)
-    assert_equal(["hey", "ho", "lets", "go"], match.value)
+    assert_equal(['hey', 'ho', 'lets', 'go'], match.value)
   end
 
   def test_datetime
     match = Document.parse('1986-08-28T15:15:00Z', root: :datetime)
-    assert_equal(Time.utc(1986,8,28,15,15), match.value)
+    assert_equal(Time.utc(1986, 8, 28, 15, 15), match.value)
   end
 
   private

data/test/hard_example.toml

@@ -6,11 +6,11 @@
 test_string = "You'll hate me after this - #" # " Annoying, isn't it?
 
     [the.hard]
-    test_array = [ "] ", " # "] # ] There you go, parse this!
-    test_array2 = [ "Test #11 ]proved that", "Experiment #9 was a success" ]
+    array = [ "] ", " # "] # ] There you go, parse this!
+    array2 = [ "Test #11 ]proved that", "Experiment #9 was a success" ]
     # You didn't think it'd as easy as chucking out the last #, did you?
-    another_test_string = " Same thing, but with a string #"
-    harder_test_string = " And when \"'s are in the string, along with # \"" # "and comments are there too"
+    another_string = " Same thing, but with a string #"
+    harder_string = "And when \"'s are in the string, along with # \"" # "and comments are there too"
     # Things will get harder
 
         [the.hard.bit#]
@@ -19,5 +19,3 @@ test_string = "You'll hate me after this - #" # " Annoying, isn't it?
             "]",
             # ] Oh yes I did
             ]
-
-# Each of the following keygroups/key value pairs should produce an error. Uncomment to them to test

data/test/helper.rb

@@ -1,2 +1,2 @@
-require "test/unit"
-require_relative "../lib/toml"
+require 'test/unit'
+require_relative '../lib/toml'

data/test/toml_test.rb

@@ -6,36 +6,36 @@ class TomlTest < Test::Unit::TestCase
     parsed = TOML.load_file(path)
 
     hash = {
-      "title" => "TOML Example",
+      'title' => 'TOML Example',
 
-      "owner" => {
-        "name" => "Tom Preston-Werner",
-        "organization" => "GitHub",
-        "bio" => "GitHub Cofounder & CEO\nLikes tater tots and beer.",
-        "dob" => Time.utc(1979,05,27,07,32,00)
+      'owner' => {
+        'name' => 'Tom Preston-Werner',
+        'organization' => 'GitHub',
+        'bio' => "GitHub Cofounder & CEO\nLikes tater tots and beer.",
+        'dob' => Time.utc(1979, 05, 27, 07, 32, 00)
       },
 
-      "database" => {
-        "server" => "192.168.1.1",
-        "ports" => [ 8001, 8001, 8002 ],
-        "connection_max" => 5000,
-        "enabled" => true
+      'database' => {
+        'server' => '192.168.1.1',
+        'ports' => [8001, 8001, 8002],
+        'connection_max' => 5000,
+        'enabled' => true
       },
 
-      "servers" => {
-        "alpha" => {
-          "ip" => "10.0.0.1",
-          "dc" => "eqdc10"
+      'servers' => {
+        'alpha' => {
+          'ip' => '10.0.0.1',
+          'dc' => 'eqdc10'
         },
-        "beta" => {
-          "ip" => "10.0.0.2",
-          "dc" => "eqdc10"
+        'beta' => {
+          'ip' => '10.0.0.2',
+          'dc' => 'eqdc10'
         }
       },
 
-      "clients" => {
-        "data" => [["gamma", "delta"], [1, 2]],
-        "hosts" => ["alpha", "omega"]
+      'clients' => {
+        'data' => [['gamma', 'delta'], [1, 2]],
+        'hosts' => ['alpha', 'omega']
       }
     }
 
@@ -47,16 +47,16 @@ class TomlTest < Test::Unit::TestCase
     parsed = TOML.load_file(path)
 
     hash = {
-      "the" => {
-        "test_string" => "You'll hate me after this - #",
-        "hard" => {
-          "test_array"  =>  [ "] ", " # "],
-          "test_array2" =>  [ "Test #11 ]proved that", "Experiment #9 was a success" ],
-          "another_test_string" => " Same thing, but with a string #",
-          "harder_test_string" => " And when \"'s are in the string, along with # \"",
-          "bit#" => {
-            "what?" => "You don't think some user won't do that?",
-            "multi_line_array" => [ "]" ]
+      'the' => {
+        'test_string' => "You'll hate me after this - #",
+        'hard' => {
+          'array'  =>  ['] ', ' # '],
+          'array2' =>  ['Test #11 ]proved that', 'Experiment #9 was a success'],
+          'another_string' => ' Same thing, but with a string #',
+          'harder_string' => "And when \"'s are in the string, along with # \"",
+          'bit#' => {
+            'what?' => "You don't think some user won't do that?",
+            'multi_line_array' => [']']
           }
         }
       }
@@ -70,36 +70,36 @@ class TomlTest < Test::Unit::TestCase
     parsed = TOML.load_file(path, symbolize_keys: true)
 
     hash = {
-      title: "TOML Example",
+      title: 'TOML Example',
 
       owner: {
-        name: "Tom Preston-Werner",
-        organization: "GitHub",
+        name: 'Tom Preston-Werner',
+        organization: 'GitHub',
         bio: "GitHub Cofounder & CEO\nLikes tater tots and beer.",
-        dob: Time.utc(1979,05,27,07,32,00)
+        dob: Time.utc(1979, 05, 27, 07, 32, 00)
       },
 
       database: {
-        server: "192.168.1.1",
-        ports: [ 8001, 8001, 8002 ],
+        server: '192.168.1.1',
+        ports: [8001, 8001, 8002],
         connection_max: 5000,
         enabled: true
       },
 
       servers: {
         alpha: {
-          ip: "10.0.0.1",
-          dc: "eqdc10"
+          ip: '10.0.0.1',
+          dc: 'eqdc10'
         },
         beta: {
-          ip: "10.0.0.2",
-          dc: "eqdc10"
+          ip: '10.0.0.2',
+          dc: 'eqdc10'
         }
       },
 
       clients: {
-        data: [["gamma", "delta"], [1, 2]],
-        hosts: ["alpha", "omega"]
+        data: [['gamma', 'delta'], [1, 2]],
+        hosts: ['alpha', 'omega']
       }
     }
 

data/toml-rb.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'toml-rb'
-  s.version     = '0.1.2'
+  s.version     = '0.1.3'
   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. Formerly known as 'toml_parser-ruby'. "

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: toml-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Emiliano Mancuso
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-12 00:00:00.000000000 Z
+date: 2013-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citrus