tomlp 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tomlp.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sandeep Ravichandran
+
+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/README.md

@@ -0,0 +1,45 @@
+# TOMLp
+
+TOMLp is a library to parse the [TOML configuration format](https://github.com/mojombo/toml).
+
+It has a fairly exhaustive test coverage and is compliant with the latest revision of TOML specifications.
+
+_**This is not yet production ready.**_
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tomlp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tomlp
+
+## Usage
+
+Straightforward.
+
+    content = '
+    [key]
+    something = "value"
+    '
+
+    TOMLP.parse(content)
+    # => {"key" => {"something" => "value"}
+
+Or you could also directly load the contents from a file.
+
+    TOMLP.load("path_to_your_toml_file")
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/tomlp.rb

@@ -0,0 +1,27 @@
+require "tomlp/version"
+require "tomlp/parser"
+
+module TOMLP
+  VERSION = "0.0.1" 
+
+  extend self
+
+  # Public: Parse the text passed as arguement
+  #
+  # content - A String containing the entire content of the File in text format
+  #
+  # Returns the parsed Data Structure
+  def parse(content)
+    TOMLP::Parser.new(content).parse
+  end
+
+  # Public: Parse the contents of the file that is passed as arguement
+  #
+  # filename - A String containing the filename that needs to be parsed
+  #
+  # Returns the parsed Data Structure
+  def load(filename)
+    file_content = File.open(filename).read
+    TOMLP::Parser.new(file_content).parse
+  end
+end

data/lib/tomlp/parser.rb

@@ -0,0 +1,41 @@
+require 'treetop'
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'token_extensions.rb'))
+
+module TOMLP
+
+  require 'treetop'
+  Treetop.load(File.expand_path(File.join(File.dirname(__FILE__), 'tomlp_grammar.treetop')))
+
+  # Methods which help in parsing the content
+  #
+  class Parser
+
+    @@parser = TomlParser.new
+
+    # Public: Initialize a Parser.
+    #
+    # name - A String stroring the contents of the file
+    def initialize(content)
+      @content = content.dup
+    end
+
+    # Public: Method to parse the document.
+    #
+    # Returns the parsed Data Structure
+    def parse
+      @content += "\n" unless @content.end_with?("\n")
+      tree = @@parser.parse(@content)
+      Parser.clean_tree(tree)
+      tree.evaluate
+    end
+
+    private
+
+    def self.clean_tree(root_node)
+      return if(root_node.elements.nil?)
+      root_node.elements.delete_if{|node| node.class.name == "Treetop::Runtime::SyntaxNode" }
+      root_node.elements.each {|node| self.clean_tree(node) }
+    end
+  end
+end

data/lib/tomlp/token_extensions.rb

@@ -0,0 +1,184 @@
+module Toml
+
+  require 'date'
+
+  class IntegerLiteral < Treetop::Runtime::SyntaxNode
+    def evaluate
+      return self.text_value.to_i
+    end
+  end
+
+  class StringLiteral < Treetop::Runtime::SyntaxNode
+    def evaluate
+      string = self.text_value
+      output = ""
+      length = self.text_value.length
+      count = 0
+      while count < length
+        if string[count] == "\\"
+          count += 1
+          case string[count]
+          when "t"
+            output << "\t"
+          when "n"
+            output << "\n"
+          when "n"
+            output << '"'
+          when '"'
+            output << "\\"
+          when "r"
+            output << "\r"
+          end
+        elsif string[count] != "\""
+          output << string[count]
+        end
+        count += 1
+      end
+      return output
+    end
+  end
+
+  class FloatLiteral < Treetop::Runtime::SyntaxNode
+    def evaluate
+      return self.text_value.to_f
+    end
+  end
+
+  class BooleanLiteral < Treetop::Runtime::SyntaxNode
+    def evaluate
+      return eval self.text_value
+    end
+  end
+
+  class TrueLiteral < Treetop::Runtime::SyntaxNode
+    def evaluate
+      return eval self.text_value
+    end
+  end
+
+  class FalseLiteral < Treetop::Runtime::SyntaxNode
+    def evaluate
+      return eval self.text_value
+    end
+  end
+
+  class DateTime < Treetop::Runtime::SyntaxNode
+    def evaluate
+      return ::DateTime.parse self.text_value
+    end
+  end
+
+  class ArrayDS < Treetop::Runtime::SyntaxNode
+    def evaluate
+      #array = self.text_value
+      #array[0..-2] if array[-1] == ","
+      return eval self.text_value
+    end
+  end
+
+  class Identifier < Treetop::Runtime::SyntaxNode
+    def evaluate
+      return self.text_value
+    end
+  end
+
+  class AssignmentOperator < Treetop::Runtime::SyntaxNode
+    def evaluate
+      return
+    end
+  end
+
+  class KeyValue < Treetop::Runtime::SyntaxNode
+    def evaluate
+      values = self.elements.map {|x| x.evaluate}
+      key_value = {}
+      key_value[values[0]] = values[2]
+      return key_value
+    end
+  end
+
+  class KeyValueList < Treetop::Runtime::SyntaxNode
+    def evaluate
+      key_value_list = {}
+      self.elements.each do |x|
+        key_value_list.merge!(x.evaluate)
+      end
+      return key_value_list
+    end
+  end
+
+  class KeyGroup < Treetop::Runtime::SyntaxNode
+    def evaluate
+      self.elements.map {|x| x.evaluate}
+    end
+  end
+
+  class KeyName < Treetop::Runtime::SyntaxNode
+    def evaluate
+      self.text_value.split(".")
+    end
+  end
+
+  class CommentLine < Treetop::Runtime::SyntaxNode
+    def evaluate
+      return self.text_value
+    end
+  end
+
+  class Expression < Treetop::Runtime::SyntaxNode
+    def evaluate
+      return self.text_value
+    end
+  end
+  
+  class Body < Treetop::Runtime::SyntaxNode
+
+    def evaluate
+      parse(self.elements.map {|x| x.evaluate})
+    end
+
+    # TODO:: Refactor this method
+    def parse(ds)
+      final_hash = {}
+      current_key, inner_key = nil, nil
+      current_hash = final_hash
+      ds.each_with_index do |value, index|
+        if value.is_a? Hash
+          if current_key == nil
+            current_hash.merge!(value)
+          elsif inner_key
+            current_hash[inner_key].merge!(value)
+          else
+            current_hash[current_key].merge!(value)
+          end
+        elsif value.is_a? Array
+          value = value.first
+          parent_key = value.count > 1 ? value[-2] : value.first
+          if parent_key == current_key
+            current_hash = final_hash[current_key]
+            inner_key = value.last
+            current_hash[inner_key] = {}
+          elsif inner_key && parent_key == inner_key
+            current_hash = current_hash[inner_key]
+            inner_key = value.last
+            current_hash[inner_key] = {}
+          elsif value.count > 1
+            value.each_with_index do |key, nindex|
+              current_hash[key] = {}
+              current_hash = current_hash[key] if nindex + 1 < value.count
+            end
+            inner_key = value.last
+            current_key = value.first
+          else
+            current_hash = final_hash
+            current_key = value.first
+            inner_key = nil
+            final_hash[current_key] = {}
+          end
+        end
+      end
+      final_hash
+    end
+  end
+
+end

data/lib/tomlp/tomlp_grammar.treetop

@@ -0,0 +1,135 @@
+grammar Toml
+
+  rule body
+    ( key_groups / key_value / comment_line / end_of_line )+ <Body>
+  end
+
+  ##################
+  # Key groups
+
+  rule key_groups
+    space? '[' key_name ']' end_of_line <KeyGroup>
+  end
+
+  rule key_value_list
+    key_value+ <KeyValueList>
+  end
+
+  ##################
+  # Key values
+
+  rule key_value
+    space? identifier space? assignment_operator space? value (comment / end_of_line) <KeyValue>
+  end
+
+  rule key_name
+    identifier ('.' identifier)* <KeyName>
+  end
+
+  rule value
+    primitive / array
+  end
+
+  ##################
+  # Primitives
+
+  rule primitive
+    float / datetime / boolean / integer / string
+  end
+
+  rule boolean
+    true / false
+  end
+  
+  rule integer
+    ('+' / '-')? [0-9]+ <IntegerLiteral>
+  end
+  
+  rule float
+    ('+' / '-')? [0-9]+ '.' [0-9]+ <FloatLiteral>
+  end
+  
+  rule string
+    '"' ([^"\\] / "\\" . )* '"' <StringLiteral>
+  end
+
+  rule identifier
+    '$'? [a-zA-Z] [a-zA-Z0-9_]* ('?' / '!')? <Identifier>
+  end
+
+  ##################
+  # Array
+
+  rule array
+    '[' array_break (value array_break ',' array_break )* value array_break ']' <ArrayDS>
+  end
+
+  rule array_break
+    (space? / end_of_line?)
+  end
+
+  ##################
+  # Boolean
+
+  rule true
+    "true" <TrueLiteral>
+  end
+  
+  rule false
+    "false" <FalseLiteral>
+  end
+
+  ##################
+  # DateTime
+
+  rule datetime
+    date 'T' time 'Z' <DateTime>
+  end
+
+  rule date
+    [0-9]4..4 '-' [0-9]2..2 '-' [0-9]2..2
+  end
+
+  rule time
+    [0-9]2..2 ':' [0-9]2..2 ':' [0-9]2..2
+  end
+
+  ##################
+  # Operators
+
+  rule assignment_operator
+    '=' <AssignmentOperator>
+  end
+
+  ##################
+  # Comments
+  
+  rule comment_line
+    comment ( "\n" / end_of_file )
+  end
+
+  rule comment
+    space? '#' [^"\n"]*
+  end
+  
+  ##################
+  # Whitespace
+  
+  rule space
+    [\s]+
+  end
+
+  ##################
+  # End of line
+  
+  rule end_of_line
+    ["^\n"]
+  end
+  
+  ##################
+  # End of file
+  
+  rule end_of_file
+    !.
+  end
+end

data/lib/tomlp/version.rb

@@ -0,0 +1,3 @@
+module Tomlp
+  VERSION = "0.1.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/tomlp/parser_spec.rb

@@ -0,0 +1,77 @@
+require "spec_helper"
+require "tomlp"
+
+describe TOMLP do
+
+  before do
+    filepath = File.join(File.dirname(__FILE__), 'spec.toml')
+    @content = File.open(filepath).read
+    @parsed = TOMLP.parse(@content)
+  end
+
+  describe "key values" do
+    describe "primitives" do
+      it "should parse integer" do
+        @parsed["number"].should == 38
+      end
+
+      it "should parse string" do
+        @parsed["string"].should == "This is a string."
+      end
+
+      it "should parse true" do
+        @parsed["true"].should == true
+      end
+
+      it "should parse false" do
+        @parsed["false"].should == false
+      end
+
+      it "should parse float" do
+        @parsed["float"].should == 0.57721
+      end
+
+      it "should parse datetime" do
+        @parsed["datetime"].should == DateTime.parse("1988-05-28")
+      end
+
+      it "should parse arrays" do
+        @parsed["array"].should == [1, 2, 3]
+      end
+    end
+  end
+
+  describe "integers" do
+    it "should parse positive integers" do
+      @parsed["integer"]["positive"].should == 38
+    end
+
+    it "should parse negative integers" do
+      @parsed["integer"]["negative"].should == -38
+    end
+  end
+
+  describe "arrays" do
+    it "should parse differnt primitives" do
+      @parsed["arrays"]["normal"].should == ["a","b","c"]
+    end
+
+    it "should parse multi arrays" do
+      @parsed["arrays"]["multi"].should == [[1,2], 100, 20]
+    end
+
+    it "should parse arrays with line break" do
+      @parsed["arrays"]["break"].should == ["first", "second", "third"]
+    end
+  end
+
+  describe "keygroups" do
+    it "should parse keygroups in one line" do
+      @parsed["key"]["group"]["value"].should == 1
+    end
+
+    it "should parse nested keygroups" do
+      @parsed["keygroup"]["nested"]["new_value"].should == 12
+    end
+  end
+end

data/spec/tomlp/spec.toml

@@ -0,0 +1,39 @@
+# Global
+
+specification = "TOML"
+
+string = "This is a string."
+
+number = 38
+
+float = 0.57721
+
+true = true
+false = false #comment at the end of a line
+
+datetime = 1988-05-28T00:00:00Z
+
+array = [1,2,3]
+
+# Keygroups
+[integer]
+positive = 38
+negative = -38
+
+[arrays]
+normal = ["a","b", "c"]
+multi = [[1,2], 100, 20]
+break = [
+          "first",
+          "second",
+          "third"
+        ]
+
+# Nested Keygroups in one line
+[key.group]
+value = 1
+
+# Nested keygroups
+[keygroup]
+  [keygroup.nested]
+  new_value = 12

data/tomlp.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tomlp/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "tomlp"
+  gem.version       = Tomlp::VERSION
+  gem.authors       = ["sandeepravi"]
+  gem.email         = ["sandeepravi.bits@gmail.com"]
+  gem.summary       = "A ruby parser for the TOML library."
+  gem.description   = %q{Parse the TOML specificatin}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'treetop'
+
+  gem.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: tomlp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- sandeepravi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Parse the TOML specificatin
+email:
+- sandeepravi.bits@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tomlp.rb
+- lib/tomlp/parser.rb
+- lib/tomlp/token_extensions.rb
+- lib/tomlp/tomlp_grammar.treetop
+- lib/tomlp/version.rb
+- spec/spec_helper.rb
+- spec/tomlp/parser_spec.rb
+- spec/tomlp/spec.toml
+- tomlp.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A ruby parser for the TOML library.
+test_files:
+- spec/spec_helper.rb
+- spec/tomlp/parser_spec.rb
+- spec/tomlp/spec.toml