toml 0.0.4 → 0.1.0

data/Gemfile

@@ -4,5 +4,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
+  gem 'multi_json', '~> 1.7.8'
   gem 'minitest'
+  gem 'simplecov', :require => false
+  gem 'simplecov-gem-adapter', :require => false
 end

data/README.md

@@ -4,6 +4,8 @@ A sane configuration format from @mojombo.  More information here: https://githu
 
 This is far superior to YAML and JSON because it doesn't suck.  Really it doesn't.
 
+**There is a bug in Rails 2.3's vendored version of BlankSlate (a dependency of Parslet which is used for parsing TOML) that breaks Parslet; please see this [Gist](https://gist.github.com/dirk/5264004) for a workaround.**
+
 ## Usage
 
 Add to your Gemfile:

data/Rakefile

@@ -45,19 +45,39 @@ end
 
 task :default => :test
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+# require 'rake/testtask'
+# Rake::TestTask.new(:test) do |test|
+#   test.libs << 'lib' << 'test'
+#   test.pattern = 'test/**/test_*.rb'
+#   test.verbose = true
+# end
+task :test do
+  Dir['./test/**/test_*.rb'].each {|f| require f }
 end
 
 desc "Generate RCov test coverage and open in your browser"
 task :coverage do
-  require 'rcov'
-  sh "rm -fr coverage"
-  sh "rcov test/test_*.rb"
-  sh "open coverage/index.html"
+  if RUBY_VERSION =~ /^1\./
+    require 'rubygems'
+    require 'bundler'
+    Bundler.setup(:test)
+    require 'simplecov'
+    require 'simplecov-gem-adapter'
+    
+    sh "rm -fr coverage"
+    SimpleCov.command_name 'Unit Tests'
+    SimpleCov.start 'gem'
+    Rake::Task[:test].invoke
+    SimpleCov.at_exit do
+      SimpleCov.result.format!
+      sh "open coverage/index.html"
+    end
+  else
+    require 'rcov'
+    sh "rm -fr coverage"
+    sh "rcov test/test_*.rb"
+    sh "open coverage/index.html"
+  end
 end
 
 require 'rdoc/task'

data/lib/toml.rb

@@ -4,7 +4,7 @@ require 'time'
 require 'parslet'
 
 require 'toml/key'
-require 'toml/key_group'
+require 'toml/table'
 require 'toml/parslet'
 require 'toml/transformer'
 require 'toml/parser'
@@ -14,7 +14,7 @@ require 'toml/generator'
 # require 'toml/monkey_patch
 
 module TOML
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'
 
   def self.load(content)
     Parser.new(content).parsed

data/lib/toml/generator.rb

@@ -48,6 +48,9 @@ module TOML
       end
       other_pairs.each do |pair|
         key, val = pair
+        if key.include? '.'
+          raise SyntaxError, "Periods are not allowed in keys (failed on key: #{key.inspect})"
+        end
         @body += "#{key} = #{format(val)}\n"
       end
       @body += "\n" unless other_pairs.empty?

data/lib/toml/monkey_patch.rb

@@ -19,3 +19,8 @@ class Array
     "[" + self.map {|v| v.to_toml }.join(",") + "]"
   end
 end
+class DateTime
+  def to_toml
+    self.to_time.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
+  end
+end

data/lib/toml/parser.rb

@@ -4,22 +4,30 @@ module TOML
 
     def initialize(markup)
       # Make sure we have a newline on the end
-      markup += "\n" unless markup.end_with?("\n")
-
+      
+      markup += "\n" unless markup.end_with?("\n") || markup.length == 0
       begin
         tree = Parslet.new.parse(markup)
       rescue Parslet::ParseFailed => failure
         puts failure.cause.ascii_tree
       end
       
-      parts = Transformer.new.apply(tree)
       
+      parts = Transformer.new.apply(tree) || []
       @parsed = {}
       @current = @parsed
       @current_path = ''
       
       parts.each do |part|
         if part.is_a? Key
+          # If @current is an array then we're in a key-group
+          if @current.is_a? Array
+            # Make sure there's a table to work with.
+            @current << {} if @current.last.nil?
+            # Set the key on the table.
+            @current.last[part.key] = part.value
+            next
+          end
           # Make sure the key isn't already set
           if !@current.is_a?(Hash) || @current.has_key?(part.key)
             err = "Cannot override key '#{part.key}'"
@@ -30,28 +38,62 @@ module TOML
           end
           # Set the key-value into the current hash
           @current[part.key] = part.value
-        elsif part.is_a? KeyGroup
-          resolve_key_group(part)
+        elsif part.is_a?(TableArray)
+          resolve_table_array(part)
+        elsif part.is_a?(Table)
+          resolve_table(part)
         else
           raise "Unrecognized part: #{part.inspect}"
         end
       end
     end
     
-    def resolve_key_group(kg)
+    def resolve_table_array(t)
       @current = @parsed
-
-      path = kg.keys.dup
+      path = t.name.dup
       @current_path = path.join('.')
-      
-      while k = path.shift
-        if @current.has_key? k
-          # pass
+      while n = path.shift
+        # If it's a table-array then get the last item.
+        @current = @current.last if @current.is_a? Array
+        
+        # If it's the last item:
+        if path.length == 0
+          # If the current table has an item:
+          if @current.has_key?(n)
+            # And that item is already a table-array:
+            if @current[n].is_a? Array
+              # Then add an item to that table-array.
+              @current[n] << {}
+            else
+              raise "Cannot override table array '#{t.name.join '.'}'"
+            end
+          else
+            # Create a new table array if nothing exists here.
+            @current[n] = []
+          end
+        elsif @current.has_key? n
+          # Don't do anything if we're just moving into tables.
         else
-          @current[k] = {}
+          @current[n] = {}
         end
-        @current = @current[k]
+        @current = @current[n]
       end
     end
+    
+    def resolve_table(t)
+      @current = @parsed
+
+      path = t.name.dup
+      @current_path = path.join('.')
+      while k = path.shift
+        # If it's a table-array then get the last item.
+        @current = @current.last if @current.is_a? Array
+        # Create a new table if one doesn't exist.
+        @current[k] = {} if !@current.has_key? k
+        # Move into the table.
+        @current = @current[k]
+      end
+    end#/resolve_key_group
+    
   end
 end

data/lib/toml/parslet.rb

@@ -2,7 +2,7 @@ module TOML
   class Parslet < ::Parslet::Parser
     rule(:document) {
       all_space >>
-      (key_group | key_value | comment_line).repeat(0) >>
+      (table | table_array | key_value | comment_line).repeat >>
       all_space
     }
     root :document
@@ -18,17 +18,19 @@ module TOML
     
     # Finding comments in multiline arrays requires accepting a bunch of
     # possible newlines and stuff before the comment
-    rule(:array_comments) { (all_space >> comment_line).repeat(0) }
+    rule(:array_comments) { (all_space >> comment_line).repeat }
     
     rule(:array) {
-      str("[") >> ( array_comments >> # Match any comments on first line
+      str("[") >> all_space >> array_comments >>
+      ( array_comments >> # Match any comments on first line
         all_space >> value >> array_comments >>
         (
           # Separator followed by any comments
           all_space >> str(",") >> array_comments >>
           # Value followed by any comments
           all_space >> value >> array_comments
-        ).repeat(0) >>
+        ).repeat >>
+        (all_space >> str(",")).maybe >> # possible trailing comma
         all_space >> array_comments # Grab any remaining comments just in case
       ).maybe.as(:array) >> str("]") 
     }
@@ -39,51 +41,57 @@ module TOML
       space >> value.as(:value) >>
       space >> comment.maybe >> str("\n") >> all_space
     }
-    rule(:key_group) {
+    rule(:table) {
       space >> str("[") >>
-        key_group_name.as(:key_group) >>
+        table_name.as(:table) >>
       str("]") >>
       space >> comment.maybe >> str("\n") >> all_space
     }
+    rule(:table_array) {
+      space >> str("[[") >>
+        table_name.as(:table_array) >>
+      str("]]") >>
+      space >> comment.maybe >> str("\n") >> all_space
+    }
     
-    rule(:key) { match("[^. \t\\]]").repeat(1) }
-    rule(:key_group_name) { key.as(:key) >> (str(".") >> key.as(:key)).repeat(0) }
+    rule(:key) { match["^. \t\\]"].repeat(1) }
+    rule(:table_name) { key.as(:key) >> (str(".") >> key.as(:key)).repeat }
 
     rule(:comment_line) { comment >> str("\n") >> all_space }
-    rule(:comment) { str("#") >> match("[^\n]").repeat(0) }
+    rule(:comment) { str("#") >> match["^\n"].repeat }
 
-    rule(:space) { match("[ \t]").repeat(0) }
-    rule(:all_space) { match("[ \t\r\n]").repeat(0) }
+    rule(:space) { match[" \t"].repeat }
+    rule(:all_space) { match[" \t\r\n"].repeat }
         
     rule(:string) {
       str('"') >> (
-      match("[^\"\\\\]") |
-      (str("\\") >> match("[0tnr\"\\\\]"))
-      ).repeat(0).as(:string) >> str('"')
+      match["^\"\\\\"] |
+      (str("\\") >> match["0tnr\"\\\\"])
+      ).repeat.as(:string) >> str('"')
     }
     
     rule(:sign) { str("-") }
     rule(:sign?) { sign.maybe }
     
     rule(:integer) {
-      str("0") | (sign? >> match("[1-9]") >> match("[0-9]").repeat(0))
+      str("0") | (sign? >> match["1-9"] >> match["0-9"].repeat)
     }
     rule(:float) {
-      sign? >> match("[0-9]").repeat(1) >> str(".") >> match("[0-9]").repeat(1)
+      sign? >> match["0-9"].repeat(1) >> str(".") >> match["0-9"].repeat(1)
     }
 
     rule(:boolean) { str("true").as(:true) | str("false").as(:false) }
     
     rule(:date) {
-      match("[0-9]").repeat(4,4) >> str("-") >>
-      match("[0-9]").repeat(2,2) >> str("-") >>
-      match("[0-9]").repeat(2,2)
+      match["0-9"].repeat(4,4) >> str("-") >>
+      match["0-9"].repeat(2,2) >> str("-") >>
+      match["0-9"].repeat(2,2)
     }
 
     rule(:time) {
-      match("[0-9]").repeat(2,2) >> str(":") >>
-      match("[0-9]").repeat(2,2) >> str(":") >>
-      match("[0-9]").repeat(2,2)
+      match["0-9"].repeat(2,2) >> str(":") >>
+      match["0-9"].repeat(2,2) >> str(":") >>
+      match["0-9"].repeat(2,2)
     }
 
     rule(:datetime) { date >> str("T") >> time >> str("Z") }

data/lib/toml/table.rb

@@ -0,0 +1,10 @@
+module TOML
+  class Table
+    # :name is array of strings
+    attr_reader :name
+    def initialize(name)
+      @name = name
+    end
+  end
+  class TableArray < Table; end
+end

data/lib/toml/transformer.rb

@@ -7,9 +7,9 @@ module TOML
       s = 0
       o = []
       while s < e
-        if val[s] == "\\"
+        if val[s].chr == "\\"
           s += 1
-          case val[s]
+          case val[s].chr
           when "t"
             o << "\t"
           when "n"
@@ -26,7 +26,7 @@ module TOML
             raise "Unexpected escape character: '\\#{val[s]}'"
           end
         else
-          o << val[s]
+          o << val[s].chr
         end
         s += 1
       end
@@ -36,6 +36,11 @@ module TOML
     # Clean up arrays
     # rule(:array => subtree(:ar)) { ar.is_a?(Array) ? ar : [ar] }
     
+    # Empty file
+    rule('') {
+      nil
+    }
+
     # Clean up simple value hashes
     rule(:integer => simple(:i)) { i.to_i }
     rule(:float => simple(:f)) { f.to_f }
@@ -88,13 +93,22 @@ module TOML
     rule(:key => simple(:k)) { k }
 
     # Then objectify the key_groups
-    rule(:key_group => simple(:kg)) {
-      KeyGroup.new([kg.to_s])
+    rule(:table => simple(:kg)) {
+      Table.new([kg.to_s])
     }
 
     # Captures array-like key-groups
-    rule(:key_group => subtree(:kg)) {
-      KeyGroup.new(kg.map &:to_s)
+    rule(:table => subtree(:kg)) {
+      Table.new(kg.map &:to_s)
+    }
+    
+    # Single name table-arrays
+    rule(:table_array => simple(:name)) {
+      TableArray.new([name.to_s])
+    }
+    # Multi-part (a.b.c) table-arrays
+    rule(:table_array => subtree(:names)) {
+      TableArray.new(names.map &:to_s)
     }
   end
 end

data/test/hard_example.toml

@@ -0,0 +1,33 @@
+# Test file for TOML
+# Only this one tries to emulate a TOML file written by a user of the kind of parser writers probably hate
+# This part you'll really hate
+
+[the]
+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" ]
+    # 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"
+    # Things will get harder
+    
+        [the.hard.bit#]
+        what? = "You don't think some user won't do that?"
+        multi_line_array = [
+            "]",
+            # ] Oh yes I did
+            ]
+
+# Each of the following keygroups/key value pairs should produce an error. Uncomment to them to test
+
+#[error]   if you didn't catch this, your parser is broken
+#string = "Anything other than tabs, spaces and newline after a keygroup or key value pair has ended should produce an error unless it is a comment"   like this
+#array = [
+#         "This might most likely happen in multiline arrays",
+#         Like here,
+#         "or here,
+#         and here"
+#         ]     End of array comment, forgot the #
+#number = 3.14  pi <--again forgot the #         

data/test/spec.toml

@@ -40,6 +40,18 @@ simple = [1, 2, 3]
 # Nested array
 nested = [[1, 2], [3]]
 
+# Empty array
+empty = []
+
+# Multiline empty
+multiline_empty = [
+]
+
+# Multiline empty with comment
+multiline_empty_comment = [
+  # You look nice today
+]
+
 # Multiline array
 multiline = [
 	1,
@@ -47,6 +59,13 @@ multiline = [
 	3
 ]
 
+# Multiline array
+multiline_trailing_comma = [
+	1,
+	2,
+	3,
+]
+
 # With comments
 multiline_comments = [ # 0
 	1, # 1

data/test/test_empty.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'toml'
+require 'minitest/autorun'
+
+class TestEmpty < MiniTest::Test
+
+  def setup
+    filepath = File.join(File.dirname(__FILE__), "empty.toml")
+    @doc = TOML::Parser.new(File.read(filepath)).parsed
+  end
+
+  def test_empty
+    assert_equal ({}), @doc, "Empty document parsed incorrectly"
+  end
+
+end

data/test/test_generator.rb

@@ -5,7 +5,7 @@ require 'bundler/setup'
 require 'toml'
 require 'minitest/autorun'
 
-class TestGenerator < MiniTest::Unit::TestCase
+class TestGenerator < MiniTest::Test
   def setup
     @doc = {
       "integer" => 1,
@@ -18,16 +18,23 @@ class TestGenerator < MiniTest::Unit::TestCase
         "group" => {
           "value" => "lol"
         }
-      }
+      },
+      "date" => DateTime.now
     }
     
   end
   
   def test_generator
-    body = TOML::Generator.new(@doc).body
+    doc = @doc.clone
+    body = TOML::Generator.new(doc).body
 
     doc_parsed = TOML::Parser.new(body).parsed
     
-    assert_equal @doc, doc_parsed
+    # Extracting dates since Ruby's DateTime equality testing sucks.
+    original_date = doc.delete "date"
+    parsed_date = doc_parsed.delete "date"
+    
+    assert_equal doc, doc_parsed
+    assert_equal original_date.to_time.to_s, parsed_date.to_time.to_s
   end
 end

data/test/test_parser.rb

@@ -5,7 +5,7 @@ require 'bundler/setup'
 require 'toml'
 require 'minitest/autorun'
 
-class TestParser < MiniTest::Unit::TestCase
+class TestParser < MiniTest::Test
   def setup
     filepath = File.join(File.dirname(__FILE__), 'spec.toml')
     @doc = TOML::Parser.new(File.read(filepath)).parsed
@@ -49,14 +49,30 @@ class TestParser < MiniTest::Unit::TestCase
     assert_equal [[1, 2], [3]], @doc["arrays"]["nested"]
   end
 
+  def test_empty_array
+    assert_equal [], @doc["arrays"]["empty"]
+  end
+
+  def test_empty_multiline_array
+    assert_equal [], @doc["arrays"]["multiline_empty"]
+  end
+
+  def test_empty_multiline_array_with_comment
+    assert_equal [], @doc["arrays"]["multiline_empty_comment"]
+  end
+
   def test_multiline_arrays
     assert_equal ["lines", "are", "super", "cool", "lol", "amirite"], @doc["arrays"]["multi"]
   end
-  
+
   def test_multiline_array
     assert_equal @doc["arrays"]["multiline"], [1, 2, 3]
   end
-  
+
+  def test_multiline_array_with_trailing_comma
+    assert_equal @doc["arrays"]["multiline_trailing_comma"], [1, 2, 3]
+  end
+
   def test_multiline_array_with_comments
     assert_equal @doc["arrays"]["multiline_comments"], [1, 2, 3]
   end

data/test/test_parser_hard.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'toml'
+require 'minitest/autorun'
+
+class TestParserHardExample < MiniTest::Test
+  def setup
+    filepath = File.join(File.dirname(__FILE__), 'hard_example.toml')
+    # @doc = TOML::Parser.new(File.read(filepath)).parsed
+    @doc = TOML.load_file(filepath)
+  end
+
+  def test_the_test_string
+    assert_equal @doc["the"]["test_string"], "You'll hate me after this - #"
+  end
+end

data/test/test_table_arrays.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'toml'
+require 'minitest/autorun'
+
+class TestParserTableArrays < MiniTest::Test
+  def setup
+    doc = '
+[[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"
+    '
+    @doc = TOML.load(doc)
+    #require 'pp'
+    #PP.pp @doc
+  end
+
+  def test_doc
+    assert_equal @doc, {
+      "fruit"=>
+        [{"name"=>"apple",
+          "physical"=>{"color"=>"red", "shape"=>"round"},
+          "variety"=>[{"name"=>"red delicious"}, {"name"=>"granny smith"}]},
+         {"name"=>"banana", "variety"=>[{"name"=>"plantain"}]}]
+    }
+  end
+end

data/toml.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'toml'
-  s.version           = '0.0.4'
-  s.date              = '2013-03-28'
+  s.version           = '0.1.0'
+  s.date              = '2013-12-05'
 
   ## Make sure your summary is short. The description may be as long
   ## as you like.
@@ -37,7 +37,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.extra_rdoc_files = %w[README.md LICENSE]
   
-  s.add_dependency 'parslet'
+  s.add_dependency "parslet", "~> 1.5.0"
   
   ## Leave this section as-is. It will be automatically generated from the
   ## contents of your Git repository via the gemspec task. DO NOT REMOVE
@@ -51,14 +51,19 @@ Gem::Specification.new do |s|
     lib/toml.rb
     lib/toml/generator.rb
     lib/toml/key.rb
-    lib/toml/key_group.rb
     lib/toml/monkey_patch.rb
     lib/toml/parser.rb
     lib/toml/parslet.rb
+    lib/toml/table.rb
     lib/toml/transformer.rb
+    test/empty.toml
+    test/hard_example.toml
     test/spec.toml
+    test/test_empty.rb
     test/test_generator.rb
     test/test_parser.rb
+    test/test_parser_hard.rb
+    test/test_table_arrays.rb
     test/tmp.rb
     toml.gemspec
   ]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: toml
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,24 +10,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-28 00:00:00.000000000 Z
+date: 2013-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
 description: Parse your TOML, seriously.
 email: jeremy@github.com
 executables: []
@@ -43,14 +43,19 @@ files:
 - lib/toml.rb
 - lib/toml/generator.rb
 - lib/toml/key.rb
-- lib/toml/key_group.rb
 - lib/toml/monkey_patch.rb
 - lib/toml/parser.rb
 - lib/toml/parslet.rb
+- lib/toml/table.rb
 - lib/toml/transformer.rb
+- test/empty.toml
+- test/hard_example.toml
 - test/spec.toml
+- test/test_empty.rb
 - test/test_generator.rb
 - test/test_parser.rb
+- test/test_parser_hard.rb
+- test/test_table_arrays.rb
 - test/tmp.rb
 - toml.gemspec
 homepage: http://github.com/jm/toml
@@ -79,5 +84,8 @@ signing_key:
 specification_version: 2
 summary: Parse your TOML.
 test_files:
+- test/test_empty.rb
 - test/test_generator.rb
 - test/test_parser.rb
+- test/test_parser_hard.rb
+- test/test_table_arrays.rb

data/lib/toml/key_group.rb

@@ -1,9 +0,0 @@
-module TOML
-  class KeyGroup
-    attr_reader :keys
-    
-    def initialize(keys)
-      @keys = keys
-    end
-  end
-end