toml-rb 0.1.3 → 0.1.4

data/README.md

@@ -3,8 +3,12 @@ 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.
+A [TOML](https://github.com/mojombo/toml) parser using [Citrus](http://mjijackson.com/citrus) library.
 
+[![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)
 
 Installation
 ------------

data/lib/toml.rb

@@ -25,7 +25,8 @@ module TOML
   #
   #
   # Returns a Ruby hash representation of the content according to TOML spec.
-  # Raises ValueOverwriteError if a key is overwritten
+  # Raises ValueOverwriteError if a key is overwritten.
+  # Raises ParseError if the content has invalid TOML.
   def self.parse(content, options = {})
     Parser.new(content, options).hash
   end
@@ -47,7 +48,8 @@ module TOML
   #
   #
   # Returns a Ruby hash representation of the content.
-  # Raises ValueOverwriteError if a key is overwritten
+  # Raises ValueOverwriteError if a key is overwritten.
+  # Raises ParseError if the content has invalid TOML.
   # Raises Errno::ENOENT if the file cannot be found.
   # Raises Errno::EACCES if the file cannot be accessed.
   def self.load_file(path, options = {})

data/lib/toml/grammars/helper.citrus

@@ -12,6 +12,6 @@ grammar Helper
   end
 
   rule line_break
-    ("\n" | "\r\n") { nil }
+    (space? "\n" | space? "\r\n") { nil }
   end
 end

data/lib/toml/parser.rb

@@ -1,4 +1,6 @@
 module TOML
+  class ParseError < StandardError; end
+
   class Parser
     attr_reader :hash
 
@@ -7,8 +9,12 @@ module TOML
       @current = @hash
       @symbolize_keys = options[:symbolize_keys]
 
-      parsed = Document.parse(content)
-      parsed.matches.map(&:value).compact.each { |m| m.accept_visitor(self) }
+      begin
+        parsed = Document.parse(content)
+        parsed.matches.map(&:value).compact.each { |m| m.accept_visitor(self) }
+      rescue Citrus::ParseError => e
+        raise ParseError.new(e.message)
+      end
     end
 
     # Read about the Visitor pattern

data/test/errors_test.rb

@@ -0,0 +1,60 @@
+require_relative 'helper'
+
+class ErrorsTest < Test::Unit::TestCase
+
+  def test_text_after_keygroup
+    str = "[error] if you didn't catch this, your parser is broken"
+    assert_raises(TOML::ParseError){ TOML.parse(str) }
+  end
+
+  def test_text_after_string
+    str =  'string = "Anything other than tabs, spaces and newline after a '
+    str += 'keygroup or key value pair has ended should produce an error '
+    str += 'unless it is a comment" like this'
+
+    assert_raises(TOML::ParseError){ TOML.parse(str) }
+  end
+
+  def test_multiline_array_bad_string
+    str =<<-EOS
+    array = [
+     "This might most likely happen in multiline arrays",
+     Like here,
+     "or here,
+     and here"
+     ] End of array comment, forgot the #
+    EOS
+
+    assert_raises(TOML::ParseError){ TOML.parse(str) }
+  end
+
+  def test_multiline_array_string_not_ended
+    str =<<-EOS
+    array = [
+     "This might most likely happen in multiline arrays",
+     "or here,
+     and here"
+     ] End of array comment, forgot the #
+    EOS
+
+    assert_raises(TOML::ParseError){ TOML.parse(str) }
+  end
+
+  def test_text_after_multiline_array
+    str =<<-EOS
+    array = [
+     "This might most likely happen in multiline arrays",
+     "or here",
+     "and here"
+     ] End of array comment, forgot the #
+    EOS
+
+    assert_raises(TOML::ParseError){ TOML.parse(str) }
+  end
+
+  def test_text_after_number
+    str = "number = 3.14 pi <--again forgot the #"
+    assert_raises(TOML::ParseError){ TOML.parse(str) }
+  end
+
+end

data/test/hard_example.toml

@@ -3,19 +3,31 @@
 # This part you'll really hate
 
 [the]
-test_string = "You'll hate me after this - #" # " Annoying, isn't it?
+test_string = "You'll hate me after this - #"          # " Annoying, isn't it?
 
     [the.hard]
-    array = [ "] ", " # "] # ] There you go, parse this!
-    array2 = [ "Test #11 ]proved that", "Experiment #9 was a success" ]
+    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_string = " Same thing, but with a string #"
-    harder_string = "And when \"'s are in the string, along with # \"" # "and comments are there too"
+    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
+
+#[error]   if you didn't catch this, your parser is broken
+#string = "Anything other than tabs, spaces and newline after a keygroup or key value pair has ended should produce an error unless it is a comment"   like this
+#array = [
+#         "This might most likely happen in multiline arrays",
+#         Like here,
+#         "or here,
+#         and here"
+#         ]     End of array comment, forgot the #
+#number = 3.14  pi <--again forgot the #         

data/test/toml_test.rb

@@ -50,10 +50,10 @@ class TomlTest < Test::Unit::TestCase
       'the' => {
         'test_string' => "You'll hate me after this - #",
         'hard' => {
-          'array'  =>  ['] ', ' # '],
-          'array2' =>  ['Test #11 ]proved that', 'Experiment #9 was a success'],
-          'another_string' => ' Same thing, but with a string #',
-          'harder_string' => "And when \"'s are in the string, along with # \"",
+          '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' => [']']

data/toml-rb.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name        = 'toml-rb'
-  s.version     = '0.1.3'
+  s.version     = '0.1.4'
   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.description = "A TOML parser using Citrus parsing library. "
   s.authors     = ["Emiliano Mancuso", "Lucas Tolchinsky"]
   s.email       = ['emiliano.mancuso@gmail.com', 'lucas.tolchinsky@gmail.com']
   s.homepage    = 'http://github.com/eMancu/toml-rb'

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: toml-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
+  prerelease: 
 platform: ruby
 authors:
 - Emiliano Mancuso
@@ -9,11 +10,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-07 00:00:00.000000000 Z
+date: 2013-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citrus
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -21,11 +23,12 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'A TOML parser using Citrus parsing library. Formerly known as ''toml_parser-ruby''. '
+description: ! 'A TOML parser using Citrus parsing library. '
 email:
 - emiliano.mancuso@gmail.com
 - lucas.tolchinsky@gmail.com
@@ -46,8 +49,8 @@ files:
 - lib/toml/grammars/helper.citrus
 - lib/toml/grammars/primitive.citrus
 - toml-rb.gemspec
-- toml_parser-ruby.gemspec
 - test/dumper_test.rb
+- test/errors_test.rb
 - test/example.toml
 - test/grammar_test.rb
 - test/hard_example.toml
@@ -57,25 +60,26 @@ files:
 homepage: http://github.com/eMancu/toml-rb
 licenses:
 - MIT
-metadata: {}
 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: 2.0.3
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: TOML parser in ruby, for ruby.
 test_files: []

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZTg0ZGY1MTk0NzM3MjAxZThkZjRhNWU2MGMxODM2OTBhMTkwZTJiYQ==
-  data.tar.gz: !binary |-
-    YTgwMDkwYzQ5ZDExNTJlYjJjMWZkZjFjOTU4MzY5N2I5MWI3MWQ2Zg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    YjYyYTczYjRhZGFlMzg2MjU0NjdjZDZkOWE2ZDQ2YmUxNjVlNTUxMDMxNTY5
-    ZGIxZDgyZjU3YmQ4MjYwMjgwZjVhN2NjMGNjZTBlNGQ3OWU3M2U5MzdiMzM3
-    NTJhNjI0ZjQxZWQ1YjQ5NTMzZjY3NGYxYWNmNWU3NzlmYjQxZGE=
-  data.tar.gz: !binary |-
-    NjY3ODY1MDA4Y2M5ZWE1ZWZhNGE2ZGQ3ZjkxMjBmODVkM2EzNDRiNjc2ZTE4
-    Mjk4ZGYzZmZhNjhjMjE0MDMxODk3NTg1MDM5MTkyYzgyMGQ0Y2MyZGE0M2Ji
-    MzEyNzYwZjQzZTU5NTE1YTc4NDNhMTkxYTg4ZWRhNGY3ZmNkMmY=

data/toml_parser-ruby.gemspec

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