Port CCK logic (#1748)

* Port runner of specs to same location as JS

* Copy+Paste of the three files required to run the specs alongside the shared examples

* Add calculator file

* Switch first class requires over to using newly copied files

* Convert all requires over to localised files

* Copy over gem code

* Fix file structure

* Fix up namespacing issues

* Remove all NDJSON files as those are stored on the gem as the source of truth

* Remove redundant code to run single groups

* Spike to get tests passing partially

* Remove redundant variable assignment

* Use new namespace to avoid conflicts

* Fix up of all naming conventions for new layout

* Remove redundant requires

* Require support code locally but feature code from the gem

* Remove all .feature files from core repo as those will be housed/ran on cck

* Calculate gherkin examples in gem to be ran locally

* Preserve markdown folder structure but remove feature

* Renames to show local code is supporting code

* Re-move helpers back into helper

* Remove all feature example detection as that now lives in the gem proper

* Copy, port and adapt meta-tests for CCK::Examples

* Copy over remaining specs from CCK repo proper and add bugfix for missing require

* Tidy up rakefile

* Remove old ref to cck tests

* Fix rake to test newly imported CCK correctly

* Use type metadata to signify a feature test to ignore rubocop issues

* Slight rubocop tweaks

* Use new namespaces / method names from unreleased CCK major

* Remove oddity from step definition code for attachments feature (Now we're using our own steps we don't need to be conformant)"

* Final tidies

* Use latest CCK

* Add changelog entry

* Fix example name in negative test

* Fix naming conflict for local/gem based feature location

* Fix issue where blank hook generated a different number of messages

* Fix up changelog docs

* Fix JRuby nuance with NME's triggering with more info

* Fix style to avoid size issues in the future

* Fix file pattern mismatch

Author: luke-hill

.rubocop.yml

@@ -18,11 +18,10 @@ AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
   Exclude:
-    - 'bin/*'
-    - 'tmp/**/*'
-    - 'vendor/**/*'
-    - 'temp_app/**/*'
-    - 'cck/features/**/*'
+    - bin/*
+    - tmp/**/*
+    - vendor/**/*
+    - temp_app/**/*
 
 # A line length of 200 covers most violations in the repo while still being a more up to date length given today's screen sizes
 Layout/LineLength:
@@ -32,29 +31,29 @@ Layout/LineLength:
 # In pretty_spec.rb & progress_spec.rb offences look false as the trailing spaces are in fact multiline string literals
 Layout/TrailingWhitespace:
   Exclude:
-    - 'spec/cucumber/formatter/pretty_spec.rb'
-    - 'spec/cucumber/formatter/progress_spec.rb'
+    - spec/cucumber/formatter/pretty_spec.rb
+    - spec/cucumber/formatter/progress_spec.rb
 
 # TODO: [LH] - This needs a re-review. I think we can pretty much delete / phase this out with incremental updates
 # We exclude proto_world for documentation (rdoc) purpose
 Lint/UselessMethodDefinition:
   Enabled: true
   Exclude:
-    - 'lib/cucumber/glue/proto_world.rb'
+    - lib/cucumber/glue/proto_world.rb
 
 # TODO: [LH] - This definitely needs a partial fix / reduction. Even if only an interim one that pushes some stuff
 Metrics/ClassLength:
   Max: 375
   Exclude:
-    - 'lib/cucumber/cli/options.rb'
+    - lib/cucumber/cli/options.rb
     # TODO: Manually added! - be careful with regenning the file - this needs a fix
     - lib/cucumber/formatter/pretty.rb
 
 # TODO: [LH] - Initial 10% reduction done Aug '23 - Further reductions should happen as/when we fix a bunch of the todo
 Metrics/ModuleLength:
   Max: 135
   Exclude:
-    - './spec/**/*'
+    - spec/**/*
     # TODO: Manually added! - be careful with regenning the file - this needs a fix
     - lib/cucumber/formatter/console.rb
 
@@ -73,13 +72,18 @@ Metrics/MethodLength:
 Naming/AsciiIdentifiers:
   Enabled: false
 
+# These directories (And associated files), are named according to the CCK convention which is kebab-case
+Naming/FileName:
+  Exclude:
+    - compatibility/features/**/*
+
 # For the most part, the project is solid on naming. There are though, a few
 # cases where the cop doesn't need to catch.
 Naming/MethodName:
   Exclude:
-    - 'examples/i18n/ar/lib/calculator.rb'
-    - 'examples/i18n/he/lib/calculator.rb'
-    - 'lib/cucumber/glue/dsl.rb'
+    - examples/i18n/ar/lib/calculator.rb
+    - examples/i18n/he/lib/calculator.rb
+    - lib/cucumber/glue/dsl.rb
 
 RSpec/ExampleLength:
   CountAsOne: ['array', 'hash', 'heredoc']

CHANGELOG.md

@@ -9,16 +9,21 @@ This document is formatted according to the principles of [Keep A CHANGELOG](htt
 Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CONTRIBUTING.md) for more info on how to contribute to Cucumber.
 
 ## [Unreleased]
-
-## [9.1.1] - 2024-01-04
 ### Added
 
 ### Changed
-- Updated dependencies to slightly more permissive / up to date versions ([luke-hill](https://github.com/luke-hill))
-- Fixed most of the `Layout` cop offenses ([luke-hill](https://github.com/luke-hill))
+- Moved all CCK step definition/miscellaneous file logic from CCK gem to this repo.
+  All logic contained in [compatibility](./compatibility) ([luke-hill](https://github.com/luke-hill))
 
 ### Fixed
 
+### Removed
+
+## [9.1.1] - 2024-01-04
+### Changed
+- Updated dependencies to slightly more permissive / up to date versions ([luke-hill](https://github.com/luke-hill))
+- Fixed most of the `Layout` cop offenses ([luke-hill](https://github.com/luke-hill))
+
 ### Removed
 - The sample sinatra tests are no longer used in internal testing (This removes a bunch of superfluous dev gems) ([#1743](https://github.com/cucumber/cucumber-ruby/pull/1743) [luke-hill](https://github.com/luke-hill))
 - Removed all references to autotest as this is an ancient plugin that is not correctly integrated

Rakefile

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require 'rubygems'
-require 'bundler'
-
-Bundler::GemHelper.install_tasks
-
 $LOAD_PATH.unshift("#{File.dirname(__FILE__)}/lib")
 Dir['gem_tasks/**/*.rake'].each { |rake| load rake }
 
@@ -15,7 +10,5 @@ require 'cucumber/rake/task'
 Cucumber::Rake::Task.new
 
 default_tasks = %i[spec cucumber cck]
-
 default_tasks << :examples if ENV['CI']
-
 task default: default_tasks

compatibility/cck_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'support/shared_examples'
+require_relative 'support/cck/examples'
+
+require 'cucumber-compatibility-kit'
+
+describe 'Cucumber Compatibility Kit', type: :feature, cck: true do
+  let(:cucumber_command) { 'bundle exec cucumber --publish-quiet --profile none --format message' }
+
+  CCK::Examples.gherkin.each do |example_name|
+    describe "'#{example_name}' example" do
+      include_examples 'cucumber compatibility kit' do
+        let(:example) { example_name }
+        let(:extra_args) { example == 'retry' ? '--retry 2' : '' }
+        let(:support_code_path) { CCK::Examples.supporting_code_for(example) }
+        let(:messages) { `#{cucumber_command} #{extra_args} --require #{support_code_path} #{cck_path}` }
+      end
+    end
+  end
+end

compatibility/features/attachments/attachments.feature.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# This blank hook has been re-added in. See https://github.com/cucumber/compatibility-kit/issues/83 for more details
+Before { nil }
+
+When('the string {string} is attached as {string}') do |text, media_type|
+  attach(text, media_type)
+end
+
+When('the string {string} is logged') do |text|
+  log(text)
+end
+
+When('text with ANSI escapes is logged') do
+  log("This displays a \x1b[31mr\x1b[0m\x1b[91ma\x1b[0m\x1b[33mi\x1b[0m\x1b[32mn\x1b[0m\x1b[34mb\x1b[0m\x1b[95mo\x1b[0m\x1b[35mw\x1b[0m")
+end
+
+When('the following string is attached as {string}:') do |media_type, doc_string|
+  attach(doc_string, media_type)
+end
+
+When('an array with {int} bytes is attached as {string}') do |size, media_type|
+  data = (0..size - 1).map { |i| [i].pack('C') }.join
+  attach(data, media_type)
+end
+
+When('a JPEG image is attached') do
+  attach(File.open("#{__dir__}/cucumber.jpeg"), 'image/jpeg')
+end
+
+When('a PNG image is attached') do
+  attach(File.open("#{__dir__}/cucumber.png"), 'image/png')
+end
+
+When('a PDF document is attached and renamed') do
+  attach(File.open("#{__dir__}/document.pdf"), 'document/pdf', 'renamed.pdf')
+end

compatibility/features/attachments/cucumber.jpeg

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Given('I have {int} <![CDATA[cukes]]> in my belly') do |_cuke_count|
+  # no-op
+end

compatibility/features/attachments/cucumber.png

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+When('the following table is transposed:') do |table|
+  @transposed = table.transpose
+end
+
+Then('it should be:') do |expected|
+  @transposed.diff!(expected)
+end

compatibility/features/attachments/document.pdf

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+Given('there are {int} cucumbers') do |initial_count|
+  @count = initial_count
+end
+
+When('I eat {int} cucumbers') do |eat_count|
+  @count -= eat_count
+end
+
+Then('I should have {int} cucumbers') do |expected_count|
+  expect(@count).to eq(expected_count)
+end

compatibility/features/cdata/cdata.feature.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+Before do
+  # no-op
+end
+
+Before(name: 'A named hook') do
+  # no-op
+end
+
+When('a step passes') do
+  # no-op
+end
+
+When('a step fails') do
+  raise 'Exception in step'
+end
+
+After do
+  # no-op
+end
+
+After('@some-tag or @some-other-tag') do
+  raise 'Exception in conditional hook'
+end
+
+After('@with-attachment') do
+  attach(File.open("#{__dir__}/cucumber.svg"), 'image/svg+xml')
+end

compatibility/features/data-tables/data-tables.feature.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Given('I have {int} cukes in my belly') do |_cuke_count|
+  # no-op
+end

compatibility/features/examples-tables/examples-tables.feature.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class Flight
+  attr_reader :from, :to
+
+  def initialize(from, to)
+    @from = from
+    @to = to
+  end
+end
+
+ParameterType(
+  name: 'flight',
+  regexp: /([A-Z]{3})-([A-Z]{3})/,
+  transformer: ->(from, to) { Flight.new(from, to) }
+)
+
+Given('{flight} has been delayed') do |flight|
+  expect(flight.from).to eq('LHR')
+  expect(flight.to).to eq('CDG')
+end

compatibility/features/hooks/cucumber.svg

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+Given('an implemented non-pending step') do
+  # no-op
+end
+
+Given('an implemented step that is skipped') do
+  # no-op
+end
+
+Given('an unimplemented pending step') do
+  pending('')
+end

compatibility/features/hooks/hooks.feature.rb

@@ -0,0 +1 @@
+--retry 2

compatibility/features/markdown/.keep

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+Given('a step that always passes') do
+  # no-op
+end
+
+second_time_pass = 0
+Given('a step that passes the second time') do
+  second_time_pass += 1
+  raise 'Exception in step' if second_time_pass < 2
+end
+
+third_time_pass = 0
+Given('a step that passes the third time') do
+  third_time_pass += 1
+  raise 'Exception in step' if third_time_pass < 3
+end
+
+Given('a step that always fails') do
+  raise 'Exception in step'
+end

compatibility/features/minimal/minimal.feature.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+Given('the customer has {int} cents') do |money|
+  @money = money
+end
+
+Given('there are chocolate bars in stock') do
+  @stock = ['Mars']
+end
+
+Given('there are no chocolate bars in stock') do
+  @stock = []
+end
+
+When('the customer tries to buy a {int} cent chocolate bar') do |price|
+  @chocolate = @stock.pop if @money >= price
+end
+
+Then('the sale should not happen') do
+  expect(@chocolate).to be_nil
+end
+
+Then('the sale should happen') do
+  expect(@chocolate).not_to be_nil
+end

compatibility/features/parameter-types/parameter-types.feature.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+Before('@skip') do
+  skip_this_scenario('')
+end
+
+Given('a step that does not skip') do
+  # no-op
+end
+
+Given('a step that is skipped') do
+  # no-op
+end
+
+Given('I skip a step') do
+  skip_this_scenario('')
+end

compatibility/features/pending/pending.feature.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+When('a step throws an exception') do
+  raise 'BOOM'
+end

compatibility/features/retry/retry.arguments.txt

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+Given('an implemented step') do
+  # no-op
+end
+
+Given('a step that will be skipped') do
+  # no-op
+end

compatibility/features/retry/retry.feature.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Given('{airport} is closed because of a strike') do |_airport|
+  raise 'Should not be called because airport parameter type has not been defined'
+end