gherkin 1.0.30 → 2.0.0

data/.rspec

@@ -0,0 +1 @@
+--color

data/History.txt

@@ -1,3 +1,22 @@
+== 2.0.0
+
+We're breaking the old listener API in this release, and added a new JSON formatter,
+which calls for a new major version.
+
+=== New Features
+* New JSON formatter. (Aslak Hellesøy, Joseph Wilk)
+* New synonyms for Hungarian (Bence Golda)
+* Upgraded to use RSpec 2.0.0 (Aslak Hellesøy)
+
+=== Bugfixes
+* undefined method `<=>' on JRuby (#52 Aslak Hellesøy)
+* Include link to explanation of LexingError (Mike Sassak)
+
+=== Changed Features
+* The formatter API has completely changed. There is a Gherkin Listener API and a Formatter API.
+  The FormatterListener acts as an adapter between them. (Aslak Hellesøy)
+* The listener API now has an additional argument for description (text following the first line of Feature:, Scenario: etc.) (Gregroy Hnatiuk, Matt Wynne)
+
 == 1.0.30 (2010-05-18)
 
 === New Features

data/Rakefile

@@ -18,10 +18,10 @@ begin
     gem.homepage = "http://github.com/aslakhellesoy/gherkin"
     gem.authors = ["Mike Sassak", "Gregory Hnatiuk", "Aslak Hellesøy"]
     gem.executables = ["gherkin"]
-    gem.add_dependency "trollop", ">= 1.16.2"
-    gem.add_development_dependency "rspec", ">= 1.3.0"
-    gem.add_development_dependency "cucumber", ">= 0.7.2"
-    gem.add_development_dependency "rake-compiler", ">= 0.7.0" unless defined?(JRUBY_VERSION)
+    gem.add_dependency "trollop", "~> 1.16.2"
+    gem.add_development_dependency 'rspec', '~> 2.0.0.beta.11'
+    gem.add_development_dependency "cucumber", "~> 0.8.1"
+    gem.add_development_dependency "rake-compiler", "~> 0.7.0" unless defined?(JRUBY_VERSION)
 
     gem.files -= FileList['ikvm/**/*']
     gem.files -= FileList['java/**/*']

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:major: 1
+:major: 2
 :minor: 0
 :build: 
-:patch: 30
+:patch: 0

data/features/feature_parser.feature

@@ -73,6 +73,17 @@ Feature: Gherkin Feature lexer
       """
     Then there should be parse errors on lines 1 through 3
 
+  Scenario: Multiple Features in file
+    Given the following text is parsed:
+      """
+      Feature: 
+        Scenario: Hi
+      Feature: Uh ohs
+        Scenario Outline:
+      Feature: This is silly
+      """
+    Then there should be parse errors on lines 3 and 5
+
   Scenario: Tag ends background and scenario
     Given the following text is parsed:
       """

data/features/json_formatter.feature

@@ -0,0 +1,238 @@
+Feature: JSON formatter
+  In order to support greater access to features
+  we want JSON
+
+  Background:
+    Given a JSON formatter
+    And a "ruby" "root" parser
+
+  Scenario: Only a Feature
+    Given the following text is parsed:
+      """
+      # language: no
+      # Another comment
+      Egenskap: Kjapp
+      """
+    Then the outputted JSON should be:
+      """
+      {
+        "comments": ["# language: no", "# Another comment"],
+        "description": "",
+        "keyword": "Egenskap",
+        "name": "Kjapp",
+        "tags": [],
+        "uri": "test.feature"
+      }
+      """
+
+  Scenario: Feature with two scenarios
+    Given the following text is parsed:
+      """
+      @one
+      Feature: OH HAI
+
+        Scenario: Fujin
+          Given wind
+          Then spirit
+
+        @two
+        Scenario: _why
+          Given chunky
+          Then bacon
+
+        @three @four
+        Scenario Outline: Life
+          Given some <boredom>
+
+        @five
+        Examples: Real life
+          |boredom|
+          |airport|
+          |meeting|
+
+        Scenario: who stole my mojo?
+          When I was
+            |asleep|
+          And so
+            \"\"\"
+            innocent
+            \"\"\"
+
+        # The
+        Scenario Outline: with
+          # all
+          Then nice
+          
+        # comments
+        # everywhere
+        Examples: An example
+          # I mean
+          | partout |
+      """
+    Then the outputted JSON should be:
+      """
+      {
+        "comments": [],
+        "keyword": "Feature",
+        "name": "OH HAI",
+        "tags": ["@one"],
+        "uri": "test.feature",
+        "description": "",
+        "elements":[
+          {
+            "comments": [],
+            "tags": [],
+            "keyword": "Scenario",
+            "name": "Fujin",
+            "description": "",
+            "line": 4,
+            "steps": [
+              {
+                "comments": [],
+                "keyword": "Given ",
+                "name": "wind",
+                "line": 5,
+                "multiline_arg": null
+              },
+              {
+                "comments": [],
+                "keyword": "Then ",
+                "name": "spirit",
+                "line": 6,
+                "multiline_arg": null
+              }
+            ]
+          },
+          {
+            "comments": [],
+            "tags": ["@two"],
+            "keyword": "Scenario",
+            "name": "_why",
+            "description": "",
+            "line": 9,
+            "steps": [
+              {
+                "comments": [],
+                "keyword": "Given ",
+                "name": "chunky",
+                "line": 10,
+                "multiline_arg": null
+              },
+              {
+                "comments": [],
+                "keyword": "Then ",
+                "name": "bacon",
+                "line": 11,
+                "multiline_arg": null
+              }
+            ]
+          },
+          {
+            "comments": [],
+            "tags": ["@three", "@four"],
+            "keyword": "Scenario Outline",
+            "name": "Life",
+            "description": "",
+            "line": 14,
+            "steps": [
+              {
+                "comments": [],
+                "keyword": "Given ",
+                "name": "some <boredom>",
+                "line": 15,
+                "multiline_arg": null
+              }
+            ]
+          },
+          {
+            "comments": [],
+            "tags": ["@five"],
+            "keyword": "Examples",
+            "name": "Real life",
+            "description": "",
+            "line": 18,
+            "examples_table": [
+              {
+                "comments": [],
+                "cells": ["boredom"],
+                "line": 19
+              },
+              {
+                "comments": [],
+                "cells": ["airport"],
+                "line": 20
+              },
+              {
+                "comments": [],
+                "cells": ["meeting"],
+                "line": 21
+              }
+            ]
+          },
+          {
+            "comments": [],
+            "tags": [],
+            "keyword": "Scenario",
+            "name": "who stole my mojo?",
+            "description": "",
+            "line": 23,
+            "steps": [
+              {
+                "comments": [],
+                "keyword": "When ",
+                "name": "I was",
+                "line": 24,
+                "multiline_arg": [
+                  {
+                    "comments": [],
+                    "line": 25,
+                    "cells": ["asleep"]
+                  }
+                ]
+              },
+              {
+                "comments": [],
+                "keyword": "And ",
+                "name": "so",
+                "line": 26,
+                "multiline_arg": "innocent"
+              }
+            ]
+          },
+          {
+            "comments": ["# The"],
+            "tags": [],
+            "keyword": "Scenario Outline",
+            "description": "",
+            "line": 32,
+            "name": "with",
+            "steps": [
+              {
+                "comments": ["# all"],
+                "keyword": "Then ",
+                "line": 34,
+                "name": "nice",
+                "multiline_arg": null
+              }
+            ]
+          },
+          {
+            "comments": ["# comments", "# everywhere"],
+            "tags": [],
+            "keyword": "Examples",
+            "name": "An example",
+            // TODO - the description should now be the comment
+            // It should be on the first row of the examples_table!
+            "description": "# I mean",
+            "line": 38,
+            "examples_table": [
+              {
+                "comments": [],
+                "line": 40,
+                "cells": ["partout"]
+              }
+            ]
+          }
+        ]
+      }
+      """

data/features/pretty_formatter.feature

@@ -0,0 +1,9 @@
+Feature: Pretty Formatter
+  In order to have pretty gherkin
+  I want to verify that all prettified cucumber features parse OK
+
+  Scenario: Parse all the features in Cucumber
+    Given I have Cucumber's source code next to Gherkin's
+    When I find all of the .feature files
+    And I parse the prettified representation of each of them
+    Then they should all be identical to the pretty output

data/features/step_definitions/gherkin_steps.rb

@@ -4,7 +4,7 @@ Given /^a "([^\"]*)" "([^\"]*)" parser$/ do |ruby_or_native, parser_name|
 end
 
 Given "the following text is parsed:" do |text|
-  @lexer.scan(text)
+  @lexer.scan(text, "test.feature", 0)
 end
 
 Then "there should be no parse errors" do

data/features/step_definitions/json_formatter_steps.rb

@@ -0,0 +1,32 @@
+require 'stringio'
+require 'gherkin/formatter/json_formatter'
+require 'gherkin/parser/formatter_listener'
+
+# Monkey patching so that Hash.to_json has a predictable result.
+class Hash
+  alias orig_keys keys
+  def keys
+    orig_keys.sort
+  end
+end
+
+Given /^a JSON formatter$/ do
+  @io = StringIO.new
+  @listener = Gherkin::Parser::FormatterListener.new(Gherkin::Formatter::JSONFormatter.new(@io))
+end
+
+Then /^the outputted JSON should be:$/ do |expected_json|
+  require 'json'
+  expected = JSON.pretty_generate(JSON.parse(expected_json))
+  actual   = JSON.pretty_generate(JSON.parse(@io.string))
+  begin
+    actual.should == expected
+  rescue # Haven't figured out how to order Hash on JRuby (JSON pure). Retry with possibly worse error message.
+    expected = JSON.parse(expected_json)
+    actual   = JSON.parse(@io.string)
+    actual.should == expected
+  end
+end
+
+
+

data/features/step_definitions/pretty_formatter_steps.rb

@@ -4,52 +4,53 @@ require 'gherkin/formatter/pretty_formatter'
 
 module PrettyPlease
   def pretty(source)
-    io       = StringIO.new
-    listener = Gherkin::Formatter::PrettyFormatter.new(io)
-    parser   = Gherkin::Parser::Parser.new(listener, true)
-    lexer    = Gherkin::I18nLexer.new(parser)
-    lexer.scan(source)
-    io.rewind
-    io.read
+    io        = StringIO.new
+    formatter = Gherkin::Formatter::PrettyFormatter.new(io, false)
+    listener  = Gherkin::Parser::FormatterListener.new(formatter)
+    parser    = Gherkin::Parser::Parser.new(listener, true)
+    lexer     = Gherkin::I18nLexer.new(parser)
+    lexer.scan(source, "test.feature", 0)
+    io.string
   end
 end
 
 World(PrettyPlease)
 
-Given /^I have Cucumber's home dir defined in CUCUMBER_HOME$/ do
-  @cucumber_home = ENV['CUCUMBER_HOME']
-  raise "No CUCUMBER_HOME" if @cucumber_home.nil?
+Given /^I have Cucumber's source code next to Gherkin's$/ do
+  @cucumber_home = File.dirname(__FILE__) + '/../../../cucumber'
+  raise "No Cucumber source in #{@cucumber_home}" unless File.file?(@cucumber_home + '/bin/cucumber')
 end
 
 When /^I find all of the \.feature files$/ do
-  @features = Dir["#{@cucumber_home}/**/*.feature"].sort
+  @feature_paths = Dir["#{@cucumber_home}/**/*.feature"].sort
 end
 
 When /^I parse the prettified representation of each of them$/ do
-  @errors = [['Path', 'Error']]
-  @features.each do |feature|
+  @error = false
+  @feature_paths.each do |feature_path|
     pretty1 = nil
     pretty2 = nil
     begin
-      pretty1 = pretty(IO.read(feature))
+      pretty1 = pretty(IO.read(feature_path))
       pretty2 = pretty(pretty1)
       pretty2.should == pretty1
-    rescue Spec::Expectations::ExpectationNotMetError => e
-      File.open("p1.feature", "wb") {|io| io.write(pretty1)}
-      File.open("p2.feature", "wb") {|io| io.write(pretty2)}
-      announce "========== #{feature}:"
+    rescue RSpec::Expectations::ExpectationNotMetError => e
+      announce "=========="
+      announce feature_path
       if(e.message =~ /(@@.*)/m)
         announce $1
+        @error = true
+        File.open("p1.feature", "wb") {|io| io.write(pretty1)}
+        File.open("p2.feature", "wb") {|io| io.write(pretty2)}
       else
-        announce "??? NO DIFF ???"
+        announce "Identical, except for newlines"
       end
-      @errors << [feature, "See announced diff"]
     rescue => e
-      @errors << [feature, e.message]
+      e.message << "\nFatal error happened when parsing #{feature_path}"
     end
   end
 end
 
-Then /^the following files should have errors:$/ do |table|
-  table.diff!(@errors)
+Then /^they should all be identical to the pretty output$/ do
+  raise "Some features didn't do pretty well" if @error
 end

data/features/support/env.rb

@@ -1,10 +1,10 @@
 # I'm sure there's a better way than this...
-%w{/../../lib /../../spec/gherkin}.each do |path|
+%w{ /../../spec /../../lib}.each do |path|
   $LOAD_PATH << File.expand_path(File.dirname(__FILE__) + path)
 end
-
 require 'gherkin'
-require "sexp_recorder"
+require "gherkin/sexp_recorder"
+require 'gherkin/output_stream_string_io'
 
 module TransformHelpers
   def tr_line_number(step_arg)