toml-rb 0.1.6 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97909cd5d9ac3403acf5fba07cfb3177fb343458
+  data.tar.gz: ee82bae7cb2a1ec814b269390899ccd47781dabd
+SHA512:
+  metadata.gz: ef153da7a2aa9623a2554825b1604f460dfad351bfee4ed4078f2a45b3902992d4ecc2fae2d32b39ed37ef29182d9c4948b389584264e4b499b6f3acad261fd9
+  data.tar.gz: 2869e5f5d5b5c946940d3d38cda21440378ba4162cf73c4218aac9c2904630b95e9b075151db1f2fe6449209641f4d65470307b4ac1b4ded510a44e8c0905fdc

data/README.md

@@ -1,12 +1,14 @@
 toml-rb
 =======
 
-A [TOML](https://github.com/mojombo/toml) parser using [Citrus](http://mjijackson.com/citrus) library.
+[![Gem Version](https://badge.fury.io/rb/toml-rb.svg)](http://badge.fury.io/rb/toml-rb)
+[![Build Status](https://travis-ci.org/emancu/toml-rb.svg)](https://travis-ci.org/emancu/toml-rb)
+[![Code Climate](https://codeclimate.com/github/emancu/toml-rb/badges/gpa.svg)](https://codeclimate.com/github/emancu/toml-rb)
+[![Dependency Status](https://gemnasium.com/emancu/toml-rb.svg)](https://gemnasium.com/emancu/toml-rb)
 
-[![Gem Version](https://badge.fury.io/rb/toml-rb.png)](http://badge.fury.io/rb/toml-rb)
-[![Build Status](https://travis-ci.org/emancu/toml-rb.png)](https://travis-ci.org/emancu/toml-rb)
-[![Code Climate](https://codeclimate.com/github/emancu/toml-rb.png)](https://codeclimate.com/github/emancu/toml-rb)
-[![Dependency Status](https://gemnasium.com/emancu/toml-rb.png)](https://gemnasium.com/emancu/toml-rb)
+A [TOML](https://github.com/mojombo/toml) parser using [Citrus](http://mjackson.github.io/citrus) library.
+
+TOML specs supported: `0.3.1`
 
 Installation
 ------------

data/Rakefile

@@ -1,6 +1,5 @@
 task :test do
-  Dir["test/*_test.rb"].each { |file| load file }
+  Dir['test/*_test.rb'].each { |file| load file }
 end
 
-task :default => :test
-
+task default: :test

data/init.rb

@@ -3,6 +3,7 @@ require 'citrus'
 ROOT = File.dirname(File.expand_path(__FILE__))
 
 require "#{ROOT}/lib/toml/string"
+require "#{ROOT}/lib/toml/table_array"
 require "#{ROOT}/lib/toml/keyvalue"
 require "#{ROOT}/lib/toml/keygroup"
 require "#{ROOT}/lib/toml/parser"
@@ -12,4 +13,3 @@ Citrus.load "#{ROOT}/lib/toml/grammars/helper.citrus"
 Citrus.load "#{ROOT}/lib/toml/grammars/primitive.citrus"
 Citrus.load "#{ROOT}/lib/toml/grammars/array.citrus"
 Citrus.load "#{ROOT}/lib/toml/grammars/document.citrus"
-

data/lib/toml.rb

@@ -1,7 +1,6 @@
 require_relative '../init'
 
 module TOML
-
   # Public: Returns a hash from *TOML* content.
   #
   # content - TOML string to be parsed.
@@ -56,7 +55,6 @@ module TOML
     TOML.parse(File.read(path), options)
   end
 
-
   # Public: Returns a *TOML* string from a Ruby Hash.
   #
   # hash - Ruby Hash to be dumped into *TOML*

data/lib/toml/dumper.rb

@@ -5,39 +5,80 @@ module TOML
     def initialize(hash)
       @toml_str = ''
 
-      visit(hash, '')
+      visit(hash, [])
     end
 
     private
 
-    def visit(hash, prefix)
+    def visit(hash, prefix, extra_brackets = false)
       nested_pairs = []
       simple_pairs = []
+      table_array_pairs = []
 
       hash.keys.sort.each do |key|
         val = hash[key]
-        (val.is_a?(Hash) ? nested_pairs : simple_pairs) << [key, val]
+        element = [key, val]
+
+        if val.is_a? Hash
+          nested_pairs << element
+        elsif val.is_a?(Array) && val.first.is_a?(Hash)
+          table_array_pairs << element
+        else
+          simple_pairs << element
+        end
       end
 
-      @toml_str += "[#{prefix}]\n" unless prefix.empty? || simple_pairs.empty?
+      unless prefix.empty? || simple_pairs.empty?
+        print_prefix prefix, extra_brackets
+      end
 
       # First add simple pairs, under the prefix
       simple_pairs.each do |key, val|
-        @toml_str << "#{key.to_s} = #{to_toml(val)}\n"
+        key = quote_key(key) unless bare_key? key
+        @toml_str << "#{key} = #{to_toml(val)}\n"
       end
 
       nested_pairs.each do |key, val|
-        visit(val, prefix.empty? ? key.to_s : [prefix, key].join('.'))
+        key = quote_key(key) unless bare_key? key
+
+        visit val, prefix + [key], false
+      end
+
+      table_array_pairs.each do |key, val|
+        key = quote_key(key) unless bare_key? key
+        aux_prefix = prefix + [key]
+
+        val.each do |child|
+          if child.empty?
+            print_prefix aux_prefix, true
+          else
+            visit child, aux_prefix, true
+          end
+        end
       end
     end
 
+    def print_prefix(prefix, extra_brackets = false)
+      new_prefix = prefix.join('.')
+      new_prefix = '[' + new_prefix + ']' if extra_brackets
+
+      @toml_str += "[" + new_prefix + "]\n"
+    end
+
     def to_toml(obj)
-      case
-      when obj.is_a?(Time)
+      if obj.is_a? Time
         obj.strftime('%Y-%m-%dT%H:%M:%SZ')
       else
         obj.inspect
       end
     end
+
+    def bare_key?(key)
+      !!key.to_s.match(/^[a-zA-Z0-9_-]*$/)
+    end
+
+    def quote_key(key)
+      '"' + key.gsub('"', '\\"') + '"'
+    end
   end
 end

data/lib/toml/grammars/array.citrus

@@ -6,30 +6,30 @@ grammar TomlArray
   end
 
   rule elements
-    float_array | string_array | array_array | integer_array | datetime_array | bool_array
+    comment | float_array | string_array | array_array | integer_array | datetime_array | bool_array
   end
 
   rule float_array
-    (float ("," indent? float)*)
+    (float ("," indent? (float | comment))*)
   end
 
   rule string_array
-    (string ("," indent? string)*)
+    (string ("," indent? (string | comment))*)
   end
 
   rule array_array
-    (array ("," indent? array)*)
+    (array ("," indent? (array | comment))*)
   end
 
   rule integer_array
-    (integer ("," indent? integer)*)
+    (integer ("," indent? (integer | comment))*)
   end
 
   rule datetime_array
-    (datetime ("," indent? datetime)*)
+    (datetime ("," indent? (datetime | comment))*)
   end
 
   rule bool_array
-    (bool ("," indent? bool)*)
+    (bool ("," indent? (bool | comment))*)
   end
 end

data/lib/toml/grammars/document.citrus

@@ -3,11 +3,15 @@ grammar Document
   include TomlArray
 
   rule document
-    (comment | keygroup | keyvalue | line_break)*
+    (comment | table_array | keygroup | keyvalue | line_break)*
+  end
+
+  rule table_array
+    (space? '[[' (space? key space? "."?)+ ']]' space? comment?) <TableArray>
   end
 
   rule keygroup
-    (space? '[' nested_keys:(key "."?)+ ']' space? comment?) <Keygroup>
+    (space? '[' (space? key space? "."?)+ ']' space? comment?) <Keygroup>
   end
 
   rule keyvalue

data/lib/toml/grammars/primitive.citrus

@@ -5,30 +5,72 @@ grammar Primitive
     string | bool | datetime | number
   end
 
+  ##
+  # String rules
+  ##
+
   rule string
-    (/(["'])(?:\\?.)*?\1/ space) <TomlString>
+    multiline_string | multiline_literal | basic_string | literal_string
   end
 
-  rule bool
-    true | false
+  rule basic_string
+    (/(["])(?:\\?.)*?\1/ space) <TomlBasicString>
+  end
+
+  rule literal_string
+    (/(['])(?:\\?.)*?\1/ space) <TomlLiteralString>
+  end
+
+  rule multiline_string
+    ('"""' line_break* text:~'"""' '"""' space) <TomlMultilineString>
+  end
+
+  rule multiline_literal
+    ("'''" line_break* text:~"'''" "'''" space) <TomlMultilineLiteral>
   end
 
-  # Full Zulu form
+  ##
+  # Date time rules
+  ##
+
   rule datetime
-    (y:/\d\d\d\d/ "-" m:/\d\d/ "-" d:/\d\d/ "T" h:/\d\d/ ":" mi:/\d\d/ ":" s:/\d\d/ "Z") {
-      y,m,d,h,mi,s = [:y,:m,:d,:h,:mi,:s].map{|s| capture(s) }
-      Time.utc(*[y,m,d,h,mi,s].map(&:value))
+    (date_skeleton ("Z" | date_offset | [,\.] frac:(/\d/1*6) date_offset)) {
+      skeleton = captures[:date_skeleton].first
+      y,m,d,h,mi,s = skeleton.value
+      offset = captures[:date_offset].first || "+00:00"
+      sec_frac = captures[:frac].first || 0
+      s = "#{s}.#{sec_frac}".to_f
+
+      Time.new(*[y,m,d,h,mi,s,offset.to_s])
+    }
+  end
+
+  rule date_skeleton
+    (y:/\d\d\d\d/ "-" m:/\d\d/ "-" d:/\d\d/ "T" h:/\d\d/ ":" mi:/\d\d/ ":" s:/\d\d/) {
+      [:y,:m,:d,:h,:mi,:s].map{ |s| capture(s).value }
     }
   end
 
+  rule date_offset
+    offset:(sign /\d\d/ ":" /\d\d/)
+  end
+
+  ##
+  # Number rules
+  ##
+
   rule number
-    float | integer
+     exponent | float | integer
   end
 
   rule float
     (integer '.' integer) { to_str.to_f }
   end
 
+  rule exponent
+    ( (float | integer) [eE] integer) { to_str.to_f }
+  end
+
   rule integer
     (sign? [0-9]+) { to_str.to_i }
   end
@@ -37,8 +79,12 @@ grammar Primitive
     '+' | '-'
   end
 
-  rule key
-    [a-zA-Z_] [a-zA-Z_0-9#?]*
+  ##
+  # Boolean rules
+  ##
+
+  rule bool
+    true | false
   end
 
   rule true
@@ -48,4 +94,20 @@ grammar Primitive
   rule false
     'false' { false }
   end
+
+  ##
+  # Key rules
+  ##
+
+  rule key
+    quoted_key | bare_key
+  end
+
+  rule bare_key
+    [a-zA-Z_] [a-zA-Z_0-9_-]*
+  end
+
+  rule quoted_key
+    string
+  end
 end

data/lib/toml/keygroup.rb

@@ -8,14 +8,15 @@ module TOML
       @nested_keys.each do |key|
         key = symbolize_keys ? key.to_sym : key
         hash[key] = {} unless hash[key]
-        hash = hash[key]
+        element = hash[key]
+        hash = element.is_a?(Array) ? element.last : element
       end
 
       hash
     end
 
     def accept_visitor(parser)
-      parser.visit_keygroup(self)
+      parser.visit_keygroup self
     end
   end
 end
@@ -23,6 +24,6 @@ end
 # Used in document.citrus
 module Keygroup
   def value
-    TOML::Keygroup.new(capture(:nested_keys).to_str.split('.'))
+    TOML::Keygroup.new(captures[:key].map(&:value))
   end
 end

data/lib/toml/keyvalue.rb

@@ -8,7 +8,7 @@ module TOML
 
     def assign(hash, symbolize_keys = false)
       key = symbolize_keys ? @key.to_sym : @key
-      raise ValueOverwriteError if hash[key]
+      fail ValueOverwriteError if hash[key]
       hash[key] = @value
     end
 

data/lib/toml/parser.rb

@@ -19,6 +19,10 @@ module TOML
 
     # Read about the Visitor pattern
     # http://en.wikipedia.org/wiki/Visitor_pattern
+    def visit_table_array(table_array)
+      @current = table_array.navigate_keys @hash, @symbolize_keys
+    end
+
     def visit_keygroup(keygroup)
       @current = keygroup.navigate_keys(@hash, @symbolize_keys)
     end

data/lib/toml/string.rb

@@ -1,27 +1,43 @@
 # Used in primitive.citrus
-module TomlString
+module TomlBasicString
   def value
-    aux = first.value
-    s = 0
-    o = []
-    while s < aux.length
-      if aux[s] == '\\'
-        s += 1
-        case aux[s]
-        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"
-        else
-          o << '\\' << aux[s]
-        end
-      else
-        o << aux[s]
-      end
-      s += 1
-    end
-    o[1...-1].join
+    aux = TomlBasicString.transform_escaped_chars first.value
+
+    aux[1...-1]
+  end
+
+  def self.transform_escaped_chars(str)
+    str
+      .gsub(/\\0/, "\0")
+      .gsub(/\\t/, "\t")
+      .gsub(/\\n/, "\n")
+      .gsub(/\\\"/, '"')
+      .gsub(/\\r/, "\r")
+      .gsub(/\\\\/, '\\')
+  end
+end
+
+module TomlLiteralString
+  def value
+    first.value[1...-1]
+  end
+end
+
+module TomlMultilineString
+  def value
+    aux = captures[:text].first.value
+
+    # Remove spaces on multilined Singleline strings
+    aux.gsub!(/\\\r?\n[\n\t\r ]*/, '')
+
+    TomlBasicString.transform_escaped_chars aux
+  end
+end
+
+module TomlMultilineLiteral
+  def value
+    aux = captures[:text].first.value
+
+    aux.gsub(/\\\r?\n[\n\t\r ]*/, '')
   end
 end

data/lib/toml/table_array.rb

@@ -0,0 +1,29 @@
+module TOML
+  class TableArray
+    def initialize(nested_keys)
+      @nested_keys = nested_keys
+    end
+
+    def navigate_keys(hash, symbolize_keys = false)
+      @nested_keys.each do |key|
+        key = symbolize_keys ? key.to_sym : key
+        hash[key] = [] unless hash[key]
+        hash[key] << {} if @nested_keys.last == key.to_s || hash[key].empty?
+        hash = hash[key].last
+      end
+
+      hash
+    end
+
+    def accept_visitor(parser)
+      parser.visit_table_array self
+    end
+  end
+end
+
+# Used in document.citrus
+module TableArray
+  def value
+    TOML::TableArray.new(captures[:key].map(&:value))
+  end
+end