cucumber 9.0.1 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad3c44ae94fec4bd2debdacbc00a745da83659ca8f1580342c33da089137b7d1
-  data.tar.gz: 4c62a3b49d680e3a79e7584e8a985a5c1fb327db9e4d9dcd227ea3c025129520
+  metadata.gz: 757154e702f016f75cb37fc68451c18a9a9e742957a197055e127cbe5ebefac6
+  data.tar.gz: '010178d0bb40315be3e1c0923c569ec9f5a8d4684da6446b7a396c45da03371c'
 SHA512:
-  metadata.gz: 61a3cb620e77ea2f31e5261fa4c00e3051d812cad99795fe19ecd3374d4de8361e3312ad8bf9eae1e28ef103f399ab015188b0471530483c61665320c55d4b49
-  data.tar.gz: 12dbf85b1b6e6e17b00746250ed00306b72b18e1e4bde4a3f559a650adb6a3be3998f8d28523cbe7db55b329643c7efb288e4874714cacd8c22a3d16bdea340a
+  metadata.gz: f9c2e02d96f40e5564643f994be4cb5ac6bc5f36849551d5a5f102225a4e62526efabf00d14b961f59a954fdf41345f06c45c4469913bfae93d775c33ac2f5e0
+  data.tar.gz: c20336a8e85dc299322e0a5cd92ba39fc7b5091195d7003b26ed014d58a3dfeb2ae8f0be6a88a6f26238589dc15acb40103049d49415431e075a1bcda4f86487

data/README.md

@@ -1,15 +1,11 @@
-<p align="center">
-  <img src="./.github/img/cucumber-open-logo.png" alt="Cucumber Open - Supported by Smartbear" width="428" />
-</p>
+<img src="docs/img/cucumber-open-logo.png" alt="Cucumber Open - Supported by Smartbear" width="428" />
 
 # Cucumber
 
 [![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://vshymanskyy.github.io/StandWithUkraine)
 [![OpenCollective](https://opencollective.com/cucumber/backers/badge.svg)](https://opencollective.com/cucumber)
 [![OpenCollective](https://opencollective.com/cucumber/sponsors/badge.svg)](https://opencollective.com/cucumber)
-[![pull requests](https://oselvar.com/api/badge?label=pull%20requests&csvUrl=https%3A%2F%2Fraw.githubusercontent.com%2Fcucumber%2Foselvar-github-metrics%2Fmain%2Fdata%2Fcucumber%2Fcucumber-ruby%2FpullRequests.csv)](https://oselvar.com/github/cucumber/oselvar-github-metrics/main/cucumber/cucumber-ruby)
-[![issues](https://oselvar.com/api/badge?label=issues&csvUrl=https%3A%2F%2Fraw.githubusercontent.com%2Fcucumber%2Foselvar-github-metrics%2Fmain%2Fdata%2Fcucumber%2Fcucumber-ruby%2Fissues.csv)](https://oselvar.com/github/cucumber/oselvar-github-metrics/main/cucumber/cucumber-ruby)
-[![Test cucumber](https://github.com/cucumber/cucumber-ruby/actions/workflows/cucumber-ruby.yml/badge.svg)](https://github.com/cucumber/cucumber-ruby/actions/workflows/cucumber-ruby.yml)
+[![Test cucumber](https://github.com/cucumber/cucumber-ruby/actions/workflows/test.yaml/badge.svg)](https://github.com/cucumber/cucumber-ruby/actions/workflows/test.yaml)
 [![Code Climate](https://codeclimate.com/github/cucumber/cucumber-ruby.svg)](https://codeclimate.com/github/cucumber/cucumber-ruby)
 [![Coverage Status](https://coveralls.io/repos/cucumber/cucumber-ruby/badge.svg?branch=main)](https://coveralls.io/r/cucumber/cucumber-ruby?branch=main)
 
@@ -18,9 +14,7 @@ written in plain language, they can be read by anyone on your team. Because they
 read by anyone, you can use them to help improve communication, collaboration and trust on
 your team.
 
-<p align="center">
-  <img src="./.github/img/gherkin-example.png" alt="Cucumber Gherkin Example" width="728" />
-</p>
+<img src="docs/img/gherkin-example.png" alt="Cucumber Gherkin Example" width="728" />
 
 This is the Ruby implementation of Cucumber. Cucumber is also available for [JavaScript](https://github.com/cucumber/cucumber-js),
 [Java](https://github.com/cucumber/cucumber-jvm), and a lot of other languages. You can find a list of implementations here: https://cucumber.io/docs/installation/.
@@ -56,13 +50,11 @@ Later in this document, bundler is considered being used so all commands are usi
 - Ruby 3.0
 - Ruby 2.7
 - TruffleRuby 22.0.0+
-- JRuby (with [some limitations](https://github.com/cucumber/cucumber-ruby/blob/main/docs/jruby-limitations.md))
-  - 9.4
+- JRuby 9.4+ (with [some limitations](https://github.com/cucumber/cucumber-ruby/blob/main/docs/jruby-limitations.md))
 
 ### Ruby on Rails
 
-Using Ruby on Rails? You can use [cucumber-rails](https://github.com/cucumber/cucumber-rails)
-to bring Cucumber into your Rails project.
+Using Ruby on Rails? You can use [cucumber-rails](https://github.com/cucumber/cucumber-rails) to bring Cucumber into your Rails project.
 
 ## Usage
 
@@ -109,19 +101,20 @@ And a file named `steps.rb` in `features/step_definitions` with:
 ```ruby
 # features/step_definitions/steps.rb
 
-Given("this will pass") do
+Given('this will pass') do
   @this_will_pass = true
 end
 
-Given("this will fail") do
+Given('this will fail') do
   @this_will_pass = false
 end
 
-When("I do an action") do
+When('I do an action') do
+  :no_op
 end
 
 Then("some results should be there") do
-  expect(@this_will_pass)
+  expect(@this_will_pass).to be true
 end
 ```
 
@@ -135,9 +128,9 @@ To execute a single feature file:
 
 To execute a single example, indicates the line of the name of the example:
 
-    $ bundle exec cucumber features/rule.feature:7
+    $ bundle exec cucumber features/rule.feature:5
 
-To summarize the results on the standard output, and writte a HTML report on disk:
+To summarize the results on the standard output, and generate a HTML report on disk:
 
     $ bundle exec cucumber --format summary --format html --out report.html
 
@@ -145,8 +138,7 @@ For more command line options
 
     $ bundle exec cucumber --help
 
-You can also find documentation on the command line possibilities in
-[features/docs/cli](features/docs/cli).
+You can also find documentation on the command line possibilities in [features/docs/cli](features/docs/cli).
 
 ## Documentation and support
 

data/VERSION

@@ -1 +1 @@
-9.0.1
+9.1.0

data/lib/cucumber/cli/options.rb

@@ -50,13 +50,13 @@ module Cucumber
       FORMAT_HELP = (BUILTIN_FORMATS.keys.sort.map do |key|
         "  #{key}#{' ' * (max - key.length)} : #{BUILTIN_FORMATS[key][1]}"
       end) + FORMAT_HELP_MSG
-      PROFILE_SHORT_FLAG = '-p'.freeze
-      NO_PROFILE_SHORT_FLAG = '-P'.freeze
-      PROFILE_LONG_FLAG = '--profile'.freeze
-      NO_PROFILE_LONG_FLAG = '--no-profile'.freeze
-      FAIL_FAST_FLAG = '--fail-fast'.freeze
-      RETRY_FLAG = '--retry'.freeze
-      RETRY_TOTAL_FLAG = '--retry-total'.freeze
+      PROFILE_SHORT_FLAG = '-p'
+      NO_PROFILE_SHORT_FLAG = '-P'
+      PROFILE_LONG_FLAG = '--profile'
+      NO_PROFILE_LONG_FLAG = '--no-profile'
+      FAIL_FAST_FLAG = '--fail-fast'
+      RETRY_FLAG = '--retry'
+      RETRY_TOTAL_FLAG = '--retry-total'
       OPTIONS_WITH_ARGS = [
         '-r', '--require', '--i18n-keywords', '-f', '--format', '-o',
         '--out', '-t', '--tags', '-n', '--name', '-e', '--exclude',
@@ -64,7 +64,7 @@ module Cucumber
         '-l', '--lines', '--port', '-I', '--snippet-type'
       ].freeze
       ORDER_TYPES = %w[defined random].freeze
-      TAG_LIMIT_MATCHER = /(?<tag_name>@\w+):(?<limit>\d+)/x
+      TAG_LIMIT_MATCHER = /(?<tag_name>@\w+):(?<limit>\d+)/x.freeze
 
       def self.parse(args, out_stream, error_stream, options = {})
         new(out_stream, error_stream, options).parse!(args)

data/lib/cucumber/deprecate.rb

@@ -4,52 +4,11 @@ require 'cucumber/platform'
 require 'cucumber/gherkin/formatter/ansi_escapes'
 
 module Cucumber
-  module Deprecate
-    class AnsiString
-      include Cucumber::Gherkin::Formatter::AnsiEscapes
-
-      def self.failure_message(message)
-        AnsiString.new.failure_message(message)
-      end
-
-      def failure_message(message)
-        failed + message + reset
-      end
-    end
-
-    class CliOption
-      def self.deprecate(stream, option, message, remove_after_version)
-        return if stream.nil?
-
-        stream.puts(
-          AnsiString.failure_message(
-            "\nWARNING: #{option} is deprecated" \
-            " and will be removed after version #{remove_after_version}.\n#{message}.\n"
-          )
-        )
-      end
-    end
-
-    module ForUsers
-      def self.call(message, method, remove_after_version)
-        $stderr.puts AnsiString.failure_message(
-          "\nWARNING: ##{method} is deprecated" \
-          " and will be removed after version #{remove_after_version}. #{message}.\n" \
-          "(Called from #{caller(3..3).first})"
-        )
-      end
-    end
-
-    module ForDevelopers
-      def self.call(_message, _method, remove_after_version)
-        raise "This method is due for removal after version #{remove_after_version}" if Cucumber::VERSION >= remove_after_version
-      end
-    end
-
-    STRATEGY = $PROGRAM_NAME =~ /rspec$/ ? ForDevelopers : ForUsers
-  end
-
-  def self.deprecate(*args)
-    Deprecate::STRATEGY.call(*args)
+  def self.deprecate(message, method, remove_after_version)
+    $stderr.puts(
+      "\nWARNING: ##{method} is deprecated" \
+        " and will be removed after version #{remove_after_version}. #{message}.\n" \
+        "(Called from #{caller(3..3).first})"
+    )
   end
 end

data/lib/cucumber/errors.rb

@@ -35,7 +35,8 @@ module Cucumber
   # Raised when a step matches 2 or more StepDefinitions
   class Ambiguous < StandardError
     def initialize(step_name, step_definitions, used_guess)
-      message = String.new # rubocop:disable Style/EmptyLiteral
+      # TODO: [LH] - Just use a heredoc here to fix this up
+      message = String.new
       message << "Ambiguous match of \"#{step_name}\":\n\n"
       message << step_definitions.map(&:backtrace_line).join("\n")
       message << "\n\n"

data/lib/cucumber/events/envelope.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/core/events'
 
 module Cucumber

data/lib/cucumber/events/gherkin_source_parsed.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/core/events'
 
 module Cucumber

data/lib/cucumber/events/gherkin_source_read.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/core/events'
 
 module Cucumber

data/lib/cucumber/events/test_case_finished.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/core/events'
 
 module Cucumber

data/lib/cucumber/events/test_case_started.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/core/events'
 
 module Cucumber

data/lib/cucumber/events/test_step_finished.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/core/events'
 
 module Cucumber

data/lib/cucumber/events/test_step_started.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/core/events'
 
 module Cucumber

data/lib/cucumber/events/undefined_parameter_type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/core/events'
 
 module Cucumber

data/lib/cucumber/file_specs.rb

@@ -5,7 +5,7 @@ require 'cucumber/core/test/location'
 
 module Cucumber
   class FileSpecs
-    FILE_COLON_LINE_PATTERN = /^([\w\W]*?)(?::([\d:]+))?$/ # :nodoc:
+    FILE_COLON_LINE_PATTERN = /^([\w\W]*?)(?::([\d:]+))?$/.freeze # :nodoc:
 
     def initialize(file_specs)
       Cucumber.logger.debug("Features:\n")

data/lib/cucumber/formatter/ast_lookup.rb

@@ -112,16 +112,24 @@ module Cucumber
             if child.respond_to?(:rule) && child.rule
               process_scenario_container(child.rule)
             elsif child.respond_to?(:scenario) && child.scenario
-              child.scenario.steps.each do |step|
-                @lookup_hash[step.location.line] = StepSource.new(:Step, step)
-              end
+              store_scenario_source_steps(child.scenario)
             elsif !child.background.nil?
-              child.background.steps.each do |step|
-                @lookup_hash[step.location.line] = StepSource.new(:Step, step)
-              end
+              store_background_source_steps(child.background)
             end
           end
         end
+
+        def store_scenario_source_steps(scenario)
+          scenario.steps.each do |step|
+            @lookup_hash[step.location.line] = StepSource.new(:Step, step)
+          end
+        end
+
+        def store_background_source_steps(background)
+          background.steps.each do |step|
+            @lookup_hash[step.location.line] = StepSource.new(:Step, step)
+          end
+        end
       end
 
       KeywordSearchNode = Struct.new(:keyword, :previous_node)

data/lib/cucumber/formatter/console.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/ModuleLength
-
 require 'cucumber/formatter/ansicolor'
 require 'cucumber/formatter/duration'
 require 'cucumber/gherkin/i18n'
@@ -48,7 +46,7 @@ module Cucumber
       def format_string(o, status)
         fmt = format_for(status)
         o.to_s.split("\n").map do |line|
-          if Proc == fmt.class
+          if fmt.instance_of?(Proc)
             fmt.call(line)
           else
             fmt % line
@@ -108,7 +106,7 @@ module Cucumber
 
       # http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/10655
       def linebreaks(msg, max)
-        return msg unless max && max > 0
+        return msg unless max.positive?
 
         msg.gsub(/.{1,#{max}}(?:\s|\Z)/) do
           (Regexp.last_match(0) + 5.chr).gsub(/\n\005/, "\n").gsub(/\005/, "\n")
@@ -171,12 +169,17 @@ module Cucumber
         end
       end
 
-      def attach(src, media_type)
+      def attach(src, media_type, filename)
         return unless media_type == 'text/x.cucumber.log+plain'
         return unless @io
 
         @io.puts
-        @io.puts(format_string(src, :tag))
+        if filename
+          @io.puts("#{filename}: #{format_string(src, :tag)}")
+        else
+          @io.puts(format_string(src, :tag))
+        end
+
         @io.flush
       end
 
@@ -262,4 +265,3 @@ module Cucumber
     end
   end
 end
-# rubocop:enable Metrics/ModuleLength

data/lib/cucumber/formatter/console_counts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/console'
 
 module Cucumber
@@ -30,7 +32,7 @@ module Cucumber
 
       def status_counts(summary)
         counts = Core::Test::Result::TYPES.map { |status| [status, summary.total(status)] }
-        counts = counts.select { |_status, count| count > 0 }
+        counts = counts.select { |_status, count| count.positive? }
         counts = counts.map { |status, count| format_string("#{count} #{status}", status) }
         "(#{counts.join(', ')})" if counts.any?
       end

data/lib/cucumber/formatter/console_issues.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/console'
 
 module Cucumber

data/lib/cucumber/formatter/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cucumber
   module Formatter
     class TestCaseUnknownError < StandardError; end

data/lib/cucumber/formatter/html.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/io'
 require 'cucumber/html_formatter'
 require 'cucumber/formatter/message_builder'

data/lib/cucumber/formatter/http_io.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'tempfile'
 require 'shellwords'

data/lib/cucumber/formatter/json.rb

@@ -85,7 +85,7 @@ module Cucumber
         @io.write(JSON.pretty_generate(@feature_hashes))
       end
 
-      def attach(src, mime_type)
+      def attach(src, mime_type, _filename)
         if mime_type == 'text/x.cucumber.log+plain'
           test_step_output << src
           return

data/lib/cucumber/formatter/message_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'base64'
 require 'cucumber/formatter/backtrace_filter'
 require 'cucumber/formatter/query/hook_by_test_step'
@@ -40,11 +42,12 @@ module Cucumber
         raise 'To be implemented'
       end
 
-      def attach(src, media_type)
+      def attach(src, media_type, filename)
         attachment_data = {
           test_step_id: @current_test_step_id,
           test_case_started_id: @current_test_case_started_id,
-          media_type: media_type
+          media_type: media_type,
+          file_name: filename
         }
 
         if media_type.start_with?('text/')
@@ -190,10 +193,13 @@ module Cucumber
 
         result_message = result.to_message
         if result.failed? || result.pending?
+          message_element = result.failed? ? result.exception : result
+
           result_message = Cucumber::Messages::TestStepResult.new(
             status: result_message.status,
             duration: result_message.duration,
-            message: create_error_message(result)
+            message: create_error_message(message_element),
+            exception: create_exception_object(result, message_element)
           )
         end
 
@@ -209,12 +215,17 @@ module Cucumber
         output_envelope(message)
       end
 
-      def create_error_message(result)
-        message_element = result.failed? ? result.exception : result
+      def create_error_message(message_element)
         message = "#{message_element.message} (#{message_element.class})"
         ([message] + message_element.backtrace).join("\n")
       end
 
+      def create_exception_object(result, message_element)
+        return unless result.failed?
+
+        Cucumber::Messages::Exception.from_h({ type: message_element.class, message: message_element.message })
+      end
+
       def on_test_case_finished(event)
         message = Cucumber::Messages::Envelope.new(
           test_case_finished: Cucumber::Messages::TestCaseFinished.new(

data/lib/cucumber/formatter/pretty.rb

@@ -19,7 +19,7 @@ module Cucumber
     #
     # If the output is STDOUT (and not a file), there are bright colours to watch too.
     #
-    class Pretty # rubocop:disable Metrics/ClassLength
+    class Pretty
       include FileUtils
       include Console
       include Io
@@ -140,10 +140,14 @@ module Cucumber
         print_summary
       end
 
-      def attach(src, media_type)
+      def attach(src, media_type, filename)
         return unless media_type == 'text/x.cucumber.log+plain'
 
-        @test_step_output.push src
+        if filename
+          @test_step_output.push("#{filename}: #{src}")
+        else
+          @test_step_output.push(src)
+        end
       end
 
       private

data/lib/cucumber/formatter/publish_banner_printer.rb

@@ -15,7 +15,6 @@ module Cucumber
         end
       end
 
-      # rubocop:disable Metrics/MethodLength
       def display_publish_ad(io)
         display_banner(
           [
@@ -59,7 +58,6 @@ module Cucumber
           io
         )
       end
-      # rubocop:enable Metrics/MethodLength
 
       def highlight(text)
         [text, :cyan]

data/lib/cucumber/formatter/query/hook_by_test_step.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/errors'
 
 module Cucumber

data/lib/cucumber/formatter/query/pickle_by_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/errors'
 
 module Cucumber

data/lib/cucumber/formatter/query/pickle_step_by_test_step.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/errors'
 
 module Cucumber

data/lib/cucumber/formatter/query/step_definitions_by_test_step.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/errors'
 
 module Cucumber

data/lib/cucumber/formatter/query/test_case_started_by_test_case.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/errors'
 
 module Cucumber

data/lib/cucumber/formatter/unicode.rb

@@ -10,13 +10,13 @@ if Cucumber::WINDOWS
     Cucumber::CODEPAGE = ENV['CUCUMBER_OUTPUT_ENCODING']
   elsif `cmd /c chcp` =~ /(\d+)/
     if [65_000, 65_001].include? Regexp.last_match(1).to_i
-      Cucumber::CODEPAGE = 'UTF-8'.freeze
+      Cucumber::CODEPAGE = 'UTF-8'
       ENV['ANSICON_API'] = 'ruby'
     else
-      Cucumber::CODEPAGE = "cp#{Regexp.last_match(1).to_i}".freeze
+      Cucumber::CODEPAGE = "cp#{Regexp.last_match(1).to_i}"
     end
   else
-    Cucumber::CODEPAGE = 'cp1252'.freeze
+    Cucumber::CODEPAGE = 'cp1252'
     $stderr.puts("WARNING: Couldn't detect your output codepage. Assuming it is 1252. You may have to chcp 1252 or SET CUCUMBER_OUTPUT_ENCODING=cp1252.")
   end
 

data/lib/cucumber/formatter/url_reporter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cucumber
   module Formatter
     class URLReporter

data/lib/cucumber/gherkin/formatter/ansi_escapes.rb

@@ -67,11 +67,10 @@ module Cucumber
           'tag'       => 'cyan'
         )
 
-        if ENV['GHERKIN_COLORS'] # Example: export GHERKIN_COLORS="passed=red:failed=yellow"
-          ENV['GHERKIN_COLORS'].split(':').each do |pair|
-            a = pair.split('=')
-            ALIASES[a[0]] = a[1]
-          end
+        # Example: export GHERKIN_COLORS="passed=red:failed=yellow"
+        ENV.fetch('GHERKIN_COLORS', '').split(':').each do |pair|
+          rule, colour = pair.split('=')
+          ALIASES[colour] = rule
         end
 
         ALIASES.each_key do |key|

data/lib/cucumber/glue/invoke_in_world.rb

@@ -28,7 +28,7 @@ module Cucumber
           if check_arity && !cucumber_compatible_arity?(args, block)
             world.instance_exec do
               ari = block.arity
-              ari = ari < 0 ? "#{ari.abs - 1}+" : ari
+              ari = ari.negative? ? "#{ari.abs - 1}+" : ari
               s1 = ari == 1 ? '' : 's'
               s2 = args.length == 1 ? '' : 's'
               raise ArityMismatchError, "Your block takes #{ari} argument#{s1}, but the Regexp matched #{args.length} argument#{s2}."

data/lib/cucumber/glue/proto_world.rb

@@ -7,7 +7,7 @@ require 'mini_mime'
 
 module Cucumber
   module Glue
-    # Defines the basic API methods availlable in all Cucumber step definitions.
+    # Defines the basic API methods available in all Cucumber step definitions.
     #
     # You can, and probably should, extend this API with your own methods that
     # make sense in your domain. For more on that, see {Cucumber::Glue::Dsl#World}
@@ -26,7 +26,7 @@ module Cucumber
       # @example Passing a multiline string
       #   step "the email should contain:", "Dear sir,\nYou've won a prize!\n"
       # @param [String] name The name of the step
-      # @param [String,Cucumber::Test::DocString,Cucumber::Ast::Table] multiline_argument
+      # @param [String, Cucumber::Test::DocString, Cucumber::Ast::Table] raw_multiline_arg
       def step(name, raw_multiline_arg = nil)
         super
       end
@@ -84,17 +84,19 @@ module Cucumber
 
       # Attach a file to the output
       # @param file [string|io] the file to attach.
-      #   It can be a string containing the file content itself,
-      #   the file path, or an IO ready to be read.
-      # @param media_type [string] the media type. If file is a valid path,
-      #   media_type can be ommitted, it will then be inferred from the file name.
-      def attach(file, media_type = nil)
+      #   It can be a string containing the file content itself, the file path, or an IO ready to be read.
+      # @param media_type [string] the media type.
+      #   If file is a valid path, media_type can be omitted, it will then be inferred from the file name.
+      # @param filename [string] the name of the file you wish to specify.
+      #   This is only needed in situations where you want to rename a PDF download e.t.c. - In most situations
+      #   you should not need to pass a filename
+      def attach(file, media_type = nil, filename = nil)
         return super unless File.file?(file)
 
         content = File.read(file, mode: 'rb')
         media_type = MiniMime.lookup_by_filename(file)&.content_type if media_type.nil?
 
-        super(content, media_type.to_s)
+        super(content, media_type.to_s, filename)
       rescue StandardError
         super
       end
@@ -103,12 +105,9 @@ module Cucumber
       def pending(message = 'TODO')
         raise Pending, message unless block_given?
 
-        begin
-          yield
-        rescue Exception # rubocop:disable Lint/RescueException
-          raise Pending, message
-        end
-        raise Pending, "Expected pending '#{message}' to fail. No Error was raised. No longer pending?"
+        yield
+      rescue Exception
+        raise Pending, message
       end
 
       # Skips this step and the remaining steps in the scenario
@@ -126,9 +125,9 @@ module Cucumber
         inspect
       end
 
-      # Dynamially generate the API module, closuring the dependencies
-      def self.for(runtime, language) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
-        Module.new do # rubocop:disable Metrics/BlockLength
+      # Dynamically generate the API module, closuring the dependencies
+      def self.for(runtime, language)
+        Module.new do
           def self.extended(object)
             # wrap the dynamically generated module so that we can document the methods
             # for yardoc, which doesn't like define_method.
@@ -156,8 +155,8 @@ module Cucumber
             runtime.ask(question, timeout_seconds)
           end
 
-          define_method(:attach) do |file, media_type|
-            runtime.attach(file, media_type)
+          define_method(:attach) do |file, media_type, filename|
+            runtime.attach(file, media_type, filename)
           end
 
           # Prints the list of modules that are included in the World
@@ -172,14 +171,12 @@ module Cucumber
 
           private
 
-          # @private
           def add_world_modules!(modules)
             modules.each do |world_module|
               extend(world_module)
             end
           end
 
-          # @private
           def add_namespaced_modules!(modules)
             @__namespaced_modules = modules
             modules.each do |namespace, world_modules|
@@ -199,7 +196,6 @@ module Cucumber
             end
           end
 
-          # @private
           def stringify_namespaced_modules
             return '' if @__namespaced_modules.nil?
 
@@ -208,7 +204,6 @@ module Cucumber
         end
       end
 
-      # @private
       AnsiEscapes = Cucumber::Gherkin::Formatter::AnsiEscapes
     end
   end

data/lib/cucumber/glue/registry_and_more.rb

@@ -29,7 +29,8 @@ module Cucumber
     # Raised if there are 2 or more World blocks.
     class MultipleWorld < StandardError
       def initialize(first_proc, second_proc)
-        message = String.new # rubocop:disable Style/EmptyLiteral
+        # TODO: [LH] - Just use a heredoc here to fix this up
+        message = String.new
         message << "You can only pass a proc to #World once, but it's happening\n"
         message << "in 2 places:\n\n"
         message << Glue.backtrace_line(first_proc, 'World') << "\n"
@@ -197,16 +198,19 @@ module Cucumber
       private
 
       def parameter_type_envelope(parameter_type)
-        # TODO: should me moved to Cucumber::Expression::ParameterType#to_envelope ?
+        # TODO: should this be moved to Cucumber::Expression::ParameterType#to_envelope ??
         # Note: that would mean that cucumber-expression would depend on cucumber-messages
-
         Cucumber::Messages::Envelope.new(
           parameter_type: Cucumber::Messages::ParameterType.new(
             id: @configuration.id_generator.new_id,
             name: parameter_type.name,
             regular_expressions: parameter_type.regexps.map(&:to_s),
-            prefer_for_regular_expression_match: parameter_type.prefer_for_regexp_match?,
-            use_for_snippets: parameter_type.use_for_snippets?
+            prefer_for_regular_expression_match: parameter_type.prefer_for_regexp_match,
+            use_for_snippets: parameter_type.use_for_snippets,
+            source_reference: Cucumber::Messages::SourceReference.new(
+              uri: parameter_type.transformer.source_location[0],
+              location: Cucumber::Messages::Location.new(line: parameter_type.transformer.source_location[1])
+            )
           )
         )
       end

data/lib/cucumber/glue/snippet.rb

@@ -61,7 +61,8 @@ module Cucumber
         end
 
         def do_block
-          do_block = String.new # rubocop:disable Style/EmptyLiteral
+          # TODO: [LH] - Just use a heredoc here to fix this up
+          do_block = String.new
           do_block << "do#{parameters}\n"
           multiline_argument.append_comment_to(do_block)
           do_block << "  pending # Write code here that turns the phrase above into concrete actions\n"
@@ -95,7 +96,8 @@ module Cucumber
             "#{prefix}#{code_keyword}('#{expr.source}') do#{parameters(expr)}"
           end.join("\n")
 
-          body = String.new # rubocop:disable Style/EmptyLiteral
+          # TODO: [LH] - Just use a heredoc here to fix this up
+          body = String.new
           multiline_argument.append_comment_to(body)
           body << "  pending # Write code here that turns the phrase above into concrete actions\n"
           body << 'end'

data/lib/cucumber/glue/world_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cucumber
   module Glue
     class WorldFactory

data/lib/cucumber/multiline_argument/data_table/diff_matrices.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cucumber
   module MultilineArgument
     class DataTable

data/lib/cucumber/multiline_argument/data_table.rb

@@ -506,7 +506,7 @@ module Cucumber
       end
 
       def ensure_table(table_or_array) # :nodoc:
-        return table_or_array if DataTable == table_or_array.class
+        return table_or_array if table_or_array.instance_of?(DataTable)
 
         DataTable.from(table_or_array)
       end
@@ -591,7 +591,7 @@ module Cucumber
         end
 
         def ==(other)
-          SurplusCell == other.class || value == other.value
+          other.class == SurplusCell || value == other.value
         end
 
         def eql?(other)

data/lib/cucumber/platform.rb

@@ -1,27 +1,22 @@
 # frozen_string_literal: true
 
-# Detect the platform we're running on so we can tweak behaviour
-# in various places.
+# Detect the platform we're running on so we can tweak behaviour in various places.
 require 'rbconfig'
 require 'cucumber/core/platform'
 
 module Cucumber
-  unless defined?(Cucumber::VERSION)
-    VERSION       = File.read(File.expand_path('../../VERSION', __dir__)).strip
-    BINARY        = File.expand_path("#{File.dirname(__FILE__)}/../../bin/cucumber")
-    LIBDIR        = File.expand_path("#{File.dirname(__FILE__)}/../../lib")
-    RAILS         = defined?(Rails)
-    RUBY_BINARY   = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
-    RUBY          = defined? RUBY_VERSION
+  VERSION       = File.read(File.expand_path('../../VERSION', __dir__)).strip
+  BINARY        = File.expand_path("#{File.dirname(__FILE__)}/../../bin/cucumber")
+  LIBDIR        = File.expand_path("#{File.dirname(__FILE__)}/../../lib")
+  RUBY_BINARY   = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
 
-    class << self
-      attr_accessor :use_full_backtrace
+  class << self
+    attr_accessor :use_full_backtrace
 
-      # @private
-      def file_mode(mode, encoding = 'UTF-8')
-        "#{mode}:#{encoding}"
-      end
+    # @private
+    def file_mode(mode, encoding = 'UTF-8')
+      "#{mode}:#{encoding}"
     end
-    self.use_full_backtrace = false
   end
+  self.use_full_backtrace = false
 end

data/lib/cucumber/rake/task.rb

@@ -2,11 +2,7 @@
 
 require 'cucumber/platform'
 require 'cucumber/gherkin/formatter/ansi_escapes'
-begin
-  # Support Rake > 0.8.7
-  require 'rake/dsl_definition'
-rescue LoadError
-end
+require 'rake/dsl_definition'
 
 module Cucumber
   module Rake

data/lib/cucumber/runtime/for_programming_languages.rb

@@ -7,8 +7,7 @@ module Cucumber
   class Runtime
     # This is what a programming language will consider to be a runtime.
     #
-    # It's a thin class that directs the handul of methods needed by the
-    # programming languages to the right place.
+    # It's a thin class that directs the handful of methods needed by the programming languages to the right place
     class ForProgrammingLanguages
       extend Forwardable
 

data/lib/cucumber/runtime/meta_message_builder.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 require 'cucumber/messages'
 require 'cucumber/ci_environment'
 
 module Cucumber
   class Runtime
-    # Builder to instanciate a Cucumber::Messages::Meta message filled-in with
+    # Builder to instantiate a Cucumber::Messages::Meta message filled-in with
     # the runtime meta-data:
     # - protocol version: the version of the Cucumber::Messages protocol
     # - implementation: the name and version of the implementation (e.g. cucumber-ruby 8.0.0)
     # - runtime: the name and version of the runtime (e.g. ruby 3.0.1)
     # - os: the name and version of the operating system (e.g. linux 3.13.0-45-generic)
     # - cpu: the name of the CPU (e.g. x86_64)
-    # - ci: informtion about the CI environment if any, including:
+    # - ci: information about the CI environment if any, including:
     #   - name: the name of the CI environment (e.g. Jenkins)
     #   - url: the URL of the CI environment (e.g. https://ci.example.com)
     #   - build_number: the build number of the CI environment (e.g. 123)

data/lib/cucumber/runtime/user_interface.rb

@@ -41,8 +41,8 @@ module Cucumber
       # be a path to a file, or if it's an image it may also be a Base64 encoded image.
       # The embedded data may or may not be ignored, depending on what kind of formatter(s) are active.
       #
-      def attach(src, media_type)
-        @visitor.attach(src, media_type)
+      def attach(src, media_type, filename)
+        @visitor.attach(src, media_type, filename)
       end
 
       private

data/lib/cucumber/runtime.rb

@@ -112,7 +112,7 @@ module Cucumber
 
     def failure?
       if @configuration.wip?
-        summary_report.test_cases.total_passed > 0
+        summary_report.test_cases.total_passed.positive?
       else
         !summary_report.ok?(@configuration.strict)
       end
@@ -150,8 +150,8 @@ module Cucumber
     end
 
     class NormalisedEncodingFile
-      COMMENT_OR_EMPTY_LINE_PATTERN = /^\s*#|^\s*$/ # :nodoc:
-      ENCODING_PATTERN = /^\s*#\s*encoding\s*:\s*([^\s]+)/ # :nodoc:
+      COMMENT_OR_EMPTY_LINE_PATTERN = /^\s*#|^\s*$/.freeze # :nodoc:
+      ENCODING_PATTERN = /^\s*#\s*encoding\s*:\s*([^\s]+)/.freeze # :nodoc:
 
       def self.read(path)
         new(path).read

data/lib/cucumber/step_match.rb

@@ -78,7 +78,7 @@ module Cucumber
 
         replacement = if block_given?
                         yield(group.value)
-                      elsif Proc == format.class
+                      elsif format.instance_of?(Proc)
                         format.call(group.value)
                       else
                         format % group.value

data/lib/cucumber/term/ansicolor.rb

@@ -63,7 +63,7 @@ module Cucumber
 
       # Regular expression that is used to scan for ANSI-sequences while
       # uncoloring strings.
-      COLORED_REGEXP = /\e\[(?:[34][0-7]|[0-9])?m/
+      COLORED_REGEXP = /\e\[(?:[34][0-7]|[0-9])?m/.freeze
 
       @coloring = true
 

data/lib/cucumber/term/banner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/term/ansicolor'
 
 module Cucumber

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber
 version: !ruby/object:Gem::Version
-  version: 9.0.1
+  version: 9.1.0
 platform: ruby
 authors:
 - Aslak Hellesøy
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-01 00:00:00.000000000 Z
+date: 2023-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -58,60 +58,48 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 11.0.0
+        version: '12.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 11.0.0
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: cucumber-cucumber-expressions
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '16.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 16.1.2
+        version: '17.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '16.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 16.1.2
+        version: '17.0'
 - !ruby/object:Gem::Dependency
   name: cucumber-gherkin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 23.0.1
+        version: '24'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 26.2.1
+        version: '27'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 23.0.1
+        version: '24'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 26.2.1
+        version: '27'
 - !ruby/object:Gem::Dependency
   name: cucumber-html-formatter
   requirement: !ruby/object:Gem::Requirement
@@ -138,7 +126,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '18'
+        version: '19'
     - - "<"
       - !ruby/object:Gem::Version
         version: '23'
@@ -148,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '18'
+        version: '19'
     - - "<"
       - !ruby/object:Gem::Version
         version: '23'
@@ -238,20 +226,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 9.2.1
+        version: '14.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 9.2.1
+        version: '14.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -272,26 +254,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.13.6
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.14.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -336,16 +298,30 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.43.0
+        version: 1.56.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.56.4
+- !ruby/object:Gem::Dependency
+  name: rubocop-capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.43.0
+        version: 2.19.0
 - !ruby/object:Gem::Dependency
   name: rubocop-packaging
   requirement: !ruby/object:Gem::Requirement
@@ -361,23 +337,45 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.2
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
-    - - ">="
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.24.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
-    - - ">="
+        version: 2.24.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.22.0
 - !ruby/object:Gem::Dependency
@@ -440,26 +438,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.1
-- !ruby/object:Gem::Dependency
-  name: octokit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -689,5 +667,5 @@ requirements: []
 rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
-summary: cucumber-9.0.1
+summary: cucumber-9.1.0
 test_files: []