gherkin 4.0.0 → 4.1.0

data/lib/gherkin/stream/gherkin_events.rb

@@ -0,0 +1,69 @@
+require 'gherkin/parser'
+require 'gherkin/pickles/compiler'
+
+module Gherkin
+  module Stream
+    class GherkinEvents
+      def initialize(options)
+        @options = options
+        @parser = Gherkin::Parser.new
+        @compiler = Gherkin::Pickles::Compiler.new
+      end
+
+      def enum(source_event)
+        Enumerator.new do |y|
+          uri = source_event['uri']
+          source = source_event['data']
+          begin
+            gherkin_document = @parser.parse(source)
+
+            if (@options[:print_source])
+              y.yield source_event
+            end
+            if (@options[:print_ast])
+              y.yield({
+                type: 'gherkin-document',
+                uri: uri,
+                document: gherkin_document
+              })
+            end
+            if (@options[:print_pickles])
+              pickles = @compiler.compile(gherkin_document)
+              pickles.each do |pickle|
+                y.yield({
+                  type: 'pickle',
+                  uri: uri,
+                  pickle: pickle
+                })
+              end
+            end
+          rescue Gherkin::CompositeParserException => e
+            yield_errors(y, e.errors, uri)
+          rescue Gherkin::ParserError => e
+            yield_errors(y, [e], uri)
+          end
+        end
+      end
+
+      def yield_errors(y, errors, uri)
+        errors.each do |error|
+          y.yield({
+            type: 'attachment',
+            source: {
+              uri: uri,
+              start: {
+                line: error.location[:line],
+                column: error.location[:column]
+              }
+            },
+            data: error.message,
+            media: {
+              encoding: 'utf-8',
+              type: 'text/vnd.cucumber.stacktrace+plain'
+            }
+          })
+        end
+      end
+    end
+  end
+end

data/lib/gherkin/stream/source_events.rb

@@ -0,0 +1,26 @@
+module Gherkin
+  module Stream
+    class SourceEvents
+      def initialize(paths)
+        @paths = paths
+      end
+
+      def enum
+        Enumerator.new do |y|
+          @paths.each do |path|
+            event = {
+              'type' => 'source',
+              'uri' => path,
+              'data' => File.open(path, 'r:UTF-8', &:read),
+              'media' => {
+                'encoding' => 'utf-8',
+                'type' => 'text/vnd.cucumber.gherkin+plain'
+              }
+            }
+            y.yield(event)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gherkin/token_scanner.rb

@@ -25,7 +25,7 @@ module Gherkin
     end
 
     def read
-      location = {line: @line_number += 1}
+      location = {line: @line_number += 1, column: 0}
       if @io.nil? || line = @io.gets
         gherkin_line = line ? GherkinLine.new(line, location[:line]) : nil
         Token.new(gherkin_line, location)

data/testdata/bad/inconsistent_cell_count.feature

@@ -0,0 +1,14 @@
+Feature: Inconsistent cell counts
+
+  Scenario: minimalistic
+    Given a data table with inconsistent cell count
+      | foo | bar |
+      | boz | 
+
+
+  Scenario Outline: minimalistic
+    Given the <what>
+
+  Examples: 
+    | what       |
+    | minimalism | extra |

data/testdata/bad/inconsistent_cell_count.feature.errors.ndjson

@@ -0,0 +1,2 @@
+{"data":"(6:7): inconsistent cell count within the table","media":{"encoding":"utf-8","type":"text/vnd.cucumber.stacktrace+plain"},"source":{"start":{"column":7,"line":6},"uri":"testdata/bad/inconsistent_cell_count.feature"},"type":"attachment"}
+{"data":"(14:5): inconsistent cell count within the table","media":{"encoding":"utf-8","type":"text/vnd.cucumber.stacktrace+plain"},"source":{"start":{"column":5,"line":14},"uri":"testdata/bad/inconsistent_cell_count.feature"},"type":"attachment"}

data/testdata/bad/invalid_language.feature

@@ -0,0 +1,6 @@
+#language:no-such
+
+Feature: Minimal
+
+  Scenario: minimalistic
+    Given the minimalism

data/testdata/bad/invalid_language.feature.errors.ndjson

@@ -0,0 +1 @@
+{"data":"(1:1): Language not supported: no-such","media":{"encoding":"utf-8","type":"text/vnd.cucumber.stacktrace+plain"},"source":{"start":{"column":1,"line":1},"uri":"testdata/bad/invalid_language.feature"},"type":"attachment"}

data/testdata/bad/multiple_parser_errors.feature

@@ -0,0 +1,9 @@
+
+invalid line here
+
+Feature: Multiple parser errors
+
+  Scenario: minimalistic
+    Given the minimalism
+
+another invalid line here

data/testdata/bad/multiple_parser_errors.feature.errors.ndjson

@@ -0,0 +1,2 @@
+{"data":"(2:1): expected: #EOF, #Language, #TagLine, #FeatureLine, #Comment, #Empty, got 'invalid line here'","media":{"encoding":"utf-8","type":"text/vnd.cucumber.stacktrace+plain"},"source":{"start":{"column":1,"line":2},"uri":"testdata/bad/multiple_parser_errors.feature"},"type":"attachment"}
+{"data":"(9:1): expected: #EOF, #TableRow, #DocStringSeparator, #StepLine, #TagLine, #ScenarioLine, #ScenarioOutlineLine, #Comment, #Empty, got 'another invalid line here'","media":{"encoding":"utf-8","type":"text/vnd.cucumber.stacktrace+plain"},"source":{"start":{"column":1,"line":9},"uri":"testdata/bad/multiple_parser_errors.feature"},"type":"attachment"}

data/testdata/bad/not_gherkin.feature

@@ -0,0 +1,2 @@
+not gherkin
+

data/testdata/bad/not_gherkin.feature.errors.ndjson

@@ -0,0 +1 @@
+{"data":"(1:1): expected: #EOF, #Language, #TagLine, #FeatureLine, #Comment, #Empty, got 'not gherkin'","media":{"encoding":"utf-8","type":"text/vnd.cucumber.stacktrace+plain"},"source":{"start":{"column":1,"line":1},"uri":"testdata/bad/not_gherkin.feature"},"type":"attachment"}

data/testdata/bad/single_parser_error.feature

@@ -0,0 +1,7 @@
+
+invalid line here
+
+Feature: Single parser error
+
+  Scenario: minimalistic
+    Given the minimalism

data/testdata/bad/single_parser_error.feature.errors.ndjson

@@ -0,0 +1 @@
+{"data":"(2:1): expected: #EOF, #Language, #TagLine, #FeatureLine, #Comment, #Empty, got 'invalid line here'","media":{"encoding":"utf-8","type":"text/vnd.cucumber.stacktrace+plain"},"source":{"start":{"column":1,"line":2},"uri":"testdata/bad/single_parser_error.feature"},"type":"attachment"}

data/testdata/bad/unexpected_eof.feature

@@ -0,0 +1,6 @@
+Feature: Unexpected end of file
+
+  Scenario Outline: minimalistic
+    Given the minimalism
+
+    @tag

data/testdata/bad/unexpected_eof.feature.errors.ndjson

@@ -0,0 +1 @@
+{"data":"(7:0): unexpected end of file, expected: #TagLine, #ScenarioLine, #ScenarioOutlineLine, #Comment, #Empty","media":{"encoding":"utf-8","type":"text/vnd.cucumber.stacktrace+plain"},"source":{"start":{"column":0,"line":7},"uri":"testdata/bad/unexpected_eof.feature"},"type":"attachment"}

data/testdata/good/background.feature

@@ -0,0 +1,8 @@
+Feature: Background
+
+  Background: a simple background
+    Given the minimalism inside a background
+
+
+  Scenario: minimalistic
+    Given the minimalism

data/testdata/good/background.feature.ast.ndjson

@@ -0,0 +1 @@
+{"document":{"comments":[],"feature":{"children":[{"keyword":"Background","location":{"column":3,"line":3},"name":"a simple background","steps":[{"keyword":"Given ","location":{"column":5,"line":4},"text":"the minimalism inside a background","type":"Step"}],"type":"Background"},{"keyword":"Scenario","location":{"column":3,"line":7},"name":"minimalistic","steps":[{"keyword":"Given ","location":{"column":5,"line":8},"text":"the minimalism","type":"Step"}],"tags":[],"type":"Scenario"}],"keyword":"Feature","language":"en","location":{"column":1,"line":1},"name":"Background","tags":[],"type":"Feature"},"type":"GherkinDocument"},"type":"gherkin-document","uri":"testdata/good/background.feature"}

data/testdata/good/background.feature.pickles.ndjson

@@ -0,0 +1 @@
+{"pickle":{"language":"en","locations":[{"column":3,"line":7}],"name":"minimalistic","steps":[{"arguments":[],"locations":[{"column":11,"line":4}],"text":"the minimalism inside a background"},{"arguments":[],"locations":[{"column":11,"line":8}],"text":"the minimalism"}],"tags":[]},"type":"pickle","uri":"testdata/good/background.feature"}

data/testdata/good/background.feature.source.ndjson

@@ -0,0 +1 @@
+{"data":"Feature: Background\n\n  Background: a simple background\n    Given the minimalism inside a background\n\n\n  Scenario: minimalistic\n    Given the minimalism\n","media":{"encoding":"utf-8","type":"text/vnd.cucumber.gherkin+plain"},"type":"source","uri":"testdata/good/background.feature"}

data/testdata/good/background.feature.tokens

@@ -0,0 +1,9 @@
+(1:1)FeatureLine:Feature/Background/
+(2:1)Empty://
+(3:3)BackgroundLine:Background/a simple background/
+(4:5)StepLine:Given /the minimalism inside a background/
+(5:1)Empty://
+(6:1)Empty://
+(7:3)ScenarioLine:Scenario/minimalistic/
+(8:5)StepLine:Given /the minimalism/
+EOF

data/testdata/good/datatables.feature

@@ -0,0 +1,18 @@
+Feature: DataTables
+
+  Scenario: minimalistic
+    Given a simple data table
+      | foo | bar |
+      | boz | boo |
+    And a data table with a single cell
+      | foo |
+    And a data table with different fromatting
+      |   foo|bar|    boz    |    
+    And a data table with an empty cell
+      |foo||boz|
+    And a data table with comments and newlines inside
+      | foo | bar |
+
+      | boz  | boo  |
+      # this is a comment
+      | boz2 | boo2 |

data/testdata/good/datatables.feature.ast.ndjson

@@ -0,0 +1 @@
+{"document":{"comments":[{"location":{"column":1,"line":17},"text":"      # this is a comment","type":"Comment"}],"feature":{"children":[{"keyword":"Scenario","location":{"column":3,"line":3},"name":"minimalistic","steps":[{"argument":{"location":{"column":7,"line":5},"rows":[{"cells":[{"location":{"column":9,"line":5},"type":"TableCell","value":"foo"},{"location":{"column":15,"line":5},"type":"TableCell","value":"bar"}],"location":{"column":7,"line":5},"type":"TableRow"},{"cells":[{"location":{"column":9,"line":6},"type":"TableCell","value":"boz"},{"location":{"column":15,"line":6},"type":"TableCell","value":"boo"}],"location":{"column":7,"line":6},"type":"TableRow"}],"type":"DataTable"},"keyword":"Given ","location":{"column":5,"line":4},"text":"a simple data table","type":"Step"},{"argument":{"location":{"column":7,"line":8},"rows":[{"cells":[{"location":{"column":9,"line":8},"type":"TableCell","value":"foo"}],"location":{"column":7,"line":8},"type":"TableRow"}],"type":"DataTable"},"keyword":"And ","location":{"column":5,"line":7},"text":"a data table with a single cell","type":"Step"},{"argument":{"location":{"column":7,"line":10},"rows":[{"cells":[{"location":{"column":11,"line":10},"type":"TableCell","value":"foo"},{"location":{"column":15,"line":10},"type":"TableCell","value":"bar"},{"location":{"column":23,"line":10},"type":"TableCell","value":"boz"}],"location":{"column":7,"line":10},"type":"TableRow"}],"type":"DataTable"},"keyword":"And ","location":{"column":5,"line":9},"text":"a data table with different fromatting","type":"Step"},{"argument":{"location":{"column":7,"line":12},"rows":[{"cells":[{"location":{"column":8,"line":12},"type":"TableCell","value":"foo"},{"location":{"column":12,"line":12},"type":"TableCell","value":""},{"location":{"column":13,"line":12},"type":"TableCell","value":"boz"}],"location":{"column":7,"line":12},"type":"TableRow"}],"type":"DataTable"},"keyword":"And ","location":{"column":5,"line":11},"text":"a data table with an empty cell","type":"Step"},{"argument":{"location":{"column":7,"line":14},"rows":[{"cells":[{"location":{"column":9,"line":14},"type":"TableCell","value":"foo"},{"location":{"column":15,"line":14},"type":"TableCell","value":"bar"}],"location":{"column":7,"line":14},"type":"TableRow"},{"cells":[{"location":{"column":9,"line":16},"type":"TableCell","value":"boz"},{"location":{"column":16,"line":16},"type":"TableCell","value":"boo"}],"location":{"column":7,"line":16},"type":"TableRow"},{"cells":[{"location":{"column":9,"line":18},"type":"TableCell","value":"boz2"},{"location":{"column":16,"line":18},"type":"TableCell","value":"boo2"}],"location":{"column":7,"line":18},"type":"TableRow"}],"type":"DataTable"},"keyword":"And ","location":{"column":5,"line":13},"text":"a data table with comments and newlines inside","type":"Step"}],"tags":[],"type":"Scenario"}],"keyword":"Feature","language":"en","location":{"column":1,"line":1},"name":"DataTables","tags":[],"type":"Feature"},"type":"GherkinDocument"},"type":"gherkin-document","uri":"testdata/good/datatables.feature"}

data/testdata/good/datatables.feature.pickles.ndjson

@@ -0,0 +1 @@
+{"pickle":{"language":"en","locations":[{"column":3,"line":3}],"name":"minimalistic","steps":[{"arguments":[{"rows":[{"cells":[{"location":{"column":9,"line":5},"value":"foo"},{"location":{"column":15,"line":5},"value":"bar"}]},{"cells":[{"location":{"column":9,"line":6},"value":"boz"},{"location":{"column":15,"line":6},"value":"boo"}]}]}],"locations":[{"column":11,"line":4}],"text":"a simple data table"},{"arguments":[{"rows":[{"cells":[{"location":{"column":9,"line":8},"value":"foo"}]}]}],"locations":[{"column":9,"line":7}],"text":"a data table with a single cell"},{"arguments":[{"rows":[{"cells":[{"location":{"column":11,"line":10},"value":"foo"},{"location":{"column":15,"line":10},"value":"bar"},{"location":{"column":23,"line":10},"value":"boz"}]}]}],"locations":[{"column":9,"line":9}],"text":"a data table with different fromatting"},{"arguments":[{"rows":[{"cells":[{"location":{"column":8,"line":12},"value":"foo"},{"location":{"column":12,"line":12},"value":""},{"location":{"column":13,"line":12},"value":"boz"}]}]}],"locations":[{"column":9,"line":11}],"text":"a data table with an empty cell"},{"arguments":[{"rows":[{"cells":[{"location":{"column":9,"line":14},"value":"foo"},{"location":{"column":15,"line":14},"value":"bar"}]},{"cells":[{"location":{"column":9,"line":16},"value":"boz"},{"location":{"column":16,"line":16},"value":"boo"}]},{"cells":[{"location":{"column":9,"line":18},"value":"boz2"},{"location":{"column":16,"line":18},"value":"boo2"}]}]}],"locations":[{"column":9,"line":13}],"text":"a data table with comments and newlines inside"}],"tags":[]},"type":"pickle","uri":"testdata/good/datatables.feature"}

data/testdata/good/datatables.feature.source.ndjson

@@ -0,0 +1 @@
+{"data":"Feature: DataTables\n\n  Scenario: minimalistic\n    Given a simple data table\n      | foo | bar |\r\n      | boz | boo |\n    And a data table with a single cell\n      | foo |\n    And a data table with different fromatting\n      |   foo|bar|    boz    |    \n    And a data table with an empty cell\n      |foo||boz|\n    And a data table with comments and newlines inside\n      | foo | bar |\r\n\r\n      | boz  | boo  |\r\n      # this is a comment\r\n      | boz2 | boo2 |\n","media":{"encoding":"utf-8","type":"text/vnd.cucumber.gherkin+plain"},"type":"source","uri":"testdata/good/datatables.feature"}

data/testdata/good/datatables.feature.tokens

@@ -0,0 +1,19 @@
+(1:1)FeatureLine:Feature/DataTables/
+(2:1)Empty://
+(3:3)ScenarioLine:Scenario/minimalistic/
+(4:5)StepLine:Given /a simple data table/
+(5:7)TableRow://9:foo,15:bar
+(6:7)TableRow://9:boz,15:boo
+(7:5)StepLine:And /a data table with a single cell/
+(8:7)TableRow://9:foo
+(9:5)StepLine:And /a data table with different fromatting/
+(10:7)TableRow://11:foo,15:bar,23:boz
+(11:5)StepLine:And /a data table with an empty cell/
+(12:7)TableRow://8:foo,12:,13:boz
+(13:5)StepLine:And /a data table with comments and newlines inside/
+(14:7)TableRow://9:foo,15:bar
+(15:1)Empty://
+(16:7)TableRow://9:boz,16:boo
+(17:1)Comment:/      # this is a comment/
+(18:7)TableRow://9:boz2,16:boo2
+EOF

data/testdata/good/descriptions.feature

@@ -0,0 +1,52 @@
+Feature: Descriptions everywhere
+  This is a single line description
+
+  Scenario: two lines
+  This description
+  has two lines and indented with two spaces
+    Given the minimalism
+
+Scenario: without indentation
+This is a description without indentation
+  Given the minimalism
+
+  Scenario: empty lines in the middle
+  This description
+
+  has an empty line in the middle
+    Given the minimalism
+
+  Scenario: empty lines around
+
+  This description
+  has an empty lines around
+
+    Given the minimalism
+
+  Scenario: comment after description
+  This description
+  has a comment after
+
+# this is a comment
+    Given the minimalism
+
+  Scenario: comment right after description
+  This description
+  has a comment right after
+    #  this is another comment
+
+    Given the minimalism
+
+  Scenario: description with escaped docstring separator
+  This description has an \"\"\" (escaped docstring sparator)
+
+    Given the minimalism
+
+  Scenario Outline: scenario outline with a description
+This is a scenario outline description
+    Given the minimalism
+
+  Examples: examples with description
+This is an examples description
+    | foo |
+    | bar |

data/testdata/good/descriptions.feature.ast.ndjson

@@ -0,0 +1 @@
+{"document":{"comments":[{"location":{"column":1,"line":30},"text":"# this is a comment","type":"Comment"},{"location":{"column":1,"line":36},"text":"    #  this is another comment","type":"Comment"}],"feature":{"children":[{"description":"  This description\n  has two lines and indented with two spaces","keyword":"Scenario","location":{"column":3,"line":4},"name":"two lines","steps":[{"keyword":"Given ","location":{"column":5,"line":7},"text":"the minimalism","type":"Step"}],"tags":[],"type":"Scenario"},{"description":"This is a description without indentation","keyword":"Scenario","location":{"column":1,"line":9},"name":"without indentation","steps":[{"keyword":"Given ","location":{"column":3,"line":11},"text":"the minimalism","type":"Step"}],"tags":[],"type":"Scenario"},{"description":"  This description\n\n  has an empty line in the middle","keyword":"Scenario","location":{"column":3,"line":13},"name":"empty lines in the middle","steps":[{"keyword":"Given ","location":{"column":5,"line":17},"text":"the minimalism","type":"Step"}],"tags":[],"type":"Scenario"},{"description":"  This description\n  has an empty lines around","keyword":"Scenario","location":{"column":3,"line":19},"name":"empty lines around","steps":[{"keyword":"Given ","location":{"column":5,"line":24},"text":"the minimalism","type":"Step"}],"tags":[],"type":"Scenario"},{"description":"  This description\n  has a comment after","keyword":"Scenario","location":{"column":3,"line":26},"name":"comment after description","steps":[{"keyword":"Given ","location":{"column":5,"line":31},"text":"the minimalism","type":"Step"}],"tags":[],"type":"Scenario"},{"description":"  This description\n  has a comment right after","keyword":"Scenario","location":{"column":3,"line":33},"name":"comment right after description","steps":[{"keyword":"Given ","location":{"column":5,"line":38},"text":"the minimalism","type":"Step"}],"tags":[],"type":"Scenario"},{"description":"  This description has an \\\"\\\"\\\" (escaped docstring sparator)","keyword":"Scenario","location":{"column":3,"line":40},"name":"description with escaped docstring separator","steps":[{"keyword":"Given ","location":{"column":5,"line":43},"text":"the minimalism","type":"Step"}],"tags":[],"type":"Scenario"},{"description":"This is a scenario outline description","examples":[{"description":"This is an examples description","keyword":"Examples","location":{"column":3,"line":49},"name":"examples with description","tableBody":[{"cells":[{"location":{"column":7,"line":52},"type":"TableCell","value":"bar"}],"location":{"column":5,"line":52},"type":"TableRow"}],"tableHeader":{"cells":[{"location":{"column":7,"line":51},"type":"TableCell","value":"foo"}],"location":{"column":5,"line":51},"type":"TableRow"},"tags":[],"type":"Examples"}],"keyword":"Scenario Outline","location":{"column":3,"line":45},"name":"scenario outline with a description","steps":[{"keyword":"Given ","location":{"column":5,"line":47},"text":"the minimalism","type":"Step"}],"tags":[],"type":"ScenarioOutline"}],"description":"  This is a single line description","keyword":"Feature","language":"en","location":{"column":1,"line":1},"name":"Descriptions everywhere","tags":[],"type":"Feature"},"type":"GherkinDocument"},"type":"gherkin-document","uri":"testdata/good/descriptions.feature"}

data/testdata/good/descriptions.feature.pickles.ndjson

@@ -0,0 +1,8 @@
+{"pickle":{"language":"en","locations":[{"column":3,"line":4}],"name":"two lines","steps":[{"arguments":[],"locations":[{"column":11,"line":7}],"text":"the minimalism"}],"tags":[]},"type":"pickle","uri":"testdata/good/descriptions.feature"}
+{"pickle":{"language":"en","locations":[{"column":1,"line":9}],"name":"without indentation","steps":[{"arguments":[],"locations":[{"column":9,"line":11}],"text":"the minimalism"}],"tags":[]},"type":"pickle","uri":"testdata/good/descriptions.feature"}
+{"pickle":{"language":"en","locations":[{"column":3,"line":13}],"name":"empty lines in the middle","steps":[{"arguments":[],"locations":[{"column":11,"line":17}],"text":"the minimalism"}],"tags":[]},"type":"pickle","uri":"testdata/good/descriptions.feature"}
+{"pickle":{"language":"en","locations":[{"column":3,"line":19}],"name":"empty lines around","steps":[{"arguments":[],"locations":[{"column":11,"line":24}],"text":"the minimalism"}],"tags":[]},"type":"pickle","uri":"testdata/good/descriptions.feature"}
+{"pickle":{"language":"en","locations":[{"column":3,"line":26}],"name":"comment after description","steps":[{"arguments":[],"locations":[{"column":11,"line":31}],"text":"the minimalism"}],"tags":[]},"type":"pickle","uri":"testdata/good/descriptions.feature"}
+{"pickle":{"language":"en","locations":[{"column":3,"line":33}],"name":"comment right after description","steps":[{"arguments":[],"locations":[{"column":11,"line":38}],"text":"the minimalism"}],"tags":[]},"type":"pickle","uri":"testdata/good/descriptions.feature"}
+{"pickle":{"language":"en","locations":[{"column":3,"line":40}],"name":"description with escaped docstring separator","steps":[{"arguments":[],"locations":[{"column":11,"line":43}],"text":"the minimalism"}],"tags":[]},"type":"pickle","uri":"testdata/good/descriptions.feature"}
+{"pickle":{"language":"en","locations":[{"column":5,"line":52},{"column":3,"line":45}],"name":"scenario outline with a description","steps":[{"arguments":[],"locations":[{"column":5,"line":52},{"column":11,"line":47}],"text":"the minimalism"}],"tags":[]},"type":"pickle","uri":"testdata/good/descriptions.feature"}

data/testdata/good/descriptions.feature.source.ndjson

@@ -0,0 +1 @@
+{"data":"Feature: Descriptions everywhere\n  This is a single line description\n\n  Scenario: two lines\n  This description\n  has two lines and indented with two spaces\n    Given the minimalism\n\nScenario: without indentation\nThis is a description without indentation\n  Given the minimalism\n\n  Scenario: empty lines in the middle\n  This description\n\n  has an empty line in the middle\n    Given the minimalism\n\n  Scenario: empty lines around\n\n  This description\n  has an empty lines around\n\n    Given the minimalism\n\n  Scenario: comment after description\n  This description\n  has a comment after\n\n# this is a comment\n    Given the minimalism\n\n  Scenario: comment right after description\n  This description\n  has a comment right after\n    #  this is another comment\n\n    Given the minimalism\n\n  Scenario: description with escaped docstring separator\n  This description has an \\\"\\\"\\\" (escaped docstring sparator)\n\n    Given the minimalism\n\n  Scenario Outline: scenario outline with a description\nThis is a scenario outline description\n    Given the minimalism\n\n  Examples: examples with description\nThis is an examples description\n    | foo |\r\n    | bar |\r\n","media":{"encoding":"utf-8","type":"text/vnd.cucumber.gherkin+plain"},"type":"source","uri":"testdata/good/descriptions.feature"}

data/testdata/good/descriptions.feature.tokens

@@ -0,0 +1,53 @@
+(1:1)FeatureLine:Feature/Descriptions everywhere/
+(2:1)Other:/  This is a single line description/
+(3:1)Other://
+(4:3)ScenarioLine:Scenario/two lines/
+(5:1)Other:/  This description/
+(6:1)Other:/  has two lines and indented with two spaces/
+(7:5)StepLine:Given /the minimalism/
+(8:1)Empty://
+(9:1)ScenarioLine:Scenario/without indentation/
+(10:1)Other:/This is a description without indentation/
+(11:3)StepLine:Given /the minimalism/
+(12:1)Empty://
+(13:3)ScenarioLine:Scenario/empty lines in the middle/
+(14:1)Other:/  This description/
+(15:1)Other://
+(16:1)Other:/  has an empty line in the middle/
+(17:5)StepLine:Given /the minimalism/
+(18:1)Empty://
+(19:3)ScenarioLine:Scenario/empty lines around/
+(20:1)Empty://
+(21:1)Other:/  This description/
+(22:1)Other:/  has an empty lines around/
+(23:1)Other://
+(24:5)StepLine:Given /the minimalism/
+(25:1)Empty://
+(26:3)ScenarioLine:Scenario/comment after description/
+(27:1)Other:/  This description/
+(28:1)Other:/  has a comment after/
+(29:1)Other://
+(30:1)Comment:/# this is a comment/
+(31:5)StepLine:Given /the minimalism/
+(32:1)Empty://
+(33:3)ScenarioLine:Scenario/comment right after description/
+(34:1)Other:/  This description/
+(35:1)Other:/  has a comment right after/
+(36:1)Comment:/    #  this is another comment/
+(37:1)Empty://
+(38:5)StepLine:Given /the minimalism/
+(39:1)Empty://
+(40:3)ScenarioLine:Scenario/description with escaped docstring separator/
+(41:1)Other:/  This description has an \"\"\" (escaped docstring sparator)/
+(42:1)Other://
+(43:5)StepLine:Given /the minimalism/
+(44:1)Empty://
+(45:3)ScenarioOutlineLine:Scenario Outline/scenario outline with a description/
+(46:1)Other:/This is a scenario outline description/
+(47:5)StepLine:Given /the minimalism/
+(48:1)Empty://
+(49:3)ExamplesLine:Examples/examples with description/
+(50:1)Other:/This is an examples description/
+(51:5)TableRow://7:foo
+(52:5)TableRow://7:bar
+EOF

data/testdata/good/docstrings.feature

@@ -0,0 +1,43 @@
+Feature: DocString variations
+
+  Scenario: minimalistic
+    Given a simple DocString
+      """
+      first line (no indent)
+        second line (indented with two spaces)
+
+      third line was empty
+      """
+    Given a DocString with content type
+      """xml
+      <foo>
+        <bar />
+      </foo>
+      """
+    And a DocString with wrong indentation
+      """
+    wrongly indented line
+      """
+    And a DocString with alternative separator
+      ```
+      first line
+      second line
+      ```
+    And a DocString with normal separator inside
+      ```
+      first line
+      """
+      third line
+      ```
+    And a DocString with alternative separator inside
+      """
+      first line
+      ```
+      third line
+      """
+    And a DocString with escaped separator inside
+      """
+      first line
+      \"\"\"
+      third line
+      """

data/testdata/good/docstrings.feature.ast.ndjson

@@ -0,0 +1 @@
+{"document":{"comments":[],"feature":{"children":[{"keyword":"Scenario","location":{"column":3,"line":3},"name":"minimalistic","steps":[{"argument":{"content":"first line (no indent)\n  second line (indented with two spaces)\n\nthird line was empty","location":{"column":7,"line":5},"type":"DocString"},"keyword":"Given ","location":{"column":5,"line":4},"text":"a simple DocString","type":"Step"},{"argument":{"content":"<foo>\n  <bar />\n</foo>","contentType":"xml","location":{"column":7,"line":12},"type":"DocString"},"keyword":"Given ","location":{"column":5,"line":11},"text":"a DocString with content type","type":"Step"},{"argument":{"content":"wrongly indented line","location":{"column":7,"line":18},"type":"DocString"},"keyword":"And ","location":{"column":5,"line":17},"text":"a DocString with wrong indentation","type":"Step"},{"argument":{"content":"first line\nsecond line","location":{"column":7,"line":22},"type":"DocString"},"keyword":"And ","location":{"column":5,"line":21},"text":"a DocString with alternative separator","type":"Step"},{"argument":{"content":"first line\n\"\"\"\nthird line","location":{"column":7,"line":27},"type":"DocString"},"keyword":"And ","location":{"column":5,"line":26},"text":"a DocString with normal separator inside","type":"Step"},{"argument":{"content":"first line\n```\nthird line","location":{"column":7,"line":33},"type":"DocString"},"keyword":"And ","location":{"column":5,"line":32},"text":"a DocString with alternative separator inside","type":"Step"},{"argument":{"content":"first line\n\"\"\"\nthird line","location":{"column":7,"line":39},"type":"DocString"},"keyword":"And ","location":{"column":5,"line":38},"text":"a DocString with escaped separator inside","type":"Step"}],"tags":[],"type":"Scenario"}],"keyword":"Feature","language":"en","location":{"column":1,"line":1},"name":"DocString variations","tags":[],"type":"Feature"},"type":"GherkinDocument"},"type":"gherkin-document","uri":"testdata/good/docstrings.feature"}

data/testdata/good/docstrings.feature.pickles.ndjson

@@ -0,0 +1 @@
+{"pickle":{"language":"en","locations":[{"column":3,"line":3}],"name":"minimalistic","steps":[{"arguments":[{"content":"first line (no indent)\n  second line (indented with two spaces)\n\nthird line was empty","location":{"column":7,"line":5}}],"locations":[{"column":11,"line":4}],"text":"a simple DocString"},{"arguments":[{"content":"<foo>\n  <bar />\n</foo>","location":{"column":7,"line":12}}],"locations":[{"column":11,"line":11}],"text":"a DocString with content type"},{"arguments":[{"content":"wrongly indented line","location":{"column":7,"line":18}}],"locations":[{"column":9,"line":17}],"text":"a DocString with wrong indentation"},{"arguments":[{"content":"first line\nsecond line","location":{"column":7,"line":22}}],"locations":[{"column":9,"line":21}],"text":"a DocString with alternative separator"},{"arguments":[{"content":"first line\n\"\"\"\nthird line","location":{"column":7,"line":27}}],"locations":[{"column":9,"line":26}],"text":"a DocString with normal separator inside"},{"arguments":[{"content":"first line\n```\nthird line","location":{"column":7,"line":33}}],"locations":[{"column":9,"line":32}],"text":"a DocString with alternative separator inside"},{"arguments":[{"content":"first line\n\"\"\"\nthird line","location":{"column":7,"line":39}}],"locations":[{"column":9,"line":38}],"text":"a DocString with escaped separator inside"}],"tags":[]},"type":"pickle","uri":"testdata/good/docstrings.feature"}

data/testdata/good/docstrings.feature.source.ndjson

@@ -0,0 +1 @@
+{"data":"Feature: DocString variations\n\n  Scenario: minimalistic\n    Given a simple DocString\n      \"\"\"\n      first line (no indent)\n        second line (indented with two spaces)\n\n      third line was empty\n      \"\"\"\n    Given a DocString with content type\n      \"\"\"xml\n      <foo>\n        <bar />\n      </foo>\n      \"\"\"\n    And a DocString with wrong indentation\n      \"\"\"\n    wrongly indented line\n      \"\"\"\n    And a DocString with alternative separator\n      ```\n      first line\n      second line\n      ```\n    And a DocString with normal separator inside\n      ```\n      first line\n      \"\"\"\n      third line\n      ```\n    And a DocString with alternative separator inside\n      \"\"\"\n      first line\n      ```\n      third line\n      \"\"\"\n    And a DocString with escaped separator inside\n      \"\"\"\n      first line\n      \\\"\\\"\\\"\n      third line\n      \"\"\"\n","media":{"encoding":"utf-8","type":"text/vnd.cucumber.gherkin+plain"},"type":"source","uri":"testdata/good/docstrings.feature"}

data/testdata/good/docstrings.feature.tokens

@@ -0,0 +1,44 @@
+(1:1)FeatureLine:Feature/DocString variations/
+(2:1)Empty://
+(3:3)ScenarioLine:Scenario/minimalistic/
+(4:5)StepLine:Given /a simple DocString/
+(5:7)DocStringSeparator://
+(6:1)Other:/first line (no indent)/
+(7:1)Other:/  second line (indented with two spaces)/
+(8:1)Other://
+(9:1)Other:/third line was empty/
+(10:7)DocStringSeparator://
+(11:5)StepLine:Given /a DocString with content type/
+(12:7)DocStringSeparator:/xml/
+(13:1)Other:/<foo>/
+(14:1)Other:/  <bar />/
+(15:1)Other:/</foo>/
+(16:7)DocStringSeparator://
+(17:5)StepLine:And /a DocString with wrong indentation/
+(18:7)DocStringSeparator://
+(19:1)Other:/wrongly indented line/
+(20:7)DocStringSeparator://
+(21:5)StepLine:And /a DocString with alternative separator/
+(22:7)DocStringSeparator://
+(23:1)Other:/first line/
+(24:1)Other:/second line/
+(25:7)DocStringSeparator://
+(26:5)StepLine:And /a DocString with normal separator inside/
+(27:7)DocStringSeparator://
+(28:1)Other:/first line/
+(29:1)Other:/"""/
+(30:1)Other:/third line/
+(31:7)DocStringSeparator://
+(32:5)StepLine:And /a DocString with alternative separator inside/
+(33:7)DocStringSeparator://
+(34:1)Other:/first line/
+(35:1)Other:/```/
+(36:1)Other:/third line/
+(37:7)DocStringSeparator://
+(38:5)StepLine:And /a DocString with escaped separator inside/
+(39:7)DocStringSeparator://
+(40:1)Other:/first line/
+(41:1)Other:/"""/
+(42:1)Other:/third line/
+(43:7)DocStringSeparator://
+EOF