toml_parser-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MGMzYmMxNTY5OTM0ZjZhM2QzZDk4YzFiZGFhZmJjMjJmMDY2MjE2ZQ==
+  data.tar.gz: !binary |-
+    MDUxMzllYTE4MzA0ZmNlYTcxNjdlMjUzYzU3ZDQ3NjgyMGUwODgzNA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OGU1NmI3N2Q1ZjNiMWVjZDA3ZDUzZDk3MzhiYTgxYmFjYTVhMWI0MWE3MjRh
+    MzRjOGIxNDkxMGY3MGIxZGJlZGU0NTE0NmQxZjM0NWVhZDgxMGU5NGQzNjk1
+    ZWNhNGIzNGE2MTlkM2ZkMzZhY2ZiY2NmZjgwMjFjNmNjMWUwYWU=
+  data.tar.gz: !binary |-
+    NzkyNzcwODgyNDY4YzEyN2RjODk2MTUyZjllODc3ZTlhMGI0OTUwODFlZDU2
+    YzA2NWM3MDg1MGMwMjM0MWI2NTlhNTlkYzk2ZDkzNzNhNDI2Yjg0OGU3MmEx
+    YWUxY2E4NzRjMTAyNWExZTU2MTE0NDMxZjQ3NTU1NDZlY2QzMDg=

data/README.md

@@ -0,0 +1,72 @@
+toml-rb
+=======
+
+Formerly known as __toml_parser-ruby__.
+
+A [TOML](https://github.com/mojombo/toml) parser using [Citrus](http://mjijackson.com/citrus/example.html) library.
+
+
+Installation
+------------
+
+    $ gem install toml-rb
+
+Usage
+-----
+
+```ruby
+require 'toml'
+
+# From a file!
+path = File.join(File.dirname(__FILE__), 'path', 'to', 'file')
+TOML.load_file(path)
+
+# From a stream!
+stream = <<-EOS
+  title = "wow!"
+
+  [awesome]
+    you    = true
+    others = false
+EOS
+TOML.parse(stream)
+
+# You want symbols as your keys? No problem!
+TOML.load_file(path, symbolize_keys: true) 
+# Works the same for TOML.parse
+```
+
+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 @@
+task :test do
+  Dir["test/*_test.rb"].each { |file| load file }
+end
+
+task :default => :test
+

data/lib/toml.rb

@@ -0,0 +1,56 @@
+require_relative "../init"
+
+module TOML
+
+  # Public: Returns a hash from *TOML* content.
+  #
+  # content - TOML string to be parsed.
+  # options - The Hash options used to refine the parser (default: {}):
+  #           :symbolize_keys - true|false (optional).
+  #
+  #
+  # Examples
+  #
+  #   TOML.parse('[group]')
+  #   # => {"group"=>{}}
+  #
+  #   TOML.parse('title = "TOML parser"')
+  #   # => {"title"=>"TOML parser"}
+  #
+  #   TOML.parse('[group]', symbolize_keys: true)
+  #   # => {group: {}}
+  #
+  #   TOML.parse('title = "TOML parser"', symbolize_keys: true)
+  #   # => {title: "TOML parser"}
+  #
+  #
+  # Returns a Ruby hash representation of the content according to TOML spec.
+  # Raises ValueOverwriteError if a key is overwritten
+  def self.parse(content, options = {})
+    Parser.new(content, options).hash
+  end
+
+  # Public: Returns a hash from a *TOML* file.
+  #
+  # path    - TOML File path
+  # options - The Hash options used to refine the parser (default: {}):
+  #           :symbolize_keys - true|false (optional).
+  #
+  #
+  # Examples
+  #
+  #   TOML.load_file('/tmp/simple.toml')
+  #   # => {"group"=>{}}
+  #
+  #   TOML.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 Errno::ENOENT if the file cannot be found.
+  # Raises Errno::EACCES if the file cannot be accessed.
+  def self.load_file(path, options = {})
+    TOML.parse(File.read(path), options)
+  end
+end

data/lib/toml/keygroup.rb

@@ -0,0 +1,24 @@
+module TOML
+  class Keygroup
+    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 = hash[key]
+      end
+
+      hash
+    end
+  end
+end
+
+# Used in toml.citrus
+module Keygroup
+  def value
+    TOML::Keygroup.new(nested_keys.to_s.split("."))
+  end
+end

data/lib/toml/keyvalue.rb

@@ -0,0 +1,23 @@
+module TOML
+  class ValueOverwriteError < StandardError; end
+
+  class Keyvalue
+    def initialize(key, value)
+      @key, @value = key, value
+    end
+
+    def assign(hash, symbolize_keys = false)
+      raise ValueOverwriteError if hash[@key]
+
+      key = symbolize_keys ? @key.to_sym : @key
+      hash[key] = @value
+    end
+  end
+end
+
+# Used in toml.citrus
+module Keyvalue
+  def value
+    TOML::Keyvalue.new(key.value, v.value)
+  end
+end

data/lib/toml/parser.rb

@@ -0,0 +1,19 @@
+module TOML
+  class Parser
+    attr_reader :hash
+
+    def initialize(content, options = {})
+      @hash = {}
+      @current = @hash
+
+      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
+    end
+  end
+end

data/lib/toml/string.rb

@@ -0,0 +1,27 @@
+# Used in primitive.citrus
+module TomlString
+  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
+  end
+end

data/test/example.toml

@@ -0,0 +1,38 @@
+# This is a TOML document. Boom.
+
+title = "TOML Example"
+
+[owner]
+name = "Tom Preston-Werner"
+organization = "GitHub"
+bio = "GitHub Cofounder & CEO\nLikes tater tots and beer."
+dob = 1979-05-27T07:32:00Z # First class dates? Why not?
+
+[database]
+server = "192.168.1.1"
+ports = [ 8001, 8001, 8002 ]
+connection_max = 5000
+enabled = true
+
+[servers]
+
+  # You can indent as you please. Tabs or spaces. TOML don't care.
+  [servers.alpha]
+  ip = "10.0.0.1"
+  dc = "eqdc10"
+
+  [servers.beta]
+  ip = "10.0.0.2"
+  dc = "eqdc10"
+
+[servers]
+  amount = 2
+
+[clients]
+data = [ ["gamma", "delta"], [1, 2] ]
+
+# Line breaks are OK when inside arrays
+hosts = [
+  "alpha",
+  "omega"
+]

data/test/grammar_test.rb

@@ -0,0 +1,121 @@
+require_relative "helper"
+
+class GrammarTest < Test::Unit::TestCase
+
+  def test_comment
+    match = Document.parse(" # A comment", root: :comment)
+    assert_equal(nil, match.value)
+  end
+
+  def test_keygroup
+    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"))
+    end
+
+    match = Document.parse('[owner.emancu]', root: :keygroup)
+    assert_equal(['owner', 'emancu'], match.value.instance_variable_get("@nested_keys"))
+  end
+
+  def test_keyvalue
+    indentation_alternatives_for('key = "value"') do |str|
+      match = Document.parse(str, root: :keyvalue)
+      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"))
+    end
+  end
+
+  def test_string
+    match = Document.parse('"TOML-Example, should work."', root: :string)
+    assert_equal("TOML-Example, should work.", match.value)
+  end
+
+  def test_special_characters
+    match = Document.parse('"\0 \" \t \n \r"', root: :string)
+    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)
+  end
+
+  def test_bool
+    match = Document.parse('true', root: :bool)
+    assert_equal(true, match.value)
+
+    match = Document.parse('false', root: :bool)
+    assert_equal(false, match.value)
+  end
+
+  def test_integer
+    match = Document.parse('26', root: :number)
+    assert_equal(26, match.value)
+  end
+
+  def test_float
+    match = Document.parse('1.69', root: :number)
+    assert_equal(1.69, match.value)
+  end
+
+  def test_signed_numbers
+    match = Document.parse('+26', root: :number)
+    assert_equal(26, match.value)
+
+    match = Document.parse('-26', root: :number)
+    assert_equal(-26, match.value)
+
+    match = Document.parse('1.69', root: :number)
+    assert_equal(1.69, match.value)
+
+    match = Document.parse('-1.69', root: :number)
+    assert_equal(-1.69, match.value)
+  end
+
+  def test_expressions_with_comments
+    match = Document.parse('[shouldwork] # with comment', root: :keygroup)
+    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"))
+  end
+
+  def test_array
+    match = Document.parse('[]', root: :array)
+    assert_equal([], match.value)
+
+    match = Document.parse('[ 2, 4]', root: :array)
+    assert_equal([2,4], match.value)
+
+    match = Document.parse('[ 2.4, 4.72]', root: :array)
+    assert_equal([2.4,4.72], match.value)
+
+    match = Document.parse('[ "hey", "TOML"]', root: :array)
+    assert_equal(["hey","TOML"], match.value)
+
+    match = Document.parse('[ ["hey", "TOML"], [2,4] ]', root: :array)
+    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)
+  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)
+  end
+
+  private
+
+  # Creates all the alternatives of valid indentations to test
+  def indentation_alternatives_for(str)
+    [str, "  #{str}", "\t#{str}", "\t\t#{str}"].each do |alternative|
+      yield(alternative)
+    end
+  end
+end
+

data/test/hard_example.toml

@@ -0,0 +1,23 @@
+# 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

data/test/helper.rb

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

data/test/toml_test.rb

@@ -0,0 +1,110 @@
+require_relative 'helper'
+
+class TomlTest < Test::Unit::TestCase
+  def test_file
+    path = File.join(File.dirname(__FILE__), 'example.toml')
+    parsed = TOML.load_file(path)
+
+    hash = {
+      "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)
+      },
+
+      "database" => {
+        "server" => "192.168.1.1",
+        "ports" => [ 8001, 8001, 8002 ],
+        "connection_max" => 5000,
+        "enabled" => true
+      },
+
+      "servers" => {
+        "amount" => 2,
+        "alpha" => {
+          "ip" => "10.0.0.1",
+          "dc" => "eqdc10"
+        },
+        "beta" => {
+          "ip" => "10.0.0.2",
+          "dc" => "eqdc10"
+        }
+      },
+
+      "clients" => {
+        "data" => [["gamma", "delta"], [1, 2]],
+        "hosts" => ["alpha", "omega"]
+      }
+    }
+
+    assert_equal(hash, parsed)
+  end
+
+  def test_hard_example
+    path = File.join(File.dirname(__FILE__), 'hard_example.toml')
+    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" => [ "]" ]
+          }
+        }
+      }
+    }
+
+    assert_equal(hash, parsed)
+  end
+
+  def test_symbolize_keys
+    path = File.join(File.dirname(__FILE__), 'example.toml')
+    parsed = TOML.load_file(path, symbolize_keys: true)
+
+    hash = {
+      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)
+      },
+
+      database: {
+        server: "192.168.1.1",
+        ports: [ 8001, 8001, 8002 ],
+        connection_max: 5000,
+        enabled: true
+      },
+
+      servers: {
+        amount: 2,
+        alpha: {
+          ip: "10.0.0.1",
+          dc: "eqdc10"
+        },
+        beta: {
+          ip: "10.0.0.2",
+          dc: "eqdc10"
+        }
+      },
+
+      clients: {
+        data: [["gamma", "delta"], [1, 2]],
+        hosts: ["alpha", "omega"]
+      }
+    }
+
+    assert_equal(hash, parsed)
+  end
+end

data/toml-rb.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = 'toml-rb'
+  s.version     = '0.1.0'
+  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'. "
+  s.authors     = ["Emiliano Mancuso", "Lucas Tolchinsky"]
+  s.email       = ['emiliano.mancuso@gmail.com', 'lucas.tolchinsky@gmail.com']
+  s.homepage    = 'http://github.com/eMancu/toml-rb'
+  s.license     = "MIT"
+
+  s.files = Dir[
+    "README.md",
+    "Rakefile",
+    "lib/**/*.rb",
+    "lib/**/*.citrus",
+    "*.gemspec",
+    "test/*.*"
+  ]
+
+  s.add_dependency "citrus"
+end

data/toml_parser-ruby.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.name        = 'toml_parser-ruby'
+  s.version     = '0.1.0'
+  s.date        = Time.now.strftime('%Y-%m-%d')
+  s.summary     = "TOML parser in ruby, for ruby."
+  s.description = "DEPRECATED by 'toml-rb' gem.\n A TOML parser using Citrus parsing library"
+  s.authors     = ["Emiliano Mancuso"]
+  s.email       = 'emiliano.mancuso@gmail.com'
+  s.homepage    = 'http://github.com/eMancu/toml_parser-ruby'
+  s.license     = "MIT"
+
+  s.files = Dir[
+    "README.md",
+    "Rakefile",
+    "lib/**/*.rb",
+    "*.gemspec",
+    "test/*.*"
+  ]
+
+  s.add_dependency "citrus"
+
+
+  s.post_install_message = <<-MESSAGE
+  !    The 'toml_parser-ruby' gem has been deprecated and has been replaced by 'toml-rb'.
+  !    See: https://rubygems.org/gems/toml-rb
+  !    And: https://github.com/eMancu/toml-rb
+  MESSAGE
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: toml_parser-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emiliano Mancuso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: citrus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "DEPRECATED by 'toml-rb' gem.\n A TOML parser using Citrus parsing
+  library"
+email: emiliano.mancuso@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/toml/keygroup.rb
+- lib/toml/keyvalue.rb
+- lib/toml/parser.rb
+- lib/toml/string.rb
+- lib/toml.rb
+- toml-rb.gemspec
+- toml_parser-ruby.gemspec
+- test/example.toml
+- test/grammar_test.rb
+- test/hard_example.toml
+- test/helper.rb
+- test/toml_test.rb
+homepage: http://github.com/eMancu/toml_parser-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: ! "  !    The 'toml_parser-ruby' gem has been deprecated and
+  has been replaced by 'toml-rb'.\n  !    See: https://rubygems.org/gems/toml-rb\n
+  \ !    And: https://github.com/eMancu/toml-rb\n"
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: TOML parser in ruby, for ruby.
+test_files: []