cucumber 7.1.0 → 9.2.1

data/lib/cucumber/deprecate.rb

@@ -4,51 +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 Cucumber::VERSION >= remove_after_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/errors.rb

@@ -9,7 +9,7 @@ module Cucumber
       return result.with_message(with_prefix(result.message)) if result.is_a?(self)
 
       begin
-        raise new(with_prefix(step_name)) # rubocop:disable Style/RaiseArgs
+        raise self, with_prefix(step_name)
       rescue StandardError => e
         e
       end
@@ -35,7 +35,8 @@ module Cucumber
   # Raised when a step matches 2 or more StepDefinitions
   class Ambiguous < StandardError
     def initialize(step_name, step_definitions, used_guess)
-      message = String.new # rubocop:disable Style/EmptyLiteral
+      # TODO: [LH] - Just use a heredoc here to fix this up
+      message = String.new
       message << "Ambiguous match of \"#{step_name}\":\n\n"
       message << step_definitions.map(&:backtrace_line).join("\n")
       message << "\n\n"

data/lib/cucumber/events/envelope.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/core/events'
 
 module Cucumber

data/lib/cucumber/events/gherkin_source_parsed.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/core/events'
 
 module Cucumber

data/lib/cucumber/events/gherkin_source_read.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/core/events'
 
 module Cucumber

data/lib/cucumber/events/hook_test_step_created.rb

@@ -6,8 +6,7 @@ module Cucumber
   module Events
     # Event fired when a step is created from a hook
     class HookTestStepCreated < Core::Event.new(:test_step, :hook)
-      attr_reader :test_step
-      attr_reader :hook
+      attr_reader :test_step, :hook
     end
   end
 end

data/lib/cucumber/events/step_activated.rb

@@ -15,12 +15,6 @@ module Cucumber
       #
       # @return [Cucumber::StepMatch]
       attr_reader :step_match
-
-      # @private
-      def initialize(test_step, step_match)
-        @test_step = test_step
-        @step_match = step_match
-      end
     end
   end
 end

data/lib/cucumber/events/step_definition_registered.rb

@@ -10,11 +10,6 @@ module Cucumber
       #
       # @return [RbSupport::RbStepDefinition]
       attr_reader :step_definition
-
-      # _@private
-      def initialize(step_definition)
-        @step_definition = step_definition
-      end
     end
   end
 end

data/lib/cucumber/events/test_case_created.rb

@@ -6,8 +6,7 @@ module Cucumber
   module Events
     # Event fired when a Test::Case is created from a Pickle
     class TestCaseCreated < Core::Event.new(:test_case, :pickle)
-      attr_reader :test_case
-      attr_reader :pickle
+      attr_reader :test_case, :pickle
     end
   end
 end

data/lib/cucumber/events/test_case_finished.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/core/events'
 
 module Cucumber

data/lib/cucumber/events/test_case_started.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/core/events'
 
 module Cucumber

data/lib/cucumber/events/test_run_finished.rb

@@ -5,7 +5,8 @@ require 'cucumber/core/events'
 module Cucumber
   module Events
     # Event fired after all test cases have finished executing
-    class TestRunFinished < Core::Event.new
+    class TestRunFinished < Core::Event.new(:success)
+      attr_reader :success
     end
   end
 end

data/lib/cucumber/events/test_step_created.rb

@@ -6,8 +6,7 @@ module Cucumber
   module Events
     # Event fired when a TestStep is created from a PickleStep
     class TestStepCreated < Core::Event.new(:test_step, :pickle_step)
-      attr_reader :test_step
-      attr_reader :pickle_step
+      attr_reader :test_step, :pickle_step
     end
   end
 end

data/lib/cucumber/events/test_step_finished.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/core/events'
 
 module Cucumber

data/lib/cucumber/events/test_step_started.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/core/events'
 
 module Cucumber

data/lib/cucumber/events/undefined_parameter_type.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'cucumber/core/events'
 
 module Cucumber
   module Events
     class UndefinedParameterType < Core::Event.new(:type_name, :expression)
-      attr_reader :type_name
-      attr_reader :expression
+      attr_reader :type_name, :expression
     end
   end
 end

data/lib/cucumber/events.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Dir[File.dirname(__FILE__) + '/events/*.rb'].map(&method(:require))
+Dir["#{File.dirname(__FILE__)}/events/*.rb"].map(&method(:require))
 
 module Cucumber
   # Events tell you what's happening while Cucumber runs your features.

data/lib/cucumber/file_specs.rb

@@ -5,7 +5,7 @@ require 'cucumber/core/test/location'
 
 module Cucumber
   class FileSpecs
-    FILE_COLON_LINE_PATTERN = /^([\w\W]*?)(?::([\d:]+))?$/ #:nodoc:
+    FILE_COLON_LINE_PATTERN = /^([\w\W]*?)(?::([\d:]+))?$/.freeze # :nodoc:
 
     def initialize(file_specs)
       Cucumber.logger.debug("Features:\n")
@@ -32,6 +32,7 @@ module Cucumber
 
       def locations
         return [Core::Test::Location.new(@file)] if @lines.empty?
+
         @lines.map { |line| Core::Test::Location.new(@file, line) }
       end
     end

data/lib/cucumber/filters/activate_steps.rb

@@ -52,6 +52,7 @@ module Cucumber
             end
             configuration.notify :step_activated, test_step, match
             return SkippingStepMatch.new if configuration.dry_run?
+
             match
           end
 

data/lib/cucumber/filters/retry.rb

@@ -7,6 +7,11 @@ require 'cucumber/events'
 module Cucumber
   module Filters
     class Retry < Core::Filter.new(:configuration)
+      def initialize(*_args)
+        super
+        @total_permanently_failed = 0
+      end
+
       def test_case(test_case)
         configuration.on_event(:test_case_finished) do |event|
           next unless retry_required?(test_case, event)
@@ -21,7 +26,21 @@ module Cucumber
       private
 
       def retry_required?(test_case, event)
-        event.test_case == test_case && event.result.failed? && test_case_counts[test_case] < configuration.retry_attempts
+        return false unless event.test_case == test_case
+
+        return false unless event.result.failed?
+
+        return false if @total_permanently_failed >= configuration.retry_total_tests
+
+        retry_required = test_case_counts[test_case] < configuration.retry_attempts
+        if retry_required
+          # retry test
+          true
+        else
+          # test failed after max. attempts
+          @total_permanently_failed += 1
+          false
+        end
       end
 
       def test_case_counts

data/lib/cucumber/filters/tag_limits/verifier.rb

@@ -47,9 +47,7 @@ module Cucumber
             locations.count
           end
 
-          attr_reader :tag_name
-          attr_reader :limit
-          attr_reader :locations
+          attr_reader :tag_name, :limit, :locations
         end
       end
     end

data/lib/cucumber/filters/tag_limits.rb

@@ -38,9 +38,7 @@ module Cucumber
 
       private
 
-      attr_reader :gated_receiver
-      attr_reader :test_case_index
-      attr_reader :verifier
+      attr_reader :gated_receiver, :test_case_index, :verifier
     end
   end
 end

data/lib/cucumber/formatter/ansicolor.rb

@@ -3,21 +3,48 @@
 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
-    # Defines aliases for coloured output. You don't invoke any methods from this
-    # module directly, but you can change the output colours by defining
-    # a <tt>CUCUMBER_COLORS</tt> variable in your shell, very much like how you can
-    # tweak the familiar POSIX command <tt>ls</tt> with
-    # <a href="http://mipsisrisc.com/rambling/2008/06/27/lscolorsls_colors-now-with-linux-support/">$LSCOLORS/$LS_COLORS</a>
+    # This module allows to format cucumber related outputs using ANSI escape sequences.
+    #
+    # For example, it provides a `passed` method which returns the string with
+    # the ANSI escape sequence to format it green per default.
+    #
+    # To use this, include or extend it in your class.
+    #
+    # Example:
+    #
+    #   require 'cucumber/formatter/ansicolor'
+    #
+    #   class MyFormatter
+    #     extend Cucumber::Term::ANSIColor
+    #
+    #     def on_test_step_finished(event)
+    #       $stdout.puts undefined(event.test_step) if event.result.undefined?
+    #       $stdout.puts passed(event.test_step) if event.result.passed?
+    #     end
+    #   end
+    #
+    # This module also allows the user to customize the format of cucumber outputs
+    # using environment variables.
+    #
+    # For instance, if your shell has a black background and a green font (like the
+    # "Homebrew" settings for OS X' Terminal.app), you may want to override passed
+    # steps to be white instead of green.
+    #
+    # Example:
+    #
+    #   export CUCUMBER_COLORS="passed=white,bold:passed_param=white,bold,underline"
     #
     # The colours that you can change are:
     #
     # * <tt>undefined</tt>     - defaults to <tt>yellow</tt>
     # * <tt>pending</tt>       - defaults to <tt>yellow</tt>
     # * <tt>pending_param</tt> - defaults to <tt>yellow,bold</tt>
+    # * <tt>flaky</tt>         - defaults to <tt>yellow</tt>
+    # * <tt>flaky_param</tt>   - defaults to <tt>yellow,bold</tt>
     # * <tt>failed</tt>        - defaults to <tt>red</tt>
     # * <tt>failed_param</tt>  - defaults to <tt>red,bold</tt>
     # * <tt>passed</tt>        - defaults to <tt>green</tt>
@@ -29,46 +56,39 @@ module Cucumber
     # * <tt>comment</tt>       - defaults to <tt>grey</tt>
     # * <tt>tag</tt>           - defaults to <tt>cyan</tt>
     #
-    # For instance, if your shell has a black background and a green font (like the
-    # "Homebrew" settings for OS X' Terminal.app), you may want to override passed
-    # steps to be white instead of green.
-    #
-    # Although not listed, you can also use <tt>grey</tt>.
-    #
-    # Examples: (On Windows, use SET instead of export.)
-    #
-    #   export CUCUMBER_COLORS="passed=white"
-    #   export CUCUMBER_COLORS="passed=white,bold:passed_param=white,bold,underline"
-    #
     # To see what colours and effects are available, just run this in your shell:
     #
-    #   ruby -e "require 'rubygems'; require 'term/ansicolor'; puts Cucumber::Term::ANSIColor.attributes"
+    #   ruby -e "require 'rubygems'; require 'cucumber/term/ansicolor'; puts Cucumber::Term::ANSIColor.attributes"
     #
     module ANSIColor
       include Cucumber::Term::ANSIColor
 
       ALIASES = Hash.new do |h, k|
-        h[Regexp.last_match(1)] + ',bold' if k.to_s =~ /(.*)_param/
+        next unless k.to_s =~ /(.*)_param/
+
+        "#{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'
       )
 
-      if ENV['CUCUMBER_COLORS'] # Example: export CUCUMBER_COLORS="passed=red:failed=yellow"
-        ENV['CUCUMBER_COLORS'].split(':').each do |pair|
+      # Apply the custom color scheme -> i.e. apply_custom_colors('passed=white')
+      def self.apply_custom_colors(colors)
+        colors.split(':').each do |pair|
           a = pair.split('=')
           ALIASES[a[0]] = a[1]
         end
       end
+      apply_custom_colors(ENV['CUCUMBER_COLORS']) if ENV['CUCUMBER_COLORS']
 
-      # Eval to define the color-named methods required by Term::ANSIColor.
+      # Define the color-named methods required by Term::ANSIColor.
       #
       # Examples:
       #
@@ -80,67 +100,39 @@ module Cucumber
       #     red(bold(string, &proc)) + red
       #   end
       ALIASES.each_key do |method_name|
-        next if method_name =~ /.*_param/
-        code = <<-COLOR
-          def #{method_name}(string=nil, &proc)
-            #{ALIASES[method_name].split(',').join('(') + '(string, &proc' + ')' * ALIASES[method_name].split(',').length}
-          end
-          # This resets the colour to the non-param colour
-          def #{method_name}_param(string=nil, &proc)
-            #{ALIASES[method_name + '_param'].split(',').join('(') + '(string, &proc' + ')' * ALIASES[method_name + '_param'].split(',').length} + #{ALIASES[method_name].split(',').join(' + ')}
-          end
-        COLOR
-        eval(code) # rubocop:disable Security/Eval
-      end
+        next if method_name.end_with?('_param')
 
-      def self.define_grey #:nodoc:
-        gem 'genki-ruby-terminfo'
-        require 'terminfo'
-        case TermInfo.default_object.tigetnum('colors')
-        when 0
-          raise "Your terminal doesn't support colours."
-        when 1
-          ::Cucumber::Term::ANSIColor.coloring = false
-          alias_method :grey, :white
-        when 2..8
-          alias_method :grey, :white # rubocop:disable Lint/DuplicateMethods
-        else
-          define_real_grey
+        define_method(method_name) do |text = nil, &proc|
+          apply_styles(ALIASES[method_name], text, &proc)
         end
-      rescue Exception => e # rubocop:disable Lint/RescueException
-        if e.class.name == 'TermInfo::TermInfoError'
-          STDERR.puts '*** WARNING ***'
-          STDERR.puts "You have the genki-ruby-terminfo gem installed, but you haven't set your TERM variable."
-          STDERR.puts 'Try setting it to TERM=xterm-256color to get grey colour in output.'
-          STDERR.puts "\n"
-          alias_method :grey, :white
-        else
-          define_real_grey
-        end
-      end
 
-      def self.define_real_grey #:nodoc:
-        define_method :grey do |string|
-          ::Cucumber::Term::ANSIColor.coloring? ? "\e[90m#{string}\e[0m" : string
+        define_method("#{method_name}_param") do |text = nil, &proc|
+          apply_styles(ALIASES["#{method_name}_param"], text, &proc) + apply_styles(ALIASES[method_name])
         end
       end
 
-      define_grey
+      def cukes(amount)
+        ('(::) ' * amount).strip
+      end
 
-      def cukes(n)
-        ('(::) ' * n).strip
+      def green_cukes(amount)
+        blink(green(cukes(amount)))
       end
 
-      def green_cukes(n)
-        blink(green(cukes(n)))
+      def red_cukes(amount)
+        blink(red(cukes(amount)))
       end
 
-      def red_cukes(n)
-        blink(red(cukes(n)))
+      def yellow_cukes(amount)
+        blink(yellow(cukes(amount)))
       end
 
-      def yellow_cukes(n)
-        blink(yellow(cukes(n)))
+      private
+
+      def apply_styles(styles, text = nil, &proc)
+        styles.split(',').reverse.reduce(text) do |result, method_name|
+          send(method_name, result, &proc)
+        end
       end
     end
   end

data/lib/cucumber/formatter/ast_lookup.rb

@@ -45,11 +45,11 @@ module Cucumber
             break
           end
           break if node.previous_node.nil?
+
           node = node.previous_node
         end
         keyword = dialect.given_keywords.reject { |kw| kw == '* ' }[0] if keyword.nil?
-        keyword = Cucumber::Gherkin::I18n.code_keyword_for(keyword)
-        keyword
+        Cucumber::Gherkin::I18n.code_keyword_for(keyword)
       end
 
       ScenarioSource = Struct.new(:type, :scenario)
@@ -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/backtrace_filter.rb

@@ -22,6 +22,7 @@ module Cucumber
     @backtrace_filters << RbConfig::CONFIG['rubylibdir'] if RbConfig::CONFIG['rubylibdir']
 
     @backtrace_filters << 'org/jruby/' if ::Cucumber::JRUBY
+    @backtrace_filters << '<internal:' if RUBY_ENGINE == 'truffleruby'
 
     BACKTRACE_FILTER_PATTERNS = Regexp.new(@backtrace_filters.join('|'))
 
@@ -33,7 +34,7 @@ module Cucumber
       def exception
         return @exception if ::Cucumber.use_full_backtrace
 
-        pwd_pattern = /#{::Regexp.escape(::Dir.pwd)}\//m # rubocop:disable Style/RegexpLiteral
+        pwd_pattern = /#{::Regexp.escape(::Dir.pwd)}\//m
         backtrace = @exception.backtrace.map { |line| line.gsub(pwd_pattern, './') }
 
         filtered = (backtrace || []).reject do |line|