cucumber-compatibility-kit 9.1.0

data/spec/capture_warnings.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+# With thanks to @myronmarston
+# https://github.com/vcr/vcr/blob/master/spec/capture_warnings.rb
+
+module CaptureWarnings
+  def report_warnings(&block)
+    current_dir = Dir.pwd
+    warnings, errors = capture_error(&block).partition { |line| line.include?('warning') }
+    project_warnings, other_warnings = warnings.uniq.partition { |line| line.include?(current_dir) }
+
+    if errors.any?
+      puts errors.join("\n")
+    end
+
+    if other_warnings.any?
+      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 } warnings detected"
+      print_warnings('cucumber-expressions', project_warnings)
+      fail "Please remove all cucumber-expressions warnings."
+    end
+
+    ensure_system_exit_if_required
+  end
+
+  def capture_error(&block)
+    old_stderr = STDERR.clone
+    pipe_r, pipe_w = IO.pipe
+    pipe_r.sync    = true
+    error          = String.new
+    reader = Thread.new do
+      begin
+        loop do
+          error << pipe_r.readpartial(1024)
+        end
+      rescue EOFError
+      end
+    end
+    STDERR.reopen(pipe_w)
+    block.call
+  ensure
+    capture_system_exit
+    STDERR.reopen(old_stderr)
+    pipe_w.close
+    reader.join
+    return error.split("\n")
+  end
+
+  def print_warnings(type, warnings)
+    puts
+    puts "-" * 30 + " #{type} warnings: " + "-" * 30
+    puts
+    puts warnings.join("\n")
+    puts
+    puts "-" * 75
+    puts
+  end
+
+  def ensure_system_exit_if_required
+    raise @system_exit if @system_exit
+  end
+
+  def capture_system_exit
+    @system_exit = $!
+  end
+end

data/spec/cucumber-compatibility-kit_spec.rb

@@ -0,0 +1,71 @@
+require 'cucumber-compatibility-kit'
+
+describe Cucumber::CompatibilityKit do
+  let(:features_path) { File.expand_path("#{File.dirname(__FILE__)}/../features") }
+  let(:gherkin_examples) {
+    [
+      'attachments',
+      'data-tables',
+      'examples-tables',
+      'hooks',
+      'minimal',
+      'parameter-types',
+      'pending',
+      'retry',
+      'rules',
+      'skipped',
+      'stack-traces',
+      'undefined',
+      'unknown-parameter-type'
+    ]
+  }
+  let(:markdown_examples) {
+    [
+      'markdown'
+    ]
+  }
+
+  describe '#examples_path' do
+    it 'returns the path of the features folder' do
+      expect(Cucumber::CompatibilityKit.examples_path)
+        .to eq(features_path)
+    end
+  end
+
+  describe '#example_path' do
+    context 'with an existing example' do
+      it 'returns the path of the folder of the example' do
+        expect(Cucumber::CompatibilityKit.example_path('hooks'))
+          .to eq("#{features_path}/hooks")
+      end
+    end
+
+    context 'with an unexisting example' do
+      it 'raises ArgumentError' do
+        expect { Cucumber::CompatibilityKit.example_path('should-not-exists') }
+          .to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#gherkin_examples' do
+    it 'returns the list of gherkin examples' do
+      expect(Cucumber::CompatibilityKit.gherkin_examples)
+        .to match_array(gherkin_examples)
+    end
+  end
+
+  describe '#markdown_examples' do
+    it 'returns the list of markdown examples' do
+      expect(Cucumber::CompatibilityKit.markdown_examples)
+        .to match_array(markdown_examples)
+    end
+  end
+
+  describe '#all_examples' do
+    it 'returns the list of all available examples' do
+      expect(Cucumber::CompatibilityKit.all_examples)
+        .to match_array(gherkin_examples + markdown_examples)
+    end
+  end
+end

data/spec/keys_checker_spec.rb

@@ -0,0 +1,77 @@
+require 'rspec'
+require 'cucumber/messages'
+require_relative '../lib/keys_checker'
+
+describe CCK::KeysChecker do
+  let(:subject) { CCK::KeysChecker }
+
+  describe '#compare' do
+    let(:complete) do
+      Cucumber::Messages::PickleStepArgument.new(
+        doc_string: '1',
+        data_table: '12'
+      )
+    end
+
+    let(:missing_data_table) do
+      Cucumber::Messages::PickleStepArgument.new(
+        doc_string: '1'
+      )
+    end
+
+    let(:missing_doc_string) do
+      Cucumber::Messages::PickleStepArgument.new(
+        data_table: '12'
+      )
+    end
+
+    let(:wrong_values) do
+      Cucumber::Messages::PickleStepArgument.new(
+        doc_string: '123',
+        data_table: '456'
+      )
+    end
+
+    it 'finds missing key' do
+      expect(subject.compare(missing_data_table, complete)).to eq(
+        ['Missing keys in message Cucumber::Messages::PickleStepArgument: [:data_table]']
+      )
+    end
+
+    it 'finds extra keys' do
+      expect(subject.compare(complete, missing_doc_string)).to eq(
+        ['Found extra keys in message Cucumber::Messages::PickleStepArgument: [:doc_string]']
+      )
+    end
+
+    it 'finds extra and missing' do
+      expect(subject.compare(missing_doc_string, missing_data_table)).to contain_exactly(
+        'Missing keys in message Cucumber::Messages::PickleStepArgument: [:doc_string]',
+        'Found extra keys in message Cucumber::Messages::PickleStepArgument: [:data_table]'
+      )
+    end
+
+    it 'does not care about the values' do
+      expect(subject.compare(complete, wrong_values)).to be_empty
+    end
+
+    context 'when default values are omitted' do
+      let(:default_set) do
+        Cucumber::Messages::Duration.new(
+          seconds: 0,
+          nanos: 12
+        )
+      end
+
+      let(:default_not_set) do
+        Cucumber::Messages::Duration.new(
+          nanos: 12
+        )
+      end
+
+      it 'does not raise an exception' do
+        expect(subject.compare(default_set, default_not_set)).to be_empty
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: cucumber-compatibility-kit
+version: !ruby/object:Gem::Version
+  version: 9.1.0
+platform: ruby
+authors:
+- Aurélien Reeves
+- Aslak Hellesøy
+- Vincent Prêtre
+- Cucumber Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber-messages
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '17.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 17.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '17.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 17.1.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+description: Kit to check compatibility with official cucumber implementation
+email: cukebot@cucumber.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- features/attachments/attachments.feature
+- features/attachments/attachments.feature.ndjson
+- features/attachments/attachments.feature.rb
+- features/attachments/cucumber.png
+- features/data-tables/data-tables.feature
+- features/data-tables/data-tables.feature.ndjson
+- features/data-tables/data-tables.feature.rb
+- features/examples-tables/examples-tables.feature
+- features/examples-tables/examples-tables.feature.ndjson
+- features/examples-tables/examples-tables.feature.rb
+- features/hooks/cucumber.svg
+- features/hooks/hooks.feature
+- features/hooks/hooks.feature.ndjson
+- features/hooks/hooks.feature.rb
+- features/markdown/markdown.feature.md
+- features/markdown/markdown.feature.md.ndjson
+- features/minimal/minimal.feature
+- features/minimal/minimal.feature.ndjson
+- features/minimal/minimal.feature.rb
+- features/parameter-types/parameter-types.feature
+- features/parameter-types/parameter-types.feature.ndjson
+- features/parameter-types/parameter-types.feature.rb
+- features/pending/pending.feature
+- features/pending/pending.feature.ndjson
+- features/pending/pending.feature.rb
+- features/retry/retry.feature
+- features/retry/retry.feature.ndjson
+- features/retry/retry.feature.rb
+- features/rules/rules.feature
+- features/rules/rules.feature.ndjson
+- features/rules/rules.feature.rb
+- features/skipped/skipped.feature
+- features/skipped/skipped.feature.ndjson
+- features/skipped/skipped.feature.rb
+- features/stack-traces/stack-traces.feature
+- features/stack-traces/stack-traces.feature.ndjson
+- features/stack-traces/stack-traces.feature.rb
+- features/undefined/undefined.feature
+- features/undefined/undefined.feature.ndjson
+- features/undefined/undefined.feature.rb
+- features/unknown-parameter-type/unknown-parameter-type.feature
+- features/unknown-parameter-type/unknown-parameter-type.feature.ndjson
+- features/unknown-parameter-type/unknown-parameter-type.feature.rb
+- lib/cucumber-compatibility-kit.rb
+- lib/keys_checker.rb
+- lib/messages_comparator.rb
+- lib/shared_examples.rb
+- spec/capture_warnings.rb
+- spec/cucumber-compatibility-kit_spec.rb
+- spec/keys_checker_spec.rb
+homepage: https://github.com/cucumber/common
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/cucumber/common/issues
+  changelog_uri: https://github.com/cucumber/common/blob/main/compatibility-kit/CHANGELOG.md
+  documentation_uri: https://cucumber.io/docs/gherkin/
+  mailing_list_uri: https://groups.google.com/forum/#!forum/cukes
+  source_code_uri: https://github.com/cucumber/common/blob/main/compatibility-kit/ruby
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: cucumber-compatibility-kit-9.1.0
+test_files:
+- spec/capture_warnings.rb
+- spec/cucumber-compatibility-kit_spec.rb
+- spec/keys_checker_spec.rb