cucumber 7.0.0 → 8.0.0

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

@@ -15,11 +15,13 @@ module Cucumber
 
         def attempt_by_test_case(test_case)
           raise TestCaseUnknownError, "No test case found for #{test_case.id} }. Known: #{@attempts_by_test_case_id.keys}" unless @attempts_by_test_case_id.key?(test_case.id)
+
           @attempts_by_test_case_id[test_case.id]
         end
 
         def test_case_started_id_by_test_case(test_case)
           raise TestCaseUnknownError, "No test case found for #{test_case.id} }. Known: #{@test_case_started_id_by_test_case_id.keys}" unless @test_case_started_id_by_test_case_id.key?(test_case.id)
+
           @test_case_started_id_by_test_case_id[test_case.id]
         end
 

data/lib/cucumber/formatter/rerun.rb

@@ -15,6 +15,7 @@ module Cucumber
           test_case, result = *event.attributes
           if @config.strict.strict?(:flaky)
             next if result.ok?(@config.strict)
+
             add_to_failures(test_case)
           else
             unless @latest_failed_test_case.nil?
@@ -31,6 +32,7 @@ module Cucumber
         config.on_event :test_run_finished do
           add_to_failures(@latest_failed_test_case) unless @latest_failed_test_case.nil?
           next if @failures.empty?
+
           @io.print file_failures.join("\n")
         end
       end

data/lib/cucumber/formatter/summary.rb

@@ -47,6 +47,7 @@ module Cucumber
       def print_feature(test_case)
         uri = test_case.location.file
         return if @current_feature_uri == uri
+
         feature_name = gherkin_document(uri).feature.name
         @io.puts unless @current_feature_uri.nil?
         @io.puts feature_name

data/lib/cucumber/formatter/unicode.rb

@@ -17,7 +17,7 @@ if Cucumber::WINDOWS
     end
   else
     Cucumber::CODEPAGE = 'cp1252'.freeze
-    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.")
+    $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
 
   module Cucumber
@@ -28,7 +28,7 @@ if Cucumber::WINDOWS
           def cucumber_preprocess_output(*out)
             out.map { |arg| arg.to_s.encode(Encoding.default_external) }
           rescue Encoding::UndefinedConversionError => e
-            STDERR.cucumber_puts("WARNING: #{e.message}")
+            $stderr.cucumber_puts("WARNING: #{e.message}")
             out
           end
 
@@ -45,8 +45,8 @@ if Cucumber::WINDOWS
       end
 
       Kernel.extend(self)
-      STDOUT.extend(self)
-      STDERR.extend(self)
+      $stdout.extend(self)
+      $stderr.extend(self)
     end
   end
 end

data/lib/cucumber/formatter/usage.rb

@@ -78,7 +78,7 @@ module Cucumber
           if @stepdef_to_match[stepdef_key].any?
             print_steps(stepdef_key)
           else
-            @io.puts('  ' + format_string('NOT MATCHED BY ANY STEPS', :failed))
+            @io.puts("  #{format_string('NOT MATCHED BY ANY STEPS', :failed)}")
           end
         end
         @io.puts
@@ -86,7 +86,7 @@ module Cucumber
       end
 
       def print_step_definition(stepdef_key)
-        @io.print format_string(format('%<duration>.7f', duration: stepdef_key.mean_duration), :skipped) + ' ' unless config.dry_run?
+        @io.print "#{format_string(format('%<duration>.7f', duration: stepdef_key.mean_duration), :skipped)} " unless config.dry_run?
         @io.print format_string(stepdef_key.regexp_source, stepdef_key.status)
         if config.source?
           indent_amount = max_length - stepdef_key.regexp_source.unpack('U*').length
@@ -99,7 +99,7 @@ module Cucumber
       def print_steps(stepdef_key)
         @stepdef_to_match[stepdef_key].each do |step|
           @io.print '  '
-          @io.print format_string(format('%<duration>.7f', duration: step[:duration]), :skipped) + ' ' unless config.dry_run?
+          @io.print "#{format_string(format('%<duration>.7f', duration: step[:duration]), :skipped)} " unless config.dry_run?
           @io.print format_step(step[:keyword], step[:step_match], step[:status], nil)
           if config.source?
             indent_amount = max_length - (step[:keyword].unpack('U*').length + step[:step_match].format_args.unpack('U*').length)

data/lib/cucumber/gherkin/data_table_parser.rb

@@ -19,6 +19,7 @@ module Cucumber
         end
 
         return if gherkin_document.nil?
+
         gherkin_document[:feature][:children][0][:scenario][:steps][0][:data_table][:rows].each do |row|
           @builder.row(row[:cells].map { |cell| cell[:value] })
         end

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

@@ -54,7 +54,7 @@ module Cucumber
         }.freeze
 
         ALIASES = Hash.new do |h, k|
-          h[Regexp.last_match(1)] + ',bold' if k.to_s =~ /(.*)_arg/
+          "#{h[Regexp.last_match(1)]},bold" if k.to_s =~ /(.*)_arg/
         end.merge(
           'undefined' => 'yellow',
           'pending'   => 'yellow',
@@ -74,7 +74,7 @@ module Cucumber
           end
         end
 
-        ALIASES.keys.each do |key|
+        ALIASES.each_key do |key|
           define_method(key) do
             ALIASES[key].split(',').map { |color| COLORS[color] }.join('')
           end

data/lib/cucumber/glue/dsl.rb

@@ -19,8 +19,8 @@ module Cucumber
           @rb_language.build_rb_world_factory(world_modules, namespaced_world_modules, proc)
         end
 
-        def register_rb_hook(phase, tag_names, proc)
-          @rb_language.register_rb_hook(phase, tag_names, proc)
+        def register_rb_hook(phase, tag_names, proc, name: nil)
+          @rb_language.register_rb_hook(phase, tag_names, proc, name: name)
         end
 
         def define_parameter_type(parameter_type)
@@ -62,14 +62,14 @@ module Cucumber
 
       # Registers a proc that will run before each Scenario. You can register as many
       # as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
-      def Before(*tag_expressions, &proc)
-        Dsl.register_rb_hook('before', tag_expressions, proc)
+      def Before(*tag_expressions, name: nil, &proc)
+        Dsl.register_rb_hook('before', tag_expressions, proc, name: name)
       end
 
       # Registers a proc that will run after each Scenario. You can register as many
       # as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
-      def After(*tag_expressions, &proc)
-        Dsl.register_rb_hook('after', tag_expressions, proc)
+      def After(*tag_expressions, name: nil, &proc)
+        Dsl.register_rb_hook('after', tag_expressions, proc, name: name)
       end
 
       # Registers a proc that will be wrapped around each scenario. The proc
@@ -77,14 +77,14 @@ module Cucumber
       # argument (but passed as a regular argument, since blocks cannot accept
       # blocks in 1.8), on which it should call the .call method. You can register
       # as many  as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
-      def Around(*tag_expressions, &proc)
-        Dsl.register_rb_hook('around', tag_expressions, proc)
+      def Around(*tag_expressions, name: nil, &proc)
+        Dsl.register_rb_hook('around', tag_expressions, proc, name: name)
       end
 
       # Registers a proc that will run after each Step. You can register as
       # as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
-      def AfterStep(*tag_expressions, &proc)
-        Dsl.register_rb_hook('after_step', tag_expressions, proc)
+      def AfterStep(*tag_expressions, name: nil, &proc)
+        Dsl.register_rb_hook('after_step', tag_expressions, proc, name: name)
       end
 
       def ParameterType(options)
@@ -107,10 +107,21 @@ module Cucumber
         value.nil? ? default : value
       end
 
-      # Registers a proc that will run after Cucumber is configured. You can register as
-      # as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
-      def AfterConfiguration(&proc)
-        Dsl.register_rb_hook('after_configuration', [], proc)
+      # Registers a proc that will run after Cucumber is configured in order to install an external plugin.
+      def InstallPlugin(name: nil, &proc)
+        Dsl.register_rb_hook('install_plugin', [], proc, name: name)
+      end
+
+      # Registers a proc that will run before the execution of the scenarios.
+      # Use it for your final set-ups
+      def BeforeAll(name: nil, &proc)
+        Dsl.register_rb_hook('before_all', [], proc, name: name)
+      end
+
+      # Registers a proc that will run after the execution of the scenarios.
+      # Use it for your final clean-ups
+      def AfterAll(name: nil, &proc)
+        Dsl.register_rb_hook('after_all', [], proc, name: name)
       end
 
       # Registers a new Ruby StepDefinition. This method is aliased
@@ -136,5 +147,8 @@ module Cucumber
   end
 end
 
-# TODO: can we avoid adding methods to the global namespace (Kernel)
+# rubocop:disable Style/MixinUsage
+# This "should" always be present, because it allows users to write `Before` and `After`
+# See. https://github.com/cucumber/cucumber-ruby/pull/1566#discussion_r683235396
 extend(Cucumber::Glue::Dsl)
+# rubocop:enable Style/MixinUsage

data/lib/cucumber/glue/hook.rb

@@ -6,11 +6,12 @@ module Cucumber
   module Glue
     # TODO: Kill pointless wrapper for Before, After and AfterStep hooks with fire
     class Hook
-      attr_reader :id, :tag_expressions, :location
+      attr_reader :id, :tag_expressions, :location, :name
 
-      def initialize(id, registry, tag_expressions, proc)
+      def initialize(id, registry, tag_expressions, proc, name: nil)
         @id = id
         @registry = registry
+        @name = name
         @tag_expressions = sanitize_tag_expressions(tag_expressions)
         @proc = proc
         @location = Cucumber::Core::Test::Location.from_source_location(*@proc.source_location)
@@ -32,7 +33,8 @@ module Cucumber
         Cucumber::Messages::Envelope.new(
           hook: Cucumber::Messages::Hook.new(
             id: id,
-            tag_expression: tag_expressions.join(' '),
+            name: name,
+            tag_expression: tag_expressions.empty? ? nil : tag_expressions.join(' '),
             source_reference: Cucumber::Messages::SourceReference.new(
               uri: location.file,
               location: Cucumber::Messages::Location.new(
@@ -58,6 +60,7 @@ module Cucumber
           end
 
           next unless tag_expression.include?(',')
+
           warn("Found tagged hook with '#{tag_expression}'." \
             "'@tag1,@tag2' is no longer supported, use '@tag or @tag2' instead.")
         end

data/lib/cucumber/glue/invoke_in_world.rb

@@ -12,6 +12,7 @@ module Cucumber
 
         instance_exec_pos = backtrace.index(instance_exec_invocation_line)
         return unless instance_exec_pos
+
         replacement_line = instance_exec_pos + INSTANCE_EXEC_OFFSET
         backtrace[replacement_line].gsub!(/`.*'/, "`#{pseudo_method}'") if pseudo_method
 
@@ -27,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).to_s + '+' : ari
+              ari = ari < 0 ? "#{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}."
@@ -40,9 +41,8 @@ module Cucumber
 
       def self.cucumber_compatible_arity?(args, block)
         return true if block.arity == args.length
-        if block.arity < 0
-          return true if args.length >= (block.arity.abs - 1)
-        end
+        return true if block.arity.negative? && args.length >= (block.arity.abs - 1)
+
         false
       end
 

data/lib/cucumber/glue/proto_world.rb

@@ -138,8 +138,8 @@ module Cucumber
           # TODO: pass these in when building the module, instead of mutating them later
           # Extend the World with user-defined modules
           def add_modules!(world_modules, namespaced_world_modules)
-            add_world_modules!(world_modules)
-            add_namespaced_modules!(namespaced_world_modules)
+            add_world_modules!(world_modules) if world_modules.any?
+            add_namespaced_modules!(namespaced_world_modules) if namespaced_world_modules.any?
           end
 
           define_method(:step) do |name, raw_multiline_arg = nil|
@@ -185,14 +185,13 @@ module Cucumber
             modules.each do |namespace, world_modules|
               world_modules.each do |world_module|
                 variable_name = "@__#{namespace}_world"
+                inner_world = instance_variable_get(variable_name) || Object.new
+
+                instance_variable_set(
+                  variable_name,
+                  inner_world.extend(world_module)
+                )
 
-                inner_world = if self.class.respond_to?(namespace)
-                                instance_variable_get(variable_name)
-                              else
-                                Object.new
-                              end
-                instance_variable_set(variable_name,
-                                      inner_world.extend(world_module))
                 self.class.send(:define_method, namespace) do
                   instance_variable_get(variable_name)
                 end
@@ -202,6 +201,8 @@ module Cucumber
 
           # @private
           def stringify_namespaced_modules
+            return '' if @__namespaced_modules.nil?
+
             @__namespaced_modules.map { |k, v| "#{v.join(',')} (as #{k})" }.join('+')
           end
         end

data/lib/cucumber/glue/registry_and_more.rb

@@ -4,6 +4,7 @@ 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/deprecate'
 require 'cucumber/glue/dsl'
 require 'cucumber/glue/snippet'
 require 'cucumber/glue/hook'
@@ -71,8 +72,8 @@ module Cucumber
         end
       end
 
-      def register_rb_hook(phase, tag_expressions, proc)
-        hook = add_hook(phase, Hook.new(@configuration.id_generator.new_id, self, tag_expressions, proc))
+      def register_rb_hook(phase, tag_expressions, proc, name: nil)
+        hook = add_hook(phase, Hook.new(@configuration.id_generator.new_id, self, tag_expressions, proc, name: name))
         @configuration.notify :envelope, hook.to_envelope
         hook
       end
@@ -91,7 +92,7 @@ module Cucumber
         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]
+        type_name = e.message.match(/^Undefined parameter type ['|{](.*)['|}].?$/)[1]
 
         @configuration.notify :undefined_parameter_type, type_name, string_or_regexp
       end
@@ -99,6 +100,7 @@ module Cucumber
       def build_rb_world_factory(world_modules, namespaced_world_modules, proc)
         if proc
           raise MultipleWorld.new(@world_proc, proc) if @world_proc
+
           @world_proc = proc
         end
         @world_modules ||= []
@@ -134,9 +136,21 @@ module Cucumber
         @current_world = nil
       end
 
-      def after_configuration(configuration)
-        hooks[:after_configuration].each do |hook|
-          hook.invoke('AfterConfiguration', configuration)
+      def install_plugin(configuration, registry)
+        hooks[:install_plugin].each do |hook|
+          hook.invoke('InstallPlugin', [configuration, registry])
+        end
+      end
+
+      def before_all
+        hooks[:before_all].each do |hook|
+          hook.invoke('BeforeAll', [])
+        end
+      end
+
+      def after_all
+        hooks[:after_all].each do |hook|
+          hook.invoke('AfterAll', [])
         end
       end
 
@@ -149,7 +163,7 @@ module Cucumber
         @hooks = nil
       end
 
-      def hooks_for(phase, scenario) #:nodoc:
+      def hooks_for(phase, scenario) # :nodoc:
         hooks[phase.to_sym].select { |hook| scenario.accept_hook?(hook) }
       end
 
@@ -168,6 +182,7 @@ module Cucumber
       def create_expression(string_or_regexp)
         return CucumberExpressions::CucumberExpression.new(string_or_regexp, @parameter_type_registry) if string_or_regexp.is_a?(String)
         return CucumberExpressions::RegularExpression.new(string_or_regexp, @parameter_type_registry) if string_or_regexp.is_a?(Regexp)
+
         raise ArgumentError, 'Expression must be a String or Regexp'
       end
 

data/lib/cucumber/glue/registry_wrapper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Cucumber
+  module Glue
+    ##
+    # This class wraps some internals methods to expose them to external plugins.
+    class RegistryWrapper
+      def initialize(registry)
+        @registry = registry
+      end
+
+      ##
+      # Creates a new CucumberExpression from the given +string_or_regexp+.
+      #
+      # If +string_or_regexp+ is a string, it will return a new CucumberExpression::CucumberExpression
+      #
+      # If +string_or_regexp+ is a regexp, it will return a new CucumberExpressions::RegularExpression
+      #
+      # An ArgumentError is raised if +string_or_regexp+ is not a string or a regexp
+      def create_expression(string_or_regexp)
+        @registry.create_expression(string_or_regexp)
+      end
+
+      ##
+      # Return the current execution environment - AKA an isntance of World
+      def current_world
+        @registry.current_world
+      end
+    end
+  end
+end

data/lib/cucumber/glue/step_definition.rb

@@ -25,6 +25,7 @@ module Cucumber
       class << self
         def new(id, registry, string_or_regexp, proc_or_sym, options)
           raise MissingProc if proc_or_sym.nil?
+
           super id, registry, registry.create_expression(string_or_regexp), create_proc(proc_or_sym, options)
         end
 
@@ -33,6 +34,7 @@ module Cucumber
         def create_proc(proc_or_sym, options)
           return proc_or_sym if proc_or_sym.is_a?(Proc)
           raise ArgumentError unless proc_or_sym.is_a?(Symbol)
+
           message = proc_or_sym
           target_proc = parse_target_proc_from(options)
           patch_location_onto lambda { |*args|
@@ -49,6 +51,7 @@ module Cucumber
 
         def parse_target_proc_from(options)
           return -> { self } unless options.key?(:on)
+
           target = options[:on]
           case target
           when Proc
@@ -65,6 +68,7 @@ module Cucumber
 
       def initialize(id, registry, expression, proc)
         raise 'No regexp' if expression.is_a?(Regexp)
+
         @id = id
         @registry = registry
         @expression = expression
@@ -92,6 +96,7 @@ module Cucumber
 
       def expression_type
         return Cucumber::Messages::StepDefinitionPatternType::CUCUMBER_EXPRESSION if expression.is_a?(CucumberExpressions::CucumberExpression)
+
         Cucumber::Messages::StepDefinitionPatternType::REGULAR_EXPRESSION
       end
 
@@ -122,9 +127,7 @@ module Cucumber
 
       # @api private
       def arguments_from(step_name)
-        args = @expression.match(step_name)
-        # @registry.invoked_step_definition(regexp_source, location) if args
-        args
+        @expression.match(step_name)
       end
 
       # @api private

data/lib/cucumber/hooks.rb

@@ -19,6 +19,7 @@ module Cucumber
 
       def after_step_hook(id, test_step, location, &block)
         raise ArgumentError if test_step.hook?
+
         build_hook_step(id, location, block, AfterStepHook, Core::Test::Action)
       end
 

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

@@ -1,7 +1,7 @@
 module Cucumber
   module MultilineArgument
     class DataTable
-      class DiffMatrices #:nodoc:
+      class DiffMatrices # :nodoc:
         attr_accessor :cell_matrix, :other_table_cell_matrix, :options
 
         def initialize(cell_matrix, other_table_cell_matrix, options)
@@ -113,6 +113,7 @@ module Cucumber
             row_index = row_indices.index(i)
             row = cell_matrix[row_index] if row_index
             next unless row
+
             (original_width..padded_width).each do |col_index|
               surplus_cell = other_row[col_index]
               row[col_index].value = surplus_cell.value if row[col_index]