parspec 0.0.1 → 1.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    Y2RjNGMzNzc3MDhmMDU5OGJjMTQyOGIyNWJjNjNmODc5NmY0ZGVmMQ==
-  data.tar.gz: !binary |-
-    ZjJmOTAzZDM3OGMyNmYxMDkyZGNlODFiMjllNGFhZTVlYjEyYzY0Nw==
+SHA1:
+  metadata.gz: a3516c885084ffddd3b46a2af4bc93ac8914f98f
+  data.tar.gz: d6ddbc77f01ce14afc524a4d0d96a38c8e239f9c
 SHA512:
-  metadata.gz: !binary |-
-    NTViMWMxNTJmYmRhMjljZDZkNGEzZjc1OTlhNmVmOTA2ODYwNWU2Y2I4N2My
-    ZjdmMDA1NWZhODQ1ZDM0YWNmMTkwODg2MGNiMjYyODNhNTlmY2ZhZmRlNzlj
-    ZjU4MGNhOTY1ODcyMDEyNzRlN2E5MmM0NjA2NWE4Y2E5YjNiNGQ=
-  data.tar.gz: !binary |-
-    MjBhMThmMWNiNjY4NzcxMmEyNGIxMzM3ODhlZDFhMmU1ZjIzZjE4ODlmYjE3
-    YTYxOGY4Y2MxN2MwNzA2ZTEyNzJjMmEyZTllMTQzYWRmYjY4ODUzMDdlM2E0
-    MjU0ODEyMWM5ZTRhZDkwMTIxYWFhNGFkMzBjMTZkZjgyYmVjNzI=
+  metadata.gz: 38f184806b33c5dc01ed232e02b87bdd4affc32127060756af394cd239798d83e34c10eff1a7b43943e0cd5cdb213864d9e53547eec60eb1ff6afabcccdaf898
+  data.tar.gz: b99de120a1bb8af2faa5190b9b118de9c3a62f33d555bcfc4ba28c8afb3d29ef83de0f42f38c2cc900a22e837371f5a24a81fb577e1ca5a251e2330933754238

data/.editorconfig

@@ -0,0 +1,28 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[*.rb]
+indent_style = space
+indent_size = 2
+
+[*.rake]
+indent_style = space
+indent_size = 2
+
+[*.parspec]
+indent_style = space
+indent_size = 4
+
+[*.md]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = false

data/README.md

@@ -1,238 +1,246 @@
-# Parspec
-
-A [gUnit](https://theantlrguy.atlassian.net/wiki/display/ANTLR3/gUnit+-+Grammar+Unit+Testing)-like specification language for [Parslet](http://kschiess.github.io/parslet/) parsers and transformers, which translates to [RSpec](http://rspec.info/).
-
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'parspec', group: :test
-```
-
-And then execute:
-
-    $ bundle
-
-Or install with gem:
-
-    $ gem install parspec
-
-
-## Specification language
-
-### Example
-
-The following example shows parts of the [TOML spec](https://github.com/zerowidth/toml-parslet/blob/master/spec/toml/parser_spec.rb) translated to Parspec:
-
-    parser TOML::Parser
-    
-    value:
-        "120381" OK
-        "0181" FAIL
-        "3.14159" OK
-        ".1" FAIL
-        "true" OK
-        "truefalse" FAIL
-        "1979-05-27T07:32:00Z" OK
-        "1979l05-27 07:32:00" FAIL
-        "\"hello world\"" OK
-        "\"hello\nworld\"" FAIL
-        "\"hello/world\"" FAIL
-    
-        "1234"                 -> ":integer => '1234'"
-        "-0.123"               -> ":float   => '-0.123'"
-        "true"                 -> ":boolean => 'true'"
-        "1979-05-27T07:32:00Z" -> ":datetime => '1979-05-27T07:32:00Z'"
-        "\"hello world\""      -> ":string => 'hello world'"
-        "\"hello\nworld\""     -> ":string => \"hello\nworld\""
-    
-    array:
-        "[]" OK
-        "[1]" OK
-        "[0.1, -0.1, 3.14159]" OK
-        "[ true, false, true, true ]" OK
-        "[1979-05-27T07:32:00Z]" OK  # [2013-02-24T17:26:21Z]
-        "[\n1\n,\n2\n]" OK
-        "[\n\n\t1  , 2,     3\\t,4\n]" OK
-        "[1, 2, \"three\"]" FAIL
-        "[1,2,]" OK
-        "[1,2\n,\\t]" OK
-    
-         "[1,2]"     -> ":array => [ {:integer => '1'}, {:integer => '2'}]"
-         "[]"        -> ":array => '[]'"
-         "[ [1,2] ]"
-            -> ":array => [
-                  {:array => [ {:integer => '1'}, {:integer => '2'}]}
-               ]"
-    
-    key:
-         "foobar" OK
-         "lolwhat.noWAY" OK
-         "no white\\tspace" FAIL
-         "noequal=thing" FAIL
-    
-    assignment:
-          "key=3.14" OK
-          "key = 10" OK
-          "key = true" OK
-          "key = \"value\"" OK
-          "#comment=1" FAIL
-          "thing = 1" -> ":key => 'thing', :value => {:integer => '1'}"
-
-
-### Description
-
-#### Header
-
-A Parspec specification starts with a definition of the subject:
-
-    <type> <instantiation expression>
-
-There are two types of specifications: `parser` and `transformer`. A parser specification describes a `Parslet::Parser`, a transformer specification describes a `Parslet::Transform`. Syntactically these types of specifications are equal, but the generated RSpec descriptions will differ.
-
-The instantiation expression is used to create a RSpec test subject. It usually consists of a constant for a `Parslet::Parser` or `Parslet::Transform` class, according to the type of specification, but can be any valid Ruby expression, which responds to `new` with a `Parslet::Parser` or `Parslet::Tranform` instance.
-
-
-#### Rule examples
-
-After the definition, a series of examples for the grammar rules follows. Rules start with a rule name followed by a colon.
-
-There are two types of examples: simple validations and mapping examples.
-
-
-##### Validations
-
-A validation is a string in double-quotes followed either by the keyword `OK` or `FAIL`, according to the expected outcome of parsing the given string under the given rule. Currently, it is supported in parser specifications only.
-
-For example, the following validation:
-
-    some_rule:
-      "some input" OK
-      "another input" FAIL
-
-will translate to this RSpec description:
-
-```ruby
-context 'some_rule parsing' do
-  subject { parser.some_rule }
-
-  it { should parse 'some input' }
-  it { should_not parse 'another input' }
-end
-```
-
-
-##### Mapping examples
-
-Mapping examples describe the input-output-behaviour of a rule. Syntactically they consist of two strings separated by `->`. Since the semantics of parser and transformer specifications differ, let's discuss them separately, starting with the parser case:
-
-While the input string on the left side is simply some sample text as in a validity example, the output string on the right must contain a valid Ruby expression, which should evaluate to the expected outcome of the respective rule parsing.
-
-For example, the following mapping:
-
-    some_rule:
-      "some input"    -> "42"
-      "another input" -> "{ foo: 'bar' }"
-
-will be translated to the following RSpec parser specification:
-
-```ruby
-context 'some_rule parsing' do
-  subject { parser.some_rule }
-
-  it "should parse 'some input' to 42" do
-    expect(subject.parse('some input')).to eq 42
-  end
-
-  it "should parse 'another input' to { foo: 'bar' }" do
-    expect(subject.parse('another input')).to eq { foo: 'bar' }
-  end
-end
-```
-
-In the case of a transformer specification, both sides must contain Ruby expressions.
-
-
-#### Shared examples
-
-The examples of a rule can be reused inside other rules with the `include` keyword:
-
-    some_rule:
-      "some input"    -> "42"
-      "another input" -> "{ foo: 'bar' }"
-
-    another_rule:
-      include some_rule
-
-
-#### String escaping
-
-Parspec strings in general support the following escape sequences: `\t`, `\n`, `\r`, `\"`, `\\`. 
-  
-
-#### Comments
-
-One-line comments are supported in the `#`-style.
-
-
-## Usage
-
-### Command-line interface
-
-Parspec comes with a command-line interface through the `parspec` command.
-
-For a full description of the available parameters, run:
-
-    $ parspec --help
-    Usage: parspec [options] PARSPEC_FILE
-        -h, --help                       Display this information
-        -v, --version                    Print version information
-        -s, --stdout                     Print the translation to stdout only
-        -o, --out OUTPUT_FILE            Path where translated RSpec file should be stored
-        -b, --beside-input               Put the output file into the same directory as the input
-        -e, --header HEADER              A block of code to be put in front of the translation
-            --no-debug-parse             Don't print the whole Parslet ascii_tree on errors
-
-Unless specified otherwise, the default header is:
-
-```ruby
-# coding: utf-8
-require 'spec_helper'
-require 'parslet/convenience'
-require 'parslet/rig/rspec'
-```
-
-
-### `load_parspec` 
-
-You can use the command-line interface to integrate Parspec in your testing tool chain, e.g. via Rake or Guard. 
-
-But you can also load your Parspec spec from a normal Ruby file in your spec directory with the `load_parspec` command:   
-
-```ruby
-require 'spec_helper'
-require 'parspec'
-require 'my_parser'
-
-load_parspec __FILE__
-```
-
-If the `load_parspec` command gets a filename with the extension `.rb`, it looks for a file with the same name, but the extension `.parspec`. For example, if the former Ruby file would be at `spec/my_parser/my_parser_spec.rb`, the `load_parspec` command would try to load a Parspec spec from a file `spec/my_parser/my_parser_spec.parspec`.
-
-
-Note: This feature is currently implemented via `eval`, till I find a way to include specs from other RSpec files or another alternative. If you have any advice, please share it in issue #1.
-
-
-## Contributing
-
-1. Fork it ( https://github.com/marcelotto/parspec/fork )
-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 a new Pull Request
-
-## Author
-
-- Marcel Otto
+# Parspec
+
+A [gUnit](https://theantlrguy.atlassian.net/wiki/display/ANTLR3/gUnit+-+Grammar+Unit+Testing)-like specification language for [Parslet](http://kschiess.github.io/parslet/) parsers and transformers, which gets translated to [RSpec](http://rspec.info/) specs.
+
+
+## Status
+
+This software is feature-complete, since it realizes the features of [gUnit](https://theantlrguy.atlassian.net/wiki/display/ANTLR3/gUnit+-+Grammar+Unit+Testing) (with some additions) completely and can successfully be used as a full [gUnit](https://theantlrguy.atlassian.net/wiki/display/ANTLR3/gUnit+-+Grammar+Unit+Testing)-like replacement of handmade [RSpec](http://rspec.info/) specs, while still using the excellent RSpec testing platform, allowing to integrate the generated specs with handmade RSpec specs.
+
+Although some nice language additions are thinkable, I won't implement them in the near future, until I need them. 
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'parspec', group: :test
+```
+
+And then execute:
+
+    $ bundle
+
+Or install with gem:
+
+    $ gem install parspec
+
+
+## Specification language
+
+### Example
+
+The following example shows parts of the [TOML spec](https://github.com/zerowidth/toml-parslet/blob/master/spec/toml/parser_spec.rb) translated to Parspec:
+
+    parser TOML::Parser
+    
+    value:
+        "120381" OK
+        "0181" FAIL
+        "3.14159" OK
+        ".1" FAIL
+        "true" OK
+        "truefalse" FAIL
+        "1979-05-27T07:32:00Z" OK
+        "1979l05-27 07:32:00" FAIL
+        "\"hello world\"" OK
+        "\"hello\nworld\"" FAIL
+        "\"hello/world\"" FAIL
+    
+        "1234"                 -> ":integer => '1234'"
+        "-0.123"               -> ":float   => '-0.123'"
+        "true"                 -> ":boolean => 'true'"
+        "1979-05-27T07:32:00Z" -> ":datetime => '1979-05-27T07:32:00Z'"
+        "\"hello world\""      -> ":string => 'hello world'"
+        "\"hello\nworld\""     -> ":string => \"hello\nworld\""
+    
+    array:
+        "[]" OK
+        "[1]" OK
+        "[0.1, -0.1, 3.14159]" OK
+        "[ true, false, true, true ]" OK
+        "[1979-05-27T07:32:00Z]" OK  # [2013-02-24T17:26:21Z]
+        "[\n1\n,\n2\n]" OK
+        "[\n\n\t1  , 2,     3\\t,4\n]" OK
+        "[1, 2, \"three\"]" FAIL
+        "[1,2,]" OK
+        "[1,2\n,\\t]" OK
+    
+         "[1,2]"     -> ":array => [ {:integer => '1'}, {:integer => '2'}]"
+         "[]"        -> ":array => '[]'"
+         "[ [1,2] ]"
+            -> ":array => [
+                  {:array => [ {:integer => '1'}, {:integer => '2'}]}
+               ]"
+    
+    key:
+         "foobar" OK
+         "lolwhat.noWAY" OK
+         "no white\\tspace" FAIL
+         "noequal=thing" FAIL
+    
+    assignment:
+          "key=3.14" OK
+          "key = 10" OK
+          "key = true" OK
+          "key = \"value\"" OK
+          "#comment=1" FAIL
+          "thing = 1" -> ":key => 'thing', :value => {:integer => '1'}"
+
+
+### Description
+
+#### Header
+
+A Parspec specification starts with a definition of the subject:
+
+    <type> <instantiation expression>
+
+There are two types of specifications: `parser` and `transformer`. A parser specification describes a `Parslet::Parser`, a transformer specification describes a `Parslet::Transform`. Syntactically these types of specifications are equal, but the generated RSpec descriptions will differ.
+
+The instantiation expression is used to create a RSpec test subject. It usually consists of a constant for a `Parslet::Parser` or `Parslet::Transform` class, according to the type of specification, but can be any valid Ruby expression, which responds to `new` with a `Parslet::Parser` or `Parslet::Tranform` instance.
+
+
+#### Rule examples
+
+After the definition, a series of examples for the grammar rules follows. Rules start with a rule name followed by a colon.
+
+There are two types of examples: validations and mapping examples.
+
+
+##### Validations
+
+A validation is a string in double-quotes followed either by the keyword `OK` or `FAIL`, according to the expected outcome of parsing the given string under the given rule. Currently, it is supported in parser specifications only.
+
+For example, the following validation:
+
+    some_rule:
+      "some input" OK
+      "another input" FAIL
+
+will translate to this RSpec description:
+
+```ruby
+context 'some_rule parsing' do
+  subject { parser.some_rule }
+
+  it { should parse 'some input' }
+  it { should_not parse 'another input' }
+end
+```
+
+
+##### Mapping examples
+
+Mapping examples describe the input-output-behaviour of a rule. Syntactically they consist of two strings separated by `->`. Since the semantics of parser and transformer specifications differ, let's discuss them separately, starting with the parser case:
+
+While the input string on the left side is simply some sample text as in a validity example, the output string on the right must contain a valid Ruby expression, which should evaluate to the expected outcome of the respective rule parsing.
+
+For example, the following mapping:
+
+    some_rule:
+      "some input"    -> "42"
+      "another input" -> "{ foo: 'bar' }"
+
+will be translated to the following RSpec parser specification:
+
+```ruby
+context 'some_rule parsing' do
+  subject { parser.some_rule }
+
+  it "should parse 'some input' to 42" do
+    expect(subject.parse('some input')).to eq 42
+  end
+
+  it "should parse 'another input' to { foo: 'bar' }" do
+    expect(subject.parse('another input')).to eq { foo: 'bar' }
+  end
+end
+```
+
+In the case of a transformer specification, both sides must contain Ruby expressions.
+
+
+#### Shared examples
+
+The examples of a rule can be reused inside other rules with the `include` keyword:
+
+    some_rule:
+      "some input"    -> "42"
+      "another input" -> "{ foo: 'bar' }"
+
+    another_rule:
+      include some_rule
+
+
+#### String escaping
+
+Parspec strings in general support the following escape sequences: `\t`, `\n`, `\r`, `\"`, `\\`. 
+  
+
+#### Comments
+
+One-line comments are supported in the `#`-style.
+
+
+## Usage
+
+### Command-line interface
+
+Parspec comes with a command-line interface through the `parspec` command.
+
+For a full description of the available parameters, run:
+
+    $ parspec --help
+    Usage: parspec [options] PARSPEC_FILE
+        -h, --help                       Display this information
+        -v, --version                    Print version information
+        -s, --stdout                     Print the translation to stdout only
+        -o, --out OUTPUT_FILE            Path where translated RSpec file should be stored
+        -b, --beside-input               Put the output file into the same directory as the input
+        -e, --header HEADER              A block of code to be put in front of the translation
+            --no-debug-parse             Don't print the whole Parslet ascii_tree on errors
+
+Unless specified otherwise, the default header is:
+
+```ruby
+# coding: utf-8
+require 'spec_helper'
+require 'parslet/convenience'
+require 'parslet/rig/rspec'
+```
+
+
+### `load_parspec` 
+
+You can use the command-line interface to integrate Parspec in your testing tool chain, e.g. via Rake or Guard. 
+
+But you can also load your Parspec spec from a normal Ruby file in your spec directory with the `load_parspec` command:   
+
+```ruby
+require 'spec_helper'
+require 'parspec'
+require 'my_parser'
+
+load_parspec __FILE__
+```
+
+If the `load_parspec` command gets a filename with the extension `.rb`, it looks for a file with the same name, but the extension `.parspec`. For example, if the former Ruby file would be at `spec/my_parser/my_parser_spec.rb`, the `load_parspec` command would try to load a Parspec spec from a file `spec/my_parser/my_parser_spec.parspec`.
+
+
+Note: This feature is currently implemented via `eval`, till I find a way to include specs from other RSpec files or another alternative. If you have any advice, please share it in issue #1.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/marcelotto/parspec/fork )
+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 a new Pull Request
+
+## Author
+
+- Marcel Otto

data/lib/parspec/version.rb

@@ -1,3 +1,3 @@
 module Parspec
-  VERSION = '0.0.1'
+  VERSION = '1.0.0'
 end

data/parspec.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Parspec::VERSION
   spec.authors       = ['Marcel Otto']
   spec.email         = ['marcelotto.de@gmail.com']
-  spec.summary       = %q{Testing of Parslet grammars and transformations}
+  spec.summary       = %q{Testing-Framework for Parslet grammars and transformations}
   spec.description   = %q{A specification language for Parslet grammars and transformers, which gets translated to RSpec.}
   spec.homepage      = 'http://github.com/marcelotto/parspec'
   spec.license       = 'MIT'

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: parspec
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Marcel Otto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-24 00:00:00.000000000 Z
+date: 2015-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 description: A specification language for Parslet grammars and transformers, which
@@ -75,8 +75,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -105,21 +106,20 @@ 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.1.9
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Testing of Parslet grammars and transformations
+summary: Testing-Framework for Parslet grammars and transformations
 test_files:
 - spec/parspec/parser_spec.rb
 - spec/spec_helper.rb
-has_rdoc: