cucumber 9.0.2 → 9.1.2

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,30 +40,30 @@ 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'
         )
 
         # Example: export GHERKIN_COLORS="passed=red:failed=yellow"
@@ -87,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

@@ -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

@@ -7,7 +7,7 @@ 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 = 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,8 +125,8 @@ module Cucumber
         inspect
       end
 
-      # Dynamially generate the API module, closuring the dependencies
-      def self.for(runtime, language) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+      # 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
@@ -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

@@ -198,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/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
 
@@ -194,17 +194,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 +340,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 +350,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 +433,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 +456,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 +469,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 +483,7 @@ module Cucumber
         end
       end
 
-      def convert_headers! # :nodoc:
+      def convert_headers!
         header_cells = cell_matrix[0]
 
         if @header_conversion_proc
@@ -501,11 +501,11 @@ 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:
+      def ensure_table(table_or_array)
         return table_or_array if table_or_array.instance_of?(DataTable)
 
         DataTable.from(table_or_array)
@@ -516,7 +516,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 +536,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 +575,7 @@ module Cucumber
         end
       end
 
-      class Cell # :nodoc:
+      class Cell
         attr_reader :line, :table
         attr_accessor :status, :value
 
@@ -603,12 +602,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

data/lib/cucumber/rake/task.rb

@@ -2,11 +2,7 @@
 
 require 'cucumber/platform'
 require 'cucumber/gherkin/formatter/ansi_escapes'
-begin
-  # Support Rake > 0.8.7
-  require 'rake/dsl_definition'
-rescue LoadError
-end
+require 'rake/dsl_definition'
 
 module Cucumber
   module Rake

data/lib/cucumber/running_test_case.rb

@@ -50,7 +50,7 @@ module Cucumber
       end
 
       def source_tag_names
-        tags.map &:name
+        tags.map(&:name)
       end
 
       def with_result(result)

data/lib/cucumber/runtime/for_programming_languages.rb

@@ -7,8 +7,7 @@ module Cucumber
   class Runtime
     # This is what a programming language will consider to be a runtime.
     #
-    # It's a thin class that directs the handul of methods needed by the
-    # programming languages to the right place.
+    # It's a thin class that directs the handful of methods needed by the programming languages to the right place
     class ForProgrammingLanguages
       extend Forwardable
 

data/lib/cucumber/runtime/meta_message_builder.rb

@@ -5,14 +5,14 @@ require 'cucumber/ci_environment'
 
 module Cucumber
   class Runtime
-    # Builder to instanciate a Cucumber::Messages::Meta message filled-in with
+    # Builder to instantiate a Cucumber::Messages::Meta message filled-in with
     # the runtime meta-data:
     # - protocol version: the version of the Cucumber::Messages protocol
     # - implementation: the name and version of the implementation (e.g. cucumber-ruby 8.0.0)
     # - runtime: the name and version of the runtime (e.g. ruby 3.0.1)
     # - os: the name and version of the operating system (e.g. linux 3.13.0-45-generic)
     # - cpu: the name of the CPU (e.g. x86_64)
-    # - ci: informtion about the CI environment if any, including:
+    # - ci: information about the CI environment if any, including:
     #   - name: the name of the CI environment (e.g. Jenkins)
     #   - url: the URL of the CI environment (e.g. https://ci.example.com)
     #   - build_number: the build number of the CI environment (e.g. 123)

data/lib/cucumber/runtime/user_interface.rb

@@ -41,8 +41,8 @@ module Cucumber
       # be a path to a file, or if it's an image it may also be a Base64 encoded image.
       # The embedded data may or may not be ignored, depending on what kind of formatter(s) are active.
       #
-      def attach(src, media_type)
-        @visitor.attach(src, media_type)
+      def attach(src, media_type, filename)
+        @visitor.attach(src, media_type, filename)
       end
 
       private

data/lib/cucumber/runtime.rb

@@ -235,7 +235,7 @@ module Cucumber
     end
 
     require 'cucumber/core/test/filters'
-    def filters # rubocop:disable Metrics/AbcSize
+    def filters
       tag_expressions = @configuration.tag_expressions
       name_regexps = @configuration.name_regexps
       tag_limits = @configuration.tag_limits