cucumber 4.1.0 → 9.2.0

data/lib/cucumber/rspec/disable_option_parser.rb

@@ -2,12 +2,12 @@
 
 require 'optparse'
 
-module Spec #:nodoc:
-  module Runner #:nodoc:
+module Spec # :nodoc:
+  module Runner # :nodoc:
     # Neuters RSpec's option parser.
     # (RSpec's option parser tries to parse ARGV, which
     # will fail when running cucumber)
-    class OptionParser < ::OptionParser #:nodoc:
+    class OptionParser < ::OptionParser # :nodoc:
       NEUTERED_RSPEC = Object.new
       def NEUTERED_RSPEC.method_missing(_method, *_args) # rubocop:disable Style/MissingRespondToMissing
         self || super
@@ -15,11 +15,14 @@ module Spec #:nodoc:
 
       def self.method_added(method)
         return if @__neutering_rspec
+
         @__neutering_rspec = true
         define_method(method) do |*_a|
           NEUTERED_RSPEC
         end
         @__neutering_rspec = false
+
+        super
       end
     end
   end

data/lib/cucumber/rspec/doubles.rb

@@ -13,9 +13,7 @@ Before do
 end
 
 After do
-  begin
-    RSpec::Mocks.verify
-  ensure
-    RSpec::Mocks.teardown
-  end
+  RSpec::Mocks.verify
+ensure
+  RSpec::Mocks.teardown
 end

data/lib/cucumber/running_test_case.rb

@@ -33,6 +33,7 @@ module Cucumber
 
       def exception
         return unless @result.failed?
+
         @result.exception
       end
 
@@ -49,7 +50,7 @@ module Cucumber
       end
 
       def source_tag_names
-        tags.map &:name
+        tags.map(&:name)
       end
 
       def with_result(result)

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

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'cucumber/messages'
+require 'cucumber/ci_environment'
+
+module Cucumber
+  class Runtime
+    # 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: 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)
+    #   - git: the git information of the CI environment if any
+    #     - remote: the remote of the git repository (e.g. git@github.com:cucumber/cucumber-ruby.git)
+    #     - revision: the revision of the git repository (e.g. abcdef)
+    #     - branch: the name of the git branch (e.g. main)
+    #     - tag: the name of the git tag (e.g. v1.0.0)
+    class MetaMessageBuilder
+      class << self
+        # Builds a Cucumber::Messages::Meta filled-in with the runtime meta-data
+        #
+        # @param [env] environment data from which the CI information will be
+        #  retrieved (default ENV). Can be used to mock the environment for
+        #  testing purpose.
+        #
+        # @return [Cucumber::Messages::Meta] the meta message
+        #
+        # @see Cucumber::Runtime::MetaMessageBuilder
+        #
+        # @example
+        # Cucumber::Runtime::MetaMessageBuilder.build_meta_message
+        #
+        def build_meta_message(env = ENV)
+          Cucumber::Messages::Meta.new(
+            protocol_version: protocol_version,
+            implementation: implementation,
+            runtime: runtime,
+            os: os,
+            cpu: cpu,
+            ci: ci(env)
+          )
+        end
+
+        private
+
+        def protocol_version
+          Cucumber::Messages::VERSION
+        end
+
+        def implementation
+          Cucumber::Messages::Product.new(
+            name: 'cucumber-ruby',
+            version: Cucumber::VERSION
+          )
+        end
+
+        def runtime
+          Cucumber::Messages::Product.new(
+            name: RUBY_ENGINE,
+            version: RUBY_VERSION
+          )
+        end
+
+        def os
+          Cucumber::Messages::Product.new(
+            name: RbConfig::CONFIG['target_os'],
+            version: Sys::Uname.uname.version
+          )
+        end
+
+        def cpu
+          Cucumber::Messages::Product.new(
+            name: RbConfig::CONFIG['target_cpu']
+          )
+        end
+
+        def ci(env)
+          ci_data = Cucumber::CiEnvironment.detect_ci_environment(env)
+          return nil unless ci_data
+
+          Cucumber::Messages::Ci.new(
+            name: ci_data[:name],
+            url: ci_data[:url],
+            build_number: ci_data[:buildNumber],
+            git: git_info(ci_data)
+          )
+        end
+
+        def git_info(ci_data)
+          return nil unless ci_data[:git]
+
+          Cucumber::Messages::Git.new(
+            remote: ci_data[:git][:remote],
+            revision: ci_data[:git][:revision],
+            branch: ci_data[:git][:branch],
+            tag: ci_data[:git][:tag]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/runtime/support_code.rb

@@ -72,6 +72,7 @@ module Cucumber
       def invoke_dynamic_step(step_name, multiline_argument, _location = nil)
         matches = step_matches(step_name)
         raise UndefinedDynamicStep, step_name if matches.empty?
+
         matches.first.invoke(multiline_argument)
       end
 
@@ -109,6 +110,7 @@ module Cucumber
 
       def apply_before_hooks(test_case)
         return test_case if test_case.test_steps.empty?
+
         scenario = RunningTestCase.new(test_case)
         hooks = registry.hooks_for(:before, scenario)
         BeforeHooks.new(@configuration.id_generator, hooks, scenario, @configuration.event_bus).apply_to(test_case)
@@ -116,6 +118,7 @@ module Cucumber
 
       def apply_after_hooks(test_case)
         return test_case if test_case.test_steps.empty?
+
         scenario = RunningTestCase.new(test_case)
         hooks = registry.hooks_for(:after, scenario)
         AfterHooks.new(@configuration.id_generator, hooks, scenario, @configuration.event_bus).apply_to(test_case)

data/lib/cucumber/runtime/user_interface.rb

@@ -21,8 +21,8 @@ module Cucumber
       # that makes a sound before invoking #ask.
       #
       def ask(question, timeout_seconds)
-        STDOUT.puts(question)
-        STDOUT.flush
+        $stdout.puts(question)
+        $stdout.flush
         puts(question)
 
         answer = if Cucumber::JRUBY
@@ -32,6 +32,7 @@ module Cucumber
                  end
 
         raise("Waited for input for #{timeout_seconds} seconds, then timed out.") unless answer
+
         puts(answer)
         answer
       end
@@ -40,15 +41,15 @@ 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
 
       def mri_gets(timeout_seconds)
         Timeout.timeout(timeout_seconds) do
-          STDIN.gets
+          $stdin.gets
         end
       rescue Timeout::Error
         nil
@@ -57,7 +58,7 @@ module Cucumber
       def jruby_gets(timeout_seconds)
         answer = nil
         t = java.lang.Thread.new do
-          answer = STDIN.gets
+          answer = $stdin.gets
         end
         t.start
         t.join(timeout_seconds * 1000)

data/lib/cucumber/runtime.rb

@@ -2,15 +2,17 @@
 
 require 'fileutils'
 require 'cucumber/configuration'
-require 'cucumber/create_meta'
+require 'cucumber/deprecate'
 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
@@ -24,8 +26,8 @@ module Cucumber
     attr_reader :path
 
     def initialize(original_exception, path)
-      super(original_exception)
       @path = path
+      super(original_exception)
     end
   end
 
@@ -35,6 +37,7 @@ module Cucumber
   class FeatureFolderNotFoundException < RuntimeError
     def initialize(path)
       @path = path
+      super
     end
 
     def message
@@ -63,21 +66,22 @@ module Cucumber
       @support_code.configure(@configuration)
     end
 
-    require 'cucumber/wire/plugin'
     def run!
       @configuration.notify :envelope, Cucumber::Messages::Envelope.new(
-        meta: Cucumber::CreateMeta.create_meta('cucumber-ruby', Cucumber::VERSION)
+        meta: MetaMessageBuilder.build_meta_message
       )
 
       load_step_definitions
-      install_wire_plugin
-      fire_after_configuration_hook
+      fire_install_plugin_hook
+      fire_before_all_hook unless dry_run?
       # TODO: can we remove this state?
       self.visitor = report
 
       receiver = Test::Runner.new(@configuration.event_bus)
       compile features, receiver, filters, @configuration.event_bus
-      @configuration.notify :test_run_finished
+      @configuration.notify :test_run_finished, !failure?
+
+      fire_after_all_hook unless dry_run?
     end
 
     def features_paths
@@ -106,10 +110,26 @@ module Cucumber
       Core::Test::DocString.new(string_without_triple_quotes, content_type)
     end
 
+    def failure?
+      if @configuration.wip?
+        summary_report.test_cases.total_passed.positive?
+      else
+        !summary_report.ok?(strict: @configuration.strict)
+      end
+    end
+
     private
 
-    def fire_after_configuration_hook #:nodoc:
-      @support_code.fire_hook(:after_configuration, @configuration)
+    def fire_install_plugin_hook # :nodoc:
+      @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
 
     require 'cucumber/core/gherkin/document'
@@ -130,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
@@ -166,11 +186,15 @@ module Cucumber
 
     require 'cucumber/formatter/ignore_missing_messages'
     require 'cucumber/formatter/fail_fast'
+    require 'cucumber/formatter/publish_banner_printer'
     require 'cucumber/core/report/summary'
+
     def report
       return @report if @report
+
       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)
     end
 
@@ -182,6 +206,10 @@ module Cucumber
       @fail_fast_report ||= Formatter::FailFast.new(@configuration)
     end
 
+    def publish_banner_printer
+      @publish_banner_printer ||= Formatter::PublishBannerPrinter.new(@configuration)
+    end
+
     def formatters
       @formatters ||=
         @configuration.formatter_factories do |factory, formatter_options, path_or_io|
@@ -192,10 +220,12 @@ module Cucumber
     def create_formatter(factory, formatter_options, path_or_io)
       if accept_options?(factory)
         return factory.new(@configuration, formatter_options) if path_or_io.nil?
+
         factory.new(@configuration.with_options(out_stream: path_or_io),
                     formatter_options)
       else
         return factory.new(@configuration) if path_or_io.nil?
+
         factory.new(@configuration.with_options(out_stream: path_or_io))
       end
     end
@@ -204,17 +234,8 @@ module Cucumber
       factory.instance_method(:initialize).arity > 1
     end
 
-    def failure?
-      if @configuration.wip?
-        summary_report.test_cases.total_passed > 0
-      else
-        !summary_report.ok?(@configuration.strict)
-      end
-    end
-    public :failure?
-
     require 'cucumber/core/test/filters'
-    def filters # rubocop:disable Metrics/AbcSize
+    def filters
       tag_expressions = @configuration.tag_expressions
       name_regexps = @configuration.name_regexps
       tag_limits = @configuration.tag_limits
@@ -228,12 +249,17 @@ module Cucumber
         step_match_search = StepMatchSearch.new(@support_code.registry.method(:step_matches), @configuration)
         filters << Filters::ActivateSteps.new(step_match_search, @configuration)
         @configuration.filters.each { |filter| filters << filter }
+
         unless configuration.dry_run?
           filters << Filters::ApplyAfterStepHooks.new(@support_code)
           filters << Filters::ApplyBeforeHooks.new(@support_code)
           filters << Filters::ApplyAfterHooks.new(@support_code)
           filters << Filters::ApplyAroundHooks.new(@support_code)
-          filters << Filters::BroadcastTestCaseReadyEvent.new(@configuration)
+        end
+
+        filters << Filters::BroadcastTestCaseReadyEvent.new(@configuration)
+
+        unless configuration.dry_run?
           filters << Filters::BroadcastTestRunStartedEvent.new(@configuration)
           filters << Filters::Quit.new
           filters << Filters::Retry.new(@configuration)
@@ -248,8 +274,8 @@ module Cucumber
       @support_code.load_files!(files)
     end
 
-    def install_wire_plugin
-      Cucumber::Wire::Plugin.new(@configuration, @support_code.registry).install if @configuration.all_files_to_load.any? { |f| f =~ /\.wire$/ }
+    def registry_wrapper
+      Cucumber::Glue::RegistryWrapper.new(@support_code.registry)
     end
 
     def log

data/lib/cucumber/step_match.rb

@@ -4,11 +4,12 @@ require 'cucumber/multiline_argument'
 
 module Cucumber
   # Represents the match found between a Test Step and its activation
-  class StepMatch #:nodoc:
+  class StepMatch # :nodoc:
     attr_reader :step_definition, :step_arguments
 
     def initialize(step_definition, step_name, step_arguments)
       raise "step_arguments can't be nil (but it can be an empty array)" if step_arguments.nil?
+
       @step_definition = step_definition
       @name_to_match = step_name
       @step_arguments = step_arguments
@@ -28,7 +29,7 @@ module Cucumber
     end
 
     def invoke(multiline_arg)
-      all_args = deep_clone_args
+      all_args = args
       multiline_arg.append_to(all_args)
       @step_definition.invoke(all_args)
     end
@@ -77,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
@@ -90,15 +91,9 @@ module Cucumber
       s
     end
 
-    def inspect #:nodoc:
+    def inspect # :nodoc:
       "#<#{self.class}: #{location}>"
     end
-
-    private
-
-    def deep_clone_args
-      Marshal.load(Marshal.dump(args))
-    end
   end
 
   class SkippingStepMatch
@@ -107,7 +102,7 @@ module Cucumber
     end
   end
 
-  class NoStepMatch #:nodoc:
+  class NoStepMatch # :nodoc:
     attr_reader :step_definition, :name
 
     def initialize(step, name)
@@ -121,6 +116,7 @@ module Cucumber
 
     def location
       raise "No location for #{@step}" unless @step.location
+
       @step.location
     end
 

data/lib/cucumber/step_match_search.rb

@@ -20,6 +20,7 @@ module Cucumber
       def call(step_name)
         result = @search.call(step_name)
         raise Cucumber::Ambiguous.new(step_name, result, @configuration.guess?) if result.length > 1
+
         result
       end
     end
@@ -35,7 +36,7 @@ module Cucumber
 
       private
 
-      def best_matches(_step_name, step_matches) #:nodoc:
+      def best_matches(_step_name, step_matches) # :nodoc:
         no_groups      = step_matches.select { |step_match| step_match.args.empty? }
         max_arg_length = step_matches.map { |step_match| step_match.args.length }.max
         top_groups     = step_matches.select { |step_match| step_match.args.length == max_arg_length }
@@ -54,7 +55,7 @@ module Cucumber
 
     require 'delegate'
     class CachesStepMatch < SimpleDelegator
-      def call(step_name) #:nodoc:
+      def call(step_name) # :nodoc:
         @match_cache ||= {}
 
         matches = @match_cache[step_name]