gherkin 2.12.2 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19714bd5cd76b6a265f7804b22ceb27939c5b8ef
-  data.tar.gz: e042bb512f5b4ad6f7e22b62caad67fe0f02fc0d
+  metadata.gz: 616936d9b8360845b1bc12aa9977027ca9798a70
+  data.tar.gz: e86bcaf18d78f4eae825334729b858b144cddb06
 SHA512:
-  metadata.gz: dd77eb77ea763b77f6d19ba13548e76c554e3e996d8b0ebabc49ac4f5286dcd6a27d3b58a02b916fd303ac7d89fb3157287c00458174f56adb5421d0eecd6f25
-  data.tar.gz: 875400eab0b0d54a392fa4931d8c2324f037b1d05b293f001ca01c70a2814893e9ccea628c6714d86bf650beb72d1e9e6c96c34dd4063b35a99f90727db61868
+  metadata.gz: a92897921797ebde32ca547eada1292adb5b338d4d3bd4b26328c361a22032460e9b117bb4acc133a19259b8aeae2b33053bed63747d4391c9521e235053db2f
+  data.tar.gz: c3a596f0c6f3d18088e2861dc40b7635a6d196f3aeceb9bf4eea6fbc17498d7470d6549235c103e996159f90141bc10da56ec98384179e3b66b706faf76f9e61

data/.travis.yml

@@ -1,15 +1,2 @@
-before_install: gem install bundler -v 1.3.5
-rvm: 
-  - 2.0.0
-  - 1.9.3
-  - jruby
-# whitelist
-branches:
-  only:
-    - master
-
-notifications:
-  email:
-    - cukes-devs@googlegroups.com
-  irc:
-    - "irc.freenode.org#cucumber"
+language: ruby
+sudo: false

data/CONTRIBUTING.md

@@ -0,0 +1,23 @@
+Please read [CONTRIBUTING](https://github.com/cucumber/gherkin/blob/master/CONTRIBUTING.md) first.
+You should clone the [cucumber/gherkin](https://github.com/cucumber/gherkin) repo if you want
+to contribute.
+
+## Run tests
+
+### Using make
+
+Just run `make` from this directory.
+
+Even if you prefer `make` - run `rake` occasionally, as it reports better warnings.
+
+### Using rake
+
+Just run `rake` from this directory.
+
+Keep in mind that this will only run unit tests. The acceptance tests are only
+run when you build with `make`.
+
+## Make a release
+
+    # Change version in `gherkin.gemspec` and commit
+    bundle exec rake build release

data/Gemfile

@@ -1,5 +1,2 @@
 source "https://rubygems.org"
 gemspec
-
-# gem 'cucumber', :path => '../cucumber'
-

data/LICENSE

@@ -1,20 +1,21 @@
-Copyright (c) 2009-2013 Mike Sassak, Gregory Hnatiuk, Aslak Hellesøy
+The MIT License (MIT)
 
-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:
+Copyright (c) 2014-2016 Cucumber Ltd, Gaspar Nagy
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+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 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.
+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/Makefile

@@ -0,0 +1,65 @@
+GOOD_FEATURE_FILES = $(shell find ../testdata/good -name "*.feature")
+BAD_FEATURE_FILES  = $(shell find ../testdata/bad -name "*.feature")
+
+TOKENS   = $(patsubst ../testdata/%.feature,acceptance/testdata/%.feature.tokens,$(GOOD_FEATURE_FILES))
+ASTS     = $(patsubst ../testdata/%.feature,acceptance/testdata/%.feature.ast.json,$(GOOD_FEATURE_FILES))
+PICKLES  = $(patsubst ../testdata/%.feature,acceptance/testdata/%.feature.pickles.json,$(GOOD_FEATURE_FILES))
+ERRORS   = $(patsubst ../testdata/%.feature,acceptance/testdata/%.feature.errors,$(BAD_FEATURE_FILES))
+
+RUBY_FILES = $(shell find . -name "*.rb")
+
+all: .compared
+.PHONY: all
+
+.compared: .built $(TOKENS) $(ASTS) $(PICKLES) $(ERRORS)
+	touch $@
+
+.built: lib/gherkin/parser.rb lib/gherkin/gherkin-languages.json $(RUBY_FILES) Gemfile.lock LICENSE
+	bundle exec rspec --color
+	touch $@
+
+acceptance/testdata/%.feature.tokens: ../testdata/%.feature ../testdata/%.feature.tokens .built
+	mkdir -p `dirname $@`
+	bin/gherkin-generate-tokens $< > $@
+	diff --unified $<.tokens $@
+.DELETE_ON_ERROR: acceptance/testdata/%.feature.tokens
+
+acceptance/testdata/%.feature.ast.json: ../testdata/%.feature ../testdata/%.feature.ast.json .built
+	mkdir -p `dirname $@`
+	bin/gherkin-generate-ast $< | jq --sort-keys "." > $@
+	diff --unified $<.ast.json $@
+.DELETE_ON_ERROR: acceptance/testdata/%.feature.ast.json
+
+acceptance/testdata/%.feature.pickles.json: ../testdata/%.feature ../testdata/%.feature.pickles.json .built
+	mkdir -p `dirname $@`
+	bin/gherkin-generate-pickles $< | jq --sort-keys "." > $@
+	diff --unified $<.pickles.json $@
+.DELETE_ON_ERROR: acceptance/testdata/%.feature.pickles.json
+
+acceptance/testdata/%.feature.errors: ../testdata/%.feature ../testdata/%.feature.errors .built
+	mkdir -p `dirname $@`
+	! bin/gherkin-generate-ast $< 2> $@
+	diff --unified $<.errors $@
+.DELETE_ON_ERROR: acceptance/testdata/%.feature.errors
+
+lib/gherkin/gherkin-languages.json: ../gherkin-languages.json
+	cp $^ $@
+
+clean:
+	rm -rf .compared .built acceptance lib/gherkin/parser.rb lib/gherkin/gherkin-languages.json coverage
+.PHONY: clean
+
+lib/gherkin/parser.rb: ../gherkin.berp gherkin-ruby.razor ../bin/berp.exe
+	mono ../bin/berp.exe -g ../gherkin.berp -t gherkin-ruby.razor -o $@
+	# Remove BOM
+	tail -c +4 $@ > $@.nobom
+	mv $@.nobom $@
+
+Gemfile.lock: Gemfile
+	bundle install
+
+LICENSE: ../LICENSE
+	cp $< $@
+
+update-gherkin-languages: lib/gherkin/gherkin-languages.json
+.PHONY: update-gherkin-languages

data/README.md

@@ -1,272 +1,13 @@
-[![Build Status](https://secure.travis-ci.org/cucumber/gherkin.png)](http://travis-ci.org/cucumber/gherkin)
+[![Build Status](https://secure.travis-ci.org/cucumber/gherkin-ruby.svg)](http://travis-ci.org/cucumber/gherkin-ruby)
 
-A fast lexer and parser for the Gherkin language based on Ragel. Gherkin is two things:
+Gherkin parser/compiler for Ruby. Please see [Gherkin](https://github.com/cucumber/gherkin) for details.
 
-* The language that has evolved out of the Cucumber project.
-* This library.
+## Developers
 
-Supported platforms:
+Some files are generated from the `gherkin-ruby.razor` file. Please run the
+following command to generate the ruby files.
 
-* [Ruby](https://rubygems.org/gems/gherkin) 1.9.3-2.0.0 (MRI, JRuby, REE, Rubinius)
-* [Pure Java](http://search.maven.org/#search%7Cga%7C1%7Cgherkin) (jar file)
-* [JavaScript](http://search.npmjs.org/#/gherkin) (Tested with V8/node.js/Chrome, but might work on other JavaScript engines)
-* [.NET](http://nuget.org/List/Packages/gherkin) (dll file)
-
-## Installation
-
-### Ruby/JRuby
-
-    gem install gherkin
-
-#### Troubleshooting
-
-On JRuby you may get an error saying:
-
-    ERROR:  While executing gem ... (ArgumentError)
-    undefined class/module YAML::Syck::DefaultKey
-
-You can get around this problem by upgrading rubygems:
-
-    jruby -S gem install rubygems-update
-    gem update --system
-
-Another problem you might encounter is:
-
-    ERROR: While executing gem ... (ArgumentError)
-    invalid byte sequence in US-ASCII
-
-If this happens, try defining your shell's encoding:
-
-    # Linux
-    export LANG=en_US.UTF-8
-
-    # OS X
-    export LC_CTYPE=en_US.UTF-8
-
-### Node.js
-
-    npm install gherkin
-
-### Java
-
-The jar file is in the central Maven repo.
-
-    <dependency>
-        <groupId>info.cukes</groupId>
-        <artifactId>gherkin</artifactId>
-        <version>2.12.2</version>
-    </dependency>
-
-You can get it manually from [Maven Central](http://search.maven.org/#browse%7C-2073395818)
-
-### .NET
-
-Get the dll from [NuGet](http://nuget.org/List/Packages/gherkin)
-
-## API Docs
-
-* [Ruby](http://cukes.info/api/gherkin/yardoc/)
-* [Java](http://cukes.info/api/gherkin/javadoc/)
-
-## Hacking: Installing the toolchain
-
-Due to the cross-platform nature of this library, you have to install a lot of tools to build gherkin yourself.
-In order to make it easier for occasional contributors to get the development environment up and running, you don't
-have to install everything up front. The build scripts should tell you if you are missing something. For example,
-you shouldn't have to install MinGW to build windows binaries if you are a Linux user and just want to fix a bug in
-the C code.
-
-### Common dependencies
-
-These are the minimal tools you need to install:
-
-* Ragel (brew install ragel or apt-get install ragel)
-* Ruby (any version should do).
-* A clone of the cucumber git repo to a "cucumber" sibling folder of your gherkin folder. (Only needed to run cucumber tests)
-* RVM (you may not need this if you are only building for a single platform)
-
-With this minimal tool chain installed, install Ruby gems needed by the build:
-
-    gem install bundler
-    bundle install
-
-Running RSpec and Cucumber tests
-
-    rake clean spec cucumber
-
-If the RL_LANGS environment variable is set, only the parsers for the languages specified there will be built.
-E.g. in Bash, export RL_LANGS="en,fr,no". This can be quite helpful when modifying the Ragel grammar.
-
-See subsections for building for a specific platform.
-
-### MRI, REE or Rubinius
-
-You'll need GCC installed.
-
-Build the gem with:
-
-    rake build
-
-### Pure Java and JRuby
-
-You must install JRuby to build the pure Java jar or the JRuby gem:
-
-    rvm install jruby
-    rvm use jruby
-    rvm gemset create cucumber
-    rvm gemset use cucumber
-    gem install bundler
-    bundle install
-
-Now you can build the jar with:
-
-    rake clean jar
-
-### JavaScript
-
-In order to build and test Gherkin for JavaScript you must install:
-
-* Node.js (0.10.9 or higher with npm)
-* Ragel with JavaScript support: http://github.com/dominicmarks/ragel-js
-  * Make sure you have gcc/g++ 4.6 (4.7 is too strict to build ragel-js)
-  * Make sure you have `autoconf` and `automake` (`brew install automake`)
-  * Make sure you have the official ragel (`brew install ragel`)
-  * Make sure you have kelbt (`brew install kelbt`). If that fails, install manually from http://www.complang.org/kelbt/
-  * `cd ragel-js/ragel-svn && ./autogen.sh && ./configure --disable-manual`
-  * `make && make install`
-* Define the GHERKIN_JS environment variable in your shell (any value will do)
-
-Update gems (to install gems which are needed only for js support):
-
-    bundle update
-
-Now you can build the JavaScript with:
-
-    bundle exec rake js
-
-And you can try it out with node.js:
-
-    node js/example/print.js spec/gherkin/fixtures/1.feature
-
-Or the json formatter:
-
-    node js/example/json_formatter_example.js
-
-If you're hacking and just want to rebuild the English parser:
-
-    rake js/lib/gherkin/lexer/en.js
-
-In order to test the native JavaScript implementation of JSONFormatter, you also need to define the `GHERKIN_JS_NATIVE` environment
-variable. It's recommended you don't do this permanently, as it will disable testing the Ruby implementation. Try this instead:
-
-    GHERKIN_JS_NATIVE=true GHERKIN_JS=true bundle exec rake
-
-TODO: Make all specs pass with js lexer - replace 'c(listener)' with 'js(listener)' in i18n.rb
-
-### .NET dll
-
-You must install Mono SDK 3.2.1 (or possibly newer). The OS X package installer is recommended, but make sure you run `brew doctor`
-after installing.
-
-Now we must update NuGet.exe and register our NuGet API Key:
-
-    # In case we need to update
-    mono ikvm/NuGet.exe Update -self
-
-    # The key is at https://nuget.org/account
-    mono --runtime=v4.0.30319 ikvm/NuGet.exe SetApiKey xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx
-    (Note: you may need to run 'mozroots --import --sync' to help mono trusts https setificate, see http://monomvc.wordpress.com/2012/03/06/nuget-on-mono/ for more information)
-
-Now you can build the .NET dll with:
-
-    mkdir release
-    rake ikvm
-    rake release/nuspec/lib/gherkin.dll
-
-This should build `release/nuspec/lib/gherkin.dll`
-
-### MinGW Rubies (for Windows gems)
-
-In order to build Windows binaries (so we can release Windows gems from OS X/Linux) we first need to install MinGW:
-
-    ./install_mingw_os_x.sh
-
-Now, make sure you have openssl installed - it's needed to build the rubies.
-
-    brew install openssl
-
-Next, we're going to install Ruby 1.9.3 and 2.0.0 for MinGW. We need both versions so we can build Windows binaries for both.
-
-    export PATH=/usr/local/mingw/bin:$PATH
-    # Test that it's on your PATH
-    i686-w64-mingw32-gcc -v
-
-Now we're ready to install the Windows rubies. You should be able to replace `rvm` with `rbenv`
-
-    unset GHERKIN_JS
-
-    # 1.9.3
-    rvm install 1.9.3-p448
-    rvm use 1.9.3-p448
-    rvm gemset use cucumber --create
-    gem install bundler
-    bundle install
-    PATH=/usr/local/mingw/bin:$PATH CC=/usr/local/mingw/bin/i686-w64-mingw32-gcc rake-compiler cross-ruby VERSION=1.9.3-p448
-
-    # 2.0.0
-    rvm install 2.0.0-p247
-    rvm use 2.0.0-p247
-    rvm gemset use cucumber --create
-    gem install bundler
-    bundle install
-    PATH=/usr/local/mingw/bin:$PATH CC=/usr/local/mingw/bin/i686-w64-mingw32-gcc rake-compiler cross-ruby VERSION=2.0.0-p247
-
-Now you can build Windows gems:
-
-    rake compile
-    mkdir release
-    PATH=/usr/local/mingw/bin:$PATH CC=/usr/local/mingw/bin/i686-w64-mingw32-gcc rake gems:win
-
-## Release process
-
-Make sure you have access to all the servers where packages are being uploaded:
-
-* npm registry: `npm login`
-* rubygems.org: `gem push`
-* sonatype: Check `~/.m2/settings.xml` and that you have gnupg (OS X users: Install [GPGTools](http://www.gpgtools.org/installer/index.html))
-  * Make sure you have a key [with no sub-key](https://docs.sonatype.org/display/Repository/How+To+Generate+PGP+Signatures+With+Maven)
-* nuget: See .NET section above
-
-Run tests once with GHERKIN_JS_NATIVE=true:
-
-    GHERKIN_JS_NATIVE=true GHERKIN_JS=true bundle exec rake
-
-Now we can release:
-
-* Make sure you have rbenv installed
-  * And that you have merged this patch: https://github.com/sstephenson/rbenv/issues/121
-  * `cd ~/.rbenv && git pull git@github.com:sstephenson/rbenv.git exec-next`
-* Make sure GHERKIN_JS is defined (see JavaScript section above)
-* Bump version in:
-  * This file (Installation/Java section)
-  * lib/gherkin/platform.rb
-  * java/pom.xml
-  * js/package.json
-  * History.md
-* Run `bundle update`, so Gemfile.lock gets updated with the changes.
-* Commit changes, otherwise you will get an error at the end when a tag is made.
-* Run `i686-w64-mingw32-gcc -v && bundle exec rake gems:prepare && ./build_native_gems.sh && bundle exec rake release:ALL`
-
-## Note on Patches/Pull Requests
-
-* Fork the project.
-* Run `bundle install` to install dependencies.
-* Run `rake` to make sure all the tests are passing.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a future version unintentionally.
-* Commit, do not mess with History.md.
-* Send me a pull request. Bonus points for topic branches.
-
-## Copyright
-
-Copyright (c) 2009-2013 Mike Sassak, Gregory Hnatiuk, Aslak Hellesøy. See LICENSE for details.
+~~~bash
+cd <project_root>/ruby
+make
+~~~