cucumber 7.1.0 → 9.2.1

data/lib/cucumber/formatter/console.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/ModuleLength
-
 require 'cucumber/formatter/ansicolor'
 require 'cucumber/formatter/duration'
 require 'cucumber/gherkin/i18n'
@@ -34,7 +32,7 @@ module Cucumber
 
       def format_step(keyword, step_match, status, source_indent)
         comment = if source_indent
-                    c = indent(('# ' + step_match.location.to_s), source_indent)
+                    c = indent("# #{step_match.location}", source_indent)
                     format_string(c, :comment)
                   else
                     ''
@@ -45,10 +43,10 @@ module Cucumber
         format_string(line, status)
       end
 
-      def format_string(o, status)
+      def format_string(input, status)
         fmt = format_for(status)
-        o.to_s.split("\n").map do |line|
-          if Proc == fmt.class
+        input.to_s.split("\n").map do |line|
+          if fmt.instance_of?(Proc)
             fmt.call(line)
           else
             fmt % line
@@ -94,22 +92,25 @@ module Cucumber
         @io.flush
       end
 
-      def print_exception(e, status, indent)
-        string = exception_message_string(e, indent)
+      def print_exception(exception, status, indent)
+        string = exception_message_string(exception, indent)
         @io.puts(format_string(string, status))
       end
 
-      def exception_message_string(e, indent_amount)
-        message = "#{e.message} (#{e.class})".dup.force_encoding('UTF-8')
+      def exception_message_string(exception, indent_amount)
+        message = "#{exception.message} (#{exception.class})".dup.force_encoding('UTF-8')
         message = linebreaks(message, ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
 
-        indent("#{message}\n#{e.backtrace.join("\n")}", indent_amount)
+        indent("#{message}\n#{exception.backtrace.join("\n")}", indent_amount)
       end
 
       # http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/10655
       def linebreaks(msg, max)
-        return msg unless max && max > 0
-        msg.gsub(/.{1,#{max}}(?:\s|\Z)/) { ($& + 5.chr).gsub(/\n\005/, "\n").gsub(/\005/, "\n") }.rstrip
+        return msg unless max.positive?
+
+        msg.gsub(/.{1,#{max}}(?:\s|\Z)/) do
+          (Regexp.last_match(0) + 5.chr).gsub(/\n\005/, "\n").gsub(/\005/, "\n")
+        end.rstrip
       end
 
       def collect_snippet_data(test_step, ast_lookup)
@@ -150,6 +151,7 @@ module Cucumber
 
       def print_passing_wip(config, passed_test_cases, ast_lookup)
         return unless config.wip?
+
         messages = passed_test_cases.map do |test_case|
           scenario_source = ast_lookup.scenario_source(test_case)
           keyword = scenario_source.type == :Scenario ? scenario_source.scenario.keyword : scenario_source.scenario_outline.keyword
@@ -167,16 +169,23 @@ module Cucumber
         end
       end
 
-      def attach(src, media_type)
+      def attach(src, media_type, filename)
         return unless media_type == 'text/x.cucumber.log+plain'
         return unless @io
+
         @io.puts
-        @io.puts(format_string(src, :tag))
+        if filename
+          @io.puts("#{filename}: #{format_string(src, :tag)}")
+        else
+          @io.puts(format_string(src, :tag))
+        end
+
         @io.flush
       end
 
       def print_profile_information
         return if @options[:skip_profile_information] || @options[:profiles].nil? || @options[:profiles].empty?
+
         do_print_profile_information(@options[:profiles])
       end
 
@@ -224,6 +233,7 @@ module Cucumber
         key = keys.join('_').to_sym
         fmt = FORMATS[key]
         raise "No format for #{key.inspect}: #{FORMATS.inspect}" if fmt.nil?
+
         fmt
       end
 
@@ -246,6 +256,7 @@ module Cucumber
 
       class SnippetData
         attr_reader :actual_keyword, :step
+
         def initialize(actual_keyword, step)
           @actual_keyword = actual_keyword
           @step = step
@@ -254,4 +265,3 @@ module Cucumber
     end
   end
 end
-# rubocop:enable Metrics/ModuleLength

data/lib/cucumber/formatter/console_counts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/console'
 
 module Cucumber
@@ -30,7 +32,7 @@ module Cucumber
 
       def status_counts(summary)
         counts = Core::Test::Result::TYPES.map { |status| [status, summary.total(status)] }
-        counts = counts.select { |_status, count| count > 0 }
+        counts = counts.select { |_status, count| count.positive? }
         counts = counts.map { |status, count| format_string("#{count} #{status}", status) }
         "(#{counts.join(', ')})" if counts.any?
       end

data/lib/cucumber/formatter/console_issues.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/console'
 
 module Cucumber
@@ -12,9 +14,9 @@ module Cucumber
         @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)
+            @issues[event.result.to_sym] << event.test_case unless event.result.ok?(strict: @config.strict)
           elsif event.result.passed?
-            @issues[:flaky] << event.test_case unless Core::Test::Result::Flaky.ok?(@config.strict.strict?(:flaky))
+            @issues[:flaky] << event.test_case unless Core::Test::Result::Flaky.ok?(strict: @config.strict.strict?(:flaky))
             @issues[:failed].delete(event.test_case)
           end
         end
@@ -23,6 +25,7 @@ module Cucumber
 
       def to_s
         return if @issues.empty?
+
         result = Core::Test::Result::TYPES.map { |type| scenario_listing(type, @issues[type]) }
         result.flatten.join("\n")
       end
@@ -35,6 +38,7 @@ module Cucumber
 
       def scenario_listing(type, test_cases)
         return [] if test_cases.empty?
+
         [format_string("#{type_heading(type)} Scenarios:", type)] + test_cases.map do |test_case|
           scenario_source = @ast_lookup.scenario_source(test_case)
           keyword = scenario_source.type == :Scenario ? scenario_source.scenario.keyword : scenario_source.scenario_outline.keyword
@@ -54,7 +58,10 @@ module Cucumber
 
       def profiles_string
         return if @config.custom_profiles.empty?
-        @config.custom_profiles.map { |profile| "-p #{profile}" }.join(' ') + ' '
+
+        profiles = @config.custom_profiles.map { |profile| "-p #{profile}" }.join(' ')
+
+        "#{profiles} "
       end
     end
   end

data/lib/cucumber/formatter/curl_option_parser.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+
+module Cucumber
+  module Formatter
+    class CurlOptionParser
+      def self.parse(options)
+        args = Shellwords.split(options)
+
+        url = nil
+        http_method = 'PUT'
+        headers = {}
+
+        until args.empty?
+          arg = args.shift
+          case arg
+          when '-X', '--request'
+            http_method = remove_arg_for(args, arg)
+          when '-H'
+            header_arg = remove_arg_for(args, arg)
+            headers = headers.merge(parse_header(header_arg))
+          else
+            raise StandardError, "#{options} was not a valid curl command. Can't set url to #{arg} it is already set to #{url}" if url
+
+            url = arg
+          end
+        end
+        raise StandardError, "#{options} was not a valid curl command" unless url
+
+        [url, http_method, headers]
+      end
+
+      # TODO: [LH] -> Switch below methods to private
+      def self.remove_arg_for(args, arg)
+        return args.shift unless args.empty?
+
+        raise StandardError, "Missing argument for #{arg}"
+      end
+
+      def self.parse_header(header_arg)
+        parts = header_arg.split(':', 2)
+        raise StandardError, "#{header_arg} was not a valid header" unless parts.length == 2
+
+        { parts[0].strip => parts[1].strip }
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/duration_extractor.rb

@@ -4,6 +4,7 @@ module Cucumber
   module Formatter
     class DurationExtractor
       attr_reader :result_duration
+
       def initialize(result)
         @result_duration = 0
         result.describe_to(self)

data/lib/cucumber/formatter/errors.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module Cucumber
   module Formatter
     class TestCaseUnknownError < StandardError; end
+
     class TestStepUnknownError < StandardError; end
   end
 end

data/lib/cucumber/formatter/fail_fast.rb

@@ -12,7 +12,7 @@ module Cucumber
           test_case, result = *event.attributes
           if test_case != @previous_test_case
             @previous_test_case = event.test_case
-            Cucumber.wants_to_quit = true unless result.ok?(configuration.strict)
+            Cucumber.wants_to_quit = true unless result.ok?(strict: configuration.strict)
           elsif result.passed?
             Cucumber.wants_to_quit = false
           end

data/lib/cucumber/formatter/fanout.rb

@@ -21,7 +21,7 @@ module Cucumber
       end
 
       def respond_to_missing?(name, include_private = false)
-        recipients.any? { |recipient| recipient.respond_to?(name, include_private) }
+        recipients.any? { |recipient| recipient.respond_to?(name, include_private) } || super(name, include_private)
       end
     end
   end

data/lib/cucumber/formatter/html.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/formatter/io'
 require 'cucumber/html_formatter'
 require 'cucumber/formatter/message_builder'

data/lib/cucumber/formatter/http_io.rb

@@ -1,146 +1,19 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'tempfile'
-require 'shellwords'
+require_relative 'curl_option_parser'
+require_relative 'io_http_buffer'
 
 module Cucumber
   module Formatter
     class HTTPIO
-      class << self
-        # Returns an IO that will write to a HTTP request's body
-        # https_verify_mode can be set to OpenSSL::SSL::VERIFY_NONE
-        # to ignore unsigned certificate - setting to nil will verify the certificate
-        def open(url, https_verify_mode = nil, reporter = nil)
-          @https_verify_mode = https_verify_mode
-          uri, method, headers = CurlOptionParser.parse(url)
-          IOHTTPBuffer.new(uri, method, headers, https_verify_mode, reporter)
-        end
-      end
-    end
-
-    class CurlOptionParser
-      def self.parse(options)
-        args = Shellwords.split(options)
-
-        url = nil
-        http_method = 'PUT'
-        headers = {}
-
-        until args.empty?
-          arg = args.shift
-          case arg
-          when '-X', '--request'
-            http_method = remove_arg_for(args, arg)
-          when '-H'
-            header_arg = remove_arg_for(args, arg)
-            headers = headers.merge(parse_header(header_arg))
-          else
-            raise StandardError, "#{options} was not a valid curl command. Can't set url to #{arg} it is already set to #{url}" if url
-            url = arg
-          end
-        end
-        raise StandardError, "#{options} was not a valid curl command" unless url
-
-        [
-          url,
-          http_method,
-          headers
-        ]
-      end
-
-      def self.remove_arg_for(args, arg)
-        return args.shift unless args.empty?
-        raise StandardError, "Missing argument for #{arg}"
-      end
-
-      def self.parse_header(header_arg)
-        parts = header_arg.split(':', 2)
-        raise StandardError, "#{header_arg} was not a valid header" unless parts.length == 2
-        { parts[0].strip => parts[1].strip }
-      end
-    end
-
-    class IOHTTPBuffer
-      attr_reader :uri, :method, :headers
-
-      def initialize(uri, method, headers = {}, https_verify_mode = nil, reporter = nil)
-        @uri = URI(uri)
-        @method = method
-        @headers = headers
-        @write_io = Tempfile.new('cucumber', encoding: 'UTF-8')
-        @https_verify_mode = https_verify_mode
-        @reporter = reporter || NoReporter.new
-      end
-
-      def close
-        response = send_content(@uri, @method, @headers)
-        @reporter.report(response.body)
-        @write_io.close
-        return if response.is_a?(Net::HTTPSuccess) || response.is_a?(Net::HTTPRedirection)
-        raise StandardError, "request to #{uri} failed with status #{response.code}"
-      end
-
-      def write(data)
-        @write_io.write(data)
-      end
-
-      def flush
-        @write_io.flush
-      end
-
-      def closed?
-        @write_io.closed?
-      end
-
-      private
-
-      def send_content(uri, method, headers, attempt = 10)
-        content = (method == 'GET' ? StringIO.new : @write_io)
-        http = build_client(uri, @https_verify_mode)
-
-        raise StandardError, "request to #{uri} failed (too many redirections)" if attempt <= 0
-        req = build_request(
-          uri,
-          method,
-          headers.merge(
-            'Content-Length' => content.size.to_s
-          )
-        )
-
-        content.rewind
-        req.body_stream = content
-
-        begin
-          response = http.request(req)
-        rescue SystemCallError
-          # We may get the redirect response before pushing the file.
-          response = http.request(build_request(uri, method, headers))
-        end
-
-        case response
-        when Net::HTTPAccepted
-          send_content(URI(response['Location']), 'PUT', {}, attempt - 1) if response['Location']
-        when Net::HTTPRedirection
-          send_content(URI(response['Location']), method, headers, attempt - 1)
-        end
-        response
-      end
-
-      def build_request(uri, method, headers)
-        method_class_name = "#{method[0].upcase}#{method[1..-1].downcase}"
-        req = Net::HTTP.const_get(method_class_name).new(uri)
-        headers.each do |header, value|
-          req[header] = value
-        end
-        req
-      end
-
-      def build_client(uri, https_verify_mode)
-        http = Net::HTTP.new(uri.hostname, uri.port)
-        if uri.scheme == 'https'
-          http.use_ssl = true
-          http.verify_mode = https_verify_mode if https_verify_mode
-        end
-        http
+      # Returns an IO that will write to a HTTP request's body
+      # https_verify_mode can be set to OpenSSL::SSL::VERIFY_NONE
+      # to ignore unsigned certificate - setting to nil will verify the certificate
+      def self.open(url, https_verify_mode = nil, reporter = nil)
+        uri, method, headers = CurlOptionParser.parse(url)
+        IOHTTPBuffer.new(uri, method, headers, https_verify_mode, reporter)
       end
     end
   end

data/lib/cucumber/formatter/ignore_missing_messages.rb

@@ -12,7 +12,7 @@ module Cucumber
       end
 
       def respond_to_missing?(name, include_private = false)
-        @receiver.respond_to?(name, include_private)
+        @receiver.respond_to?(name, include_private) || super(name, include_private)
       end
     end
   end

data/lib/cucumber/formatter/io.rb

@@ -57,19 +57,21 @@ module Cucumber
       end
 
       def url?(path_or_url_or_io)
-        path_or_url_or_io.match(%r{^https?://})
+        path_or_url_or_io.match(/^https?:\/\//)
       end
 
       def ensure_file(path, name)
-        raise "You *must* specify --out FILE for the #{name} formatter" unless String == path.class
+        raise "You *must* specify --out FILE for the #{name} formatter" unless path.instance_of? String
         raise "I can't write #{name} to a directory - it has to be a file" if File.directory?(path)
         raise "I can't write #{name} to a file in the non-existing directory #{File.dirname(path)}" unless File.directory?(File.dirname(path))
+
         ensure_io(path, nil)
       end
 
       def ensure_dir(path, name)
-        raise "You *must* specify --out DIR for the #{name} formatter" unless String == path.class
+        raise "You *must* specify --out DIR for the #{name} formatter" unless path.instance_of? String
         raise "I can't write #{name} reports to a file - it has to be a directory" if File.file?(path)
+
         FileUtils.mkdir_p(path) unless File.directory?(path)
         File.absolute_path path
       end

data/lib/cucumber/formatter/io_http_buffer.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Cucumber
+  module Formatter
+    class IOHTTPBuffer
+      attr_reader :uri, :method, :headers
+
+      def initialize(uri, method, headers = {}, https_verify_mode = nil, reporter = nil)
+        @uri = URI(uri)
+        @method = method
+        @headers = headers
+        @write_io = Tempfile.new('cucumber', encoding: 'UTF-8')
+        @https_verify_mode = https_verify_mode
+        @reporter = reporter || NoReporter.new
+      end
+
+      def close
+        @reporter.report(response.body)
+        @write_io.close
+        return if response.is_a?(Net::HTTPSuccess) || response.is_a?(Net::HTTPRedirection)
+
+        raise StandardError, "request to #{uri} failed with status #{response.code}"
+      end
+
+      def write(data)
+        @write_io.write(data)
+      end
+
+      def flush
+        @write_io.flush
+      end
+
+      def closed?
+        @write_io.closed?
+      end
+
+      private
+
+      def response
+        @response ||= send_content(uri, method, headers)
+      end
+
+      def send_content(uri, method, headers, attempts_remaining = 10)
+        content = (method == 'GET' ? StringIO.new : @write_io)
+        http = build_client(uri)
+
+        raise StandardError, "request to #{uri} failed (too many redirections)" if attempts_remaining <= 0
+
+        request = build_request(uri, method, headers.merge('Content-Length' => content.size.to_s))
+        content.rewind
+        request.body_stream = content
+
+        begin
+          response = http.request(request)
+        rescue SystemCallError
+          # We may get the redirect response before pushing the file.
+          response = http.request(build_request(uri, method, headers))
+        end
+
+        case response
+        when Net::HTTPAccepted
+          send_content(URI(response['Location']), 'PUT', {}, attempts_remaining - 1) if response['Location']
+        when Net::HTTPRedirection
+          send_content(URI(response['Location']), method, headers, attempts_remaining - 1)
+        end
+        response
+      end
+
+      def build_request(uri, method, headers)
+        method_class_name = "#{method[0].upcase}#{method[1..].downcase}"
+        Net::HTTP.const_get(method_class_name).new(uri).tap do |request|
+          headers.each do |header, value|
+            request[header] = value
+          end
+        end
+      end
+
+      def build_client(uri)
+        Net::HTTP.new(uri.hostname, uri.port).tap do |http|
+          if uri.scheme == 'https'
+            http.use_ssl = true
+            http.verify_mode = @https_verify_mode if @https_verify_mode
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/formatter/json.rb

@@ -68,6 +68,7 @@ module Cucumber
         test_step, result = *event.attributes
         result = result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
         return if internal_hook?(test_step)
+
         add_match_and_result(test_step, result)
         @any_step_failed = true if result.failed?
       end
@@ -81,10 +82,10 @@ module Cucumber
       end
 
       def on_test_run_finished(_event)
-        @io.write(JSON.generate(@feature_hashes, pretty: true))
+        @io.write(JSON.pretty_generate(@feature_hashes))
       end
 
-      def attach(src, mime_type)
+      def attach(src, mime_type, _filename)
         if mime_type == 'text/x.cucumber.log+plain'
           test_step_output << src
           return
@@ -101,21 +102,17 @@ module Cucumber
       private
 
       def same_feature_as_previous_test_case?(test_case)
-        current_feature[:uri] == test_case.location.file
+        @feature_hash&.fetch(:uri, nil) == test_case.location.file
       end
 
       def first_step_after_background?(test_step)
-        @in_background && test_step.location.lines.max >= @test_case_hash[:line]
+        @in_background && test_step.location.file == @feature_hash[:uri] && test_step.location.lines.max >= @test_case_hash[:line]
       end
 
       def internal_hook?(test_step)
         test_step.location.file.include?('lib/cucumber/')
       end
 
-      def current_feature
-        @feature_hash ||= {} # rubocop:disable Naming/MemoizedInstanceVariableName
-      end
-
       def feature_elements
         @feature_hash[:elements] ||= []
       end
@@ -133,7 +130,7 @@ module Cucumber
         when 'AfterStep hook'
           after_step_hooks
         else
-          raise 'Unknown hook type ' + hook_step.to_s
+          raise "Unknown hook type #{hook_step}"
         end
       end
 
@@ -175,15 +172,15 @@ module Cucumber
           name: test_step.text,
           line: test_step.location.lines.min
         }
-        step_hash[:doc_string] = create_doc_string_hash(step_source.doc_string) unless step_source.doc_string.nil?
+        step_hash[:doc_string] = create_doc_string_hash(step_source.doc_string, test_step.multiline_arg.content) unless step_source.doc_string.nil?
         step_hash[:rows] = create_data_table_value(step_source.data_table) unless step_source.data_table.nil?
         step_hash
       end
 
-      def create_doc_string_hash(doc_string)
+      def create_doc_string_hash(doc_string, doc_string_content)
         content_type = doc_string.media_type || ''
         {
-          value: doc_string.content,
+          value: doc_string_content,
           content_type: content_type,
           line: doc_string.location.line
         }
@@ -259,6 +256,7 @@ module Cucumber
             line: feature.location.line
           }
           return if feature.tags.empty?
+
           @feature_hash[:tags] = create_tags_array_from_hash_array(feature.tags)
         end