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

luke-hill

12/18 files marked as good. Few minor comments

luke-hill · 2026-06-16T14:25:07Z

+        ruby: ['3.2', '3.3', '3.4', '3.5']
+        include:
+          - os: macos-latest
+            ruby: '3.4'


4.0 here and for all single ruby variants

luke-hill · 2026-06-16T14:26:10Z

@@ -0,0 +1,75 @@
+PATH


This file needs gitignoring

luke-hill · 2026-06-16T14:26:43Z

@@ -0,0 +1 @@
+15.0.1


This numbers seems wrong. But I believe this shouldn't matter @mpkorstanje as it'll be overwritten on the next polyglot-release we call?

luke-hill

Items previously mentioned for review @mpkorstanje

luke-hill · 2026-06-16T14:29:31Z

+
+    # This method will be called with 1 of these 2 messages
+    #   [TestCaseStarted || TestCaseFinished]
+    def find_most_severe_test_step_result_by(message)


@mpkorstanje - Method 1 to review as/when you have time

luke-hill · 2026-06-16T14:29:43Z

+
+    # This method will be called with 1 of these 5 messages
+    #   [TestCase || TestCaseStarted || TestCaseFinished || TestStepStarted || TestStepFinished]
+    def find_pickle_by(message)


@mpkorstanje - Method 2 to review as/when you have time

luke-hill · 2026-06-16T14:30:44Z

+      end
+    end
+
+    def update_gherkin_document(gherkin_document)


@mpkorstanje this is the only part of the repository update I think you need to review.

We previously spoke of Lineages but I think this is now considered good.

luke-hill · 2026-06-16T14:33:04Z

+    }.freeze
+    private_constant :UPDATE_HANDLERS
+
+    def update(envelope)


Note to self / @mattwynne

I'm proposing to write a small amount of custom code inside the Envelope message that'll return a type. Which should then make this a bit simpler/less metaprogrammy

luke-hill · 2026-06-16T14:34:20Z

+      repository.test_case_finished_by_test_case_started_id[test_case_started.id]
+    end
+
+    def find_test_run_duration


@mpkorstanje - This one I think can be ignored for review, but I had it flagged. Would be good to know if we have some edge case specs for this where the missing values are there.

Co-authored-by: Luke Hill <20105237+luke-hill@users.noreply.github.com>

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

mattwynne added 5 commits June 13, 2026 13:41

Move Ruby query implementation into gem

df0df56

Fix Ruby query packaging and test step lookup

d238b78

Add Ruby CI and release workflow

18b10c8

Align Ruby gem version

367300f

Update Ruby lockfile version

4c70e37

mattwynne force-pushed the feature/ruby_implementation branch from eeb238d to 4c70e37 Compare June 13, 2026 20:42

github-advanced-security AI found potential problems Jun 13, 2026

View reviewed changes

mattwynne added 2 commits June 13, 2026 14:08

Update changelog for Ruby implementation

004ccfa

Pin Ruby workflow actions

0ff633e

github-advanced-security AI found potential problems Jun 13, 2026

View reviewed changes

Comment thread .github/workflows/release-rubygem.yaml Fixed

mattwynne and others added 4 commits June 13, 2026 14:12

Disable bundler cache in Ruby release workflow

05cba61

Add RubyGems badge

7b446a7

Tidy Ruby query implementation

ca2efd2

Merge branch 'main' into feature/ruby_implementation

e98f91f

mattwynne marked this pull request as ready for review June 13, 2026 21:43

luke-hill commented Jun 16, 2026

View reviewed changes

mpkorstanje self-requested a review June 16, 2026 15:11

Update .github/workflows/test-ruby.yml

171185e

Co-authored-by: Luke Hill <20105237+luke-hill@users.noreply.github.com>


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

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

		@@ -0,0 +1 @@
		15.0.1

Uh oh!

Conversation

luke-hill commented Sep 5, 2025 • edited by mattwynne 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

luke-hill left a comment

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!

luke-hill left a comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

luke-hill commented Sep 5, 2025 •

edited by mattwynne

Loading

mpkorstanje left a comment •

edited

Loading