toml 0.0.2 → 0.0.3

data/README.md

@@ -2,6 +2,8 @@
 
 A sane configuration format from @mojombo.  More information here: https://github.com/mojombo/toml
 
+This is far superior to YAML and JSON because it doesn't suck.  Really it doesn't.
+
 ## Usage
 
 It's simple, really.
@@ -32,4 +34,4 @@ TOML.load_file("my_file.toml")
 
 ## Contributors
 
-Written by Jeremy McAnally (@jm) and Dirk Gadsden (@dirk) based on TOML from Tom Preston-Werner (@mojombo).
+Written by Jeremy McAnally (@jm) and Dirk Gadsden (@dirk) based on TOML from Tom Preston-Werner (@mojombo).

data/lib/toml.rb

@@ -8,9 +8,13 @@ require 'toml/key_group'
 require 'toml/parslet'
 require 'toml/transformer'
 require 'toml/parser'
+require 'toml/generator'
+# Don't do monkey-patching by default. Only pulled in by TOML::Generator
+# if needed (see generator.rb line 27).
+# require 'toml/monkey_patch
 
 module TOML
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 
   def self.load(content)
     Parser.new(content).parsed

data/lib/toml/generator.rb

@@ -0,0 +1,68 @@
+
+module TOML  
+  class Generator
+    attr_reader :body, :doc
+
+    def initialize(doc)
+      # Ensure all the to_toml methods are injected into the base Ruby classes
+      # used by TOML.
+      self.class.inject!
+      
+      @body = ""
+      @doc = doc
+      
+      visit(@doc)
+      
+      return @body
+    end
+    
+    # Whether or not the injections have already been done.
+    @@injected = false
+    # Inject to_toml methods into the Ruby classes used by TOML (booleans,
+    # String, Numeric, Array). You can add to_toml methods to your own classes
+    # to allow them to be easily serialized by the generator (and it will shout
+    # if something doesn't have a to_toml method).
+    def self.inject!
+      return if @@injected
+      require 'toml/monkey_patch'
+      @@injected = true
+    end
+    
+    def visit(hash, path = "")
+      hash_pairs = [] # Sub-hashes
+      other_pairs = []
+      
+      hash.keys.sort.each do |key|
+        val = hash[key]
+        # TODO: Refactor for other hash-likes (OrderedHash)
+        if val.is_a? Hash
+          hash_pairs << [key, val]
+        else
+          other_pairs << [key, val]
+        end
+      end
+      
+      # Handle all the key-values
+      if !path.empty? && !other_pairs.empty?
+        @body += "[#{path}]\n"
+      end
+      other_pairs.each do |pair|
+        key, val = pair
+        @body += "#{key} = #{format(val)}\n"
+      end
+      @body += "\n" unless other_pairs.empty?
+      
+      # Then deal with sub-hashes
+      hash_pairs.each do |pair|
+        key, hash = pair
+        visit(hash, (path.empty? ? key : [path, key].join(".")))
+      end
+    end#visit
+    
+    # Returns the value formatted for TOML.
+    def format(val)
+      val.to_toml
+    end
+    
+  end#Generator
+end#TOML

data/lib/toml/key.rb

@@ -1,6 +1,7 @@
 module TOML
   class Key
     attr_reader :key, :value
+    
     def initialize(key, value)
       @key = key
       @value = value

data/lib/toml/monkey_patch.rb

@@ -0,0 +1,21 @@
+# Adds to_toml methods to base Ruby classes used by the generator.
+class TrueClass
+  def to_toml; "true"; end
+end
+class FalseClass
+  def to_toml; "false"; end
+end
+class String
+  def to_toml; self.inspect; end
+end
+class Numeric
+  def to_toml; self.to_s; end
+end
+class Array
+  def to_toml
+    unless self.map(&:class).uniq.length < 2
+      raise "All array values must be the same type"
+    end
+    "[" + self.map {|v| v.to_toml }.join(",") + "]"
+  end
+end

data/lib/toml/parser.rb

@@ -6,14 +6,29 @@ module TOML
       # Make sure we have a newline on the end
       markup += "\n" unless markup.end_with?("\n")
 
-      tree = Parslet.new.parse(markup)
+      begin
+        tree = Parslet.new.parse(markup)
+      rescue Parslet::ParseFailed => failure
+        puts failure.cause.ascii_tree
+      end
+      
       parts = Transformer.new.apply(tree)
       
       @parsed = {}
       @current = @parsed
+      @current_path = ''
       
       parts.each do |part|
         if part.is_a? Key
+          # Make sure the key isn't already set
+          if !@current.is_a?(Hash) || @current.has_key?(part.key)
+            err = "Cannot override key '#{part.key}'"
+            unless @current_path.empty?
+              err += " at path '#{@current_path}'"
+            end
+            raise err
+          end
+          # Set the key-value into the current hash
           @current[part.key] = part.value
         elsif part.is_a? KeyGroup
           resolve_key_group(part)
@@ -27,6 +42,8 @@ module TOML
       @current = @parsed
 
       path = kg.keys.dup
+      @current_path = path.join('.')
+      
       while k = path.shift
         if @current.has_key? k
           # pass

data/lib/toml/parslet.rb

@@ -1,27 +1,50 @@
 module TOML
   class Parslet < ::Parslet::Parser
-    rule(:document) { (key_group | key_value | comment_line).repeat(0) }
+    rule(:document) {
+      all_space >>
+      (key_group | key_value | comment_line).repeat(0) >>
+      all_space
+    }
     root :document
 
     rule(:value) {
-      array.as(:array) |
+      array |
       string |
       datetime.as(:datetime) |
       float.as(:float) |
       integer.as(:integer) |
       boolean
     }
-
+    
+    # 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) {
-      str("[") >> (
-        all_space >> value >>
-        (all_space >> str(",") >> all_space >> value).repeat(0) >>
-        all_space
-      ).maybe >> str("]") 
+      str("[") >> ( 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) >>
+        all_space >> array_comments # Grab any remaining comments just in case
+      ).maybe.as(:array) >> str("]") 
     }
     
-    rule(:key_value) { space >> key.as(:key) >> space >> str("=") >> space >> value >> space >> comment.maybe >> str("\n") >> all_space }
-    rule(:key_group) { space >> str("[") >> key_group_name.as(:key_group) >> str("]") >> space >> comment.maybe >> str("\n") >> all_space }
+    rule(:key_value) { 
+      space >> key.as(:key) >>
+      space >> str("=") >>
+      space >> value.as(:value) >>
+      space >> comment.maybe >> str("\n") >> all_space
+    }
+    rule(:key_group) {
+      space >> str("[") >>
+        key_group_name.as(:key_group) >>
+      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) }
@@ -40,12 +63,13 @@ module TOML
     }
     
     rule(:sign) { str("-") }
+    rule(:sign?) { sign.maybe }
+    
     rule(:integer) {
-      str("0") | (sign.maybe >> match("[1-9]") >> match("[0-9]").repeat(0))
+      str("0") | (sign? >> match("[1-9]") >> match("[0-9]").repeat(0))
     }
-    
     rule(:float) {
-      sign.maybe >> 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) }

data/lib/toml/transformer.rb

@@ -1,4 +1,5 @@
 module TOML
+  
   class Transformer < ::Parslet::Transform
     # Utility to properly handle escape sequences in parsed string.
     def self.parse_string(val)
@@ -33,9 +34,9 @@ module TOML
     end
     
     # Clean up arrays
-    rule(:array => subtree(:ar)) { ar.is_a?(Array) ? ar : [ar] }
-
-    # Clean up simples (inside arrays)
+    # rule(:array => subtree(:ar)) { ar.is_a?(Array) ? ar : [ar] }
+    
+    # Clean up simple value hashes
     rule(:integer => simple(:i)) { i.to_i }
     rule(:float => simple(:f)) { f.to_f }
     rule(:string => simple(:s)) {
@@ -45,20 +46,41 @@ module TOML
     rule(:true => simple(:b)) { true }
     rule(:false => simple(:b)) { false }
     
-    # TODO: Refactor to remove redundancy
-    rule(:key => simple(:k), :array => subtree(:ar)) { Key.new(k.to_s, ar) }
-    rule(:key => simple(:k), :integer => simple(:i)) { Key.new(k.to_s, i.to_i) }
-    rule(:key => simple(:k), :float => simple(:f)) { Key.new(k.to_s, f.to_f) }
-    rule(:key => simple(:k), :string => simple(:s)) {
-      Key.new(k.to_s, Transformer.parse_string(s.to_s))
-    }
-    rule(:key => simple(:k), :datetime => simple(:d)) {
-      Key.new(k.to_s, DateTime.iso8601(d))
+    rule(:key => simple(:k), :value => simple(:v)) { Key.new(k.to_s, v) }
+    
+    # New array cleanup
+    # TODO: Make this more readable/understandable.
+    def self.visit_array(h)
+      if h.is_a? Hash
+        # If it's an {:array => ...} hash
+        a = h[:array]
+        if a.is_a? Array
+          # If the value is already an array
+          a = a.map {|v| visit_array(v) }
+          classes = a.map {|v|
+            # Grab the class, with a little exception for true and false since
+            # they're different classes (TrueClass and FalseClass).
+            (v == true || v == false) ? true : v.class
+          }
+          if classes.uniq.length != 1
+            raise "Conflicting types in array: " + \
+              classes.map(&:to_s).join(", ")
+          end
+          return a
+        else
+          # Turn the value into an array
+          return [visit_array(a)].compact
+        end
+      else
+        # Plain old non-hash value
+        return h
+      end
+    end
+    rule(:key => simple(:k), :value => subtree(:v)) {
+      Key.new(k.to_s, Transformer.visit_array(v))
     }
-    rule(:key => simple(:k), :true => simple(:b)) { Key.new(k.to_s, true) }
-    rule(:key => simple(:k), :false => simple(:b)) { Key.new(k.to_s, false) }
     
-    # Make keys just be strings
+    # Make key hashes (inside key_groups) just be strings
     rule(:key => simple(:k)) { k }
 
     # Then objectify the key_groups
@@ -71,4 +93,4 @@ module TOML
       KeyGroup.new(kg.map &:to_s)
     }
   end
-end
+end

data/test/spec.toml

@@ -1,22 +1,26 @@
 # Comment
 
+# Booleans
+true = true
+false = false
+
+[strings]
 # String
 string = "string\n\t\"string"
 
-# Integer
-integer = 42
+[ints]
+simple = 42
+negative = -42
 
-# Float
+[floats]
 pi = 3.14159
+negative = -10.0
 
-# Booleans
-true = true
-false = false
-
+[datetimes]
 # DateTime
-datetime = 1979-05-27T07:32:00Z
+simple = 1979-05-27T07:32:00Z
 
-# Keygroup
+# Keygroups
 [a.b.c]
 d = "test"
 
@@ -33,7 +37,21 @@ on = "a line" # with markup
 simple = [1, 2, 3]
 
 # Nested array
-nested = [[[1], 2], 3]
+nested = [[1, 2], [3]]
+
+# Multiline array
+multiline = [
+	1,
+	2,
+	3
+]
+
+# With comments
+multiline_comments = [ # 0
+	1, # 1
+	2, # 2
+	3 # 3
+]
 
 multi = ["lines", "are",
 "super", "cool", "lol",

data/test/test_generator.rb

@@ -0,0 +1,33 @@
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'toml'
+require 'minitest/autorun'
+
+class TestGenerator < MiniTest::Unit::TestCase
+  def setup
+    @doc = {
+      "integer" => 1,
+      "float" => 3.14159,
+      "true" => true,
+      "false" => false,
+      "string" => "hi",
+      "array" => [[1], [2], [3]],
+      "key" => {
+        "group" => {
+          "value" => "lol"
+        }
+      }
+    }
+    
+  end
+  
+  def test_generator
+    body = TOML::Generator.new(@doc).body
+
+    doc_parsed = TOML::Parser.new(body).parsed
+    
+    assert_equal @doc, doc_parsed
+  end
+end

data/test/test_parser.rb

@@ -12,39 +12,63 @@ class TestParser < MiniTest::Unit::TestCase
   end
   
   def test_string
-    assert_equal @doc["string"], "string\n\t\"string"
+    assert_equal "string\n\t\"string", @doc["strings"]["string"]
   end
 
   def test_integer
-    assert_equal @doc["integer"], 42
+    assert_equal 42, @doc["ints"]["simple"]
+  end
+
+  def test_negative_integer
+    assert_equal -42, @doc["ints"]["negative"]
   end
 
   def test_float
-    assert_equal @doc["pi"], 3.14159
+    assert_equal 3.14159, @doc["floats"]["pi"]
+  end
+
+  def test_negative_float
+    assert_equal -10.0, @doc["floats"]["negative"]
   end
 
   def test_datetime
-    assert_equal @doc["datetime"], DateTime.iso8601("1979-05-27T07:32:00Z")
+    assert_equal DateTime.iso8601("1979-05-27T07:32:00Z"), @doc["datetimes"]["simple"]
   end
 
   def test_booleans
-    assert_equal @doc["true"], true
-    assert_equal @doc["false"], false
+    assert_equal true, @doc["true"]
+    assert_equal false, @doc["false"]
   end
 
   def test_simple_array
-    assert_equal @doc["arrays"]["simple"], [1, 2, 3]
+    assert_equal [1, 2, 3], @doc["arrays"]["simple"]
   end
 
   def test_nested_array
-    assert_equal @doc["arrays"]["nested"], [[[1], 2], 3]
+    assert_equal [[1, 2], [3]], @doc["arrays"]["nested"]
+  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_comments
+    assert_equal @doc["arrays"]["multiline_comments"], [1, 2, 3]
   end
 
   def test_simple_keygroup
-    assert_equal @doc["e"]["f"], "test"
+    assert_equal "test", @doc["e"]["f"]
   end
 
   def test_nested_keygroup
-    assert_equal @doc["a"]["b"]["c"]["d"], "test"
+    assert_equal "test", @doc["a"]["b"]["c"]["d"]
+  end
+
+  def test_inline_comment
+    assert_equal "a line", @doc["comments"]["on"]
   end
 end

data/test/tmp.rb

@@ -0,0 +1,25 @@
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'toml'
+
+doc = "
+a = [true, false]
+"
+
+puts TOML.load(doc).inspect
+
+# puts TOML.load("a = [[[[1]]]]")["a"].inspect
+# puts "[[[[1]]]] <- expected"
+# 
+# puts TOML.load("a = [1]")["a"].inspect
+# puts "[1] <- expected"
+# 
+# puts TOML.load("a = [1, 2, 3]")["a"].inspect
+# puts "[1, 2, 3] <- expected"
+# 
+# puts TOML.load("a = [[[1], 2], 3]")["a"].inspect
+# puts "[[[1], 2], 3] <- expected"
+# 
+# puts TOML.load("a = [[]]")["a"].inspect

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.2'
-  s.date              = '2013-02-24'
+  s.version           = '0.0.3'
+  s.date              = '2013-03-06'
 
   ## Make sure your summary is short. The description may be as long
   ## as you like.
@@ -45,18 +45,21 @@ Gem::Specification.new do |s|
   # = MANIFEST =
   s.files = %w[
     Gemfile
-    Gemfile.lock
     LICENSE
     README.md
     Rakefile
     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/transformer.rb
     test/spec.toml
+    test/test_generator.rb
     test/test_parser.rb
+    test/tmp.rb
     toml.gemspec
   ]
   # = MANIFEST =

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: toml
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-24 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -37,18 +37,21 @@ extra_rdoc_files:
 - LICENSE
 files:
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - 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/transformer.rb
 - test/spec.toml
+- test/test_generator.rb
 - test/test_parser.rb
+- test/tmp.rb
 - toml.gemspec
 homepage: http://github.com/jm/toml
 licenses: []
@@ -76,4 +79,5 @@ signing_key:
 specification_version: 2
 summary: Parse your TOML.
 test_files:
+- test/test_generator.rb
 - test/test_parser.rb

data/Gemfile.lock

@@ -1,20 +0,0 @@
-PATH
-  remote: .
-  specs:
-    toml (0.0.1)
-      parslet
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    blankslate (2.1.2.4)
-    minitest (4.6.1)
-    parslet (1.5.0)
-      blankslate (~> 2.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  minitest
-  toml!