gherkin 5.1.0 → 6.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c66b95af339175dae07eee21dbfe46234e1a642f2c22ec2d9c6031503efc1974
-  data.tar.gz: 546eb9edae7fedc96885b2672b6fed1bd0e8daf9b79aec2b2d19fc4a24bc81b3
+  metadata.gz: 1e7051086a62daf33ee23f42691d0a3649694ea80821974175f7f2fa5cdada23
+  data.tar.gz: 3a396634034f2d1c8370aeca2328595e4038b030a1d30755b9a1c0030158707c
 SHA512:
-  metadata.gz: 19aafa00c304000ef00b29a08c9438bc5a95693427dfd1182c941061a49fb34736a1f63df08012a73e9de9ed8bd71b03faa429fb55e935ce07c80f1ceed51f05
-  data.tar.gz: 25f3ba9e15dcd5802dafa84adfbbecc1c0ba0412e28957da408e256c5858bd8121f75f9be8b2a767cba0a22bd80e172044ac1b619c466828601ed97c5a48ec44
+  metadata.gz: 575a8827cff148a70711a8231d0d3f606e7ab104fb20a34420f3cb0e76fd4b7c9bfa94386dabb0d0823f2ff69be51b9e9c6424393f679c8661ed3e56203bb9fb
+  data.tar.gz: 48b083b51f3acb43eaf7d3568f0b2daba395888ccee90b5a34132974ad099a8461b2c8856fd7d9639a28b0ecf9adf0ba49d26b204f11e7bfde4d7a256c9980ef

data/README.md

@@ -2,10 +2,7 @@
 
 Gherkin parser/compiler for Ruby. Please see [Gherkin](https://github.com/cucumber/gherkin) for details.
 
-## Developers
-
-Some files are generated from the `gherkin-ruby.razor` file. Please run the
-following command to generate the ruby files.
+## To build
 
 ~~~bash
 cd <project_root>/ruby

data/bin/gherkin

@@ -1,34 +1,61 @@
 #!/usr/bin/env ruby
 $VERBOSE=nil # Shut up JRuby warnings on Travis
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__),"../lib"))
+
 require 'optparse'
 require 'json'
-require 'gherkin/stream/source_events'
-require 'gherkin/stream/gherkin_events'
+require 'gherkin/gherkin'
 
 options = {
-  print_source: true,
-  print_ast: true,
-  print_pickles: true
+  include_source: true,
+  include_gherkin_document: true,
+  include_pickles: true,
+  protobuf: false
 }
 
 OptionParser.new do |opts|
-  opts.on("--[no-]source", "Don't print source events") do |v|
-    options[:print_source] = v
+  opts.on("--[no-]source", "Don't print source messages") do |v|
+    options[:include_source] = v
   end
-  opts.on("--[no-]ast", "Don't print ast events") do |v|
-    options[:print_ast] = v
+  opts.on("--[no-]ast", "Don't print ast messages") do |v|
+    options[:include_gherkin_document] = v
   end
-  opts.on("--[no-]pickles", "Don't print pickle events") do |v|
-    options[:print_pickles] = v
+  opts.on("--[no-]pickles", "Don't print pickle messages") do |v|
+    options[:include_pickles] = v
   end
 end.parse!
 
-source_events = Gherkin::Stream::SourceEvents.new(ARGV)
-gherkin_events = Gherkin::Stream::GherkinEvents.new(options)
+def include_messages(messages)
+  messages.each do |message|
+    json = message.class.encode_json(message)
+    ob = JSON.parse(json)
+    remove_empties(ob)
+    puts JSON.generate(ob)
+  end
+end
 
-source_events.enum.each do |source_event|
-  gherkin_events.enum(source_event).each do |event|
-    puts JSON.generate(event)
+def remove_empties(ob)
+  if Hash === ob
+    ob.each do |key, value|
+      if value == []
+        ob.delete(key)
+      else
+        remove_empties(value)
+      end
+    end
+  elsif Array === ob
+    ob.each do |value|
+      remove_empties(value)
+    end
   end
 end
+
+messages = ARGV.empty? ? 
+  # Read protobuf from STDIN
+  Gherkin::ProtobufCucumberMessages.new(STDIN).messages
+  :
+  Gherkin::Gherkin.from_paths(
+    ARGV,
+    options
+  )
+include_messages(messages)

data/gherkin-go/gherkin-go-linux-mips

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Error><Code>NoSuchKey</Code><Message>The specified key does not exist.</Message><Key>gherkin-go/v6.0.10/gherkin-go-linux-mips</Key><RequestId>9BA4E98529360585</RequestId><HostId>LgE761MCAUDB2BXTUj5XTk8IKkQoCY19FBrvimajYJE+rd451soycWVWxsK8zE+yXl6b1lYH79g=</HostId></Error>

data/gherkin-go/gherkin-go-linux-mips64

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Error><Code>NoSuchKey</Code><Message>The specified key does not exist.</Message><Key>gherkin-go/v6.0.10/gherkin-go-linux-mips64</Key><RequestId>34F63197D1A00BFF</RequestId><HostId>wIL30jU9d4iSAUtx/eFR3xqunYlEBaOtL2hQ77UZ8mEZmRJ5aVGFcQNCgY/Gp2KZj1pJv04JUtY=</HostId></Error>

data/gherkin-go/gherkin-go-linux-mips64le

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Error><Code>NoSuchKey</Code><Message>The specified key does not exist.</Message><Key>gherkin-go/v6.0.10/gherkin-go-linux-mips64le</Key><RequestId>79780A30A814B543</RequestId><HostId>DE0NzpSoLtmXmw5AUa0XSsfOfh89jhxoafVJTAXxY6LdbfVqcsneBkDvIxZthKjUfEn6q5t+jik=</HostId></Error>

data/gherkin-go/gherkin-go-linux-mipsle

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Error><Code>NoSuchKey</Code><Message>The specified key does not exist.</Message><Key>gherkin-go/v6.0.10/gherkin-go-linux-mipsle</Key><RequestId>CFC4710522D0D02B</RequestId><HostId>2vVq1SdPbDR6WOdUG734+vvWM8mcvax3t1ZzeMdFhDOgNOTxtkeIZW4zpfm4TKRQkbXZIJ0WcD4=</HostId></Error>

data/gherkin-go/gherkin-go-linux-s390x

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Error><Code>NoSuchKey</Code><Message>The specified key does not exist.</Message><Key>gherkin-go/v6.0.10/gherkin-go-linux-s390x</Key><RequestId>C590F84DB9E09B43</RequestId><HostId>rcJIIedSh3pMck0vxGzVwWABy1bmEAyw16hXntKD5wEMDxg27Jigy28n5pXQ1ECXsexUj2x4qWU=</HostId></Error>

data/lib/gherkin/dialect.rb

@@ -1,8 +1,18 @@
 require 'json'
+require 'open3'
+require 'c21e/exe_file'
+require 'gherkin/exe_file_path'
 
 module Gherkin
-  DIALECT_FILE_PATH = File.expand_path("gherkin-languages.json", File.dirname(__FILE__))
-  DIALECTS = JSON.parse File.open(DIALECT_FILE_PATH, 'r:UTF-8').read
+  def self.dialects_json
+    gherkin_executable = C21e::ExeFile.new(EXE_FILE_PATH).target_file
+    data, = Open3.capture2e(gherkin_executable, '--dialects')
+    data
+  end
+
+  private_class_method :dialects_json
+
+  DIALECTS = JSON.parse(dialects_json)
 
   class Dialect
     def self.for(name)
@@ -19,6 +29,10 @@ module Gherkin
       @spec.fetch('feature')
     end
 
+    def rule_keywords
+      @spec.fetch('rule')
+    end
+
     def scenario_keywords
       @spec.fetch('scenario')
     end

data/lib/gherkin/exe_file_path.rb

@@ -0,0 +1,3 @@
+module Gherkin
+  EXE_FILE_PATH = File.expand_path("#{File.dirname(__FILE__)}/../../gherkin-go/gherkin-go-{{.OS}}-{{.Arch}}{{.Ext}}")
+end

data/lib/gherkin/gherkin.rb

@@ -0,0 +1,75 @@
+require 'open3'
+require 'c21e/exe_file'
+require 'gherkin/protobuf_cucumber_messages'
+require 'gherkin/exe_file_path'
+require 'cucumber/messages'
+
+module Gherkin
+  class Gherkin
+    include Cucumber::Messages::Varint
+
+    DEFAULT_OPTIONS = {
+      include_source: true,
+      include_gherkin_document: true,
+      include_pickles: true
+    }.freeze
+
+    def self.from_paths(paths, options={})
+      self.new(paths, [], options).messages
+    end
+
+    def self.from_sources(sources, options={})
+      self.new([], sources, options).messages
+    end
+
+    def self.from_source(uri, data, options={})
+      from_sources([encode_source_message(uri, data)], options)
+    end
+    
+    def initialize(paths, sources, options)
+      @paths = paths
+      @sources = sources
+      @options = DEFAULT_OPTIONS.merge(options)
+      @gherkin_executable = C21e::ExeFile.new(EXE_FILE_PATH).target_file
+    end
+
+    def messages
+      args = base_args
+      args = args.concat(@paths)
+      stdin, stdout, stderr, wait_thr = Open3.popen3(*args)
+      stdin.binmode
+      @sources.each do |source|
+        wrapper = Cucumber::Messages::Wrapper.new(
+          source: source
+        )
+        proto = Cucumber::Messages::Wrapper.encode(wrapper)
+        encode_varint(stdin, proto.length)
+        stdin.write(proto)
+      end
+      stdin.close
+      ProtobufCucumberMessages.new(stdout, stderr).messages
+    end
+
+    private
+
+    def base_args
+      args = [@gherkin_executable]
+      args.push('--no-source') unless @options[:include_source]
+      args.push('--no-ast') unless @options[:include_gherkin_document]
+      args.push('--no-pickles') unless @options[:include_pickles]
+      args.push("--default-dialect=#{@options[:default_dialect]}") unless @options[:default_dialect].nil?
+      args
+    end
+
+    def self.encode_source_message(uri, data)
+      media_obj = Cucumber::Messages::Media.new
+      media_obj.encoding = 'UTF-8'
+      media_obj.content_type = 'text/x.cucumber.gherkin+plain'
+      source_obj = Cucumber::Messages::Source.new
+      source_obj.uri = uri
+      source_obj.data = data
+      source_obj.media = media_obj
+      source_obj
+    end
+  end
+end

data/lib/gherkin/protobuf_cucumber_messages.rb

@@ -0,0 +1,30 @@
+require 'cucumber/messages'
+
+module Gherkin
+  class ProtobufCucumberMessages
+    include Cucumber::Messages::Varint
+
+    def initialize(io, err = nil)
+      @io = io
+      @err = err
+    end
+
+    def messages
+      read_pipes = @err.nil? ? [@io] : [@io, @err]
+      Enumerator.new do |y|
+        while true
+          r, = IO.select(read_pipes)
+          if r.first == @err
+            raise @err.read unless @err.eof?
+          else
+            break if @io.eof?
+            len = decode_varint(@io)
+            buf = @io.read(len)
+            wrapper = Cucumber::Messages::Wrapper.decode(buf)
+            y.yield wrapper
+          end
+        end
+      end
+    end
+  end
+end

data/spec/capture_warnings.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # With thanks to @myronmarston
 # https://github.com/vcr/vcr/blob/master/spec/capture_warnings.rb
 
@@ -12,14 +13,19 @@ module CaptureWarnings
     end
 
     if other_warnings.any?
-      puts "#{ other_warnings.count } non-gherkin warnings detected, set VIEW_OTHER_WARNINGS=true to see them."
+      puts "#{ other_warnings.count } warnings detected, set VIEW_OTHER_WARNINGS=true to see them."
       print_warnings('other', other_warnings) if ENV['VIEW_OTHER_WARNINGS']
     end
 
+    # Until they fix https://bugs.ruby-lang.org/issues/10661
+    if RUBY_VERSION == "2.2.0"
+      project_warnings = project_warnings.reject { |w| w =~ /warning: possible reference to past scope/ }
+    end
+
     if project_warnings.any?
-      puts "#{ project_warnings.count } gherkin warnings detected"
-      print_warnings('gherkin', project_warnings)
-      fail "Please remove all gherkin warnings."
+      puts "#{ project_warnings.count } warnings detected"
+      print_warnings('cucumber-expressions', project_warnings)
+      fail "Please remove all cucumber-expressions warnings."
     end
 
     ensure_system_exit_if_required
@@ -29,7 +35,7 @@ module CaptureWarnings
     old_stderr = STDERR.clone
     pipe_r, pipe_w = IO.pipe
     pipe_r.sync    = true
-    error         = ""
+    error          = String.new
     reader = Thread.new do
       begin
         loop do

data/spec/coverage.rb

@@ -1,10 +1,7 @@
+# frozen_string_literal: true
 require 'simplecov'
 formatters = [ SimpleCov::Formatter::HTMLFormatter ]
 
-if ENV['TRAVIS']
-  require 'coveralls'
-  formatters << Coveralls::SimpleCov::Formatter
-end
-
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[*formatters]
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(*formatters)
+SimpleCov.add_filter 'spec/'
 SimpleCov.start

data/spec/gherkin/dialect_spec.rb

@@ -0,0 +1,13 @@
+# coding: utf-8
+require 'rspec'
+require 'gherkin/dialect'
+
+module Gherkin
+  describe Dialect do
+    it 'provides an interface to the keywords of a dialect' do
+      dialect_en = Dialect.for('en')
+
+      expect(dialect_en.feature_keywords).to eq(['Feature', 'Business Need', 'Ability'])
+    end
+  end
+end

data/spec/gherkin/gherkin_spec.rb

@@ -0,0 +1,354 @@
+# coding: utf-8
+require 'rspec'
+require 'gherkin/gherkin'
+
+module Gherkin
+  describe Gherkin do
+    context 'using paths' do
+      it "works" do
+        messages = Gherkin.from_paths(
+          ["testdata/good/minimal.feature"]
+        )
+        expect(messages.to_a.length).to eq(3)
+      end
+    end
+
+    context 'using string content' do
+      it 'works' do
+        file = File.new('testdata/good/minimal.feature')
+        content = file.read.encode('UTF-8')
+        messages = Gherkin.from_source('testdata/good/minimal.feature', content).to_a
+        expect(messages.to_a.length).to eq(3)
+      end
+
+      it 'also works' do
+        content = """
+Feature:
+
+  Scenario: scenario 1
+    Given text
+
+  Scenario: scenario 2
+    Given text
+
+  Scenario: scenario 3
+    Given text
+
+  Scenario: scenario 4
+    Given text
+
+  Scenario: scenario 5
+    Given text
+
+  Scenario: scenario 6
+    Given text
+
+  Scenario: scenario 7
+    Given text
+
+  Scenario: scenario 8
+    Given text
+
+  Scenario: scenario 9
+    Given text
+
+  Scenario: scenario 10
+    Given text
+
+  Scenario: scenario 11
+    Given text
+
+  Scenario: scenario 12
+    Given text
+
+  Scenario: scenario 13
+    Given text
+
+  Scenario: scenario 14
+    Given text
+
+  Scenario: scenario 15
+    Given text
+
+  Scenario: scenario 16
+    Given text
+
+  Scenario: scenario 17
+    Given text
+
+  Scenario: scenario 18
+    Given text
+
+  Scenario: scenario 19
+    Given text
+
+  Scenario: scenario 20
+    Given text
+
+  Scenario: scenario 21
+    Given text
+
+  Scenario: scenario 22
+    Given text
+
+  Scenario: scenario 23
+    Given text
+
+  Scenario: scenario 24
+    Given text
+
+  Scenario: scenario 25
+    Given text
+
+  Scenario: scenario 26
+    Given text
+
+  Scenario: scenario 27
+    Given text
+
+  Scenario: scenario 28
+    Given text
+
+  Scenario: scenario 29
+    Given text
+
+  Scenario: scenario 30
+    Given text
+
+  Scenario: scenario 31
+    Given text
+
+  Scenario: scenario 32
+    Given text
+
+  Scenario: scenario 33
+    Given text
+
+  Scenario: scenario 34
+    Given text
+
+  Scenario: scenario 35
+    Given text
+
+  Scenario: scenario 36
+    Given text
+
+  Scenario: scenario 37
+    Given text
+
+  Scenario: scenario 38
+    Given text
+
+  Scenario: scenario 39
+    Given text
+
+  Scenario: scenario 40
+    Given text
+
+  Scenario: scenario 41
+    Given text
+
+  Scenario: scenario 42
+    Given text
+
+  Scenario: scenario 43
+    Given text
+
+  Scenario: scenario 44
+    Given text
+
+  Scenario: scenario 45
+    Given text
+
+  Scenario: scenario 46
+    Given text
+
+  Scenario: scenario 47
+    Given text
+
+  Scenario: scenario 48
+    Given text
+
+  Scenario: scenario 49
+    Given text
+"""
+        messages = Gherkin.from_source('dummy', content).to_a
+        expect(messages.to_a.length).to eq(51)
+      end
+
+      it 'still works' do
+        content = """
+Feature:
+
+  Scenario: scenario 1
+    Given text
+
+  Scenario: scenario 2
+    Given text
+
+  Scenario: scenario 3
+    Given text
+
+  Scenario: scenario 4
+    Given text
+
+  Scenario: scenario 5
+    Given text
+
+  Scenario: scenario 6
+    Given text
+
+  Scenario: scenario 7
+    Given text
+
+  Scenario: scenario 8
+    Given text
+
+  Scenario: scenario 9
+    Given text
+
+  Scenario: scenario 10
+    Given text
+
+  Scenario: scenario 11
+    Given text
+
+  Scenario: scenario 12
+    Given text
+
+  Scenario: scenario 13
+    Given text
+
+  Scenario: scenario 14
+    Given text
+
+  Scenario: scenario 15
+    Given text
+
+  Scenario: scenario 16
+    Given text
+
+  Scenario: scenario 17
+    Given text
+
+  Scenario: scenario 18
+    Given text
+
+  Scenario: scenario 19
+    Given text
+
+  Scenario: scenario 20
+    Given text
+
+  Scenario: scenario 21
+    Given text
+
+  Scenario: scenario 22
+    Given text
+
+  Scenario: scenario 23
+    Given text
+
+  Scenario: scenario 24
+    Given text
+
+  Scenario: scenario 25
+    Given text
+
+  Scenario: scenario 26
+    Given text
+
+  Scenario: scenario 27
+    Given text
+
+  Scenario: scenario 28
+    Given text
+
+  Scenario: scenario 29
+    Given text
+
+  Scenario: scenario 30
+    Given text
+
+  Scenario: scenario 31
+    Given text
+
+  Scenario: scenario 32
+    Given text
+
+  Scenario: scenario 33
+    Given text
+
+  Scenario: scenario 34
+    Given text
+
+  Scenario: scenario 35
+    Given text
+
+  Scenario: scenario 36
+    Given text
+
+  Scenario: scenario 37
+    Given text
+
+  Scenario: scenario 38
+    Given text
+
+  Scenario: scenario 39
+    Given text
+
+  Scenario: scenario 40
+    Given text
+
+  Scenario: scenario 41
+    Given text
+
+  Scenario: scenario 42
+    Given text
+
+  Scenario: scenario 43
+    Given text
+
+  Scenario: scenario 44
+    Given text
+
+  Scenario: scenario 45
+    Given text
+
+  Scenario: scenario 46
+    Given text
+
+  Scenario: scenario 47
+    Given text
+
+  Scenario: scenario 48
+    Given text
+
+  Scenario: scenario 49
+    Given text
+
+  Scenario: scenario 50
+    Given text
+"""
+        messages = Gherkin.from_source('dummy', content).to_a
+        expect(messages.to_a.length).to eq(52)
+    end
+
+    end
+
+    context 'setting the default dialect' do
+      it 'features will be parsed using the set default dialect' do
+        content = """
+          Egenskap: i18n support
+
+            Scenario: Parsing many languages
+              Gitt Gherkin supports many languages
+              Når Norwegian keywords are parsed
+              Så they should be recognized
+          """
+        messages = Gherkin.from_source('dummy', content, {default_dialect: 'no'})
+        expect(messages.to_a.length).to eq(3)
+      end
+    end
+  end
+end