cucumber 2.99.0 → 3.0.0

data/lib/cucumber/filters/prepare_world.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/filter'
 require 'cucumber/core/ast/location'
 require 'cucumber/running_test_case'

data/lib/cucumber/filters/quit.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Filters
 

data/lib/cucumber/filters/randomizer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'digest/sha2'
 
 module Cucumber

data/lib/cucumber/filters/retry.rb

@@ -1,18 +1,18 @@
+# frozen_string_literal: true
 require 'cucumber/core/filter'
 require 'cucumber/running_test_case'
-require 'cucumber/events/bus'
-require 'cucumber/events/after_test_case'
+require 'cucumber/events'
 
 module Cucumber
   module Filters
     class Retry < Core::Filter.new(:configuration)
 
       def test_case(test_case)
-        configuration.on_event(:after_test_case) do |event|
+        configuration.on_event(:test_case_finished) do |event|
           next unless retry_required?(test_case, event)
 
           test_case_counts[test_case] += 1
-          event.test_case.describe_to(receiver)
+          test_case.describe_to(receiver)
         end
 
         super

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Filters
     class TagLimits

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Filters
     class TagLimits
@@ -27,7 +28,7 @@ module Cucumber
         attr_reader :tag_limits
 
         class Breach
-          INDENT = (" " * 2).freeze
+          INDENT = (' ' * 2).freeze
 
           def initialize(tag_name, limit, locations)
             @tag_name = tag_name

data/lib/cucumber/filters/tag_limits.rb

@@ -1,6 +1,7 @@
-require "cucumber/filters/gated_receiver"
-require "cucumber/filters/tag_limits/test_case_index"
-require "cucumber/filters/tag_limits/verifier"
+# frozen_string_literal: true
+require 'cucumber/filters/gated_receiver'
+require 'cucumber/filters/tag_limits/test_case_index'
+require 'cucumber/filters/tag_limits/verifier'
 
 module Cucumber
   module Filters

data/lib/cucumber/filters.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
 require 'cucumber/filters/activate_steps'
 require 'cucumber/filters/apply_after_step_hooks'
 require 'cucumber/filters/apply_before_hooks'
 require 'cucumber/filters/apply_after_hooks'
 require 'cucumber/filters/apply_around_hooks'
+require 'cucumber/filters/broadcast_test_run_started_event'
 require 'cucumber/filters/prepare_world'
 require 'cucumber/filters/quit'
 require 'cucumber/filters/randomizer'
+require 'cucumber/filters/retry'
 require 'cucumber/filters/tag_limits'

data/lib/cucumber/formatter/ansicolor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/platform'
 require 'cucumber/term/ansicolor'
 
@@ -8,7 +9,7 @@ if Cucumber::WINDOWS_MRI
   end
 end
 
-Cucumber::Term::ANSIColor.coloring = false if !STDOUT.tty? && !ENV.has_key?("AUTOTEST")
+Cucumber::Term::ANSIColor.coloring = false if !STDOUT.tty? && !ENV.key?('AUTOTEST')
 
 module Cucumber
   module Formatter
@@ -59,6 +60,7 @@ module Cucumber
       end.merge({
         'undefined' => 'yellow',
         'pending'   => 'yellow',
+        'flaky'     => 'yellow',
         'failed'    => 'red',
         'passed'    => 'green',
         'outline'   => 'cyan',
@@ -104,7 +106,7 @@ module Cucumber
         begin
           gem 'genki-ruby-terminfo'
           require 'terminfo'
-          case TermInfo.default_object.tigetnum("colors")
+          case TermInfo.default_object.tigetnum('colors')
           when 0
             raise "Your terminal doesn't support colours."
           when 1
@@ -117,9 +119,9 @@ module Cucumber
           end
         rescue Exception => e
           if e.class.name == 'TermInfo::TermInfoError'
-            STDERR.puts "*** WARNING ***"
+            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 'Try setting it to TERM=xterm-256color to get grey colour in output.'
             STDERR.puts "\n"
             alias grey white
           else
@@ -129,19 +131,15 @@ module Cucumber
       end
 
       def self.define_real_grey #:nodoc:
-        def grey(string) #:nodoc:
-          if ::Cucumber::Term::ANSIColor.coloring?
-            "\e[90m#{string}\e[0m"
-          else
-            string
-          end
+        define_method :grey do |string|
+          ::Cucumber::Term::ANSIColor.coloring? ? "\e[90m#{string}\e[0m" : string
         end
       end
 
       define_grey
 
       def cukes(n)
-        ("(::) " * n).strip
+        ('(::) ' * n).strip
       end
 
       def green_cukes(n)

data/lib/cucumber/formatter/backtrace_filter.rb

@@ -1,15 +1,28 @@
+# frozen_string_literal: true
 require 'cucumber/platform'
 
 
 module Cucumber
   module Formatter
-    BACKTRACE_FILTER_PATTERNS = \
-      [/vendor\/rails|lib\/cucumber|bin\/cucumber:|lib\/rspec|gems\/|minitest|test\/unit|.gem\/ruby|lib\/ruby/]
-
-    if(::Cucumber::JRUBY)
-      BACKTRACE_FILTER_PATTERNS << /org\/jruby/
+    @backtrace_filters = %w(
+      /vendor/rails
+      lib/cucumber
+      bin/cucumber:
+      lib/rspec
+      gems/
+      minitest
+      test/unit
+      .gem/ruby
+      lib/ruby/
+      bin/bundle
+    )
+
+    if ::Cucumber::JRUBY
+      @backtrace_filters << 'org/jruby/'
     end
 
+    BACKTRACE_FILTER_PATTERNS = Regexp.new(@backtrace_filters.join('|'))
+
     class BacktraceFilter
       def initialize(exception)
         @exception = exception
@@ -19,10 +32,10 @@ module Cucumber
         return @exception if ::Cucumber.use_full_backtrace
 
         pwd_pattern = /#{::Regexp.escape(::Dir.pwd)}\//m
-        @exception.backtrace.each { |line| line.gsub!(pwd_pattern, "./") }
+        backtrace = @exception.backtrace.map { |line| line.gsub(pwd_pattern, './') }
 
-        filtered = (@exception.backtrace || []).reject do |line|
-          BACKTRACE_FILTER_PATTERNS.detect { |p| line =~ p }
+        filtered = (backtrace || []).reject do |line|
+          line =~ BACKTRACE_FILTER_PATTERNS
         end
 
         if ::ENV['CUCUMBER_TRUNCATE_OUTPUT']

data/lib/cucumber/formatter/console.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require 'cucumber/formatter/ansicolor'
 require 'cucumber/formatter/duration'
-require 'cucumber/formatter/summary'
+require 'cucumber/gherkin/i18n'
 
 module Cucumber
   module Formatter
@@ -28,15 +29,14 @@ module Cucumber
     module Console
       extend ANSIColor
       include Duration
-      include Summary
 
       def format_step(keyword, step_match, status, source_indent)
         comment = if source_indent
-          c = ('# ' + step_match.location.to_s).indent(source_indent)
-          format_string(c, :comment)
-        else
-          ''
-        end
+                    c = ('# ' + step_match.location.to_s).indent(source_indent)
+                    format_string(c, :comment)
+                  else
+                    ''
+                  end
 
         format = format_for(status, :param)
         line = keyword + step_match.format_args(format) + comment
@@ -59,75 +59,53 @@ module Cucumber
       end
 
       def print_elements(elements, status, kind)
-        if elements.any?
+        return if elements.empty?
+
+        element_messages = element_messages(elements, status)
+        print_element_messages(element_messages, status, kind)
+      end
+
+      def print_element_messages(element_messages, status, kind)
+        if element_messages.any?
           @io.puts(format_string("(::) #{status} #{kind} (::)", status))
           @io.puts
           @io.flush
         end
 
-        elements.each_with_index do |element, i|
-          if status == :failed
-            print_exception(element.exception, status, 0)
-          else
-            message = linebreaks(element.backtrace_line, ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
-            @io.puts(format_string(message, status))
-          end
+        element_messages.each do |message|
+          @io.puts(format_string(message, status))
           @io.puts
           @io.flush
         end
       end
 
-      def print_stats(features, options)
-        duration = features ? features.duration : nil
-        print_statistics(duration, options)
-      end
-
-      def print_statistics(duration, options)
-        failures = collect_failing_scenarios(runtime)
-        if !failures.empty?
-          print_failing_scenarios(failures, options.custom_profiles, options[:source])
+      def print_statistics(duration, config, counts, issues)
+        if issues.any?
+          @io.puts issues.to_s
+          @io.puts
         end
 
-        @io.puts scenario_summary(runtime) {|status_count, status| format_string(status_count, status)}
-        @io.puts step_summary(runtime) {|status_count, status| format_string(status_count, status)}
-        @io.puts(format_duration(duration)) if duration && options[:duration]
+        @io.puts counts.to_s
+        @io.puts(format_duration(duration)) if duration && config.duration?
 
-        if runtime.configuration.randomize?
+        if config.randomize?
           @io.puts
-          @io.puts "Randomized with seed #{runtime.configuration.seed}"
+          @io.puts "Randomized with seed #{config.seed}"
         end
 
         @io.flush
       end
 
-      def collect_failing_scenarios(runtime)
-        # TODO: brittle - stop coupling to types
-        scenario_class = LegacyApi::Ast::Scenario
-        example_table_class = Core::Ast::ExamplesTable
-
-        runtime.scenarios(:failed).select do |s|
-          [scenario_class, example_table_class].include?(s.class)
-        end.map do |s|
-          s.is_a?(example_table_class)? s.scenario_outline : s
-        end
-      end
-
-      def print_failing_scenarios(failures, custom_profiles, given_source)
-        @io.puts format_string("Failing Scenarios:", :failed)
-        failures.each do |failure|
-          profiles_string = custom_profiles.empty? ? '' : (custom_profiles.map{|profile| "-p #{profile}" }).join(' ') + ' '
-          source = given_source ? format_string(" # " + failure.name, :comment) : ''
-          @io.puts format_string("cucumber #{profiles_string}" + failure.location, :failed) + source
-        end
-        @io.puts
+      def print_exception(e, status, indent)
+        string = exception_message_string(e, indent)
+        @io.puts(format_string(string, status))
       end
 
-      def print_exception(e, status, indent)
-        message = "#{e.message} (#{e.class})".force_encoding("UTF-8")
+      def exception_message_string(e, indent)
+        message = "#{e.message} (#{e.class})".dup.force_encoding('UTF-8')
         message = linebreaks(message, ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
 
-        string = "#{message}\n#{e.backtrace.join("\n")}".indent(indent)
-        @io.puts(format_string(string, status))
+        "#{message}\n#{e.backtrace.join("\n")}".indent(indent)
       end
 
       # http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/10655
@@ -138,21 +116,26 @@ module Cucumber
 
       def collect_snippet_data(test_step, result)
         # collect snippet data for undefined steps
-        unless hook?(test_step)
-          keyword = test_step.source.last.actual_keyword(@previous_step_keyword)
-          @previous_step_keyword = keyword
-          if result.undefined?
-            @snippets_input << Console::SnippetData.new(keyword, test_step.source.last)
-          end
-        end
+        return if hook?(test_step)
+        keyword = test_step.source.last.actual_keyword(@previous_step_keyword)
+        @previous_step_keyword = keyword
+        return unless result.undefined?
+        @snippets_input << Console::SnippetData.new(keyword, test_step.source.last)
       end
 
       def print_snippets(options)
         return unless options[:snippets]
         return if runtime.steps(:undefined).empty?
 
+        snippet_text_proc = lambda { |step_keyword, step_name, multiline_arg|
+          runtime.snippet_text(step_keyword, step_name, multiline_arg)
+        }
+        do_print_snippets(snippet_text_proc)
+      end
+
+      def do_print_snippets(snippet_text_proc)
         snippets = @snippets_input.map do |data|
-          @runtime.snippet_text(data.actual_keyword, data.step.name, data.step.multiline_arg)
+          snippet_text_proc.call(data.actual_keyword, data.step.text, data.step.multiline_arg)
         end.uniq
 
         text = "\nYou can implement step definitions for undefined steps with these snippets:\n\n"
@@ -165,10 +148,14 @@ module Cucumber
 
       def print_passing_wip(options)
         return unless options[:wip]
-        passed = runtime.scenarios(:passed)
-        if passed.any?
+        passed_messages = element_messages(runtime.scenarios(:passed), :passed)
+        do_print_passing_wip(passed_messages)
+      end
+
+      def do_print_passing_wip(passed_messages)
+        if passed_messages.any?
           @io.puts format_string("\nThe --wip switch was used, so I didn't expect anything to pass. These scenarios passed:", :failed)
-          print_elements(passed, :passed, "scenarios")
+          print_element_messages(passed_messages, :passed, 'scenarios')
         else
           @io.puts format_string("\nThe --wip switch was used, so the failures were expected. All is good.\n", :passed)
         end
@@ -217,8 +204,10 @@ module Cucumber
 
       def print_profile_information
         return if @options[:skip_profile_information] || @options[:profiles].nil? || @options[:profiles].empty?
-        profiles = @options[:profiles]
-        profiles_sentence = ''
+        do_print_profile_information(@options[:profiles])
+      end
+
+      def do_print_profile_information(profiles)
         profiles_sentence = profiles.size == 1 ? profiles.first :
           "#{profiles[0...-1].join(', ')} and #{profiles.last}"
 
@@ -240,6 +229,23 @@ module Cucumber
         not test_step.source.last.respond_to?(:actual_keyword)
       end
 
+      def element_messages(elements, status)
+        elements.map do |element|
+          if status == :failed
+            exception_message_string(element.exception, 0)
+          else
+            linebreaks(element.backtrace_line, ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
+          end
+        end
+      end
+
+      def snippet_text(step_keyword, step_name, multiline_arg)
+        keyword = Cucumber::Gherkin::I18n.code_keyword_for(step_keyword).strip
+        config.snippet_generators.map { |generator|
+          generator.call(keyword, step_name, multiline_arg, config.snippet_type)
+        }.join("\n")
+      end
+
       class SnippetData
         attr_reader :actual_keyword, :step
         def initialize(actual_keyword, step)

data/lib/cucumber/formatter/console_counts.rb

@@ -0,0 +1,44 @@
+require 'cucumber/formatter/console'
+
+module Cucumber
+  module Formatter
+    class ConsoleCounts
+      include Console
+
+      def initialize(config)
+        @summary = Core::Report::Summary.new(config.event_bus)
+      end
+
+      def to_s
+        [
+          [scenario_count, status_counts(@summary.test_cases)].compact.join(' '),
+          [step_count, status_counts(@summary.test_steps)].compact.join(' ')
+        ].join("\n")
+      end
+
+      private
+
+      def scenario_count
+        count = @summary.test_cases.total
+        "#{count} scenario" + (count == 1 ? '' : 's')
+      end
+
+      def step_count
+        count = @summary.test_steps.total
+        "#{count} step" + (count == 1 ? '' : 's')
+      end
+
+      def status_counts(summary)
+        counts = Core::Test::Result::TYPES.map { |status|
+          count = summary.total(status)
+          [status, count]
+        }.select { |status, count|
+          count > 0
+        }.map { |status, count|
+          format_string("#{count} #{status}", status)
+        }
+        "(#{counts.join(", ")})" if counts.any?
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/console_issues.rb

@@ -0,0 +1,58 @@
+require 'cucumber/formatter/console'
+
+module Cucumber
+  module Formatter
+    class ConsoleIssues
+      include Console
+
+      def initialize(config)
+        @previous_test_case = nil
+        @issues = Hash.new { |h, k| h[k] = [] }
+        @config = config
+        @config.on_event(:test_case_finished) do |event|
+          if event.test_case != @previous_test_case
+            @previous_test_case = event.test_case
+            @issues[event.result.to_sym] << event.test_case unless event.result.ok?(@config.strict)
+          elsif event.result.passed?
+            @issues[:flaky] << event.test_case unless Core::Test::Result::Flaky.ok?(@config.strict)
+            @issues[:failed].delete(event.test_case)
+          end
+        end
+      end
+
+      def to_s
+        return if @issues.empty?
+        result = Core::Test::Result::TYPES.map { |type| scenario_listing(type, @issues[type]) }
+        result.flatten.join("\n")
+      end
+
+      def any?
+        @issues.any?
+      end
+
+      private
+
+      def scenario_listing(type, test_cases)
+        return [] if test_cases.empty?
+        [ format_string("#{type_heading(type)} Scenarios:", type) ] + test_cases.map { |test_case|
+          source = @config.source? ? format_string(" # #{test_case.keyword}: #{test_case.name}", :comment) : ''
+          format_string("cucumber #{profiles_string}" + test_case.location, type) + source
+        }
+      end
+
+      def type_heading(type)
+        case type
+        when :failed
+          'Failing'
+        else
+          type.to_s.slice(0, 1).capitalize + type.to_s.slice(1..-1)
+        end
+      end
+
+      def profiles_string
+        return if @config.custom_profiles.empty?
+        @config.custom_profiles.map { |profile| "-p #{profile}" }.join(' ') + ' '
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/duration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Formatter
     module Duration
@@ -6,7 +7,7 @@ module Cucumber
       # <tt>time</tt> format.
       def format_duration(seconds)
         m, s = seconds.divmod(60)
-        "#{m}m#{'%.3f' % s}s"
+        "#{m}m#{format('%.3f', s)}s"
       end
     end
   end

data/lib/cucumber/formatter/duration_extractor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Formatter
 

data/lib/cucumber/formatter/fail_fast.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/formatter/io'
 require 'cucumber/formatter/console'
 
@@ -7,8 +8,9 @@ module Cucumber
     class FailFast
 
       def initialize(configuration)
-        configuration.on_event :after_test_case do |event|
-          Cucumber.wants_to_quit = true unless event.result.ok?(configuration.strict?)
+        configuration.on_event :test_case_finished do |event|
+          _test_case, result = *event.attributes
+          Cucumber.wants_to_quit = true unless result.ok?(configuration.strict)
         end
       end
 

data/lib/cucumber/formatter/fanout.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Formatter
 

data/lib/cucumber/formatter/hook_query_visitor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Formatter
     class HookQueryVisitor