cucumber 8.0.0 → 9.2.1

data/lib/cucumber/formatter/pretty.rb

@@ -19,7 +19,7 @@ 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
@@ -140,16 +140,20 @@ 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
@@ -391,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]

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

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

data/lib/cucumber/formatter/rerun.rb

@@ -14,7 +14,7 @@ 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
@@ -22,11 +22,11 @@ module Cucumber
               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

data/lib/cucumber/formatter/unicode.rb

@@ -10,13 +10,13 @@ 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
+    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
 

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/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,37 +40,36 @@ 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/
         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.each_key do |key|
@@ -88,8 +86,8 @@ module Cucumber
           "\e[0m"
         end
 
-        def up(n)
-          "\e[#{n}A"
+        def up(amount)
+          "\e[#{amount}A"
         end
       end
     end

data/lib/cucumber/glue/invoke_in_world.rb

@@ -28,7 +28,7 @@ module Cucumber
           if check_arity && !cucumber_compatible_arity?(args, block)
             world.instance_exec do
               ari = block.arity
-              ari = ari < 0 ? "#{ari.abs - 1}+" : ari
+              ari = ari.negative? ? "#{ari.abs - 1}+" : ari
               s1 = ari == 1 ? '' : 's'
               s2 = args.length == 1 ? '' : 's'
               raise ArityMismatchError, "Your block takes #{ari} argument#{s1}, but the Regexp matched #{args.length} argument#{s2}."
@@ -48,7 +48,7 @@ module Cucumber
 
       def self.cucumber_run_with_backtrace_filtering(pseudo_method)
         yield
-      rescue Exception => e # rubocop:disable Lint/RescueException
+      rescue Exception => e
         instance_exec_invocation_line = "#{__FILE__}:#{__LINE__ - 2}:in `cucumber_run_with_backtrace_filtering'"
         replace_instance_exec_invocation_line!((e.backtrace || []), instance_exec_invocation_line, pseudo_method)
         raise e

data/lib/cucumber/glue/proto_world.rb

@@ -3,11 +3,11 @@
 require 'cucumber/gherkin/formatter/ansi_escapes'
 require 'cucumber/core/test/data_table'
 require 'cucumber/deprecate'
-require 'mime/types'
+require 'mini_mime'
 
 module Cucumber
   module Glue
-    # Defines the basic API methods availlable in all Cucumber step definitions.
+    # Defines the basic API methods available in all Cucumber step definitions.
     #
     # You can, and probably should, extend this API with your own methods that
     # make sense in your domain. For more on that, see {Cucumber::Glue::Dsl#World}
@@ -26,7 +26,7 @@ module Cucumber
       # @example Passing a multiline string
       #   step "the email should contain:", "Dear sir,\nYou've won a prize!\n"
       # @param [String] name The name of the step
-      # @param [String,Cucumber::Test::DocString,Cucumber::Ast::Table] multiline_argument
+      # @param [String, Cucumber::Test::DocString, Cucumber::Ast::Table] raw_multiline_arg
       def step(name, raw_multiline_arg = nil)
         super
       end
@@ -84,17 +84,19 @@ module Cucumber
 
       # Attach a file to the output
       # @param file [string|io] the file to attach.
-      #   It can be a string containing the file content itself,
-      #   the file path, or an IO ready to be read.
-      # @param media_type [string] the media type. If file is a valid path,
-      #   media_type can be ommitted, it will then be inferred from the file name.
-      def attach(file, media_type = nil)
+      #   It can be a string containing the file content itself, the file path, or an IO ready to be read.
+      # @param media_type [string] the media type.
+      #   If file is a valid path, media_type can be omitted, it will then be inferred from the file name.
+      # @param filename [string] the name of the file you wish to specify.
+      #   This is only needed in situations where you want to rename a PDF download e.t.c. - In most situations
+      #   you should not need to pass a filename
+      def attach(file, media_type = nil, filename = nil)
         return super unless File.file?(file)
 
         content = File.read(file, mode: 'rb')
-        media_type = MIME::Types.type_for(file).first if media_type.nil?
+        media_type = MiniMime.lookup_by_filename(file)&.content_type if media_type.nil?
 
-        super(content, media_type.to_s)
+        super(content, media_type.to_s, filename)
       rescue StandardError
         super
       end
@@ -103,12 +105,9 @@ module Cucumber
       def pending(message = 'TODO')
         raise Pending, message unless block_given?
 
-        begin
-          yield
-        rescue Exception # rubocop:disable Lint/RescueException
-          raise Pending, message
-        end
-        raise Pending, "Expected pending '#{message}' to fail. No Error was raised. No longer pending?"
+        yield
+      rescue Exception
+        raise Pending, message
       end
 
       # Skips this step and the remaining steps in the scenario
@@ -126,9 +125,9 @@ module Cucumber
         inspect
       end
 
-      # Dynamially generate the API module, closuring the dependencies
-      def self.for(runtime, language) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
-        Module.new do # rubocop:disable Metrics/BlockLength
+      # Dynamically generate the API module, closuring the dependencies
+      def self.for(runtime, language)
+        Module.new do
           def self.extended(object)
             # wrap the dynamically generated module so that we can document the methods
             # for yardoc, which doesn't like define_method.
@@ -156,8 +155,8 @@ module Cucumber
             runtime.ask(question, timeout_seconds)
           end
 
-          define_method(:attach) do |file, media_type|
-            runtime.attach(file, media_type)
+          define_method(:attach) do |file, media_type, filename|
+            runtime.attach(file, media_type, filename)
           end
 
           # Prints the list of modules that are included in the World
@@ -172,14 +171,12 @@ module Cucumber
 
           private
 
-          # @private
           def add_world_modules!(modules)
             modules.each do |world_module|
               extend(world_module)
             end
           end
 
-          # @private
           def add_namespaced_modules!(modules)
             @__namespaced_modules = modules
             modules.each do |namespace, world_modules|
@@ -199,7 +196,6 @@ module Cucumber
             end
           end
 
-          # @private
           def stringify_namespaced_modules
             return '' if @__namespaced_modules.nil?
 
@@ -208,7 +204,6 @@ module Cucumber
         end
       end
 
-      # @private
       AnsiEscapes = Cucumber::Gherkin::Formatter::AnsiEscapes
     end
   end

data/lib/cucumber/glue/registry_and_more.rb

@@ -29,7 +29,8 @@ module Cucumber
     # Raised if there are 2 or more World blocks.
     class MultipleWorld < StandardError
       def initialize(first_proc, second_proc)
-        message = String.new # rubocop:disable Style/EmptyLiteral
+        # TODO: [LH] - Just use a heredoc here to fix this up
+        message = String.new
         message << "You can only pass a proc to #World once, but it's happening\n"
         message << "in 2 places:\n\n"
         message << Glue.backtrace_line(first_proc, 'World') << "\n"
@@ -197,16 +198,19 @@ module Cucumber
       private
 
       def parameter_type_envelope(parameter_type)
-        # TODO: should me moved to Cucumber::Expression::ParameterType#to_envelope ?
+        # TODO: should this be moved to Cucumber::Expression::ParameterType#to_envelope ??
         # Note: that would mean that cucumber-expression would depend on cucumber-messages
-
         Cucumber::Messages::Envelope.new(
           parameter_type: Cucumber::Messages::ParameterType.new(
             id: @configuration.id_generator.new_id,
             name: parameter_type.name,
             regular_expressions: parameter_type.regexps.map(&:to_s),
-            prefer_for_regular_expression_match: parameter_type.prefer_for_regexp_match?,
-            use_for_snippets: parameter_type.use_for_snippets?
+            prefer_for_regular_expression_match: parameter_type.prefer_for_regexp_match,
+            use_for_snippets: parameter_type.use_for_snippets,
+            source_reference: Cucumber::Messages::SourceReference.new(
+              uri: parameter_type.transformer.source_location[0],
+              location: Cucumber::Messages::Location.new(line: parameter_type.transformer.source_location[1])
+            )
           )
         )
       end

data/lib/cucumber/glue/snippet.rb

@@ -61,7 +61,8 @@ module Cucumber
         end
 
         def do_block
-          do_block = String.new # rubocop:disable Style/EmptyLiteral
+          # TODO: [LH] - Just use a heredoc here to fix this up
+          do_block = String.new
           do_block << "do#{parameters}\n"
           multiline_argument.append_comment_to(do_block)
           do_block << "  pending # Write code here that turns the phrase above into concrete actions\n"
@@ -95,7 +96,8 @@ module Cucumber
             "#{prefix}#{code_keyword}('#{expr.source}') do#{parameters(expr)}"
           end.join("\n")
 
-          body = String.new # rubocop:disable Style/EmptyLiteral
+          # TODO: [LH] - Just use a heredoc here to fix this up
+          body = String.new
           multiline_argument.append_comment_to(body)
           body << "  pending # Write code here that turns the phrase above into concrete actions\n"
           body << 'end'

data/lib/cucumber/glue/world_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cucumber
   module Glue
     class WorldFactory

data/lib/cucumber/multiline_argument/data_table/diff_matrices.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cucumber
   module MultilineArgument
     class DataTable

data/lib/cucumber/multiline_argument/data_table.rb

@@ -27,7 +27,7 @@ module Cucumber
     # This will store <tt>[['a', 'b'], ['c', 'd']]</tt> in the <tt>data</tt> variable.
     #
     class DataTable
-      def self.default_arg_name # :nodoc:
+      def self.default_arg_name
         'table'
       end
 
@@ -75,7 +75,9 @@ module Cucumber
         def eof; end
       end
 
-      NULL_CONVERSIONS = Hash.new(strict: false, proc: ->(cell_value) { cell_value }).freeze
+      # This is a Hash being initialized with a default value of a Hash, DO NOT REFORMAT TO REMOVE {}
+      # Future versions [3.4.0+] of ruby will interpret these as keywords and break.
+      NULL_CONVERSIONS = Hash.new({ strict: false, proc: ->(cell_value) { cell_value } }).freeze
 
       # @param data [Core::Test::DataTable] the data for the table
       # @param conversion_procs [Hash] see map_column
@@ -194,17 +196,17 @@ module Cucumber
         end
       end
 
-      def column_names # :nodoc:
+      def column_names
         @column_names ||= cell_matrix[0].map(&:value)
       end
 
       def rows
         hashes.map do |hash|
-          hash.values_at *headers
+          hash.values_at(*headers)
         end
       end
 
-      def each_cells_row(&proc) # :nodoc:
+      def each_cells_row(&proc)
         cells_rows.each(&proc)
       end
 
@@ -340,7 +342,7 @@ module Cucumber
         cells_rows.map { |cells| cells.map(&:value) }
       end
 
-      def cells_to_hash(cells) # :nodoc:
+      def cells_to_hash(cells)
         hash = Hash.new do |hash_inner, key|
           hash_inner[key.to_s] if key.is_a?(Symbol)
         end
@@ -350,51 +352,51 @@ module Cucumber
         hash
       end
 
-      def index(cells) # :nodoc:
+      def index(cells)
         cells_rows.index(cells)
       end
 
-      def verify_column(column_name) # :nodoc:
+      def verify_column(column_name)
         raise %(The column named "#{column_name}" does not exist) unless raw[0].include?(column_name)
       end
 
-      def verify_table_width(width) # :nodoc:
+      def verify_table_width(width)
         raise %(The table must have exactly #{width} columns) unless raw[0].size == width
       end
 
       # TODO: remove the below function if it's not actually being used.
       # Nothing else in this repo calls it.
-      def text?(text) # :nodoc:
+      def text?(text)
         raw.flatten.compact.detect { |cell_value| cell_value.index(text) }
       end
 
-      def cells_rows # :nodoc:
-        @rows ||= cell_matrix.map do |cell_row| # rubocop:disable Naming/MemoizedInstanceVariableName
+      def cells_rows
+        @rows ||= cell_matrix.map do |cell_row|
           Cells.new(self, cell_row)
         end
       end
 
-      def headers # :nodoc:
+      def headers
         raw.first
       end
 
-      def header_cell(col) # :nodoc:
+      def header_cell(col)
         cells_rows[0][col]
       end
 
       attr_reader :cell_matrix
 
-      def col_width(col) # :nodoc:
+      def col_width(col)
         columns[col].__send__(:width)
       end
 
-      def to_s(options = {}) # :nodoc:
+      def to_s(options = {})
         indentation = options.key?(:indent) ? options[:indent] : 2
         prefixes = options.key?(:prefixes) ? options[:prefixes] : TO_S_PREFIXES
         DataTablePrinter.new(self, indentation, prefixes).to_s
       end
 
-      class DataTablePrinter # :nodoc:
+      class DataTablePrinter
         include Cucumber::Gherkin::Formatter::Escaping
         attr_reader :data_table, :indentation, :prefixes
         private :data_table, :indentation, :prefixes
@@ -433,7 +435,7 @@ module Cucumber
         end
       end
 
-      def columns # :nodoc:
+      def columns
         @columns ||= cell_matrix.transpose.map do |cell_row|
           Cells.new(self, cell_row)
         end
@@ -456,7 +458,7 @@ module Cucumber
         cells_rows[1..].map(&:to_hash)
       end
 
-      def create_cell_matrix(ast_table) # :nodoc:
+      def create_cell_matrix(ast_table)
         ast_table.raw.map do |raw_row|
           line = begin
             raw_row.line
@@ -469,7 +471,7 @@ module Cucumber
         end
       end
 
-      def convert_columns! # :nodoc:
+      def convert_columns!
         @conversion_procs.each do |column_name, conversion_proc|
           verify_column(column_name) if conversion_proc[:strict]
         end
@@ -483,7 +485,7 @@ module Cucumber
         end
       end
 
-      def convert_headers! # :nodoc:
+      def convert_headers!
         header_cells = cell_matrix[0]
 
         if @header_conversion_proc
@@ -501,12 +503,12 @@ module Cucumber
         end
       end
 
-      def clear_cache! # :nodoc:
+      def clear_cache!
         @hashes = @rows_hash = @column_names = @rows = @columns = nil
       end
 
-      def ensure_table(table_or_array) # :nodoc:
-        return table_or_array if DataTable == table_or_array.class
+      def ensure_table(table_or_array)
+        return table_or_array if table_or_array.instance_of?(DataTable)
 
         DataTable.from(table_or_array)
       end
@@ -516,7 +518,7 @@ module Cucumber
       end
 
       # Represents a row of cells or columns of cells
-      class Cells # :nodoc:
+      class Cells
         include Enumerable
         include Cucumber::Gherkin::Formatter::Escaping
 
@@ -536,21 +538,20 @@ module Cucumber
           nil
         end
 
-        # For testing only
-        def to_sexp # :nodoc:
+        def to_sexp
           [:row, line, *@cells.map(&:to_sexp)]
         end
 
-        def to_hash # :nodoc:
+        def to_hash
           @to_hash ||= @table.cells_to_hash(self)
         end
 
-        def value(n) # :nodoc:
-          self[n].value
+        def value(index)
+          self[index].value
         end
 
-        def [](n)
-          @cells[n]
+        def [](index)
+          @cells[index]
         end
 
         def line
@@ -576,7 +577,7 @@ module Cucumber
         end
       end
 
-      class Cell # :nodoc:
+      class Cell
         attr_reader :line, :table
         attr_accessor :status, :value
 
@@ -591,7 +592,7 @@ module Cucumber
         end
 
         def ==(other)
-          SurplusCell == other.class || value == other.value
+          other.class == SurplusCell || value == other.value
         end
 
         def eql?(other)
@@ -603,12 +604,12 @@ module Cucumber
         end
 
         # For testing only
-        def to_sexp # :nodoc:
+        def to_sexp
           [:cell, @value]
         end
       end
 
-      class SurplusCell < Cell # :nodoc:
+      class SurplusCell < Cell
         def status
           :comment
         end