cucumber 11.1.0 → 12.0.0

data/lib/cucumber/glue/registry_and_more.rb

@@ -6,17 +6,22 @@ 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'
-require 'cucumber/glue/proto_world'
-require 'cucumber/glue/step_definition'
-require 'cucumber/glue/world_factory'
-require 'cucumber/gherkin/i18n'
+require_relative 'dsl'
+require_relative 'snippet'
+require_relative 'hook'
+require_relative 'proto_world'
+require_relative 'step_definition'
+require_relative 'world_factory'
+require_relative '../step_match'
+require_relative '../gherkin/i18n'
+
 require 'multi_test'
-require 'cucumber/step_match'
-require 'cucumber/events/base'
-require 'cucumber/events/step_definition_registered'
+require 'cucumber/core/event/base'
+
+require_relative '../events/step_definition_registered'
+
+require_relative 'multiple_world'
+require_relative 'nil_world'
 
 module Cucumber
   module Glue
@@ -25,28 +30,6 @@ module Cucumber
       "#{location}:in `#{name}'"
     end
 
-    # Raised if a World block returns Nil.
-    class NilWorld < StandardError
-      def initialize
-        super('World procs should never return nil')
-      end
-    end
-
-    # Raised if there are 2 or more World blocks.
-    class MultipleWorld < StandardError
-      def initialize(first_proc, second_proc)
-        # 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"
-        message << Glue.backtrace_line(second_proc, 'World') << "\n\n"
-        message << "Use Ruby modules instead to extend your worlds. See the Cucumber::Glue::Dsl#World RDoc\n"
-        message << "or http://wiki.github.com/cucumber/cucumber/a-whole-new-world.\n\n"
-        super(message)
-      end
-    end
-
     # TODO: This class has too many responsibilities, split off
     class RegistryAndMore
       attr_reader :current_world, :step_definitions

data/lib/cucumber/multiline_argument/data_table.rb

@@ -77,7 +77,7 @@ module Cucumber
 
       # This is a Hash being initialized with a default value of a Hash
       # DO NOT REFORMAT TO REMOVE {} - Ruby 3.4+ will interpret these as keywords and cucumber will not work
-      NULL_CONVERSIONS = Hash.new({ strict: false, proc: ->(cell_value) { cell_value } }).freeze
+      NULL_CONVERSIONS = Hash.new({ proc: ->(cell_value) { cell_value } }).freeze
 
       # @param data [Core::Test::DataTable] the data for the table
       # @param conversion_procs [Hash] see map_column
@@ -265,9 +265,7 @@ module Cucumber
       # Returns a new Table with an additional column mapping.
       #
       # Change how #hashes converts column values. The +column_name+ argument identifies the column
-      # and +conversion_proc+ performs the conversion for each cell in that column. If +strict+ is
-      # true, an error will be raised if the column named +column_name+ is not found. If +strict+
-      # is false, no error will be raised. Example:
+      # and +conversion_proc+ performs the conversion for each cell in that column.
       #
       #   Given /^an expense report for (.*) with the following posts:$/ do |table|
       #     posts_table = posts_table.map_column('amount') { |a| a.to_i }
@@ -276,9 +274,9 @@ module Cucumber
       #     end
       #   end
       #
-      def map_column(column_name, strict: true, &conversion_proc)
+      def map_column(column_name, &conversion_proc)
         conversion_procs = @conversion_procs.dup
-        conversion_procs[column_name.to_s] = { strict: strict, proc: conversion_proc }
+        conversion_procs[column_name.to_s] = { proc: conversion_proc }
         self.class.new(Core::Test::DataTable.new(raw), conversion_procs, @header_mappings.dup, @header_conversion_proc)
       end
 
@@ -467,7 +465,7 @@ module Cucumber
 
       def convert_columns!
         @conversion_procs.each do |column_name, conversion_proc|
-          verify_column(column_name) if conversion_proc[:strict]
+          verify_column(column_name)
         end
 
         cell_matrix.transpose.each do |col|

data/lib/cucumber/retry_policy.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Cucumber
+  # Decides whether a failed test case is run again, honouring both the `--retry` and the `--retry-total` options.
+  #
+  # The retry filter asks it and then records what it did, the test runner asks it when it reports the outcome of a
+  # test case. Both have to get the same answer, so #will_be_retried? never changes the state of the policy.
+  class RetryPolicy
+    def initialize(max_retries, max_permanent_failures)
+      @max_retries = max_retries
+      @max_permanent_failures = max_permanent_failures
+      @retries = Hash.new(0)
+      @permanent_failures = 0
+    end
+
+    def will_be_retried?(test_case, result)
+      return false unless result.failed?
+      return false if @permanent_failures >= @max_permanent_failures
+
+      @retries[test_case] < @max_retries
+    end
+
+    def record_retry(test_case) = @retries[test_case] += 1
+
+    def record_permanent_failure = @permanent_failures += 1
+  end
+end

data/lib/cucumber/rspec/doubles.rb

@@ -5,15 +5,9 @@ require 'rspec/mocks'
 World(RSpec::Mocks::ExampleMethods)
 
 Before do
-  if RSpec::Mocks::Version::STRING >= '2.9.9'
-    RSpec::Mocks.setup
-  else
-    RSpec::Mocks.setup(self)
-  end
+  RSpec::Mocks.setup(self)
 end
 
 After do
-  RSpec::Mocks.verify
-ensure
   RSpec::Mocks.teardown
 end

data/lib/cucumber/runtime/meta_message_builder.rb

@@ -70,7 +70,7 @@ module Cucumber
         def os
           Cucumber::Messages::Product.new(
             name: RbConfig::CONFIG['target_os'],
-            version: Sys::Uname.uname.version
+            version: Sys::Uname.version
           )
         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
@@ -21,6 +22,7 @@ module Cucumber
       # that makes a sound before invoking #ask.
       #
       def ask(question, timeout_seconds)
+        Cucumber.deprecate(ask_deprecation_message, 'Cucumber::Runtime#ask (From UserInterface Module)', 'v12')
         $stdout.puts(question)
         $stdout.flush
         puts(question)
@@ -41,12 +43,25 @@ 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, filename, streamed_file)
-        @visitor.attach(src, media_type, filename, streamed_file)
+      def attach(src, media_type, filename)
+        @configuration.notify(:attach_called, src, media_type, filename)
+        self
       end
 
       private
 
+      def ask_deprecation_message
+        <<~MESSAGE
+          The `#ask` method has been present in cucumber for a while, but its purpose outside of cucumber is
+          questionable. It is being deprecated and will be removed in a future version (Targeting v12).
+
+          If you are using it in your own code, you should remove the dependency on it and implement your own version
+          of it. If you are using it in a step definition, you should consider whether that is really necessary and
+          use either a conditional waiter or use a tag so that the scenario doesn't automatically run in a CI
+          environment where there is no operator to answer the question.
+        MESSAGE
+      end
+
       def mri_gets(timeout_seconds)
         Timeout.timeout(timeout_seconds) do
           $stdin.gets

data/lib/cucumber/runtime.rb

@@ -1,52 +1,26 @@
 # frozen_string_literal: true
 
 require 'fileutils'
-require 'cucumber/configuration'
-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'
-require 'cucumber/messages'
-require 'cucumber/runtime/meta_message_builder'
 require 'sys/uname'
 
-module Cucumber
-  module FixRuby21Bug9285
-    def message
-      String(super).gsub('@ rb_sysopen ', '')
-    end
-  end
-
-  class FileException < RuntimeError
-    attr_reader :path
-
-    def initialize(original_exception, path)
-      @path = path
-      super(original_exception)
-    end
-  end
-
-  class FileNotFoundException < FileException
-  end
+require 'cucumber/core'
+require 'cucumber/messages'
 
-  class FeatureFolderNotFoundException < RuntimeError
-    def initialize(path)
-      @path = path
-      super
-    end
+require_relative 'configuration'
+require_relative 'errors'
+require_relative 'file_specs'
+require_relative 'filters'
+require_relative 'load_path'
+require_relative 'step_match_search'
 
-    def message
-      "No such file or directory - #{@path}"
-    end
-  end
+require_relative 'formatter/duration'
+require_relative 'gherkin/i18n'
+require_relative 'glue/registry_wrapper'
+require_relative 'runtime/meta_message_builder'
+require_relative 'runtime/support_code'
+require_relative 'runtime/user_interface'
 
-  require 'cucumber/core'
-  require 'cucumber/runtime/user_interface'
-  require 'cucumber/runtime/support_code'
+module Cucumber
   class Runtime
     attr_reader :results, :support_code, :configuration
 
@@ -72,10 +46,14 @@ module Cucumber
 
       load_step_definitions
       fire_install_plugin_hook
-      # TODO: can we remove this state?
-      self.visitor = report
-
-      receiver = Test::Runner.new(@configuration.event_bus)
+      create_formatters
+
+      options = {
+        id_generator: @configuration.id_generator,
+        backtrace_filter: Cucumber::Formatter::BacktraceFilter,
+        retry_policy: @configuration.retry_policy
+      }
+      receiver = Test::Runner.new(@configuration.event_bus, **options)
       compile features, receiver, filters, @configuration.event_bus
       fire_after_all_hook unless dry_run?
       @configuration.notify :test_run_finished, !failure?
@@ -111,7 +89,7 @@ module Cucumber
       if @configuration.wip?
         summary_report.test_cases.total_passed.positive?
       else
-        !summary_report.ok?(strict: @configuration.strict) || !global_hooks_summary_report.ok?
+        !summary_report.ok? || !global_hooks_summary_report.ok?
       end
     end
 
@@ -198,13 +176,16 @@ module Cucumber
     require 'cucumber/formatter/publish_banner_printer'
     require 'cucumber/core/report/summary'
 
-    def report
-      return @report if @report
-
-      reports = [message_builder, summary_report, global_hooks_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 create_formatters
+      # Define the MessageBuilder - Required until all messages are generated at the source
+      message_builder
+      # `summary_report` and `global_hooks_summary_report` are used to determine the exit code
+      summary_report
+      global_hooks_summary_report
+      # Define all formatters which are specified via cli options
+      formatters
+      fail_fast_report if @configuration.fail_fast?
+      publish_banner_printer unless @configuration.publish_quiet?
     end
 
     def message_builder

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber
 version: !ruby/object:Gem::Version
-  version: 11.1.0
+  version: 12.0.0
 platform: ruby
 authors:
 - Aslak Hellesøy
@@ -49,7 +49,7 @@ dependencies:
         version: '9'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -59,27 +59,27 @@ dependencies:
         version: '9'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '14'
 - !ruby/object:Gem::Dependency
   name: cucumber-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 16.2.0
+        version: '20'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '17'
+        version: '21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 16.2.0
+        version: '20'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '17'
+        version: '21'
 - !ruby/object:Gem::Dependency
   name: cucumber-cucumber-expressions
   requirement: !ruby/object:Gem::Requirement
@@ -89,7 +89,7 @@ dependencies:
         version: '17'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '20'
+        version: '21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -99,7 +99,7 @@ dependencies:
         version: '17'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '20'
+        version: '21'
 - !ruby/object:Gem::Dependency
   name: cucumber-html-formatter
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +109,7 @@ dependencies:
         version: '21'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '24'
+        version: '25'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -119,21 +119,41 @@ dependencies:
         version: '21'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '24'
+        version: '25'
 - !ruby/object:Gem::Dependency
-  name: diff-lcs
+  name: cucumber-query
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '16.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '16.1'
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -166,16 +186,22 @@ dependencies:
   name: multi_test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: sys-uname
   requirement: !ruby/object:Gem::Requirement
@@ -196,14 +222,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '24.0'
+        version: '26.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '24.0'
+        version: '26.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -353,7 +379,7 @@ files:
 - lib/cucumber/encoding.rb
 - lib/cucumber/errors.rb
 - lib/cucumber/events.rb
-- lib/cucumber/events/base.rb
+- lib/cucumber/events/attach_called.rb
 - lib/cucumber/events/envelope.rb
 - lib/cucumber/events/gherkin_source_parsed.rb
 - lib/cucumber/events/gherkin_source_read.rb
@@ -402,7 +428,6 @@ files:
 - lib/cucumber/formatter/duration.rb
 - lib/cucumber/formatter/duration_extractor.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
@@ -414,6 +439,7 @@ 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
@@ -433,6 +459,8 @@ files:
 - lib/cucumber/glue/dsl.rb
 - lib/cucumber/glue/hook.rb
 - lib/cucumber/glue/invoke_in_world.rb
+- lib/cucumber/glue/multiple_world.rb
+- lib/cucumber/glue/nil_world.rb
 - lib/cucumber/glue/proto_world.rb
 - lib/cucumber/glue/registry_and_more.rb
 - lib/cucumber/glue/registry_wrapper.rb
@@ -447,12 +475,11 @@ files:
 - lib/cucumber/multiline_argument/doc_string.rb
 - lib/cucumber/platform.rb
 - lib/cucumber/project_initializer.rb
-- lib/cucumber/query.rb
 - lib/cucumber/rake.rb
 - lib/cucumber/rake/forked_cucumber_runner.rb
 - lib/cucumber/rake/in_process_cucumber_runner.rb
 - lib/cucumber/rake/task.rb
-- lib/cucumber/repository.rb
+- lib/cucumber/retry_policy.rb
 - lib/cucumber/rspec/disable_option_parser.rb
 - lib/cucumber/rspec/doubles.rb
 - lib/cucumber/running_test_case.rb
@@ -489,14 +516,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 3.2.8
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
-summary: cucumber-11.1.0
+summary: cucumber-12.0.0
 test_files: []

data/lib/cucumber/events/base.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-# TODO: Remove this class and use Cucumber::Core::Event::Base once v17 of core is minimum
-module Cucumber
-  module Events
-    # An archetype of what each Cucumber Event defined in cucumber-ruby must adhere to
-    class Base
-      # The "key" name of the class to be used as the key in the event registry (Underscored name symbolized)
-      #   @return [Symbol]
-      def self.event_id
-        raise 'Must be implemented in subclass'
-      end
-
-      # The properties of each event. Stored in iVar named format - where the key is the name of the iVar
-      #   @return [Hash<Symbol>]
-      def to_h
-        instance_variables.to_h { |variable_name| [variable_name[1..].to_sym, instance_variable_get(variable_name)] }
-      end
-
-      def event_id
-        self.class.event_id
-      end
-    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