cucumber 9.0.2 → 9.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 313150f1f463d99e105864744641cd87c56e55f5d4d7856a437214a8db79dbdd
-  data.tar.gz: 90cdd041c890ab05108d3951be679f424ae096bc2df09044b26320096074eee3
+  metadata.gz: 81294b0304068bde0d87c31fc0d58451d79a59c73bc743bf4ea282dcf5c2ba2c
+  data.tar.gz: 9f8e3297cfd2fdf1f977a1e748abf2a2cd08f742709884042d56213ab4ff6499
 SHA512:
-  metadata.gz: 76252cc34ed4bc38ba6e7c0cec30d31b5319d14cdc9745f3e589bad8abf4713c95ec27527095b969dfd983f59ecea57f27ef9d119b68f8c032a19143d332d549
-  data.tar.gz: bef2260cd88f77daa139256c03e68b1744849667d71a3a71931d6c57a4c546e437e996ef6e7aed157520d5ff7dc1b86d2c1a1041b9dd9747f20fe53fd61dec2a
+  metadata.gz: 380511f8909d71467d326c13510820ed9e16517c4aaf68e3bcc6bf14a9a7e9588060e04238e970a1e4d37ed8dd4b725347c4153dd12357dae2c7ffcf548e6949
+  data.tar.gz: 3ee41bcacdfb4b040cd5cab60c3c94c5a7fcb533b06fc73d2a58e49aa12652b0e834298931425e537ef15b51f528a4469c833044dc577e277374175a9fbdbacc

data/README.md

@@ -5,9 +5,7 @@
 [![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)
 
@@ -56,8 +54,7 @@ Later in this document, bundler is considered being used so all commands are usi
 
 ### 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
 
@@ -133,7 +130,7 @@ To execute a single example, indicates the line of the name of the example:
 
     $ 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
 
@@ -141,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.2
+9.1.1

data/lib/cucumber/cli/main.rb

@@ -49,7 +49,7 @@ module Cucumber
       rescue Errno::EACCES, Errno::ENOENT => e
         @err.puts("#{e.message} (#{e.class})")
         exit_unable_to_finish
-      rescue Exception => e # rubocop:disable Lint/RescueException
+      rescue Exception => e
         @err.puts("#{e.message} (#{e.class})")
         @err.puts(e.backtrace.join("\n"))
         exit_unable_to_finish

data/lib/cucumber/cli/options.rb

@@ -92,13 +92,13 @@ module Cucumber
         @options[key] = value
       end
 
-      def parse!(args) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def parse!(args)
         @args = args
         @expanded_args = @args.dup
 
         @args.extend(::OptionParser::Arguable)
 
-        @args.options do |opts| # rubocop:disable Metrics/BlockLength
+        @args.options do |opts|
           opts.banner = banner
           opts.on('--publish', 'Publish a report to https://reports.cucumber.io') do
             set_option :publish_enabled, true
@@ -143,11 +143,11 @@ module Cucumber
           opts.on('-x', '--expand', 'Expand Scenario Outline Tables in output.') { set_option :expand }
 
           opts.on('--order TYPE[:SEED]', 'Run examples in the specified order. Available types:',
-                  *<<-TEXT.split("\n")) do |order|
-  [defined]     Run scenarios in the order they were defined (default).
-  [random]      Shuffle scenarios before running.
-Specify SEED to reproduce the shuffling from a previous run.
-  e.g. --order random:5738
+                  *<<~TEXT.split("\n")) do |order|
+                      [defined]     Run scenarios in the order they were defined (default).
+                      [random]      Shuffle scenarios before running.
+                    Specify SEED to reproduce the shuffling from a previous run.
+                      e.g. --order random:5738
                   TEXT
             @options[:order], @options[:seed] = *order.split(':')
             raise "'#{@options[:order]}' is not a recognised order type. Please use one of #{ORDER_TYPES.join(', ')}." unless ORDER_TYPES.include?(@options[:order])
@@ -522,7 +522,7 @@ Specify SEED to reproduce the shuffling from a previous run.
         @profile_loader ||= ProfileLoader.new
       end
 
-      def reverse_merge(other_options) # rubocop:disable Metrics/AbcSize
+      def reverse_merge(other_options)
         @options = other_options.options.merge(@options)
         @options[:require] += other_options[:require]
         @options[:excludes] += other_options[:excludes]

data/lib/cucumber/cli/profile_loader.rb

@@ -11,11 +11,11 @@ module Cucumber
 
       def args_from(profile)
         unless cucumber_yml.key?(profile)
-          raise(ProfileNotFound, <<-END_OF_ERROR)
-Could not find profile: '#{profile}'
+          raise(ProfileNotFound, <<~END_OF_ERROR)
+            Could not find profile: '#{profile}'
 
-Defined profiles in cucumber.yml:
-  * #{cucumber_yml.keys.sort.join("\n  * ")}
+            Defined profiles in cucumber.yml:
+              * #{cucumber_yml.keys.sort.join("\n  * ")}
           END_OF_ERROR
         end
 
@@ -84,7 +84,7 @@ Defined profiles in cucumber.yml:
       def load_configuration
         require 'yaml'
         begin
-          @cucumber_yml = YAML.load(@cucumber_erb) # rubocop:disable Security/YAMLLoad
+          @cucumber_yml = YAML.load(@cucumber_erb)
         rescue StandardError
           raise(YmlLoadError, "cucumber.yml was found, but could not be parsed. Please refer to cucumber's documentation on correct profile usage.\n")
         end

data/lib/cucumber/configuration.rb

@@ -213,7 +213,7 @@ module Cucumber
         yield factory,
               formatter_options,
               path_or_io
-      rescue Exception => e # rubocop:disable Lint/RescueException
+      rescue Exception => e
         raise e, "#{e.message}\nError creating formatter: #{format}", e.backtrace
       end
     end

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 remove_after_version <= Cucumber::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/formatter/ansicolor.rb

@@ -3,7 +3,7 @@
 require 'cucumber/platform'
 require 'cucumber/term/ansicolor'
 
-Cucumber::Term::ANSIColor.coloring = false if !$stdout.tty? && !ENV.key?('AUTOTEST')
+Cucumber::Term::ANSIColor.coloring = false unless $stdout.tty?
 
 module Cucumber
   module Formatter
@@ -70,14 +70,14 @@ module Cucumber
         "#{h[Regexp.last_match(1)]},bold"
       end.merge(
         'undefined' => 'yellow',
-        'pending'   => 'yellow',
-        'flaky'     => 'yellow',
-        'failed'    => 'red',
-        'passed'    => 'green',
-        'outline'   => 'cyan',
-        'skipped'   => 'cyan',
-        'comment'   => 'grey',
-        'tag'       => 'cyan'
+        'pending' => 'yellow',
+        'flaky' => 'yellow',
+        'failed' => 'red',
+        'passed' => 'green',
+        'outline' => 'cyan',
+        'skipped' => 'cyan',
+        'comment' => 'grey',
+        'tag' => 'cyan'
       )
       # :startdoc:
 

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

@@ -169,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
 

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
@@ -114,7 +114,7 @@ module Cucumber
       end
 
       def current_feature
-        @feature_hash ||= {} # rubocop:disable Naming/MemoizedInstanceVariableName
+        @feature_hash ||= {}
       end
 
       def feature_elements

data/lib/cucumber/formatter/message_builder.rb

@@ -42,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/')
@@ -192,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
 
@@ -211,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

@@ -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
@@ -391,7 +395,7 @@ module Cucumber
         end
       end
 
-      def print_outline_data(scenario_outline) # rubocop:disable Metrics/AbcSize
+      def print_outline_data(scenario_outline)
         print_comments(scenario_outline.location.line, 2)
         print_tags(scenario_outline.tags, 2)
         @source_indent = calculate_source_indent_for_ast_node(scenario_outline) if options[:source]

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

@@ -41,30 +41,30 @@ module Cucumber
       # Although not listed, you can also use <tt>grey</tt>
       module AnsiEscapes
         COLORS = {
-          'black'   => "\e[30m",
-          'red'     => "\e[31m",
-          'green'   => "\e[32m",
-          'yellow'  => "\e[33m",
-          'blue'    => "\e[34m",
+          'black' => "\e[30m",
+          'red' => "\e[31m",
+          'green' => "\e[32m",
+          'yellow' => "\e[33m",
+          'blue' => "\e[34m",
           'magenta' => "\e[35m",
-          'cyan'    => "\e[36m",
-          'white'   => "\e[37m",
-          'grey'    => "\e[90m",
-          'bold'    => "\e[1m"
+          'cyan' => "\e[36m",
+          'white' => "\e[37m",
+          'grey' => "\e[90m",
+          'bold' => "\e[1m"
         }.freeze
 
         ALIASES = Hash.new do |h, k|
           "#{h[Regexp.last_match(1)]},bold" if k.to_s =~ /(.*)_arg/
         end.merge(
           'undefined' => 'yellow',
-          'pending'   => 'yellow',
+          'pending' => 'yellow',
           'executing' => 'grey',
-          'failed'    => 'red',
-          'passed'    => 'green',
-          'outline'   => 'cyan',
-          'skipped'   => 'cyan',
-          'comments'  => 'grey',
-          'tag'       => 'cyan'
+          'failed' => 'red',
+          'passed' => 'green',
+          'outline' => 'cyan',
+          'skipped' => 'cyan',
+          'comments' => 'grey',
+          'tag' => 'cyan'
         )
 
         # Example: export GHERKIN_COLORS="passed=red:failed=yellow"

data/lib/cucumber/glue/invoke_in_world.rb

@@ -48,7 +48,7 @@ module Cucumber
 
       def self.cucumber_run_with_backtrace_filtering(pseudo_method)
         yield
-      rescue Exception => e # rubocop:disable Lint/RescueException
+      rescue Exception => e
         instance_exec_invocation_line = "#{__FILE__}:#{__LINE__ - 2}:in `cucumber_run_with_backtrace_filtering'"
         replace_instance_exec_invocation_line!((e.backtrace || []), instance_exec_invocation_line, pseudo_method)
         raise e

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,8 +125,8 @@ module Cucumber
         inspect
       end
 
-      # Dynamially generate the API module, closuring the dependencies
-      def self.for(runtime, language) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+      # 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
@@ -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

@@ -198,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