toml-rb-hs 1.1.1

data/README.md

@@ -0,0 +1,101 @@
+toml-rb
+=======
+
+[![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)
+
+A [TomlRB](https://github.com/toml-lang/toml) parser using [Citrus](http://mjackson.github.io/citrus) library.
+
+TomlRB specs supported: `0.4.0`
+
+Installation
+------------
+
+    $ gem install toml-rb
+
+Parser Usage
+------------
+
+```ruby
+require 'toml-rb'
+
+# From a file!
+path = File.join(File.dirname(__FILE__), 'path', 'to', 'file')
+TomlRB.load_file(path)
+
+# From a stream!
+stream = <<-EOS
+  title = "wow!"
+
+  [awesome]
+    you    = true
+    others = false
+EOS
+TomlRB.parse(stream)
+# => {"title"=>"wow!", "awesome"=>{"you"=>true, "others"=>false}}
+
+# You want symbols as your keys? No problem!
+TomlRB.load_file(path, symbolize_keys: true) 
+# Works the same for TomlRB.parse
+```
+
+Dumper Usage
+------------
+
+```ruby
+require 'toml-rb'
+
+# Simple example
+TomlRB.dump( simple: true)
+# => "simple = true\n"
+
+
+# Complex example
+hash = { 
+    "title"=>"wow!", 
+    "awesome"=> {
+        "you"=>true, 
+        "others"=>false
+    }
+}
+
+TomlRB.dump(hash)
+# => "title = \"wow!\"\n[awesome]\nothers = false\nyou = true\n"
+```
+
+Contributing
+------------
+
+1. Fork it
+2. Bundle it `$ dep install` (install [dep](https://github.com/cyx/dep) if you don't have it)
+3. Create your feature branch `git checkout -b my-new-feature`
+4. Add tests and commit your changes `git commit -am 'Add some feature'`
+5. Run tests `$ rake`
+6. Push the branch `git push origin my-new-feature`
+7. Create new Pull Request
+
+License
+-------
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/*_test.rb'
+end
+task default: :test

data/lib/toml-rb.rb

@@ -0,0 +1,106 @@
+require 'citrus'
+
+unless defined? require_relative
+  def require_relative(path)
+    require path
+  end
+end
+
+require_relative "toml-rb/errors"
+require_relative "toml-rb/array"
+require_relative "toml-rb/string"
+require_relative "toml-rb/table_array"
+require_relative "toml-rb/inline_table"
+require_relative "toml-rb/keyvalue"
+require_relative "toml-rb/keygroup"
+require_relative "toml-rb/parser"
+require_relative "toml-rb/dumper"
+
+ROOT = File.dirname(File.expand_path(__FILE__))
+Citrus.load "#{ROOT}/toml-rb/grammars/helper.citrus"
+Citrus.load "#{ROOT}/toml-rb/grammars/primitive.citrus"
+Citrus.load "#{ROOT}/toml-rb/grammars/array.citrus"
+Citrus.load "#{ROOT}/toml-rb/grammars/document.citrus"
+
+module TomlRB
+  # Public: Returns a hash from *TomlRB* content.
+  #
+  # content - TomlRB string to be parsed.
+  # options - The Hash options used to refine the parser (default: {}):
+  #           :symbolize_keys - true|false (optional).
+  #
+  #
+  # Examples
+  #
+  #   TomlRB.parse('[group]')
+  #   # => {"group"=>{}}
+  #
+  #   TomlRB.parse('title = "TomlRB parser"')
+  #   # => {"title"=>"TomlRB parser"}
+  #
+  #   TomlRB.parse('[group]', symbolize_keys: true)
+  #   # => {group: {}}
+  #
+  #   TomlRB.parse('title = "TomlRB parser"', symbolize_keys: true)
+  #   # => {title: "TomlRB parser"}
+  #
+  #
+  # Returns a Ruby hash representation of the content according to TomlRB spec.
+  # Raises ValueOverwriteError if a key is overwritten.
+  # Raises ParseError if the content has invalid TomlRB.
+  def self.parse(content, options = {})
+    Parser.new(content, options).hash
+  end
+
+  # Public: Returns a hash from a *TomlRB* file.
+  #
+  # path    - TomlRB File path
+  # options - The Hash options used to refine the parser (default: {}):
+  #           :symbolize_keys - true|false (optional).
+  #
+  #
+  # Examples
+  #
+  #   TomlRB.load_file('/tmp/simple.toml')
+  #   # => {"group"=>{}}
+  #
+  #   TomlRB.load_file('/tmp/simple.toml', symbolize_keys: true)
+  #   # => {group: {}}
+  #
+  #
+  # Returns a Ruby hash representation of the content.
+  # Raises ValueOverwriteError if a key is overwritten.
+  # Raises ParseError if the content has invalid TomlRB.
+  # Raises Errno::ENOENT if the file cannot be found.
+  # Raises Errno::EACCES if the file cannot be accessed.
+  def self.load_file(path, options = {})
+    TomlRB.parse(File.read(path), options)
+  end
+
+  # Public: Returns a *TomlRB* string from a Ruby Hash.
+  #
+  # hash - Ruby Hash to be dumped into *TomlRB*
+  #
+  #
+  # Examples
+  #
+  #   TomlRB.dump(title: 'TomlRB dump')
+  #   # => "simple = true\n"
+  #
+  #   hash = {
+  #     "title"=>"wow!",
+  #     "awesome"=> {
+  #       "you"=>true,
+  #       "others"=>false
+  #     }
+  #   }
+  #
+  #   TomlRB.dump(hash)
+  #   # => "title = \"wow!\"\n[awesome]\nothers = false\nyou = true\n"
+  #
+  #
+  # Returns a TomlRB string representing the hash.
+  def self.dump(hash)
+    Dumper.new(hash).toml_str
+  end
+end

data/lib/toml-rb/array.rb

@@ -0,0 +1,14 @@
+module TomlRB
+  module ArrayParser
+    def value
+      elements = captures[:elements].first
+      return [] unless elements
+
+      if elements.captures.key? :string
+        elements.captures[:string].map(&:value)
+      else
+        eval(to_str)
+      end
+    end
+  end
+end

data/lib/toml-rb/dumper.rb

@@ -0,0 +1,103 @@
+module TomlRB
+  class Dumper
+    attr_reader :toml_str
+
+    def initialize(hash)
+      @toml_str = ''
+
+      visit(hash, [])
+    end
+
+    private
+
+    def visit(hash, prefix, extra_brackets = false)
+      simple_pairs, nested_pairs, table_array_pairs = sort_pairs hash
+
+      if prefix.any? && (simple_pairs.any? || hash.empty?)
+        print_prefix prefix, extra_brackets
+      end
+
+      dump_pairs simple_pairs, nested_pairs, table_array_pairs, prefix
+    end
+
+    def sort_pairs(hash)
+      nested_pairs = []
+      simple_pairs = []
+      table_array_pairs = []
+
+      hash.keys.sort.each do |key|
+        val = hash[key]
+        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
+
+      [simple_pairs, nested_pairs, table_array_pairs]
+    end
+
+    def dump_pairs(simple, nested, table_array, prefix = [])
+      # First add simple pairs, under the prefix
+      dump_simple_pairs simple
+      dump_nested_pairs nested, prefix
+      dump_table_array_pairs table_array, prefix
+    end
+
+    def dump_simple_pairs(simple_pairs)
+      simple_pairs.each do |key, val|
+        key = quote_key(key) unless bare_key? key
+        @toml_str << "#{key} = #{to_toml(val)}\n"
+      end
+    end
+
+    def dump_nested_pairs(nested_pairs, prefix)
+      nested_pairs.each do |key, val|
+        key = quote_key(key) unless bare_key? key
+
+        visit val, prefix + [key], false
+      end
+    end
+
+    def dump_table_array_pairs(table_array_pairs, prefix)
+      table_array_pairs.each do |key, val|
+        key = quote_key(key) unless bare_key? key
+        aux_prefix = prefix + [key]
+
+        val.each do |child|
+          print_prefix aux_prefix, true
+          args = sort_pairs(child) << aux_prefix
+
+          dump_pairs(*args)
+        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)
+      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-rb/errors.rb

@@ -0,0 +1,17 @@
+module TomlRB
+  # Parent class for all TomlRB errors
+  Error = Class.new(StandardError)
+
+  # Error related to parsing.
+  ParseError = Class.new(Error)
+
+  # Overwrite error
+  class ValueOverwriteError < Error
+    attr_accessor :key
+
+    def initialize(key)
+      @key = key
+      super "Key #{key.inspect} is defined more than once"
+    end
+  end
+end

data/lib/toml-rb/grammars/array.citrus

@@ -0,0 +1,39 @@
+grammar TomlRB::Arrays
+  include TomlRB::Primitive
+
+  rule array
+    ("[" array_comments (elements)? space ","? array_comments "]" indent?) <TomlRB::ArrayParser>
+  end
+
+  rule array_comments
+    (indent? comment* indent?)
+  end
+
+  rule elements
+    float_array | string_array | array_array | integer_array | datetime_array | bool_array
+  end
+
+  rule float_array
+    ((exponent | float) (space "," array_comments (exponent | float))*)
+  end
+
+  rule string_array
+    (string (space "," array_comments string)*)
+  end
+
+  rule array_array
+    (array (space "," array_comments array)*)
+  end
+
+  rule integer_array
+    (integer (space "," array_comments integer)*)
+  end
+
+  rule datetime_array
+    (datetime (space "," array_comments datetime)*)
+  end
+
+  rule bool_array
+    (bool (space "," array_comments bool)*)
+  end
+end

data/lib/toml-rb/grammars/document.citrus

@@ -0,0 +1,40 @@
+grammar TomlRB::Document
+  include TomlRB::Primitive
+  include TomlRB::Arrays
+
+  rule document
+    (comment | table_array | keygroup | keyvalue | line_break)*
+  end
+
+  rule table_array
+    (space? '[[' stripped_key ("." stripped_key)* ']]' comment?) <TomlRB::TableArrayParser>
+  end
+
+  rule keygroup
+    (space? '[' stripped_key ("." stripped_key)* ']' comment?) <TomlRB::KeygroupParser>
+  end
+
+  rule keyvalue
+    (stripped_key '=' space? v:(toml_values) comment?) <TomlRB::KeyvalueParser>
+  end
+
+  rule inline_table
+    (space? '{' (keyvalue (',' keyvalue)*)? space? '}' ) <TomlRB::InlineTableParser>
+  end
+
+  rule inline_table_array
+    ("[" array_comments inline_table_array_elements space ","? array_comments "]" indent?) <TomlRB::InlineTableArrayParser>
+  end
+
+  rule inline_table_array_elements
+    (inline_table (space "," array_comments inline_table)*)
+  end
+
+  rule toml_values
+    primitive | inline_table | array | inline_table_array
+  end
+
+  rule stripped_key
+    (space? key space?) { captures[:key].first.value }
+  end
+end

data/lib/toml-rb/grammars/helper.citrus

@@ -0,0 +1,17 @@
+grammar TomlRB::Helper
+  rule comment
+    (space? "#" (~line_break)* line_break?) { nil }
+  end
+
+  rule space
+    [ \t]*
+  end
+
+  rule indent
+    [ \t\r\n]*
+  end
+
+  rule line_break
+    (space? "\n" | space? "\r\n") { nil }
+  end
+end