Ruby implementation by luke-hill · Pull Request #98 · cucumber/query

luke-hill · 2025-09-05T17:53:13Z

🤔 What's changed?

Just enough cucumber-query to satisfy the rerun formatter.

⚡️ What's your motivation?

Move code that was written inside Cucumber-ruby over to this library. Get a first release out that we can build on.

🏷️ What kind of change is this?

🏦 Refactoring/debt/DX (improvement to code design, tooling, etc. without changing behaviour)

♻️ Anything particular you want feedback on?

Are we following standard patterns? Is this a good foundation to build on?

Checklist

Configure RubyGems trusted publishing for cucumber-query
Do the release

mpkorstanje

It looks like you're writing tests for each method. That isn't necessary.

Rather you can define a list of sources:

"../testdata/attachments.ndjson"
"../testdata/empty.ndjson"
"../testdata/hooks.ndjson"
"../testdata/minimal.ndjson"
"../testdata/rules.ndjson"
"../testdata/examples-tables.ndjson"

And a map of query functions queries of the form (Query query) -> /* execute some query and return the results*/. For example:

queries.put("findAllTestStepsStarted", (query) -> query.findAllTestStepsStarted().size());

Then take the product of sources and queries and for each of those populate a instance of the Query object with the messages from the source, and then apply the query function to the Query object.

Then you compare the result of query function to the ../testdata/<source>.<methodname>.results.json file.

The nice thing is that you can add methods to the queries list as you implement them.

luke-hill · 2025-09-05T18:21:00Z

Atm I'm copying over things that already exist. I'm well aware this is likely wrong. I just want to get what currently "works" in here and equivalent passing/failing.

See https://github.com/cucumber/cucumber-ruby/tree/main/lib/cucumber/formatter/query for where I'm adapting things from for now.

mpkorstanje

Some other nitpicks below, but I suppose those are there because this is WIP

mpkorstanje · 2025-09-05T18:15:19Z

+
+  s.add_dependency 'cucumber-messages', '> 25', '< 30'
+
+  s.add_development_dependency 'cucumber', '~> 10.1'


mpkorstanje · 2025-09-05T18:15:55Z

+  s.metadata = {
+    'bug_tracker_uri' => 'https://github.com/cucumber/query/issues',
+    'changelog_uri' => 'https://github.com/cucumber/query/blob/main/CHANGELOG.md',
+    'documentation_uri' => 'https://github.com/cucumber/query/blob/main/CONTRIBUTING.md',


Should be the read me I guess, not the contributors guide.

mpkorstanje · 2025-09-05T18:20:53Z

+      def hook_id(test_step)
+        return @hook_id_by_test_step_id[test_step.id] if @hook_id_by_test_step_id.key?(test_step.id)
+
+        raise TestStepUnknownError, "No hook found for #{test_step.id} }. Known: #{@hook_id_by_test_step_id.keys}"


The design of the query object assumes that if something can't be found either an empty list, empty optional or null is returned. There are no methods that throw.

This is also why all the methods are name findX or findAllX or findZByX`.

mpkorstanje · 2025-09-05T18:26:04Z

Atm I'm copying over things that already exist. I'm well aware this is likely wrong. I just want to get what currently "works" in here and equivalent passing/failing.

That doesn't seem like a good idea. The query object is used by the xml, json, pretty formatters, ect. By using a different API the Ruby implementations of these will lose the resemblance to the Java and Javascript versions. That will make maintenance much harder.

I think you'd be better of leaving that old query object in place, implement the new query object here, then migrate your users of the old query object over to the new query object instead.

mpkorstanje · 2025-09-05T18:27:33Z

Removed WIP from title, marked PR as draft.

…queries

…ematurely

…run (let alone pass!)

mpkorstanje

Looks okay. What does the code coverage look like?

mpkorstanje · 2026-06-30T19:12:55Z

+# Given one Cucumber Message, find another.
+#
+# Queries can be made while the test run is incomplete - and this will naturally return incomplete results
+# see <a href="https://github.com/cucumber/messages?tab=readme-ov-file#message-overview">Cucumber Messages - Message Overview</a>


I don't think html tags are valid in Ruby doc.

https://github.com/ruby/rdoc/blob/master/doc/markup_reference/rdoc.rdoc#multi-word-text-link

mpkorstanje · 2026-06-30T19:15:44Z

+        find_test_steps_finished_by(message)
+          .map(&:test_step_result)
+          .max_by { |test_step_result| test_step_result_rankings[test_step_result.status] }
+        # Java code: "PREVIOUS".max(comparing(TestStepResult::getStatus, new TestStepResultStatusComparator()));


Comments like this can be cleaned up.

mpkorstanje · 2026-06-30T19:18:35Z

+
+    def message_types
+      {
+        pickle_step: Cucumber::Messages::PickleStep,


Does Ruby have some sort of alias that lets you use the qualified name instead of the unqualified name? If so, this lookup table could be removed.

mpkorstanje · 2026-07-01T12:19:22Z

+      attachments_by_test_run_hook_started_id[attachment.test_run_hook_started_id] << attachment if attachment.test_run_hook_started_id
+    end
+
+    def update_feature(feature)


I would suggest removing this method and it's dependencies for now. You won't need it unless you implement the naming strategy which is a long way away. It's also not testable without implementing the naming strategy so you can safe on some work here.

Update @mpkorstanje we need this method and "some" type of handler (Even if it's a nil handler), to handle the metaprogrammed enumeration.

We've added in 2 more "dumb" handlers for undefined_parameter_type and source as well as a catchall method that'll bubble up a warning that things aren't updating.

Merging this in AS IS, as it's essentially RtM - but there's no need to rush anything out for this, so it can just sit until someone builds a new version. 16.1+

Then why not use a nil handler? Dead and untested code just slow you down.

…w message type on envelopes

luke-hill · 2026-07-01T13:09:31Z

Note to viewers. CI is red whilst we move forward on messages being cut for a new major - Which would bring version parity in-line plus enable access to new methods

luke-hill · 2026-07-09T12:28:38Z

Updated with latest main and fixed version requirements to pick up a new enough version of messages to facilitate this working.

Should be green now

…or new undefined ones

mpkorstanje reviewed Sep 5, 2025

View reviewed changes

mpkorstanje marked this pull request as draft September 5, 2025 18:27

mpkorstanje changed the title ~~WIP: Ruby implementation~~ Ruby implementation Sep 5, 2025

luke-hill added 23 commits June 13, 2026 13:39

Initial files

7c49898

Add hidden files

c6a0dba

Fix typo

5f4a90b

Add cucumber messages to runtime requirements and port over existing …

a988fd0

…queries

Add in spec files

273e248

Fix up all loading, relations and requirements

b6c0a15

Alter error class for new API

36e2a52

Alter all other tests to pass

8db670b

Auto-gen rubocop config;

e3637f1

Add note about duplication of code

b096339

Minor linting and starting to unpick redundant pieces of spec support

c0637d8

Lint / DRY up tests

ef56500

Linting for tests and 1 bug fix where test case started was firing pr…

f0b2552

…ematurely

Add in legacy ns;

c900365

Ported over helpers from JS

f35fa9b

Initial implementation of initializer and update method

c3d7fe5

Remove un-needed placeholder

0a4c755

Regen the rubocop config;

2b2b2d0

Remove all legacy query entities

f780531

Move query into correct NS and rename helpers

47e4f14

Remove legacy tests

3e72470

Fix readme

b2b1c59

Remove un-necessary items from package

354aee3

luke-hill and others added 7 commits June 30, 2026 17:13

Target Ruby 3.3+

92a4ed3

Fix CI

5d39812

Convert into new testing format for new query;

648fa0c

Tidy up test iteration code to ensure we only select files that will …

84e1560

…run (let alone pass!)

Add in more cck examples to be tested against

f385309

Remove gemfile.lock

048184e

Nitpicks

0575da5

mpkorstanje reviewed Jun 30, 2026

View reviewed changes

luke-hill added 6 commits July 1, 2026 07:46

Fix version

b6d01eb

Merge branch 'main' into feature/ruby_implementation

3e82877

Fix for old ruby

74ad722

Fix requirements and rdoc

4f274cf

Fix up test code

831859f

Refactor out symbol refs to use verbose classes

1fcf781

luke-hill mentioned this pull request Jul 1, 2026

[Ruby] Query Lambdas missing for majority of query methods #181

Closed

34 tasks

mpkorstanje reviewed Jul 1, 2026

View reviewed changes

Fix required version of messages and improve handlers by utilising ne…

53e4325

…w message type on envelopes

luke-hill added 7 commits July 1, 2026 15:23

Tidy up line length and remove comments

8f9af81

Add in some more simple lambdas to validate more of the queries

6f79e9e

Fix findAll lambdas to return int

2023797

Fix findMeta to return name of implementation

7fdde96

Add in 2 new queries which also return simple counters;

7077a0d

Bump version requirements for messages

e04185b

Merge branch 'main' into feature/ruby_implementation

6dabc4b

Add in missing message handlers for 2 message updates plus catchall f…

be8521b

…or new undefined ones

luke-hill merged commit cc25e82 into main Jul 13, 2026
19 checks passed

luke-hill deleted the feature/ruby_implementation branch July 13, 2026 13:42

mpkorstanje self-requested a review July 13, 2026 13:42


		s.add_dependency 'cucumber-messages', '> 25', '< 30'

		s.add_development_dependency 'cucumber', '~> 10.1'

Uh oh!

Uh oh!

Conversation

luke-hill commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🤔 What's changed?

⚡️ What's your motivation?

🏷️ What kind of change is this?

♻️ Anything particular you want feedback on?

Checklist

Uh oh!

mpkorstanje left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

luke-hill commented Sep 5, 2025

Uh oh!

mpkorstanje left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mpkorstanje commented Sep 5, 2025

Uh oh!

mpkorstanje commented Sep 5, 2025

Uh oh!

mpkorstanje left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mpkorstanje Jul 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

luke-hill commented Jul 1, 2026

Uh oh!

luke-hill commented Jul 9, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

luke-hill commented Sep 5, 2025 •

edited

Loading

mpkorstanje left a comment •

edited

Loading

mpkorstanje Jul 13, 2026 •

edited

Loading