cucumber 5.3.0 → 7.1.0

data/lib/cucumber/formatter/json.rb

@@ -5,7 +5,6 @@ require 'base64'
 require 'cucumber/formatter/backtrace_filter'
 require 'cucumber/formatter/io'
 require 'cucumber/formatter/ast_lookup'
-require 'cucumber/deprecate'
 
 module Cucumber
   module Formatter
@@ -14,14 +13,6 @@ module Cucumber
       include Io
 
       def initialize(config)
-        Cucumber::Deprecate::CliOption.deprecate(
-          config.error_stream,
-          '--format=json',
-          "Please use --format=message and stand-alone json-formatter.\n" \
-          'json-formatter homepage: https://github.com/cucumber/cucumber/tree/master/json-formatter#cucumber-json-formatter',
-          '6.0.0'
-        )
-
         @io = ensure_io(config.out_stream, config.error_stream)
         @ast_lookup = AstLookup.new(config)
         @feature_hashes = []
@@ -41,21 +32,23 @@ module Cucumber
           @feature_hashes << @feature_hash
         end
         @test_case_hash = builder.test_case_hash
-        if builder.background?
-          @in_background = true
-          feature_elements << builder.background_hash
-          @element_hash = builder.background_hash
-        else
-          @in_background = false
-          feature_elements << @test_case_hash
-          @element_hash = @test_case_hash
-        end
+
+        @element_hash = nil
+        @element_background_hash = builder.background_hash
+        @in_background = builder.background?
+
         @any_step_failed = false
       end
 
       def on_test_step_started(event)
         test_step = event.test_step
         return if internal_hook?(test_step)
+
+        if @element_hash.nil?
+          @element_hash = create_element_hash(test_step)
+          feature_elements << @element_hash
+        end
+
         if test_step.hook?
           @step_or_hook_hash = {}
           hooks_of_type(test_step) << @step_or_hook_hash
@@ -80,6 +73,8 @@ module Cucumber
       end
 
       def on_test_case_finished(event)
+        feature_elements << @test_case_hash if @in_background
+
         _test_case, result = *event.attributes
         result = result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
         add_failed_around_hook(result) if result.failed? && !@any_step_failed
@@ -94,10 +89,7 @@ module Cucumber
           test_step_output << src
           return
         end
-        if File.file?(src)
-          content = File.open(src, 'rb', &:read)
-          data = encode64(content)
-        elsif mime_type =~ /;base64$/
+        if mime_type =~ /;base64$/
           mime_type = mime_type[0..-8]
           data = src
         else
@@ -169,6 +161,13 @@ module Cucumber
         @step_or_hook_hash[:embeddings] ||= []
       end
 
+      def create_element_hash(test_step)
+        return @element_background_hash if @in_background && !first_step_after_background?(test_step)
+
+        @in_background = false
+        @test_case_hash
+      end
+
       def create_step_hash(test_step)
         step_source = @ast_lookup.step_source(test_step).step
         step_hash = {
@@ -269,7 +268,8 @@ module Cucumber
             name: background.name,
             description: value_or_empty_string(background.description),
             line: background.location.line,
-            type: 'background'
+            type: 'background',
+            steps: []
           }
         end
 
@@ -281,7 +281,8 @@ module Cucumber
             name: test_case.name,
             description: value_or_empty_string(scenario.description),
             line: test_case.location.lines.max,
-            type: 'scenario'
+            type: 'scenario',
+            steps: []
           }
           @test_case_hash[:tags] = create_tags_array_from_tags_array(test_case.tags) unless test_case.tags.empty?
         end

data/lib/cucumber/formatter/message.rb

@@ -15,7 +15,8 @@ module Cucumber
       end
 
       def output_envelope(envelope)
-        envelope.write_ndjson_to(@io)
+        @io.write(envelope.to_json)
+        @io.write("\n")
       end
     end
   end

data/lib/cucumber/formatter/message_builder.rb

@@ -48,12 +48,12 @@ module Cucumber
         }
 
         if media_type.start_with?('text/')
-          attachment_data[:content_encoding] = Cucumber::Messages::Attachment::ContentEncoding::IDENTITY
+          attachment_data[:content_encoding] = Cucumber::Messages::AttachmentContentEncoding::IDENTITY
           attachment_data[:body] = src
         else
           body = src.respond_to?(:read) ? src.read : src
 
-          attachment_data[:content_encoding] = Cucumber::Messages::Attachment::ContentEncoding::BASE64
+          attachment_data[:content_encoding] = Cucumber::Messages::AttachmentContentEncoding::BASE64
           attachment_data[:body] = Base64.strict_encode64(body)
         end
 
@@ -101,7 +101,7 @@ module Cucumber
       def test_step_to_message(step)
         return hook_step_to_message(step) if step.hook?
 
-        Cucumber::Messages::TestCase::TestStep.new(
+        Cucumber::Messages::TestStep.new(
           id: step.id,
           pickle_step_id: @pickle_step_by_test_step.pickle_step_id(step),
           step_definition_ids: @step_definitions_by_test_step.step_definition_ids(step),
@@ -110,7 +110,7 @@ module Cucumber
       end
 
       def hook_step_to_message(step)
-        Cucumber::Messages::TestCase::TestStep.new(
+        Cucumber::Messages::TestStep.new(
           id: step.id,
           hook_id: @hook_by_test_step.hook_id(step)
         )
@@ -118,7 +118,7 @@ module Cucumber
 
       def step_match_arguments_lists(step)
         match_arguments = step_match_arguments(step)
-        [Cucumber::Messages::TestCase::TestStep::StepMatchArgumentsList.new(
+        [Cucumber::Messages::StepMatchArgumentsList.new(
           step_match_arguments: match_arguments
         )]
       rescue Cucumber::Formatter::TestStepUnknownError
@@ -127,7 +127,7 @@ module Cucumber
 
       def step_match_arguments(step)
         @step_definitions_by_test_step.step_match_arguments(step).map do |argument|
-          Cucumber::Messages::TestCase::TestStep::StepMatchArgumentsList::StepMatchArgument.new(
+          Cucumber::Messages::StepMatchArgument.new(
             group: argument_group_to_message(argument.group),
             parameter_type_name: argument.parameter_type.name
           )
@@ -135,7 +135,7 @@ module Cucumber
       end
 
       def argument_group_to_message(group)
-        Cucumber::Messages::TestCase::TestStep::StepMatchArgumentsList::StepMatchArgument::Group.new(
+        Cucumber::Messages::Group.new(
           start: group.start,
           value: group.value,
           children: group.children.map { |child| argument_group_to_message(child) }
@@ -190,7 +190,7 @@ module Cucumber
 
         result_message = result.to_message
         if result.failed? || result.pending?
-          result_message = Cucumber::Messages::TestStepFinished::TestStepResult.new(
+          result_message = Cucumber::Messages::TestStepResult.new(
             status: result_message.status,
             duration: result_message.duration,
             message: create_error_message(result)

data/lib/cucumber/formatter/pretty.rb

@@ -181,7 +181,7 @@ module Cucumber
       end
 
       def print_step_output
-        @test_step_output.each { |message| @io.puts(format_string(message, :tag).indent(6)) }
+        @test_step_output.each { |message| @io.puts(indent(format_string(message, :tag), 6)) }
         @test_step_output = []
       end
 
@@ -259,33 +259,34 @@ module Cucumber
         end
       end
 
-      def print_comments(up_to_line, indent)
+      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|
           if comment.location.line <= up_to_line
-            @io.puts(format_string(comment.text.strip, :comment).indent(indent))
+            @io.puts(indent(format_string(comment.text.strip, :comment), indent_amount))
             @next_comment_to_be_printed += 1
           end
           break if @next_comment_to_be_printed >= comments.length
         end
       end
 
-      def print_tags(tags, indent)
+      def print_tags(tags, indent_amount)
         return if !tags || tags.empty?
-        @io.puts(tags.map { |tag| format_string(tag.name, :tag) }.join(' ').indent(indent))
+
+        @io.puts(indent(tags.map { |tag| format_string(tag.name, :tag) }.join(' '), indent_amount))
       end
 
       def print_feature_line(feature)
         print_keyword_name(feature.keyword, feature.name, 0)
       end
 
-      def print_keyword_name(keyword, name, indent, location = nil)
+      def print_keyword_name(keyword, name, indent_amount, location = nil)
         line = "#{keyword}:"
         line += " #{name}"
-        @io.print(line.indent(indent))
+        @io.print(indent(line, indent_amount))
         if location && options[:source]
-          line_comment = format_string("# #{location}", :comment).indent(@source_indent - line.length - indent)
+          line_comment = indent(format_string("# #{location}", :comment), @source_indent - line.length - indent_amount)
           @io.print(line_comment)
         end
         @io.puts
@@ -339,7 +340,7 @@ module Cucumber
         indent = options[:source] ? @source_indent - step_keyword.length - test_step.text.length - base_indent : nil
         print_comments(test_step.location.lines.max, base_indent)
         name_to_report = format_step(step_keyword, @step_matches.fetch(test_step.to_s) { NoStepMatch.new(test_step, test_step.text) }, result.to_sym, indent)
-        @io.puts(name_to_report.indent(base_indent))
+        @io.puts(indent(name_to_report, base_indent))
         print_multiline_argument(test_step, result, base_indent + 2) unless options[:no_multiline]
         @io.flush
       end
@@ -374,10 +375,10 @@ module Cucumber
         end
       end
 
-      def print_data_table(data_table, status, indent)
+      def print_data_table(data_table, status, indent_amount)
         data_table.rows.each do |row|
-          print_comments(row.location.line, indent)
-          @io.puts format_string(gherkin_source.split("\n")[row.location.line - 1].strip, status).indent(indent)
+          print_comments(row.location.line, indent_amount)
+          @io.puts indent(format_string(gherkin_source.split("\n")[row.location.line - 1].strip, status), indent_amount)
         end
       end
 
@@ -393,7 +394,7 @@ module Cucumber
           @io.print(format_string(step_line, :skipped))
           if options[:source]
             comment_line = format_string("# #{current_feature_uri}:#{step.location.line}", :comment)
-            @io.print(comment_line.indent(@source_indent - step_line.length))
+            @io.print(indent(comment_line, @source_indent - step_line.length))
           end
           @io.puts
           next if options[:no_multiline]
@@ -403,8 +404,8 @@ module Cucumber
         @io.flush
       end
 
-      def print_doc_string(content, status, indent)
-        s = %("""\n#{content}\n""").indent(indent)
+      def print_doc_string(content, status, indent_amount)
+        s = indent(%("""\n#{content}\n"""), indent_amount)
         s = s.split("\n").map { |l| l =~ /^\s+$/ ? '' : l }.join("\n")
         @io.puts(format_string(s, status))
       end
@@ -416,15 +417,15 @@ module Cucumber
         print_description(examples.description)
         unless options[:expand]
           print_comments(examples.table_header.location.line, 6)
-          @io.puts(gherkin_source.split("\n")[examples.table_header.location.line - 1].strip.indent(6))
+          @io.puts(indent(gherkin_source.split("\n")[examples.table_header.location.line - 1].strip, 6))
         end
         @io.flush
       end
 
       def print_row_data(test_case, result)
         print_comments(test_case.location.lines.max, 6)
-        @io.print(format_string(gherkin_source.split("\n")[test_case.location.lines.max - 1].strip, result.to_sym).indent(6))
-        @io.print(format_string(@test_step_output.join(', '), :tag).indent(2)) unless @test_step_output.empty?
+        @io.print(indent(format_string(gherkin_source.split("\n")[test_case.location.lines.max - 1].strip, result.to_sym), 6))
+        @io.print(indent(format_string(@test_step_output.join(', '), :tag), 2)) unless @test_step_output.empty?
         @test_step_output = []
         @io.puts
         if result.failed? || result.pending?

data/lib/cucumber/formatter/publish_banner_printer.rb

@@ -41,7 +41,7 @@ module Cucumber
             '',
             [
               'More information at ',
-              link('https://reports.cucumber.io/docs/cucumber-ruby')
+              link('https://cucumber.io/docs/cucumber/environment-variables/')
             ],
             '',
             [

data/lib/cucumber/formatter/steps.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+require 'cucumber/formatter/console'
+
 module Cucumber
   module Formatter
     # The formatter used for <tt>--format steps</tt>
     class Steps
+      include Console
       def initialize(runtime, path_or_io, options)
         @io = ensure_io(path_or_io, nil)
         @options = options
@@ -24,8 +27,8 @@ module Cucumber
           sources = @step_definition_files[step_definition_file]
           source_indent = source_indent(sources)
           sources.sort.each do |file_colon_line, regexp_source|
-            @io.print regexp_source.indent(2)
-            @io.print " # #{file_colon_line}".indent(source_indent - regexp_source.unpack('U*').length)
+            @io.print indent(regexp_source, 2)
+            @io.print indent(" # #{file_colon_line}", source_indent - regexp_source.unpack('U*').length)
             @io.puts
           end
           @io.puts

data/lib/cucumber/formatter/usage.rb

@@ -2,10 +2,12 @@
 
 require 'cucumber/formatter/progress'
 require 'cucumber/step_definition_light'
+require 'cucumber/formatter/console'
 
 module Cucumber
   module Formatter
     class Usage < Progress
+      include Console
       class StepDefKey < StepDefinitionLight
         attr_accessor :mean_duration, :status
       end
@@ -87,8 +89,8 @@ module Cucumber
         @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 = max_length - stepdef_key.regexp_source.unpack('U*').length
-          line_comment = "   # #{stepdef_key.location}".indent(indent)
+          indent_amount = max_length - stepdef_key.regexp_source.unpack('U*').length
+          line_comment = indent("   # #{stepdef_key.location}", indent_amount)
           @io.print(format_string(line_comment, :comment))
         end
         @io.puts
@@ -100,8 +102,8 @@ module Cucumber
           @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 = max_length - (step[:keyword].unpack('U*').length + step[:step_match].format_args.unpack('U*').length)
-            line_comment = " # #{step[:location]}".indent(indent)
+            indent_amount = max_length - (step[:keyword].unpack('U*').length + step[:step_match].format_args.unpack('U*').length)
+            line_comment = indent(" # #{step[:location]}", indent_amount)
             @io.print(format_string(line_comment, :comment))
           end
           @io.puts

data/lib/cucumber/gherkin/data_table_parser.rb

@@ -15,7 +15,7 @@ module Cucumber
         messages = ::Gherkin.from_source('dummy', feature_header + text, gherkin_options)
 
         messages.each do |message|
-          gherkin_document = message.gherkin_document.to_hash unless message.gherkin_document.nil?
+          gherkin_document = message.gherkin_document.to_h unless message.gherkin_document.nil?
         end
 
         return if gherkin_document.nil?

data/lib/cucumber/gherkin/steps_parser.rb

@@ -17,7 +17,7 @@ module Cucumber
         messages = ::Gherkin.from_source('dummy', feature_header(dialect) + text, gherkin_options)
 
         messages.each do |message|
-          gherkin_document = message.gherkin_document.to_hash unless message.gherkin_document.nil?
+          gherkin_document = message.gherkin_document.to_h unless message.gherkin_document.nil?
         end
 
         @builder.steps(gherkin_document[:feature][:children][0][:scenario][:steps])

data/lib/cucumber/glue/dsl.rb

@@ -109,10 +109,29 @@ module Cucumber
 
       # Registers a proc that will run after Cucumber is configured. You can register as
       # as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
+      #
+      # DEPRECATED: please use InstallPlugin or BeforeAll instead
       def AfterConfiguration(&proc)
         Dsl.register_rb_hook('after_configuration', [], proc)
       end
 
+      # Registers a proc that will run after Cucumber is configured in order to install an external plugin.
+      def InstallPlugin(&proc)
+        Dsl.register_rb_hook('install_plugin', [], proc)
+      end
+
+      # Registers a proc that will run before the execution of the scenarios.
+      # Use it for your final set-ups
+      def BeforeAll(&proc)
+        Dsl.register_rb_hook('before_all', [], proc)
+      end
+
+      # Registers a proc that will run after the execution of the scenarios.
+      # Use it for your final clean-ups
+      def AfterAll(&proc)
+        Dsl.register_rb_hook('after_all', [], proc)
+      end
+
       # Registers a new Ruby StepDefinition. This method is aliased
       # to <tt>Given</tt>, <tt>When</tt> and <tt>Then</tt>, and
       # also to the i18n translations whenever a feature of a

data/lib/cucumber/glue/proto_world.rb

@@ -3,6 +3,7 @@
 require 'cucumber/gherkin/formatter/ansi_escapes'
 require 'cucumber/core/test/data_table'
 require 'cucumber/deprecate'
+require 'mime/types'
 
 module Cucumber
   module Glue
@@ -72,46 +73,29 @@ module Cucumber
         MultilineArgument::DataTable.from(text_or_table)
       end
 
-      # Print a message to the output.
-      #
-      # @note Cucumber might surprise you with the behaviour of this method. Instead
-      #   of sending the output directly to STDOUT, Cucumber will intercept and cache
-      #   the message until the current step has finished, and then display it.
-      #
-      #   If you'd prefer to see the message immediately, call {Kernel.puts} instead.
-      def puts(*messages)
-        Cucumber.deprecate(
-          'Messages emitted with "puts" will no longer be caught by Cucumber ' \
-          'and sent to the formatter. If you want message to be in the formatted output, ' \
-          "please use log(message) instead.\n" \
-          'If you simply want it in the console, '\
-          'keep using "puts" (or Kernel.puts to avoid this message)',
-          'puts(message)',
-          '6.0.0'
-        )
-        messages.each { |message| log(message.to_s) }
-      end
-
       # Pause the tests and ask the operator for input
       def ask(question, timeout_seconds = 60)
         super
       end
 
-      # Embed an image in the output
-      def embed(file, mime_type, _label = 'Screenshot')
-        Cucumber.deprecate(
-          'Please use attach(file, media_type) instead',
-          'embed(file, mime_type, label)',
-          '6.0.0'
-        )
-        attach(file, mime_type)
-      end
-
       def log(*messages)
         messages.each { |message| attach(message.to_s.dup, 'text/x.cucumber.log+plain') }
       end
 
-      def attach(file, media_type)
+      # 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)
+        return super unless File.file?(file)
+
+        content = File.read(file, mode: 'rb')
+        media_type = MIME::Types.type_for(file).first if media_type.nil?
+
+        super(content, media_type.to_s)
+      rescue StandardError
         super
       end
 

data/lib/cucumber/glue/registry_and_more.rb

@@ -4,6 +4,7 @@ require 'cucumber/cucumber_expressions/parameter_type_registry'
 require 'cucumber/cucumber_expressions/cucumber_expression'
 require 'cucumber/cucumber_expressions/regular_expression'
 require 'cucumber/cucumber_expressions/cucumber_expression_generator'
+require 'cucumber/deprecate'
 require 'cucumber/glue/dsl'
 require 'cucumber/glue/snippet'
 require 'cucumber/glue/hook'
@@ -91,7 +92,7 @@ module Cucumber
         step_definition
       rescue Cucumber::CucumberExpressions::UndefinedParameterTypeError => e
         # TODO: add a way to extract the parameter type directly from the error.
-        type_name = e.message.match(/^Undefined parameter type \{(.*)\}$/)[1]
+        type_name = e.message.match(/^Undefined parameter type ['|\{](.*)['|\}].?$/)[1]
 
         @configuration.notify :undefined_parameter_type, type_name, string_or_regexp
       end
@@ -135,11 +136,31 @@ module Cucumber
       end
 
       def after_configuration(configuration)
+        deprecate_after_configuration_hook if hooks[:after_configuration].any?
+
         hooks[:after_configuration].each do |hook|
           hook.invoke('AfterConfiguration', configuration)
         end
       end
 
+      def install_plugin(configuration, registry)
+        hooks[:install_plugin].each do |hook|
+          hook.invoke('InstallPlugin', [configuration, registry])
+        end
+      end
+
+      def before_all
+        hooks[:before_all].each do |hook|
+          hook.invoke('BeforeAll', [])
+        end
+      end
+
+      def after_all
+        hooks[:after_all].each do |hook|
+          hook.invoke('AfterAll', [])
+        end
+      end
+
       def add_hook(phase, hook)
         hooks[phase.to_sym] << hook
         hook
@@ -207,6 +228,14 @@ module Cucumber
       def hooks
         @hooks ||= Hash.new { |h, k| h[k] = [] }
       end
+
+      def deprecate_after_configuration_hook
+        Cucumber.deprecate(
+          'See https://github.com/cucumber/cucumber-ruby/blob/main/UPGRADING.md#upgrading-to-710 for more info',
+          ' AfterConfiguration hook',
+          '8.0.0'
+        )
+      end
     end
 
     def self.backtrace_line(proc, name)

data/lib/cucumber/glue/registry_wrapper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Cucumber
+  module Glue
+    ##
+    # This class wraps some internals methods to expose them to external plugins.
+    class RegistryWrapper
+      def initialize(registry)
+        @registry = registry
+      end
+
+      ##
+      # Creates a new CucumberExpression from the given +string_or_regexp+.
+      #
+      # If +string_or_regexp+ is a string, it will return a new CucumberExpression::CucumberExpression
+      #
+      # If +string_or_regexp+ is a regexp, it will return a new CucumberExpressions::RegularExpression
+      #
+      # An ArgumentError is raised if +string_or_regexp+ is not a string or a regexp
+      def create_expression(string_or_regexp)
+        @registry.create_expression(string_or_regexp)
+      end
+
+      ##
+      # Return the current execution environment - AKA an isntance of World
+      def current_world
+        @registry.current_world
+      end
+    end
+  end
+end

data/lib/cucumber/glue/step_definition.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'cucumber/step_match'
-require 'cucumber/core_ext/string'
 require 'cucumber/glue/invoke_in_world'
 
 module Cucumber
@@ -77,7 +76,7 @@ module Cucumber
         Cucumber::Messages::Envelope.new(
           step_definition: Cucumber::Messages::StepDefinition.new(
             id: id,
-            pattern: Cucumber::Messages::StepDefinition::StepDefinitionPattern.new(
+            pattern: Cucumber::Messages::StepDefinitionPattern.new(
               source: expression.source.to_s,
               type: expression_type
             ),
@@ -92,8 +91,8 @@ module Cucumber
       end
 
       def expression_type
-        return Cucumber::Messages::StepDefinition::StepDefinitionPattern::StepDefinitionPatternType::CUCUMBER_EXPRESSION if expression.is_a?(CucumberExpressions::CucumberExpression)
-        Cucumber::Messages::StepDefinition::StepDefinitionPattern::StepDefinitionPatternType::REGULAR_EXPRESSION
+        return Cucumber::Messages::StepDefinitionPatternType::CUCUMBER_EXPRESSION if expression.is_a?(CucumberExpressions::CucumberExpression)
+        Cucumber::Messages::StepDefinitionPatternType::REGULAR_EXPRESSION
       end
 
       # @api private