cucumber 7.1.0 → 9.2.1

data/lib/cucumber/formatter/junit.rb

@@ -54,7 +54,7 @@ module Cucumber
         test_step, result = *event.attributes
         return if @failing_test_step
 
-        @failing_test_step = test_step unless result.ok?(@config.strict)
+        @failing_test_step = test_step unless result.ok?(strict: @config.strict)
       end
 
       def on_test_case_finished(event)
@@ -71,7 +71,7 @@ module Cucumber
       end
 
       def on_test_run_finished(_event)
-        @features_data.each { |_file, data| end_feature(data) }
+        @features_data.each_value { |data| end_feature(data) }
       end
 
       private
@@ -84,6 +84,7 @@ module Cucumber
         uri = test_case.location.file
         feature = @ast_lookup.gherkin_document(uri).feature
         raise UnNamedFeatureError, uri if feature.name.empty?
+
         @current_feature_data = @features_data[uri]
         @current_feature_data[:uri] = uri unless @current_feature_data[:uri]
         @current_feature_data[:feature] = feature unless @current_feature_data[:feature]
@@ -110,7 +111,8 @@ module Cucumber
         scenario_source = @ast_lookup.scenario_source(test_case)
         keyword = scenario_source.type == :Scenario ? scenario_source.scenario.keyword : scenario_source.scenario_outline.keyword
         output = "#{keyword}: #{scenario}\n\n"
-        return output if result.ok?(@config.strict)
+        return output if result.ok?(strict: @config.strict)
+
         if scenario_source.type == :Scenario
           if @failing_test_step
             if @failing_test_step.hook?
@@ -125,7 +127,7 @@ module Cucumber
         else
           output += "Example row: #{row_name}\n"
         end
-        output + "\nMessage:\n"
+        "#{output}\nMessage:\n"
       end
 
       def build_testcase(result, scenario_designation, output)
@@ -138,7 +140,7 @@ module Cucumber
         testcase_attributes = get_testcase_attributes(classname, name, duration, filename)
 
         @current_feature_data[:builder].testcase(testcase_attributes) do
-          if !result.passed? && result.ok?(@config.strict)
+          if !result.passed? && result.ok?(strict: @config.strict)
             @current_feature_data[:builder].skipped
             @current_feature_data[:skipped] += 1
           elsif !result.passed?
@@ -191,7 +193,7 @@ module Cucumber
       end
 
       def basename(feature_file)
-        File.basename(feature_file.gsub(/[\\\/]/, '-'), '.feature') # rubocop:disable Style/RegexpLiteral
+        File.basename(feature_file.gsub(/[\\\/]/, '-'), '.feature')
       end
 
       def write_file(feature_filename, data)
@@ -228,13 +230,14 @@ module Cucumber
       end
 
       def examples_table_row(row)
-        @row_name = '| ' + row.cells.map(&:value).join(' | ') + ' |'
+        @row_name = "| #{row.cells.map(&:value).join(' | ')} |"
         @name_suffix = " (outline example : #{@row_name})"
       end
     end
 
     class ResultBuilder
       attr_reader :test_case_duration
+
       def initialize(result)
         @test_case_duration = 0
         result.describe_to(self)

data/lib/cucumber/formatter/message_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'base64'
 require 'cucumber/formatter/backtrace_filter'
 require 'cucumber/formatter/query/hook_by_test_step'
@@ -40,11 +42,12 @@ module Cucumber
         raise 'To be implemented'
       end
 
-      def attach(src, media_type)
+      def attach(src, media_type, filename)
         attachment_data = {
           test_step_id: @current_test_step_id,
           test_case_started_id: @current_test_case_started_id,
-          media_type: media_type
+          media_type: media_type,
+          file_name: filename
         }
 
         if media_type.start_with?('text/')
@@ -129,7 +132,7 @@ module Cucumber
         @step_definitions_by_test_step.step_match_arguments(step).map do |argument|
           Cucumber::Messages::StepMatchArgument.new(
             group: argument_group_to_message(argument.group),
-            parameter_type_name: argument.parameter_type.name
+            parameter_type_name: parameter_type_name(argument)
           )
         end
       end
@@ -142,6 +145,10 @@ module Cucumber
         )
       end
 
+      def parameter_type_name(step_match_argument)
+        step_match_argument.parameter_type&.name if step_match_argument.respond_to?(:parameter_type)
+      end
+
       def on_test_run_started(*)
         message = Cucumber::Messages::Envelope.new(
           test_run_started: Cucumber::Messages::TestRunStarted.new(
@@ -190,10 +197,13 @@ module Cucumber
 
         result_message = result.to_message
         if result.failed? || result.pending?
+          message_element = result.failed? ? result.exception : result
+
           result_message = Cucumber::Messages::TestStepResult.new(
             status: result_message.status,
             duration: result_message.duration,
-            message: create_error_message(result)
+            message: create_error_message(message_element),
+            exception: create_exception_object(result, message_element)
           )
         end
 
@@ -209,12 +219,17 @@ module Cucumber
         output_envelope(message)
       end
 
-      def create_error_message(result)
-        message_element = result.failed? ? result.exception : result
+      def create_error_message(message_element)
         message = "#{message_element.message} (#{message_element.class})"
         ([message] + message_element.backtrace).join("\n")
       end
 
+      def create_exception_object(result, message_element)
+        return unless result.failed?
+
+        Cucumber::Messages::Exception.from_h({ type: message_element.class, message: message_element.message })
+      end
+
       def on_test_case_finished(event)
         message = Cucumber::Messages::Envelope.new(
           test_case_finished: Cucumber::Messages::TestCaseFinished.new(
@@ -226,10 +241,11 @@ module Cucumber
         output_envelope(message)
       end
 
-      def on_test_run_finished(*)
+      def on_test_run_finished(event)
         message = Cucumber::Messages::Envelope.new(
           test_run_finished: Cucumber::Messages::TestRunFinished.new(
-            timestamp: time_to_timestamp(Time.now)
+            timestamp: time_to_timestamp(Time.now),
+            success: event.success
           )
         )
 

data/lib/cucumber/formatter/pretty.rb

@@ -19,16 +19,14 @@ module Cucumber
     #
     # If the output is STDOUT (and not a file), there are bright colours to watch too.
     #
-    class Pretty # rubocop:disable Metrics/ClassLength
+    class Pretty
       include FileUtils
       include Console
       include Io
       include Cucumber::Gherkin::Formatter::Escaping
-      attr_reader :config, :options
+      attr_reader :config, :options, :current_feature_uri, :current_scenario_outline, :current_examples, :current_test_case, :in_scenario_outline, :print_background_steps
       private :config, :options
-      attr_reader :current_feature_uri, :current_scenario_outline, :current_examples, :current_test_case
       private :current_feature_uri, :current_scenario_outline, :current_examples, :current_test_case
-      attr_reader :in_scenario_outline, :print_background_steps
       private :in_scenario_outline, :print_background_steps
 
       def initialize(config)
@@ -105,16 +103,19 @@ module Cucumber
 
       def on_test_step_started(event)
         return if event.test_step.hook?
+
         print_step_header(current_test_case) if first_step_after_printing_background_steps?(event.test_step)
       end
 
       def on_test_step_finished(event)
         collect_snippet_data(event.test_step, @ast_lookup) if event.result.undefined?
         return if in_scenario_outline && !options[:expand]
+
         exception_to_be_printed = find_exception_to_be_printed(event.result)
         print_step_data(event.test_step, event.result) if print_step_data?(event, exception_to_be_printed)
         print_step_output
         return unless exception_to_be_printed
+
         print_exception(exception_to_be_printed, event.result.to_sym, 6)
         @exceptions << exception_to_be_printed
       end
@@ -127,6 +128,7 @@ module Cucumber
         else
           exception_to_be_printed = find_exception_to_be_printed(event.result)
           return unless exception_to_be_printed
+
           print_exception(exception_to_be_printed, event.result.to_sym, 6)
           @exceptions << exception_to_be_printed
         end
@@ -138,18 +140,25 @@ module Cucumber
         print_summary
       end
 
-      def attach(src, media_type)
+      def attach(src, media_type, filename)
         return unless media_type == 'text/x.cucumber.log+plain'
-        @test_step_output.push src
+
+        if filename
+          @test_step_output.push("#{filename}: #{src}")
+        else
+          @test_step_output.push(src)
+        end
       end
 
       private
 
       def find_exception_to_be_printed(result)
-        return nil if result.ok?(options[:strict])
+        return nil if result.ok?(strict: options[:strict])
+
         result = result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
         exception = result.failed? ? result.exception : result
         return nil if @exceptions.include?(exception)
+
         exception
       end
 
@@ -196,6 +205,7 @@ module Cucumber
       def feature_has_background?
         feature_children = gherkin_document.feature.children
         return false if feature_children.empty?
+
         !feature_children.first.background.nil?
       end
 
@@ -239,6 +249,7 @@ module Cucumber
       def first_step_after_printing_background_steps?(test_step)
         return false unless print_background_steps
         return false unless test_step.location.lines.max >= current_test_case.location.lines.max
+
         @print_background_steps = false
         true
       end
@@ -262,7 +273,8 @@ module Cucumber
       def print_comments(up_to_line, indent_amount)
         comments = gherkin_document.comments
         return if comments.empty? || comments.length <= @next_comment_to_be_printed
-        comments[@next_comment_to_be_printed..-1].each do |comment|
+
+        comments[@next_comment_to_be_printed..].each do |comment|
           if comment.location.line <= up_to_line
             @io.puts(indent(format_string(comment.text.strip, :comment), indent_amount))
             @next_comment_to_be_printed += 1
@@ -294,6 +306,7 @@ module Cucumber
 
       def print_description(description)
         return unless description
+
         description.split("\n").each do |line|
           @io.puts(line)
         end
@@ -382,7 +395,7 @@ module Cucumber
         end
       end
 
-      def print_outline_data(scenario_outline) # rubocop:disable Metrics/AbcSize
+      def print_outline_data(scenario_outline)
         print_comments(scenario_outline.location.line, 2)
         print_tags(scenario_outline.tags, 2)
         @source_indent = calculate_source_indent_for_ast_node(scenario_outline) if options[:source]
@@ -398,6 +411,7 @@ module Cucumber
           end
           @io.puts
           next if options[:no_multiline]
+
           print_doc_string(step.doc_string.content, :skipped, 6) unless step.doc_string.nil?
           print_data_table(step.data_table, :skipped, 6) unless step.data_table.nil?
         end
@@ -445,7 +459,7 @@ module Cucumber
         language = ::Gherkin::Dialect.for(language_code)
         scenario_keyword = language.scenario_keywords[0]
         row = scenario_source(test_case).row
-        expanded_name = '| ' + row.cells.map(&:value).join(' | ') + ' |'
+        expanded_name = "| #{row.cells.map(&:value).join(' | ')} |"
         @source_indent = calculate_source_indent_for_expanded_test_case(test_case, scenario_keyword, expanded_name)
         @io.puts
         print_keyword_name(scenario_keyword, expanded_name, 6, test_case.location)

data/lib/cucumber/formatter/progress.rb

@@ -58,6 +58,7 @@ module Cucumber
         progress(result.to_sym) if !test_step.hook? || result.failed?
 
         return if test_step.hook?
+
         collect_snippet_data(test_step, @ast_lookup) if result.undefined?
         @pending_step_matches << @matches[test_step.to_s] if result.pending?
         @failed_results << result if result.failed?

data/lib/cucumber/formatter/publish_banner_printer.rb

@@ -15,7 +15,6 @@ module Cucumber
         end
       end
 
-      # rubocop:disable Metrics/MethodLength
       def display_publish_ad(io)
         display_banner(
           [
@@ -59,7 +58,6 @@ module Cucumber
           io
         )
       end
-      # rubocop:enable Metrics/MethodLength
 
       def highlight(text)
         [text, :cyan]

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/errors'
 
 module Cucumber
@@ -13,6 +15,7 @@ module Cucumber
 
         def hook_id(test_step)
           return @hook_id_by_test_step_id[test_step.id] if @hook_id_by_test_step_id.key?(test_step.id)
+
           raise TestStepUnknownError, "No hook found for #{test_step.id} }. Known: #{@hook_id_by_test_step_id.keys}"
         end
 

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

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

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

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

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/errors'
 
 module Cucumber
@@ -15,11 +17,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

@@ -14,23 +14,25 @@ module Cucumber
         config.on_event :test_case_finished do |event|
           test_case, result = *event.attributes
           if @config.strict.strict?(:flaky)
-            next if result.ok?(@config.strict)
+            next if result.ok?(strict: @config.strict)
+
             add_to_failures(test_case)
           else
             unless @latest_failed_test_case.nil?
               if @latest_failed_test_case != test_case
                 add_to_failures(@latest_failed_test_case)
                 @latest_failed_test_case = nil
-              elsif result.ok?(@config.strict)
+              elsif result.ok?(strict: @config.strict)
                 @latest_failed_test_case = nil
               end
             end
-            @latest_failed_test_case = test_case unless result.ok?(@config.strict)
+            @latest_failed_test_case = test_case unless result.ok?(strict: @config.strict)
           end
         end
         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

@@ -10,14 +10,14 @@ if Cucumber::WINDOWS
     Cucumber::CODEPAGE = ENV['CUCUMBER_OUTPUT_ENCODING']
   elsif `cmd /c chcp` =~ /(\d+)/
     if [65_000, 65_001].include? Regexp.last_match(1).to_i
-      Cucumber::CODEPAGE = 'UTF-8'.freeze
+      Cucumber::CODEPAGE = 'UTF-8'
       ENV['ANSICON_API'] = 'ruby'
     else
-      Cucumber::CODEPAGE = "cp#{Regexp.last_match(1).to_i}".freeze
+      Cucumber::CODEPAGE = "cp#{Regexp.last_match(1).to_i}"
     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.")
+    Cucumber::CODEPAGE = '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/url_reporter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cucumber
   module Formatter
     class URLReporter
@@ -11,7 +13,7 @@ module Cucumber
     end
 
     class NoReporter
-      def report(banner); end
+      def report(_banner); end
     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

@@ -5,8 +5,7 @@ module Cucumber
     module Formatter
       # Defines aliases for ANSI coloured output. Default colours can be overridden by defining
       # a <tt>GHERKIN_COLORS</tt> variable in your shell, very much like how you can
-      # tweak the familiar POSIX command <tt>ls</tt> with
-      # $LSCOLORS: http://linux-sxs.org/housekeeping/lscolors.html
+      # tweak the familiar POSIX command <tt>ls</tt> with $LSCOLORS: http://linux-sxs.org/housekeeping/lscolors.html
       #
       # The colours that you can change are:
       #
@@ -41,40 +40,39 @@ module Cucumber
       # Although not listed, you can also use <tt>grey</tt>
       module AnsiEscapes
         COLORS = {
-          'black'   => "\e[30m",
-          'red'     => "\e[31m",
-          'green'   => "\e[32m",
-          'yellow'  => "\e[33m",
-          'blue'    => "\e[34m",
+          'black' => "\e[30m",
+          'red' => "\e[31m",
+          'green' => "\e[32m",
+          'yellow' => "\e[33m",
+          'blue' => "\e[34m",
           'magenta' => "\e[35m",
-          'cyan'    => "\e[36m",
-          'white'   => "\e[37m",
-          'grey'    => "\e[90m",
-          'bold'    => "\e[1m"
+          'cyan' => "\e[36m",
+          'white' => "\e[37m",
+          'grey' => "\e[90m",
+          'bold' => "\e[1m"
         }.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',
+          'pending' => 'yellow',
           'executing' => 'grey',
-          'failed'    => 'red',
-          'passed'    => 'green',
-          'outline'   => 'cyan',
-          'skipped'   => 'cyan',
-          'comments'  => 'grey',
-          'tag'       => 'cyan'
+          'failed' => 'red',
+          'passed' => 'green',
+          'outline' => 'cyan',
+          'skipped' => 'cyan',
+          'comments' => 'grey',
+          'tag' => 'cyan'
         )
 
-        if ENV['GHERKIN_COLORS'] # Example: export GHERKIN_COLORS="passed=red:failed=yellow"
-          ENV['GHERKIN_COLORS'].split(':').each do |pair|
-            a = pair.split('=')
-            ALIASES[a[0]] = a[1]
-          end
+        # Example: export GHERKIN_COLORS="passed=red:failed=yellow"
+        ENV.fetch('GHERKIN_COLORS', '').split(':').each do |pair|
+          rule, colour = pair.split('=')
+          ALIASES[colour] = rule
         end
 
-        ALIASES.keys.each do |key|
+        ALIASES.each_key do |key|
           define_method(key) do
             ALIASES[key].split(',').map { |color| COLORS[color] }.join('')
           end
@@ -88,8 +86,8 @@ module Cucumber
           "\e[0m"
         end
 
-        def up(n)
-          "\e[#{n}A"
+        def up(amount)
+          "\e[#{amount}A"
         end
       end
     end