gherkin 2.3.7 → 2.4.0

data/{README.rdoc → README.md}

@@ -1,6 +1,4 @@
-= Gherkin
-
-Fast Gherkin lexer and parser based on Ragel. Gherkin is two things:
+A fast lexer and parser for the Gherkin language based on Ragel. Gherkin is two things:
 
 * The language that has evolved out of the Cucumber project.
 * This library
@@ -13,7 +11,7 @@ Supported platforms:
 * .NET
 * IronRuby (experimental)
 
-== Installing the toolchain
+## 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
@@ -21,7 +19,7 @@ have to install everything up front. The build scripts should tell you if you ar
 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
+### Common dependencies
 
 These are the minimal tools you need to install:
 
@@ -32,42 +30,42 @@ These are the minimal tools you need to install:
 
 With this minimal toolchain installed, install Ruby gems needed by the build:
 
-  gem install bundler
-  bundle install
+    gem install bundler
+    bundle install
 
 Running RSpec and Cucumber tests
 
-  rake clean spec cucumber
+    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
+### MRI, REE or Rubinius
 
 You'll need GCC installed.
 
 Build the gem with:
 
-  rake build
+    rake build
 
-=== Pure Java and JRuby
+### 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 use @cucumber
-  gem install bundler
-  bundle install
+    rvm install jruby
+    rvm use jruby
+    rvm gemset create cucumber
+    rvm use @cucumber
+    gem install bundler
+    bundle install
 
 Now you can build the jar with:
 
-  rake clean jar
+    rake clean jar
 
-=== Javascript
+### Javascript
 
 In order to build and test Gherkin for Javascript you must install:
 
@@ -78,26 +76,28 @@ In order to build and test Gherkin for Javascript you must install:
 
 Now you can build the Javascript with:
 
-  rake js
-  cd js
-  npm install
+    rake js
+    cd js
+    npm install
 
 And you can try it out with node.js:
 
-  node js/example/print.js spec/gherkin/fixtures/1.feature
+    node js/example/print.js spec/gherkin/fixtures/1.feature
 
 You can also try out Gherkin running in the browser (likely to move to a separate project):
 
-  # Pull in the Ace (http://ace.ajax.org/) editor:
-  git submodule update --init
-  # Open a sample Gherkin-powered editor in Chrome
-  open js/example/index.html
+    # Pull in the Ace (http://ace.ajax.org/) editor:
+    git submodule update --init
+    # Open a sample Gherkin-powered editor in Chrome
+    open js/example/index.html
 
 If you're hacking and just want to rebuild the English parser:
 
   rake js/lib/gherkin/lexer/en.js
 
-=== .NET and IronRuby
+TODO: Make all specs pass with js lexer - replace 'c(listener)' with 'js(listener)' in i18n.rb
+
+### .NET and IronRuby
 
 You must install Mono and IKVM to build the pure .NET dll and the IronRuby gem:
 
@@ -106,9 +106,9 @@ You must install Mono and IKVM to build the pure .NET dll and the IronRuby gem:
 
 Now you can build the .NET dll with:
 
-  rake ikvm
+    rake ikvm
 
-=== MinGW Rubies (for Windows gems)
+### MinGW Rubies (for Windows gems)
 
 In order to build Windows binaries (so we can release Windows gems from OS X/Linux) we need to set up rake-compiler.
 
@@ -125,46 +125,48 @@ First you need to download and install MinGW:
 OS X users can get it from http://crossgcc.rts-software.org/doku.php
 Once you have installed it, add this to your .bashrc:
 
-  export PATH=$PATH:/usr/local/i386-mingw32-4.3.0/bin
+    export PATH=$PATH:/usr/local/i386-mingw32-4.3.0/bin
 
 Now, let's install some rubies.
 Make sure you have openssl installed first.
 
-  brew install openssl
-
-  # 1.8.6
-  # Don't worry about inconsistent patchlevels here. It works.
-  rvm install 1.8.6-p399
-  rvm use 1.8.6-p399
-  rvm gemset create cucumber
-  rvm use @cucumber
-  gem install bundler
-  bundle install
-  rake-compiler cross-ruby VERSION=1.8.6-p287
-
-  # 1.9.1
-  # Later 1.9.1 patch levels or 1.9.2 don't compile on mingw.
-  # The compiled binaries should still work on 1.9.2
-  rvm install 1.9.1-p243
-  rvm use 1.9.1-p243
-  rvm gemset create cucumber
-  rvm use @cucumber
-  gem install bundler
-  bundle install
-  rake-compiler cross-ruby VERSION=1.9.1-p243
-
-== Release process
+    brew install openssl
+
+    # 1.8.6
+    # Don't worry about inconsistent patchlevels here. It works.
+    rvm install 1.8.6-p399
+    rvm use 1.8.6-p399
+    rvm gemset create cucumber
+    rvm use @cucumber
+    gem install bundler
+    bundle install
+    rake-compiler cross-ruby VERSION=1.8.6-p287
+
+    # 1.9.1
+    # Later 1.9.1 patch levels or 1.9.2 don't compile on mingw.
+    # The compiled binaries should still work on 1.9.2
+    rvm install 1.9.1-p243
+    rvm use 1.9.1-p243
+    rvm gemset create cucumber
+    rvm use @cucumber
+    gem install bundler
+    bundle install
+    rake-compiler cross-ruby VERSION=1.9.1-p243
+
+## Release process
 
 * Make sure GHERKIN_JS is defined (see Javascript section above)
-* Bump version in the VERSION file and:
-** java/pom.xml
-** ikvm/Gherkin/Gherkin.csproj (2 places)
-** js/package.json
-* Commit changes.
-* rake gems:prepare && ./build_native_gems.sh && rake release:ALL
+* Bump version in:
+  * gherkin.gemspec
+  * java/pom.xml
+  * ikvm/Gherkin/Gherkin.csproj (2 places)
+  * js/package.json
+* Commit changes, otherwise you will get an error at the end when a tag is made.
+* bundle exec rake gems:prepare && ./build_native_gems.sh && bundle exec rake release:ALL
+  * The specs intermittently fail with a segfault from therubyracer. Running specs can be disabled with SKIP_JS_SPECS=true
 * Announce on Cucumber list, IRC and Twitter.
 
-== Note on Patches/Pull Requests
+## Note on Patches/Pull Requests
  
 * Fork the project.
 * Run rake ragel:rb to generate all the I18n lexers
@@ -173,9 +175,9 @@ Make sure you have openssl installed first.
   future version unintentionally.
 * Commit, do not mess with Rakefile, VERSION, or History.txt.
   (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
+  bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-== Copyright
+## Copyright
 
 Copyright (c) 2009-2010 Mike Sassak, Gregory Hnatiuk, Aslak Hellesøy. See LICENSE for details.

data/Rakefile

@@ -1,7 +1,8 @@
 # encoding: utf-8
+GHERKIN_VERSION = Gem::Specification.load(File.dirname(__FILE__) + '/gherkin.gemspec').version.version
 require 'rubygems'
-require 'bundler'
 unless ENV['RUBY_CC_VERSION']
+  require 'bundler'
   Bundler.setup
   Bundler::GemHelper.install_tasks
 end
@@ -9,8 +10,14 @@ ENV['RUBYOPT'] = nil # Necessary to prevent Bundler from *&^%$#ing up rake-compi
 
 require 'rake/clean'
 
+begin
+  # Support Rake >= 0.9.0
+  require 'rake/dsl_definition'
+  include Rake::DSL
+rescue LoadError
+end
+
 $:.unshift(File.dirname(__FILE__) + '/lib')
-require 'gherkin/version'
 
 Dir['tasks/**/*.rake'].each { |rake| load File.expand_path(rake) }
 

data/features/json_formatter.feature

@@ -180,7 +180,7 @@ Feature: JSON formatter
                 "name": "so",
                 "line": 26,
                 "multiline_arg": {
-                  "type": "py_string",
+                  "type": "doc_string",
                   "value": "innocent",
                   "line": 27
                 }

data/features/json_parser.feature

@@ -161,7 +161,7 @@ Feature: JSON lexer
                 "name": "so",
                 "line": 26,
                 "multiline_arg": {
-                  "type": "py_string",
+                  "type": "doc_string",
                   "value": "innocent",
                   "line": 27
                 }

data/gherkin.gemspec

@@ -1,16 +1,13 @@
 # -*- encoding: utf-8 -*-
-gherkin_dir = Dir.pwd =~ /gherkin\/tmp/ ? File.expand_path("../../../..", Dir.pwd) : File.expand_path("..", __FILE__)
-$LOAD_PATH.unshift File.join(gherkin_dir, 'lib')
-require "gherkin/version"
 
 Gem::Specification.new do |s|
   s.name        = "gherkin"
-  s.version     = Gherkin::VERSION
+  s.version     = "2.4.0"
   s.authors     = ["Mike Sassak", "Gregory Hnatiuk", "Aslak Hellesøy"]
   s.description = "A fast Gherkin lexer/parser for based on the Ragel State Machine Compiler."
-  s.summary     = "gherkin-#{Gherkin::VERSION}"
+  s.summary     = "#{s.name}-#{s.version}"
   s.email       = "cukes@googlegroups.com"
-  s.homepage    = "http://github.com/aslakhellesoy/gherkin"
+  s.homepage    = "http://github.com/cucumber/gherkin"
 
   s.rubygems_version   = "1.3.7"
   s.default_executable = "gherkin"
@@ -18,7 +15,6 @@ Gem::Specification.new do |s|
   s.files            = `git ls-files`.split("\n")
   s.test_files       = `git ls-files -- {spec,features}/*`.split("\n")
   s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.extra_rdoc_files = ["LICENSE", "README.rdoc", "History.txt"]
   s.rdoc_options     = ["--charset=UTF-8"]
   s.require_path     = "lib"
 
@@ -51,14 +47,20 @@ Gem::Specification.new do |s|
 
   s.add_dependency('json', '>= 1.4.6')
 
-  s.add_development_dependency('cucumber', '>= 0.10.0')
-  s.add_development_dependency('rake', '>= 0.8.7')
-  s.add_development_dependency('bundler', '>= 1.0.10')
-  s.add_development_dependency('rspec', '>= 2.5.0')
-  s.add_development_dependency('awesome_print', '>= 0.3')
-  s.add_development_dependency('therubyracer', '>= 0.8.2.pre2') if ENV['GHERKIN_JS'] && !defined?(JRUBY_VERSION)
+  s.add_development_dependency('cucumber', '>= 0.10.3')
+  s.add_development_dependency('rake', '= 0.8.7')
+  s.add_development_dependency('bundler', '>= 1.0.14')
+  s.add_development_dependency('rspec', '>= 2.6.0')
+  s.add_development_dependency('awesome_print', '>= 0.4.0')
+
+  unless ENV['RUBY_CC_VERSION'] || defined?(JRUBY_VERSION)
+    s.add_development_dependency('therubyracer', '>= 0.9.0.beta7') if ENV['GHERKIN_JS']
+    # For Documentation:
+    s.add_development_dependency('yard', '= 0.7.1')
+    s.add_development_dependency('rdiscount', '= 1.6.8')
+  end
 
   # Only needed by Cucumber. Remove when Cucumber no longer needs those.
   s.add_development_dependency('term-ansicolor', '>= 1.0.5')
-  s.add_development_dependency('builder', '>= 3.0.0')
+  s.add_development_dependency('builder', '>= 2.1.2')
 end

data/lib/gherkin/formatter/ansi_escapes.rb

@@ -3,7 +3,7 @@ module Gherkin
     # Defines aliases for ANSI coloured output. Default colours can be overridden by defining
     # a <tt>GHERKIN_COLORS</tt> variable in your shell, very much like how you can
     # tweak the familiar POSIX command <tt>ls</tt> with
-    # <a href="http://mipsisrisc.com/rambling/2008/06/27/lscolorsls_colors-now-with-linux-support/">$LSCOLORS/$LS_COLORS</a>
+    # $LSCOLORS: http://linux-sxs.org/housekeeping/lscolors.html
     #
     # The colours that you can change are:
     #

data/lib/gherkin/formatter/model.rb

@@ -119,7 +119,7 @@ module Gherkin
           case multiline_arg
           when Array
             range = range.first..multiline_arg[-1].line
-          when Model::PyString
+          when Model::DocString
             range = range.first..multiline_arg.line_range.last
           end
           range
@@ -144,8 +144,8 @@ module Gherkin
               'type' => 'table',
               'value' => hash['multiline_arg']
             }
-          elsif PyString === @multiline_arg
-            hash['multiline_arg']['type'] = 'py_string'
+          elsif DocString === @multiline_arg
+            hash['multiline_arg']['type'] = 'doc_string'
           end
           hash
         end
@@ -179,7 +179,7 @@ module Gherkin
         end
       end
 
-      class PyString < Hashable
+      class DocString < Hashable
         native_impl('gherkin')
 
         attr_reader :value, :line

data/lib/gherkin/formatter/pretty_formatter.rb

@@ -111,8 +111,8 @@ module Gherkin
         @step_printer.write_step(@io, text_format, arg_format, step.name, arguments)
         @io.puts(indented_location(location, proceed))
         case step.multiline_arg
-        when Model::PyString
-          py_string(step.multiline_arg)
+        when Model::DocString
+          doc_string(step.multiline_arg)
         when Array
           table(step.multiline_arg)
         end
@@ -180,8 +180,8 @@ module Gherkin
 
     private
 
-      def py_string(py_string)
-        @io.puts "      \"\"\"\n" + escape_triple_quotes(indent(py_string.value, '      ')) + "\n      \"\"\""
+      def doc_string(doc_string)
+        @io.puts "      \"\"\"\n" + escape_triple_quotes(indent(doc_string.value, '      ')) + "\n      \"\"\""
       end
 
       def exception(exception)

data/lib/gherkin/json_parser.rb

@@ -57,7 +57,7 @@ module Gherkin
         if(ma['type'] == 'table')
           step.multiline_arg = rows(ma['value'])
         else
-          step.multiline_arg = Formatter::Model::PyString.new(ma['value'], ma['line'])
+          step.multiline_arg = Formatter::Model::DocString.new(ma['value'], ma['line'])
         end
       end
 

data/lib/gherkin/listener/formatter_listener.rb

@@ -57,8 +57,8 @@ module Gherkin
         @table << Formatter::Model::Row.new(grab_comments!, cells, line)
       end
 
-      def py_string(string, line)
-        @py_string = Formatter::Model::PyString.new(string, line)
+      def doc_string(string, line)
+        @doc_string = Formatter::Model::DocString.new(string, line)
       end
 
       def eof
@@ -90,15 +90,15 @@ module Gherkin
         table
       end
 
-      def grab_py_string!
-        py_string = @py_string
-        @py_string = nil
-        py_string
+      def grab_doc_string!
+        doc_string = @doc_string
+        @doc_string = nil
+        doc_string
       end
 
       def replay_step_or_examples
         if(@step_statement)
-          @step_statement.multiline_arg = grab_py_string! || grab_rows!
+          @step_statement.multiline_arg = grab_doc_string! || grab_rows!
           @formatter.step(@step_statement)
           @step_statement = nil
         end

data/lib/gherkin/parser/meta.txt

@@ -1,4 +1,4 @@
- |         | feature | background | scenario | scenario_outline | examples | step  | row   | py_string | eof | comment | tag |
+ |         | feature | background | scenario | scenario_outline | examples | step  | row   | doc_string | eof | comment | tag |
  | meta    | E       | E          | E        | E                | E        | E     | E     | E         | eof | comment | tag |
  | comment | pop()   | pop()      | pop()    | pop()            | pop()    | pop() | pop() | pop()     | eof | pop()   | tag |
  | tag     | pop()   | E          | pop()    | pop()            | pop()    | E     | E     | E         | E   | E       | tag |

data/lib/gherkin/parser/root.txt

@@ -1,4 +1,4 @@
- |                  | feature | background | scenario | scenario_outline | examples | step         | row            | py_string    | eof | comment    | tag        |
+ |                  | feature | background | scenario | scenario_outline | examples | step         | row            | doc_string    | eof | comment    | tag        |
  | root             | feature | E          | E        | E                | E        | E            | E              | E            | eof | push(meta) | push(meta) |
  | feature          | E       | background | scenario | scenario_outline | E        | E            | E              | E            | eof | push(meta) | push(meta) |
  | step             | E       | E          | scenario | scenario_outline | E        | step         | step           | step         | eof | push(meta) | push(meta) |

data/lib/gherkin/parser/steps.txt

@@ -1,4 +1,4 @@
- |       | feature | background | scenario | scenario_outline | examples | step | row  | py_string | eof | comment | tag |
+ |       | feature | background | scenario | scenario_outline | examples | step | row  | doc_string | eof | comment | tag |
  | steps | E       | E          | E        | E                | E        | step | E    | E         | eof | E       | E   |
  | step  | E       | E          | E        | E                | E        | step | step | steps     | eof | E       | E   |
  | eof   | E       | E          | E        | E                | E        | E    | E    | E         | E   | E       | E   |