cucumber 2.99.0 → 3.0.0

data/lib/cucumber/formatter/legacy_api/adapter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'forwardable'
 require 'delegate'
 require 'cucumber/errors'
@@ -14,46 +15,56 @@ module Cucumber
 
         def initialize(*)
           super
-          @matches = collect_matches
-        end
-
-        def_delegators :formatter,
-          :ask
-
-        def_delegators :printer,
-          :embed
-
-        def before_test_case(test_case)
-          formatter.before_test_case(test_case)
-          printer.before_test_case(test_case)
-        end
-
-        def before_test_step(test_step)
-          formatter.before_test_step(test_step)
-          printer.before_test_step(test_step)
-        end
+          emit_deprecation_warning
 
-        def after_test_step(test_step, result)
-          printer.after_test_step(test_step, result)
-          formatter.after_test_step(test_step, result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter))
+          @matches = collect_matches
+          config.on_event(:test_case_started) do |event|
+            formatter.before_test_case(event.test_case)
+            printer.before_test_case(event.test_case)
+          end
+          config.on_event(:test_step_started) do |event|
+            formatter.before_test_step(event.test_step)
+            printer.before_test_step(event.test_step)
+          end
+          config.on_event(:test_step_finished) do |event|
+            test_step, result = *event.attributes
+            printer.after_test_step(test_step, result)
+            formatter.after_test_step(test_step, result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter))
+          end
+          config.on_event(:test_case_finished) do |event|
+            test_case, result = *event.attributes
+            record_test_case_result(test_case, result)
+            printer.after_test_case(test_case, result)
+            formatter.after_test_case(test_case, result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter))
+          end
+          config.on_event(:test_run_finished) do
+            printer.after
+            formatter.done
+          end
         end
 
-        def after_test_case(test_case, result)
-          record_test_case_result(test_case, result)
-          printer.after_test_case(test_case, result)
-          formatter.after_test_case(test_case, result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter))
-        end
+        def_delegators :formatter, :ask
+        def_delegators :printer, :embed
 
         def puts(*messages)
           printer.puts(messages)
         end
 
-        def done
-          printer.after
-          formatter.done
+        private
+
+        def emit_deprecation_warning
+          parent_name = formatter_class_name =~ /::[^:]+\Z/ ? $`.freeze : nil
+          return if parent_name == 'Cucumber::Formatter'
+          return if !config.out_stream # some unit tests don't set it
+          config.out_stream.puts "WARNING: The formatter #{formatter.class.name} is using the deprecated formatter API which will be removed in v4.0 of Cucumber."
+          config.out_stream.puts
         end
 
-        private
+        def formatter_class_name
+          formatter.class.name
+        rescue NoMethodError # when we use the Fanout, things get gnarly
+          formatter.class[0].class.name
+        end
 
         def printer
           @printer ||= FeaturesPrinter.new(formatter, results, config, @matches).before
@@ -66,8 +77,9 @@ module Cucumber
 
         def collect_matches
           result = {}
-          config.on_event(:step_match) do |event|
-            result[event.test_step.source.last] = event.step_match
+          config.on_event(:step_activated) do |event|
+            test_step, step_match = *event.attributes
+            result[test_step.source.last] = step_match
           end
           result
         end
@@ -155,7 +167,7 @@ module Cucumber
               @result = CaseSource.new
             end
 
-            def method_missing(name, node, test_case_result, *args)
+            def method_missing(name, node, _test_case_result, *_args)
               result.send "#{name}=", node
             end
           end
@@ -179,7 +191,7 @@ module Cucumber
               @result = StepSource.new
             end
 
-            def method_missing(name, node, step_result, *args)
+            def method_missing(name, node, step_result, *_args)
               result.send "#{name}=", node
               result.send "#{name}_result=", LegacyResultBuilder.new(step_result)
             end
@@ -189,7 +201,7 @@ module Cucumber
           class StepSource < OpenStruct
             def build_step_invocation(indent, matches, config, messages, embeddings)
               step_result.step_invocation(
-                matches.fetch(step) { NoStepMatch.new(step, step.name) },
+                matches.fetch(step) { NoStepMatch.new(step, step.text) },
                 step,
                 indent,
                 background,
@@ -224,7 +236,7 @@ module Cucumber
 
           attr_reader :current_test_step_source
 
-          def before_test_case(test_case)
+          def before_test_case(_test_case)
             @before_hook_results = Ast::HookResultCollection.new
             @test_step_results = []
           end
@@ -262,22 +274,22 @@ module Cucumber
             @previous_test_case_scenario_outline = current_test_step_source && current_test_step_source.scenario_outline
           end
 
-          def before_hook(location, result)
+          def before_hook(_location, result)
             @before_hook_results << Ast::HookResult.new(LegacyResultBuilder.new(result), @delayed_messages, @delayed_embeddings)
             @delayed_messages = []
             @delayed_embeddings = []
           end
 
-          def after_hook(location, result)
+          def after_hook(_location, result)
             # if the scenario has no steps, we can hit this before we've created the scenario printer
             # ideally we should call switch_step_container in before_step_step
-            switch_step_container if !@child 
+            switch_step_container if !@child
             @child.after_hook Ast::HookResult.new(LegacyResultBuilder.new(result), @delayed_messages, @delayed_embeddings)
             @delayed_messages = []
             @delayed_embeddings = []
           end
 
-          def after_step_hook(hook, result)
+          def after_step_hook(_hook, result)
             p current_test_step_source if current_test_step_source.step.nil?
             line = current_test_step_source.step.backtrace_line
             @child.after_step_hook Ast::HookResult.new(LegacyResultBuilder.new(result).
@@ -334,7 +346,7 @@ module Cucumber
             elsif source.scenario
               ScenarioPrinter.new(formatter, source.scenario, before_hook_results)
             elsif source.scenario_outline
-              if same_scenario_outline_as_previous_test_case?(source) and @previous_outline_child
+              if same_scenario_outline_as_previous_test_case?(source) && @previous_outline_child
                 @previous_outline_child
               else
                 ScenarioOutlinePrinter.new(formatter, config, source.scenario_outline)
@@ -363,7 +375,7 @@ module Cucumber
 
             if @failed_hidden_background_step
               indent = Indent.new(@child.node)
-              step_invocation = @failed_hidden_background_step.build_step_invocation(indent, matches, config, messages = [], embeddings = [])
+              step_invocation = @failed_hidden_background_step.build_step_invocation(indent, matches, config, [], [])
               @child.step_invocation(step_invocation, @failed_hidden_background_step)
               @failed_hidden_background_step = nil
             end
@@ -392,19 +404,19 @@ module Cucumber
                   @previous_outline_child.after unless same_scenario_outline_as_previous_test_case?(source)
                 end
               end
-              unless from_scenario_outline_to_hidden_backgroud(@child, child)
-                @child.after 
-                @previous_outline_child = nil
-              else
+              if from_scenario_outline_to_hidden_background(@child, child)
                 @previous_outline_child = @child
+              else
+                @child.after
+                @previous_outline_child = nil
               end
             end
-            child.before unless to_scenario_outline(child) and same_scenario_outline_as_previous_test_case?(source)
+            child.before unless to_scenario_outline(child) && same_scenario_outline_as_previous_test_case?(source)
             @child = child
           end
 
-          def from_scenario_outline_to_hidden_backgroud(from, to)
-            from.class.name == ScenarioOutlinePrinter.name and
+          def from_scenario_outline_to_hidden_background(from, to)
+            from.class.name == ScenarioOutlinePrinter.name &&
             to.class.name == HiddenBackgroundPrinter.name
           end
 
@@ -499,7 +511,7 @@ module Cucumber
             return @source_of_failed_step
           end
 
-          def step_invocation(step_invocation, source)
+          def step_invocation(_step_invocation, source)
             if source.step_result.status == :failed
               @source_of_failed_step = source
             end
@@ -526,7 +538,7 @@ module Cucumber
             self
           end
 
-          def step_invocation(step_invocation, source)
+          def step_invocation(step_invocation, _source)
             @child ||= StepsPrinter.new(formatter).before
             @child.step_invocation step_invocation
           end
@@ -535,7 +547,7 @@ module Cucumber
             result.accept formatter
           end
 
-          def after_test_case(test_case, result)
+          def after_test_case(_test_case, result)
             @test_case_result = result
             after
           end
@@ -596,7 +608,7 @@ module Cucumber
           end
 
           def step_invocation(step_invocation, source)
-            node, result = source.step, source.step_result
+            _node, result = source.step, source.step_result
             @last_step_result = result
             @child.step_invocation(step_invocation, source)
           end
@@ -616,7 +628,7 @@ module Cucumber
 
           def after
             @child.after if @child
-            # TODO - the last step result might not accurately reflect the
+            # TODO: the last step result might not accurately reflect the
             # overall scenario result.
             scenario_outline = last_step_result.scenario_outline(node.name, node.location)
             formatter.after_feature_element(scenario_outline)
@@ -640,14 +652,14 @@ module Cucumber
             steps_printer.after
           end
 
-          def scenario_outline(node, &descend)
+          def scenario_outline(_node, &descend)
             descend.call(self)
           end
 
           def outline_step(step)
-            step_match = NoStepMatch.new(step, step.name)
+            step_match = NoStepMatch.new(step, step.text)
             step_invocation = LegacyResultBuilder.new(Core::Test::Result::Skipped.new).
-              step_invocation(step_match, step, indent, background = nil, configuration, messages = [], embeddings = [])
+              step_invocation(step_match, step, indent, nil, configuration, [], [])
             steps_printer.step_invocation step_invocation
           end
 
@@ -703,11 +715,11 @@ module Cucumber
             return if examples_table_row == @current
             @child.after if @child
             row = ExampleTableRow.new(examples_table_row)
-            if !configuration.expand?
-              @child = TableRowPrinter.new(formatter, row, before_hook_results).before
-            else
-              @child = ExpandTableRowPrinter.new(formatter, row, before_hook_results).before
-            end
+            @child = if !configuration.expand?
+                       TableRowPrinter.new(formatter, row, before_hook_results).before
+                     else
+                       ExpandTableRowPrinter.new(formatter, row, before_hook_results).before
+                     end
             @current = examples_table_row
           end
 
@@ -750,7 +762,7 @@ module Cucumber
                 descend.call(self)
               end
 
-              def examples_table_row(row, &descend)
+              def examples_table_row(row, &_descend)
                 width = char_length_of(row.values[index])
                 @result = width if width > result
               end
@@ -775,7 +787,7 @@ module Cucumber
             @after_step_hook_result << result
           end
 
-          def after_test_case(*args)
+          def after_test_case(*_args)
             after
           end
 
@@ -918,11 +930,11 @@ module Cucumber
           def of(node)
             # The length of the instantiated steps in --expand mode are currently
             # not included in the calculation of max => make sure to return >= 1
-            [1, max - node.name.length - node.keyword.length].max
+            [1, max - node.to_s.length - node.keyword.length].max
           end
 
           def record_width_of(node)
-            @widths << node.keyword.length + node.name.length + 1
+            @widths << node.keyword.length + node.to_s.length + 1
           end
 
           private
@@ -993,8 +1005,8 @@ module Cucumber
 
           def step_exception(step, configuration)
             return filtered_step_exception(step) if @exception
-            return nil unless @status == :undefined && configuration.strict?
-            @exception = Cucumber::Undefined.from(@result, step.name)
+            return nil unless @status == :undefined && configuration.strict.strict?(:undefined)
+            @exception = Cucumber::Undefined.from(@result, step.text)
             @exception.backtrace << step.backtrace_line
             filtered_step_exception(step)
           end
@@ -1003,7 +1015,7 @@ module Cucumber
             Cucumber::Formatter::BacktraceFilter.new(@exception.dup).exception
           end
 
-          def filtered_step_exception(step)
+          def filtered_step_exception(_step)
             exception = filtered_exception
             return Cucumber::Formatter::BacktraceFilter.new(exception).exception
           end

data/lib/cucumber/formatter/legacy_api/ast.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Formatter
     module LegacyApi
@@ -22,7 +23,7 @@ module Cucumber
         # ExampleTableRow#keyword is never called on them,
         # but this will pass silently if it happens anyway
         class NullLanguage
-          def method_missing(*args, &block)
+          def method_missing(*_args, &_block)
             self
           end
 
@@ -79,17 +80,15 @@ module Cucumber
           end
 
           def send_output_to(formatter)
-            unless @already_accepted
-              @messages.each { |message| formatter.puts(message) }
-              @embeddings.each { |embedding| embedding.send_to_formatter(formatter) }
-            end
+            return if @already_accepted
+            @messages.each { |message| formatter.puts(message) }
+            @embeddings.each { |embedding| embedding.send_to_formatter(formatter) }
           end
 
           def describe_exception_to(formatter)
-            unless @already_accepted
-              @result.describe_exception_to(formatter)
-              @already_accepted = true
-            end
+            return if @already_accepted
+            @result.describe_exception_to(formatter)
+            @already_accepted = true
           end
         end
 
@@ -104,27 +103,27 @@ module Cucumber
                                     :embeddings) do
           extend Forwardable
 
-          def_delegators :step, :keyword, :name, :multiline_arg, :location
+          def_delegators :step, :keyword, :text, :multiline_arg, :location
 
           def accept(formatter)
             formatter.before_step(self)
             Ast::Comments.new(step.comments).accept(formatter)
             messages.each { |message| formatter.puts(message) }
             embeddings.each { |embedding| embedding.send_to_formatter(formatter) }
-            formatter.before_step_result *step_result_attributes
+            formatter.before_step_result(*step_result_attributes)
             print_step_name(formatter)
             Ast::MultilineArg.for(multiline_arg).accept(formatter)
             print_exception(formatter)
-            formatter.after_step_result *step_result_attributes
+            formatter.after_step_result(*step_result_attributes)
             formatter.after_step(self)
           end
 
           def step_result_attributes
-            legacy_multiline_arg = if multiline_arg.kind_of?(Core::Ast::EmptyMultilineArgument)
-              nil
-            else
-              step.multiline_arg
-            end
+            legacy_multiline_arg = if multiline_arg.is_a?(Core::Ast::EmptyMultilineArgument)
+                                     nil
+                                   else
+                                     step.multiline_arg
+                                   end
             [keyword, step_match, legacy_multiline_arg, status, exception, source_indent, background, file_colon_line]
           end
 
@@ -156,6 +155,10 @@ module Cucumber
             self
           end
 
+          def to_s
+            text
+          end
+
           private
 
           def source_indent
@@ -241,6 +244,10 @@ module Cucumber
             '| ' + cells.join(' | ') + ' |'
           end
 
+          def to_s
+            name
+          end
+
           def failed?
             status == :failed
           end
@@ -279,7 +286,7 @@ module Cucumber
         end
 
         Scenario = Struct.new(:status, :name, :location) do
-          def backtrace_line(step_name = "#{name}", line = self.location.line)
+          def backtrace_line(step_name = name.to_s, line = self.location.line)
             "#{location.on_line(line)}:in `#{step_name}'"
           end
 
@@ -293,7 +300,7 @@ module Cucumber
         end
 
         ScenarioOutline = Struct.new(:status, :name, :location) do
-          def backtrace_line(step_name = "#{name}", line = self.location.line)
+          def backtrace_line(step_name = name.to_s, line = self.location.line)
             "#{location.on_line(line)}:in `#{step_name}'"
           end
 
@@ -378,9 +385,7 @@ module Cucumber
             @feature = feature
           end
 
-          def feature
-            @feature
-          end
+          attr_reader :feature
         end
 
       end

data/lib/cucumber/formatter/legacy_api/results.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Formatter
     module LegacyApi
@@ -12,19 +13,17 @@ module Cucumber
         def step_visited(step) #:nodoc:
           step_id = step.object_id
 
-          unless @inserted_steps.has_key?(step_id)
-            @inserted_steps[step_id] = step
-            steps.push(step)
-          end
+          return if @inserted_steps.key?(step_id)
+          @inserted_steps[step_id] = step
+          steps.push(step)
         end
 
         def scenario_visited(scenario) #:nodoc:
           scenario_id = scenario.object_id
 
-          unless @inserted_scenarios.has_key?(scenario_id)
-            @inserted_scenarios[scenario_id] = scenario
-            scenarios.push(scenario)
-          end
+          return if @inserted_scenarios.key?(scenario_id)
+          @inserted_scenarios[scenario_id] = scenario
+          scenarios.push(scenario)
         end
 
         def steps(status = nil) #:nodoc:

data/lib/cucumber/formatter/legacy_api/runtime_facade.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/gherkin/i18n'
 
 module Cucumber

data/lib/cucumber/formatter/pretty.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
 require 'fileutils'
 require 'cucumber/formatter/console'
 require 'cucumber/formatter/io'
 require 'cucumber/gherkin/formatter/escaping'
+require 'cucumber/formatter/console_counts'
+require 'cucumber/formatter/console_issues'
 
 module Cucumber
   module Formatter
@@ -22,15 +25,18 @@ module Cucumber
 
       def initialize(runtime, path_or_io, options)
         @runtime, @io, @options = runtime, ensure_io(path_or_io), options
+        @config = runtime.configuration
         @exceptions = []
         @indent = 0
         @prefixes = options[:prefixes] || {}
         @delayed_messages = []
         @previous_step_keyword = nil
         @snippets_input = []
+        @counts = ConsoleCounts.new(runtime.configuration)
+        @issues = ConsoleIssues.new(runtime.configuration)
       end
 
-      def before_features(features)
+      def before_features(_features)
         print_profile_information
       end
 
@@ -38,7 +44,7 @@ module Cucumber
         print_summary(features)
       end
 
-      def before_feature(feature)
+      def before_feature(_feature)
         @exceptions = []
         @indent = 0
       end
@@ -48,7 +54,7 @@ module Cucumber
         @io.flush
       end
 
-      def after_tags(tags)
+      def after_tags(_tags)
         if @indent == 1
           @io.puts
           @io.flush
@@ -68,24 +74,24 @@ module Cucumber
         @io.flush
       end
 
-      def before_feature_element(feature_element)
+      def before_feature_element(_feature_element)
         @indent = 2
         @scenario_indent = 2
       end
 
-      def after_feature_element(feature_element)
+      def after_feature_element(_feature_element)
         print_messages
         @io.puts
         @io.flush
       end
 
-      def before_background(background)
+      def before_background(_background)
         @indent = 2
         @scenario_indent = 2
         @in_background = true
       end
 
-      def after_background(background)
+      def after_background(_background)
         print_messages
         @in_background = nil
         @io.puts
@@ -96,7 +102,7 @@ module Cucumber
         print_feature_element_name(keyword, name, file_colon_line, source_indent)
       end
 
-      def before_examples_array(examples_array)
+      def before_examples_array(_examples_array)
         @indent = 4
         @io.puts
         @visiting_first_example_name = true
@@ -115,7 +121,7 @@ module Cucumber
         @table = outline_table
       end
 
-      def after_outline_table(outline_table)
+      def after_outline_table(_outline_table)
         @table = nil
         @indent = 4
       end
@@ -130,7 +136,7 @@ module Cucumber
         print_messages
       end
 
-      def before_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background, file_colon_line)
+      def before_step_result(_keyword, _step_match, _multiline_arg, status, exception, _source_indent, background, _file_colon_line)
         @hide_this_step = false
         if exception
           if @exceptions.include?(exception)
@@ -146,7 +152,7 @@ module Cucumber
         @status = status
       end
 
-      def step_name(keyword, step_match, status, source_indent, background, file_colon_line)
+      def step_name(keyword, step_match, status, source_indent, _background, _file_colon_line)
         return if @hide_this_step
         source_indent = nil unless @options[:source]
         name_to_report = format_step(keyword, step_match, status, source_indent)
@@ -174,11 +180,11 @@ module Cucumber
         @table = multiline_arg
       end
 
-      def after_multiline_arg(multiline_arg)
+      def after_multiline_arg(_multiline_arg)
         @table = nil
       end
 
-      def before_table_row(table_row)
+      def before_table_row(_table_row)
         return if !@table || @hide_this_step
         @col_index = 0
         @io.print '  |'.indent(@indent-2)
@@ -193,7 +199,7 @@ module Cucumber
         end
       end
 
-      def after_table_cell(cell)
+      def after_table_cell(_cell)
         return unless @table
         @col_index += 1
       end
@@ -205,11 +211,11 @@ module Cucumber
         cell_text = escape_cell(value.to_s || '')
         padded = cell_text + (' ' * (width - cell_text.unpack('U*').length))
         prefix = cell_prefix(status)
-        @io.print(' ' + format_string("#{prefix}#{padded}", status) + ::Cucumber::Term::ANSIColor.reset(" |"))
+        @io.print(' ' + format_string("#{prefix}#{padded}", status) + ::Cucumber::Term::ANSIColor.reset(' |'))
         @io.flush
       end
 
-      def before_test_case(test_case)
+      def before_test_case(_test_case)
         @previous_step_keyword = nil
       end
 
@@ -229,7 +235,7 @@ module Cucumber
           @io.print(format_string(line_comment, :comment))
         end
         @io.puts
-        names[1..-1].each {|s| @io.puts "#{s}"}
+        names[1..-1].each {|s| @io.puts s.to_s}
         @io.flush
       end
 
@@ -238,7 +244,7 @@ module Cucumber
       end
 
       def print_summary(features)
-        print_stats(features, @options)
+        print_statistics(features.duration, @config, @counts, @issues)
         print_snippets(@options)
         print_passing_wip(@options)
       end