cucumber 11.0.0 → 11.1.1

data/lib/cucumber/formatter/rerun.rb

@@ -1,17 +1,24 @@
 # frozen_string_literal: true
 
-require 'cucumber/formatter/io'
-require 'cucumber/formatter/message_builder'
+require 'cucumber/query'
+
+require_relative 'io'
 
 module Cucumber
   module Formatter
-    class Rerun < MessageBuilder
+    class Rerun
+      include Io
+
       def initialize(config)
+        @config = config
         @io = ensure_io(config.out_stream, config.error_stream)
-        super(config)
+        @repository = Cucumber::Repository.new
+        @query = Cucumber::Query.new(@repository)
+        config.on_event :envelope, &method(:output_envelope)
       end
 
-      def output_envelope(envelope)
+      def output_envelope(event)
+        envelope = event.envelope
         @repository.update(envelope)
         finish_report if envelope.test_run_finished
       end

data/lib/cucumber/formatter/summary.rb

@@ -4,12 +4,13 @@ require 'cucumber/formatter/io'
 require 'cucumber/formatter/console'
 require 'cucumber/formatter/console_counts'
 require 'cucumber/formatter/console_issues'
+require 'cucumber/formatter/backtrace_filter'
 require 'cucumber/core/test/result'
 require 'cucumber/formatter/ast_lookup'
 
 module Cucumber
   module Formatter
-    # Summary formatter, outputting only feature / scenario titles
+    # Summary formatter, outputting feature / scenario titles plus failure details
     class Summary
       include Io
       include Console
@@ -20,6 +21,7 @@ module Cucumber
         @ast_lookup = AstLookup.new(config)
         @counts = ConsoleCounts.new(@config)
         @issues = ConsoleIssues.new(@config, @ast_lookup)
+        @failed_results = []
         @start_time = Time.now
 
         @config.on_event :test_case_started do |event|
@@ -31,9 +33,14 @@ module Cucumber
           print_result event.result
         end
 
+        @config.on_event :test_step_finished do |event|
+          collect_failed_result(event.test_step, event.result)
+        end
+
         @config.on_event :test_run_finished do |_event|
           duration = Time.now - @start_time
           @io.puts
+          print_elements(@failed_results, :failed, 'steps')
           print_statistics(duration, @config, @counts, @issues)
         end
       end
@@ -61,6 +68,13 @@ module Cucumber
       def print_result(result)
         @io.puts format_string(result, result.to_sym)
       end
+
+      def collect_failed_result(test_step, result)
+        return if test_step.hook?
+
+        result = result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
+        @failed_results << result if result.failed?
+      end
     end
   end
 end

data/lib/cucumber/formatter/usage.rb

@@ -32,8 +32,7 @@ module Cucumber
         @total_duration = 0
         @matches = {}
         config.on_event :step_activated do |event|
-          test_step, step_match = *event.attributes
-          @matches[test_step.to_s] = step_match
+          @matches[event.test_step.to_s] = event.step_match
         end
         config.on_event :step_definition_registered, &method(:on_step_definition_registered)
       end

data/lib/cucumber/glue/proto_world.rb

@@ -94,9 +94,10 @@ module Cucumber
           media_type = MiniMime.lookup_by_filename(file)&.content_type if media_type.nil?
           file = File.read(file, mode: 'rb')
         end
-        super
+        # We pass in the concept of whether the file is streamed to ensure that the envelope encoding is correct
+        super(file, media_type, filename)
       rescue StandardError
-        super
+        super(file, media_type, filename)
       end
 
       # Mark the matched step as pending.

data/lib/cucumber/glue/registry_and_more.rb

@@ -4,6 +4,8 @@ require 'cucumber/cucumber_expressions/parameter_type_registry'
 require 'cucumber/cucumber_expressions/cucumber_expression'
 require 'cucumber/cucumber_expressions/regular_expression'
 require 'cucumber/cucumber_expressions/cucumber_expression_generator'
+require 'cucumber/messages/helpers/time_conversion'
+
 require 'cucumber/glue/dsl'
 require 'cucumber/glue/snippet'
 require 'cucumber/glue/hook'
@@ -13,6 +15,7 @@ require 'cucumber/glue/world_factory'
 require 'cucumber/gherkin/i18n'
 require 'multi_test'
 require 'cucumber/step_match'
+require 'cucumber/events/base'
 require 'cucumber/events/step_definition_registered'
 
 module Cucumber
@@ -48,6 +51,8 @@ module Cucumber
     class RegistryAndMore
       attr_reader :current_world, :step_definitions
 
+      include Cucumber::Messages::Helpers::TimeConversion
+
       all_keywords = ::Gherkin::DIALECTS.keys.map do |dialect_name|
         dialect = ::Gherkin::Dialect.for(dialect_name)
         dialect.given_keywords + dialect.when_keywords + dialect.then_keywords + dialect.and_keywords + dialect.but_keywords
@@ -98,13 +103,20 @@ module Cucumber
       def register_rb_step_definition(string_or_regexp, proc_or_sym, options)
         step_definition = StepDefinition.new(@configuration.id_generator.new_id, self, string_or_regexp, proc_or_sym, options)
         @step_definitions << step_definition
-        @configuration.notify :step_definition_registered, step_definition
+        @configuration.notify(:step_definition_registered, step_definition)
+        @configuration.notify(:envelope, step_definition.to_envelope)
         step_definition
       rescue Cucumber::CucumberExpressions::UndefinedParameterTypeError => e
-        # TODO: add a way to extract the parameter type directly from the error.
-        type_name = e.message.match(/^Undefined parameter type ['|{](.*)['|}].?$/)[1]
-
-        @configuration.notify :undefined_parameter_type, type_name, string_or_regexp
+        @configuration.notify(:undefined_parameter_type, e.undefined_parameter_type_name, string_or_regexp)
+        # Move the below code into cucumber-expressions. Once done. Switch the line for
+        # @configuration.notify(:envelope, e.to_envelope(string_or_regexp))
+        to_envelope = Cucumber::Messages::Envelope.new(
+          undefined_parameter_type: Cucumber::Messages::UndefinedParameterType.new(
+            name: e.undefined_parameter_type_name,
+            expression: string_or_regexp
+          )
+        )
+        @configuration.notify(:envelope, to_envelope)
       end
 
       def build_rb_world_factory(world_modules, namespaced_world_modules, proc)
@@ -131,7 +143,7 @@ module Cucumber
 
       def begin_scenario(test_case)
         @current_world = WorldFactory.new(@world_proc).create_world
-        @current_world.extend(ProtoWorld.for(@runtime, test_case.language))
+        @current_world.extend(ProtoWorld.for(@runtime, test_case&.language))
         MultiTest.extend_with_best_assertion_library(@current_world)
         @current_world.add_modules!(@world_modules || [], @namespaced_world_modules || {})
       end
@@ -147,15 +159,27 @@ module Cucumber
       end
 
       def before_all
+        set_up_world_for_global_hooks
+        all_succeeded = true
+        # Run each `BeforeAll` hook. Ensuring that we store the overall result as the worst status
         hooks[:before_all].each do |hook|
-          invoke_run_hook(hook, 'BeforeAll')
+          result = invoke_run_hook(hook, 'BeforeAll')
+          all_succeeded = false unless result
         end
+        @current_world = nil
+        all_succeeded
       end
 
       def after_all
+        set_up_world_for_global_hooks
+        all_succeeded = true
+        # Run each `AfterAll` hook. Ensuring that we store the overall result as the worst status
         hooks[:after_all].each do |hook|
-          invoke_run_hook(hook, 'AfterAll')
+          result = invoke_run_hook(hook, 'AfterAll')
+          all_succeeded = false unless result
         end
+        @current_world = nil
+        all_succeeded
       end
 
       def add_hook(type, hook)
@@ -182,16 +206,76 @@ module Cucumber
 
       def invoke_run_hook(hook, pseudo_method)
         @configuration.notify(:test_run_hook_started, hook)
+
+        current_test_run_hook_started_id = @configuration.id_generator.new_id
+        started_envelope = test_run_hook_started_envelope(hook, current_test_run_hook_started_id)
+        @configuration.notify(:envelope, started_envelope)
+
         timer = Core::Test::Timer.new.start
         begin
           hook.invoke(pseudo_method, [])
           @configuration.notify(:test_run_hook_finished, hook, Core::Test::Result::Passed.new(timer.duration))
+          finished_envelope = test_run_hook_finished_envelope(Core::Test::Result::Passed.new(timer.duration), current_test_run_hook_started_id)
+          @configuration.notify(:envelope, finished_envelope)
+          true
         rescue StandardError => e
           @configuration.notify(:test_run_hook_finished, hook, Core::Test::Result::Failed.new(timer.duration, e))
-          raise
+          finished_envelope = test_run_hook_finished_envelope(Core::Test::Result::Failed.new(timer.duration, e), current_test_run_hook_started_id)
+          @configuration.notify(:envelope, finished_envelope)
+          false
         end
       end
 
+      def test_run_hook_started_envelope(hook, id)
+        Cucumber::Messages::Envelope.new(
+          test_run_hook_started: Cucumber::Messages::TestRunHookStarted.new(
+            id: id,
+            hook_id: hook.id,
+            test_run_started_id: @configuration.test_run_started_id,
+            timestamp: time_to_timestamp(Time.now)
+          )
+        )
+      end
+
+      def test_run_hook_finished_envelope(test_result, test_run_hook_started_id)
+        result = test_result
+        result_message = result.to_message
+
+        if result.failed?
+          result_message = Cucumber::Messages::TestStepResult.new(
+            status: result_message.status,
+            duration: result_message.duration,
+            message: create_error_message(result.exception),
+            exception: create_exception_object(result, result.exception)
+          )
+        end
+
+        Cucumber::Messages::Envelope.new(
+          test_run_hook_finished: Cucumber::Messages::TestRunHookFinished.new(
+            test_run_hook_started_id: test_run_hook_started_id,
+            timestamp: time_to_timestamp(Time.now),
+            result: result_message
+          )
+        )
+      end
+
+      def create_error_message(message_element)
+        <<~ERROR_MESSAGE
+          #{message_element.message} (#{message_element.class})
+          #{message_element.backtrace}
+        ERROR_MESSAGE
+      end
+
+      def create_exception_object(result, message_element)
+        return unless result.failed?
+
+        Cucumber::Messages::Exception.new(
+          type: message_element.class,
+          message: message_element.message,
+          stack_trace: message_element.backtrace.join("\n")
+        )
+      end
+
       def parameter_type_envelope(parameter_type)
         # TODO: should this be moved to Cucumber::Expression::ParameterType#to_envelope ??
         # Note: that would mean that cucumber-expression would depend on cucumber-messages
@@ -221,6 +305,11 @@ module Cucumber
       def hooks
         @hooks ||= Hash.new { |h, k| h[k] = [] }
       end
+
+      def set_up_world_for_global_hooks
+        # We don't need a language as we're just creating a world object to attach the BeforeAll / AfterAll hooks to
+        begin_scenario(nil)
+      end
     end
   end
 end

data/lib/cucumber/runtime/user_interface.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require 'timeout'
+require 'cucumber/events/attach_called'
 
 module Cucumber
   class Runtime
     module UserInterface
-      attr_writer :visitor
+      attr_writer :configuration
 
       # Suspends execution and prompts +question+ to the console (STDOUT).
       # An operator (manual tester) can then enter a line of text and hit
@@ -42,7 +43,8 @@ module Cucumber
       # The embedded data may or may not be ignored, depending on what kind of formatter(s) are active.
       #
       def attach(src, media_type, filename)
-        @visitor.attach(src, media_type, filename)
+        @configuration.notify(:attach_called, src, media_type, filename)
+        self
       end
 
       private

data/lib/cucumber/runtime.rb

@@ -6,7 +6,6 @@ require 'cucumber/load_path'
 require 'cucumber/formatter/duration'
 require 'cucumber/file_specs'
 require 'cucumber/filters'
-require 'cucumber/formatter/fanout'
 require 'cucumber/gherkin/i18n'
 require 'cucumber/glue/registry_wrapper'
 require 'cucumber/step_match_search'
@@ -72,15 +71,12 @@ module Cucumber
 
       load_step_definitions
       fire_install_plugin_hook
-      fire_before_all_hook unless dry_run?
-      # TODO: can we remove this state?
-      self.visitor = report
+      create_formatters
 
       receiver = Test::Runner.new(@configuration.event_bus)
       compile features, receiver, filters, @configuration.event_bus
-      @configuration.notify :test_run_finished, !failure?
-
       fire_after_all_hook unless dry_run?
+      @configuration.notify :test_run_finished, !failure?
     end
 
     def features_paths
@@ -113,7 +109,7 @@ module Cucumber
       if @configuration.wip?
         summary_report.test_cases.total_passed.positive?
       else
-        !summary_report.ok?(strict: @configuration.strict)
+        !summary_report.ok?(strict: @configuration.strict) || !global_hooks_summary_report.ok?
       end
     end
 
@@ -123,10 +119,6 @@ module Cucumber
       @support_code.fire_hook(:install_plugin, @configuration, registry_wrapper)
     end
 
-    def fire_before_all_hook # :nodoc:
-      @support_code.fire_hook(:before_all)
-    end
-
     def fire_after_all_hook # :nodoc:
       @support_code.fire_hook(:after_all)
     end
@@ -136,6 +128,22 @@ module Cucumber
       @features ||= feature_files.map do |path|
         source = NormalisedEncodingFile.read(path)
         @configuration.notify :gherkin_source_read, path, source
+
+        # TODO: When core is v17+ switch the below code out to the following
+        # Cucumber::Core::Gherkin::Document.new(path, source).tap do |document|
+        #   @configuration.notify(:envelope, document.to_envelope)
+        # end
+        to_envelope =
+          Cucumber::Messages::Envelope.new(
+            source: Cucumber::Messages::Source.new(
+              uri: path,
+              data: source,
+              media_type: 'text/x.cucumber.gherkin+plain'
+            )
+          )
+
+        @configuration.notify(:envelope, to_envelope)
+
         Cucumber::Core::Gherkin::Document.new(path, source)
       end
     end
@@ -188,19 +196,31 @@ module Cucumber
     require 'cucumber/formatter/publish_banner_printer'
     require 'cucumber/core/report/summary'
 
-    def report
-      return @report if @report
+    def create_formatters
+      # Define all formatters which are specified via cli options
+      formatters
+      # Define the MessageBuilder formatter - Required until all messages are generated at the source
+      #   Skip when a user formatter already inherits from MessageBuilder (e.g. HTML) to avoid sending every event twice.
+      message_builder unless formatters.any? { |f| f.is_a?(Formatter::MessageBuilder) }
+      # `summary_report` and `global_hooks_summary_report` are used to determine the exit code
+      summary_report
+      global_hooks_summary_report
+      fail_fast_report if @configuration.fail_fast?
+      publish_banner_printer unless @configuration.publish_quiet?
+    end
 
-      reports = [summary_report] + formatters
-      reports << fail_fast_report if @configuration.fail_fast?
-      reports << publish_banner_printer unless @configuration.publish_quiet?
-      @report ||= Formatter::Fanout.new(reports)
+    def message_builder
+      @message_builder ||= Formatter::MessageBuilder.new(@configuration)
     end
 
     def summary_report
       @summary_report ||= Core::Report::Summary.new(@configuration.event_bus)
     end
 
+    def global_hooks_summary_report
+      @global_hooks_summary_report ||= Formatter::GlobalHooksSummary.new(@configuration)
+    end
+
     def fail_fast_report
       @fail_fast_report ||= Formatter::FailFast.new(@configuration)
     end
@@ -256,6 +276,7 @@ module Cucumber
           filters << Filters::ApplyAfterHooks.new(@support_code)
           filters << Filters::ApplyAroundHooks.new(@support_code)
           filters << Filters::BroadcastTestRunStartedEvent.new(@configuration)
+          filters << Filters::FireBeforeAllHooks.new(@support_code)
           filters << Filters::Quit.new
         end
 

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: cucumber
 version: !ruby/object:Gem::Version
-  version: 11.0.0
+  version: 11.1.1
 platform: ruby
 authors:
 - Aslak Hellesøy
 - Matt Wynne
 - Steve Tooke
 - Luke Hill
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -197,14 +196,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '22.0'
+        version: '24.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '22.0'
+        version: '24.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -354,6 +353,8 @@ files:
 - lib/cucumber/encoding.rb
 - lib/cucumber/errors.rb
 - lib/cucumber/events.rb
+- lib/cucumber/events/attach_called.rb
+- lib/cucumber/events/base.rb
 - lib/cucumber/events/envelope.rb
 - lib/cucumber/events/gherkin_source_parsed.rb
 - lib/cucumber/events/gherkin_source_read.rb
@@ -381,6 +382,7 @@ files:
 - lib/cucumber/filters/apply_before_hooks.rb
 - lib/cucumber/filters/broadcast_test_case_ready_event.rb
 - lib/cucumber/filters/broadcast_test_run_started_event.rb
+- lib/cucumber/filters/fire_before_all_hooks.rb
 - lib/cucumber/filters/gated_receiver.rb
 - lib/cucumber/filters/prepare_world.rb
 - lib/cucumber/filters/quit.rb
@@ -400,9 +402,8 @@ files:
 - lib/cucumber/formatter/curl_option_parser.rb
 - lib/cucumber/formatter/duration.rb
 - lib/cucumber/formatter/duration_extractor.rb
-- lib/cucumber/formatter/errors.rb
 - lib/cucumber/formatter/fail_fast.rb
-- lib/cucumber/formatter/fanout.rb
+- lib/cucumber/formatter/global_hooks_summary.rb
 - lib/cucumber/formatter/html.rb
 - lib/cucumber/formatter/http_io.rb
 - lib/cucumber/formatter/ignore_missing_messages.rb
@@ -413,13 +414,10 @@ files:
 - lib/cucumber/formatter/junit.rb
 - lib/cucumber/formatter/message.rb
 - lib/cucumber/formatter/message_builder.rb
+- lib/cucumber/formatter/message_handlers.rb
 - lib/cucumber/formatter/pretty.rb
 - lib/cucumber/formatter/progress.rb
 - lib/cucumber/formatter/publish_banner_printer.rb
-- lib/cucumber/formatter/query/hook_by_test_step.rb
-- lib/cucumber/formatter/query/pickle_by_test.rb
-- lib/cucumber/formatter/query/step_definitions_by_test_step.rb
-- lib/cucumber/formatter/query/test_case_started_by_test_case.rb
 - lib/cucumber/formatter/rerun.rb
 - lib/cucumber/formatter/stepdefs.rb
 - lib/cucumber/formatter/steps.rb
@@ -484,7 +482,6 @@ metadata:
   mailing_list_uri: https://groups.google.com/forum/#!forum/cukes
   source_code_uri: https://github.com/cucumber/cucumber-ruby
   funding_uri: https://opencollective.com/cucumber
-post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -500,8 +497,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.2.8
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
-summary: cucumber-11.0.0
+summary: cucumber-11.1.1
 test_files: []

data/lib/cucumber/formatter/errors.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Cucumber
-  module Formatter
-    class TestCaseUnknownError < StandardError; end
-
-    class TestStepUnknownError < StandardError; end
-  end
-end

data/lib/cucumber/formatter/fanout.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Cucumber
-  module Formatter
-    # Forwards any messages sent to this object to all recipients
-    # that respond to that message.
-    class Fanout < BasicObject
-      attr_reader :recipients
-      private :recipients
-
-      def initialize(recipients)
-        @recipients = recipients
-      end
-
-      def method_missing(message, *args)
-        super unless recipients
-
-        recipients.each do |recipient|
-          recipient.send(message, *args) if recipient.respond_to?(message)
-        end
-      end
-
-      def respond_to_missing?(name, include_private = false)
-        recipients.any? { |recipient| recipient.respond_to?(name, include_private) } || super(name, include_private)
-      end
-    end
-  end
-end

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

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require 'cucumber/formatter/errors'
-
-module Cucumber
-  module Formatter
-    module Query
-      class HookByTestStep
-        def initialize(config)
-          @hook_id_by_test_step_id = {}
-
-          config.on_event :test_step_created, &method(:on_test_step_created)
-          config.on_event :hook_test_step_created, &method(:on_hook_test_step_created)
-        end
-
-        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}"
-        end
-
-        private
-
-        def on_test_step_created(event)
-          @hook_id_by_test_step_id[event.test_step.id] = nil
-        end
-
-        def on_hook_test_step_created(event)
-          @hook_id_by_test_step_id[event.test_step.id] = event.hook.id
-        end
-      end
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require 'cucumber/formatter/errors'
-
-module Cucumber
-  module Formatter
-    module Query
-      class PickleByTest
-        def initialize(config)
-          @pickle_id_by_test_case_id = {}
-          config.on_event :test_case_created, &method(:on_test_case_created)
-        end
-
-        def pickle_id(test_case)
-          return @pickle_id_by_test_case_id[test_case.id] if @pickle_id_by_test_case_id.key?(test_case.id)
-
-          raise TestCaseUnknownError, "No pickle found for #{test_case.id} }. Known: #{@pickle_id_by_test_case_id.keys}"
-        end
-
-        private
-
-        def on_test_case_created(event)
-          @pickle_id_by_test_case_id[event.test_case.id] = event.pickle.id
-        end
-      end
-    end
-  end
-end

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

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require 'cucumber/formatter/errors'
-
-module Cucumber
-  module Formatter
-    module Query
-      class StepDefinitionsByTestStep
-        def initialize(config)
-          @step_definition_ids_by_test_step_id = {}
-          @step_match_arguments_by_test_step_id = {}
-
-          config.on_event :test_step_created, &method(:on_test_step_created)
-          config.on_event :step_activated, &method(:on_step_activated)
-        end
-
-        def step_definition_ids(test_step)
-          return @step_definition_ids_by_test_step_id[test_step.id] if @step_definition_ids_by_test_step_id.key?(test_step.id)
-
-          raise TestStepUnknownError, "No step definition found for #{test_step.id} }. Known: #{@step_definition_ids_by_test_step_id.keys}"
-        end
-
-        def step_match_arguments(test_step)
-          return @step_match_arguments_by_test_step_id[test_step.id] if @step_match_arguments_by_test_step_id.key?(test_step.id)
-
-          raise TestStepUnknownError, "No step match arguments found for #{test_step.id} }. Known: #{@step_match_arguments_by_test_step_id.keys}"
-        end
-
-        private
-
-        def on_test_step_created(event)
-          @step_definition_ids_by_test_step_id[event.test_step.id] = []
-        end
-
-        def on_step_activated(event)
-          @step_definition_ids_by_test_step_id[event.test_step.id] << event.step_match.step_definition.id
-          @step_match_arguments_by_test_step_id[event.test_step.id] = event.step_match.step_arguments
-        end
-      end
-    end
-  end
-end