Ruby implementation

.github/workflows/release-rubygem.yaml

@@ -0,0 +1,29 @@
+name: Release RubyGems
+
+permissions: {}
+
+on:
+  push:
+    branches:
+      - release/*
+
+jobs:
+  publish-rubygem:
+    name: Publish Ruby Gem
+    runs-on: ubuntu-latest
+    environment: Release
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+        with:
+          persist-credentials: false
+      - uses: ruby/setup-ruby@9eb537ca036ebaed86729dcb9309076e4c5c3b74 # v1.314.0
+        with:
+          ruby-version: 4.0.5
+          working-directory: ruby
+      - uses: rubygems/configure-rubygems-credentials@dc5a8d8553e6ee01fc26761a49e99e733d17954a # v2.1.0
+      - uses: cucumber/action-publish-rubygem@4e79bb9aed597c835e8438f57c04d0996ab80d72 # v2.0.0
+        with:
+          working-directory: ruby

.github/workflows/test-ruby.yaml

@@ -0,0 +1,48 @@
+name: test-ruby
+
+permissions: {}
+
+on:
+  push:
+    branches:
+      - main
+      - renovate/**
+    paths:
+      - ruby/**
+      - testdata/**
+      - .github/**
+  pull_request:
+    branches:
+      - main
+      - renovate/**
+    paths:
+      - ruby/**
+      - testdata/**
+      - .github/**
+
+jobs:
+  test-ruby:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os:
+          - ubuntu-latest
+        ruby: ['3.3', '3.4', '4.0']
+        include:
+          - os: macos-latest
+            ruby: '4.0'
+          - os: windows-latest
+            ruby: '4.0'
+
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+      - uses: ruby/setup-ruby@6aaa311d81eba98ae12eaffbcb63296ace0efcde # v1.307.0
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          working-directory: ruby
+      - run: bundle exec rspec
+        working-directory: ruby

CHANGELOG.md

@@ -6,6 +6,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+### Added
+- [Ruby] Add initial Ruby implementation and RubyGems release workflow, covering the needs of the rerun formatter only for now ([#98](https://github.com/cucumber/query/pull/98))
+
 ### Changed
 - Prefer Pickle.Location with fallback to Lineage ([#175](https://github.com/cucumber/query/pull/175))
 

README.md

@@ -14,6 +14,9 @@
   <a href="https://central.sonatype.com/artifact/io.cucumber/query">
     <img src="https://img.shields.io/maven-central/v/io.cucumber/query.svg?label=Maven%20Central&color=dark-green" alt="maven-central">
   </a>
+  <a href="https://rubygems.org/gems/cucumber-query">
+    <img src="https://img.shields.io/gem/v/cucumber-query.svg?color=dark-green" alt="rubygems">
+  </a>
   <a href="https://github.com/cucumber/query/actions/workflows/release-github.yaml">
     <img src="https://github.com/cucumber/query/actions/workflows/release-github.yaml/badge.svg" alt="build">
   </a>
@@ -38,3 +41,4 @@ is rendering the [GherkinDocument](https://github.com/cucumber/messages/blob/mai
 
 The Query library makes this easy by providing a function to look up the
 status of a step, a scenario or an entire file.
+

ruby/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+*.gem

ruby/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

ruby/.rubocop.yml

@@ -0,0 +1,21 @@
+inherit_from: .rubocop_todo.yml
+
+plugins:
+  - rubocop-performance
+  - rubocop-rspec
+
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+
+# Stylistic preference for cucumber
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+# Disabled on our repo's to enable polyglot-release
+Gemspec/RequireMFA:
+  Enabled: false

ruby/.rubocop_todo.yml

@@ -0,0 +1,133 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-09-05 19:34:38 UTC using RuboCop version 1.80.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
+Layout/EmptyLinesAroundModuleBody:
+  Exclude:
+    - 'spec/support/runner_helper.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'spec/cucumber/query/legacy/step_definitions_by_test_step_spec.rb'
+
+# Offense count: 8
+# Configuration parameters: AllowComments, AllowEmptyLambdas.
+Lint/EmptyBlock:
+  Exclude:
+    - 'spec/cucumber/query/legacy/hook_by_test_step_spec.rb'
+    - 'spec/cucumber/query/legacy/step_definitions_by_test_step_spec.rb'
+
+# Offense count: 8
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods, NotImplementedExceptions.
+# NotImplementedExceptions: NotImplementedError
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/cucumber/query/query.rb'
+
+# Offense count: 4
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 43
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 14
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/ClassLength:
+  Max: 160
+
+# Offense count: 3
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 24
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 14
+
+# Offense count: 8
+Performance/MethodObjectAsBlock:
+  Exclude:
+    - 'lib/cucumber/query/legacy/hook_by_test_step.rb'
+    - 'lib/cucumber/query/legacy/pickle_by_test.rb'
+    - 'lib/cucumber/query/legacy/pickle_step_by_test_step.rb'
+    - 'lib/cucumber/query/legacy/step_definitions_by_test_step.rb'
+    - 'lib/cucumber/query/legacy/test_case_started_by_test_case.rb'
+
+# Offense count: 1
+# Configuration parameters: Prefixes, AllowedPatterns.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/cucumber/query/legacy/hook_by_test_step_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 7
+
+# Offense count: 32
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/cucumber/query/legacy/hook_by_test_step_spec.rb'
+    - 'spec/cucumber/query/legacy/pickle_by_test_spec.rb'
+    - 'spec/cucumber/query/legacy/pickle_step_by_test_step_spec.rb'
+    - 'spec/cucumber/query/legacy/step_definitions_by_test_step_spec.rb'
+    - 'spec/cucumber/query/legacy/test_case_started_by_test_case_spec.rb'
+
+# Offense count: 3
+RSpec/MultipleExpectations:
+  Max: 3
+
+# Offense count: 12
+# Configuration parameters: AllowedGroups.
+RSpec/NestedGroups:
+  Max: 5
+
+# Offense count: 8
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'lib/cucumber/query/helpers.rb'
+    - 'lib/cucumber/query/legacy/hook_by_test_step.rb'
+    - 'lib/cucumber/query/legacy/pickle_by_test.rb'
+    - 'lib/cucumber/query/legacy/pickle_step_by_test_step.rb'
+    - 'lib/cucumber/query/legacy/step_definitions_by_test_step.rb'
+    - 'lib/cucumber/query/legacy/test_case_started_by_test_case.rb'
+    - 'lib/cucumber/query/legacy/test_run_started.rb'
+    - 'lib/cucumber/query/query.rb'
+
+# Offense count: 4
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'lib/cucumber/query/helpers.rb'
+    - 'lib/cucumber/query/query.rb'
+    - 'spec/support/gherkin_helper.rb'
+    - 'spec/support/runner_helper.rb'
+
+# Offense count: 8
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 198

ruby/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

ruby/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Cucumber Ltd and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ruby/VERSION

@@ -0,0 +1 @@
+16.0.0

ruby/cucumber-query.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name        = 'cucumber-query'
+  s.version     = File.read(File.expand_path('VERSION', __dir__)).strip
+  s.authors     = ['Luke Hill']
+  s.description = 'Cucumber Query - query messages'
+  s.summary     = "#{s.name}-#{s.version}"
+  s.email       = 'cukebot@cucumber.io'
+  s.homepage    = 'https://github.com/cucumber/query'
+  s.platform    = Gem::Platform::RUBY
+  s.license     = 'MIT'
+  s.required_ruby_version = '>= 3.3'
+  s.required_rubygems_version = '>= 3.2.8'
+
+  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/README.md',
+    'mailing_list_uri' => 'https://groups.google.com/forum/#!forum/cukes',
+    'source_code_uri' => 'https://github.com/cucumber/query/blob/main/ruby'
+  }
+
+  s.add_dependency 'cucumber-messages', '> 34', '< 36'
+
+  s.add_development_dependency 'rspec', '~> 3.13'
+  s.add_development_dependency 'rubocop', '~> 1.88.0'
+  s.add_development_dependency 'rubocop-performance', '~> 1.26.1'
+  s.add_development_dependency 'rubocop-rspec', '~> 3.10.2'
+
+  s.files            = Dir['LICENSE', 'VERSION', 'lib/**/*']
+  s.rdoc_options     = ['--charset=UTF-8']
+  s.require_path     = 'lib'
+end