cucumber 5.1.1 → 6.0.0

data/CONTRIBUTING.md

@@ -21,17 +21,29 @@ You can chat with the core team on https://gitter.im/cucumber/contributors. We t
 
 ## Installing your own gems
 
-A `Gemfile.local`-file can be used to have your own gems installed to support
-your normal development workflow.
+A `Gemfile.local`-file can be used to have your own gems installed to support your normal development workflow. 
+Execute `bundle config set --local gemfile Gemfile.local` to use it per default.
 
 Example:
 
 ~~~ruby
-gem 'pry'
-gem 'pry-byebug'
-gem 'byebug'
+# Include the regular Gemfile
+eval File.read('Gemfile')
+
+group :development do
+  gem 'byebug'
+  gem 'debase', require: false
+  gem 'ruby-debug-ide', require: false
+  gem 'pry'
+  gem 'pry-byebug'
+end 
 ~~~
 
+## Using Visual Studio Code?
+
+Sample for launch.json configuration is available in
+[docs/vscode-example-launch-configuration.md](https://github.com/cucumber/cucumber-ruby/blob/master/docs/vscode-example-launch-configuration.md)
+
 ## Note on Patches/Pull Requests
 
 * Fork the project. Make a branch for your change.

data/README.md

@@ -1,8 +1,8 @@
 [![OpenCollective](https://opencollective.com/cucumber/backers/badge.svg)](https://opencollective.com/cucumber)
 [![OpenCollective](https://opencollective.com/cucumber/sponsors/badge.svg)](https://opencollective.com/cucumber)
-
+[![pull requests](https://oselvar.com/api/badge?label=pull%20requests&csvUrl=https%3A%2F%2Fraw.githubusercontent.com%2Fcucumber%2Foselvar-github-metrics%2Fmain%2Fdata%2Fcucumber%2Fcucumber-ruby%2FpullRequests.csv)](https://oselvar.com/github/cucumber/oselvar-github-metrics/main/cucumber/cucumber-ruby)
+[![issues](https://oselvar.com/api/badge?label=issues&csvUrl=https%3A%2F%2Fraw.githubusercontent.com%2Fcucumber%2Foselvar-github-metrics%2Fmain%2Fdata%2Fcucumber%2Fcucumber-ruby%2Fissues.csv)](https://oselvar.com/github/cucumber/oselvar-github-metrics/main/cucumber/cucumber-ruby)
 [![CircleCI](https://circleci.com/gh/cucumber/cucumber-ruby.svg?style=svg)](https://circleci.com/gh/cucumber/cucumber-ruby)
-
 [![Code Climate](https://codeclimate.com/github/cucumber/cucumber-ruby.svg)](https://codeclimate.com/github/cucumber/cucumber-ruby)
 [![Coverage Status](https://coveralls.io/repos/cucumber/cucumber-ruby/badge.svg?branch=master)](https://coveralls.io/r/cucumber/cucumber-ruby?branch=master)
 
@@ -24,6 +24,8 @@ Where to get more info:
 See [CONTRIBUTING.md](CONTRIBUTING.md) for info on contributing to Cucumber.
 
 ## Supported platforms
+* Ruby 3.0
+* Ruby 2.7
 * Ruby 2.6
 * Ruby 2.5
 * Ruby 2.4

data/lib/cucumber/cli/configuration.rb

@@ -126,13 +126,35 @@ module Cucumber
       end
 
       def arrange_formats
-        @options[:formats] << ['pretty', {}, @out_stream] if @options[:formats].empty?
+        add_default_formatter if needs_default_formatter?
+
         @options[:formats] = @options[:formats].sort_by do |f|
           f[2] == @out_stream ? -1 : 1
         end
         @options[:formats].uniq!
         @options.check_formatter_stream_conflicts
       end
+
+      def add_default_formatter
+        @options[:formats] << ['pretty', {}, @out_stream]
+      end
+
+      def needs_default_formatter?
+        formatter_missing? || publish_only?
+      end
+
+      def formatter_missing?
+        @options[:formats].empty?
+      end
+
+      def publish_only?
+        @options[:formats]
+          .uniq
+          .map { |formatter, _, stream| [formatter, stream] }
+          .uniq
+          .reject { |formatter, stream| formatter == 'message' && stream != @out_stream }
+          .empty?
+      end
     end
   end
 end

data/lib/cucumber/cli/options.rb

@@ -22,7 +22,8 @@ module Cucumber
                                                               "#{INDENT}filename instead."],
         'stepdefs'    => ['Cucumber::Formatter::Stepdefs',    "Prints All step definitions with their locations. Same as\n" \
                                                               "#{INDENT}the usage formatter, except that steps are not printed."],
-        'junit'       => ['Cucumber::Formatter::Junit',       'Generates a report similar to Ant+JUnit.'],
+        'junit'       => ['Cucumber::Formatter::Junit',       "Generates a report similar to Ant+JUnit. Use\n" \
+                                                              "#{INDENT}junit,fileattribute=true to include a file attribute."],
         'json'        => ['Cucumber::Formatter::Json',        '[DEPRECATED] Prints the feature as JSON'],
         'message'     => ['Cucumber::Formatter::Message',     'Outputs protobuf messages'],
         'html'        => ['Cucumber::Formatter::HTML',        'Outputs HTML report'],
@@ -335,7 +336,7 @@ Specify SEED to reproduce the shuffling from a previous run.
           'option is specified; all loading becomes explicit.',
           'Files in directories named "support" are still always',
           'loaded first when their parent directories are',
-          'required or if the "support" directoires themselves are',
+          'required or if the "support" directories themselves are',
           'explicitly required.',
           'This option can be specified multiple times.'
         ]

data/lib/cucumber/formatter/backtrace_filter.rb

@@ -15,6 +15,7 @@ module Cucumber
       test/unit
       .gem/ruby
       bin/bundle
+      rdebug-ide
     ]
 
     @backtrace_filters << RbConfig::CONFIG['rubyarchdir'] if RbConfig::CONFIG['rubyarchdir']

data/lib/cucumber/formatter/html.rb

@@ -8,7 +8,7 @@ module Cucumber
       include Io
 
       def initialize(config)
-        @io = ensure_io(config.out_stream)
+        @io = ensure_io(config.out_stream, config.error_stream)
         @html_formatter = Cucumber::HTMLFormatter::Formatter.new(@io)
         @html_formatter.write_pre_message
 

data/lib/cucumber/formatter/http_io.rb

@@ -1,5 +1,6 @@
 require 'net/http'
 require 'tempfile'
+require 'shellwords'
 
 module Cucumber
   module Formatter
@@ -18,48 +19,43 @@ module Cucumber
 
     class CurlOptionParser
       def self.parse(options)
-        chunks = options.split(/\s/).compact
-        http_method = 'PUT'
-        url = chunks[0]
-        headers = ''
-
-        last_flag = nil
-        chunks.each do |chunk|
-          if ['-X', '--request'].include?(chunk)
-            last_flag = '-X'
-            next
-          end
-
-          if chunk == '-H'
-            last_flag = '-H'
-            next
-          end
+        args = Shellwords.split(options)
 
-          if last_flag == '-X'
-            http_method = chunk
-            last_flag = nil
+        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
-
-          headers += chunk if last_flag == '-H'
         end
+        raise StandardError, "#{options} was not a valid curl command" unless url
 
         [
           url,
           http_method,
-          make_headers(headers)
+          headers
         ]
       end
 
-      def self.make_headers(headers)
-        hash_headers = {}
-        str_scanner = /("(?<key>[^":]+)\s*:\s*(?<value>[^":]+)")|('(?<key1>[^':]+)\s*:\s*(?<value1>[^':]+)')/
-
-        headers.scan(str_scanner) do |header|
-          header = header.compact!
-          hash_headers[header[0]] = header[1]&.strip
-        end
+      def self.remove_arg_for(args, arg)
+        return args.shift unless args.empty?
+        raise StandardError, "Missing argument for #{arg}"
+      end
 
-        hash_headers
+      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
 
@@ -76,10 +72,11 @@ module Cucumber
       end
 
       def close
-        resource_uri = send_content(@uri, @method, @headers)
-
-        @reporter.report(resource_uri)
+        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)
@@ -121,16 +118,11 @@ module Cucumber
 
         case response
         when Net::HTTPAccepted
-          return uri unless response['Location']
-
-          send_content(URI(response['Location']), 'PUT', headers, attempt - 1)
-        when Net::HTTPSuccess
-          uri
+          send_content(URI(response['Location']), 'PUT', {}, attempt - 1) if response['Location']
         when Net::HTTPRedirection
           send_content(URI(response['Location']), method, headers, attempt - 1)
-        else
-          raise StandardError, "request to #{uri} failed with status #{response.code}"
         end
+        response
       end
 
       def build_request(uri, method, headers)

data/lib/cucumber/formatter/io.rb

@@ -9,13 +9,13 @@ module Cucumber
     module Io
       module_function
 
-      def ensure_io(path_or_url_or_io)
+      def ensure_io(path_or_url_or_io, error_stream)
         return nil if path_or_url_or_io.nil?
         return path_or_url_or_io if io?(path_or_url_or_io)
 
         io = if url?(path_or_url_or_io)
                url = path_or_url_or_io
-               reporter = url.start_with?(Cucumber::Cli::Options::CUCUMBER_PUBLISH_URL) ? URLReporter.new($stderr) : NoReporter.new
+               reporter = url.start_with?(Cucumber::Cli::Options::CUCUMBER_PUBLISH_URL) ? URLReporter.new(error_stream) : NoReporter.new
                HTTPIO.open(url, nil, reporter)
              else
                File.open(path_or_url_or_io, Cucumber.file_mode('w'))
@@ -64,7 +64,7 @@ module Cucumber
         raise "You *must* specify --out FILE for the #{name} formatter" unless String == path.class
         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)
+        ensure_io(path, nil)
       end
 
       def ensure_dir(path, name)

data/lib/cucumber/formatter/json.rb

@@ -22,7 +22,7 @@ module Cucumber
           '6.0.0'
         )
 
-        @io = ensure_io(config.out_stream)
+        @io = ensure_io(config.out_stream, config.error_stream)
         @ast_lookup = AstLookup.new(config)
         @feature_hashes = []
         @step_or_hook_hash = {}
@@ -94,10 +94,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

data/lib/cucumber/formatter/junit.rb

@@ -132,9 +132,12 @@ module Cucumber
         duration = ResultBuilder.new(result).test_case_duration
         @current_feature_data[:time] += duration
         classname = @current_feature_data[:feature].name
+        filename = @current_feature_data[:uri]
         name = scenario_designation
 
-        @current_feature_data[:builder].testcase(classname: classname, name: name, time: format('%<duration>.6f', duration: duration)) do
+        testcase_attributes = get_testcase_attributes(classname, name, duration, filename)
+
+        @current_feature_data[:builder].testcase(testcase_attributes) do
           if !result.passed? && result.ok?(@config.strict)
             @current_feature_data[:builder].skipped
             @current_feature_data[:skipped] += 1
@@ -157,6 +160,20 @@ module Cucumber
         @current_feature_data[:tests] += 1
       end
 
+      def get_testcase_attributes(classname, name, duration, filename)
+        { classname: classname, name: name, time: format('%<duration>.6f', duration: duration) }.tap do |attributes|
+          attributes[:file] = filename if add_fileattribute?
+        end
+      end
+
+      def add_fileattribute?
+        return false if @config.formats.nil? || @config.formats.empty?
+
+        !!@config.formats.find do |format|
+          format.first == 'junit' && format.dig(1, 'fileattribute') == 'true'
+        end
+      end
+
       def get_backtrace_object(result)
         if result.failed?
           result.exception

data/lib/cucumber/formatter/message.rb

@@ -10,7 +10,7 @@ module Cucumber
       include Io
 
       def initialize(config)
-        @io = ensure_io(config.out_stream)
+        @io = ensure_io(config.out_stream, config.error_stream)
         super(config)
       end
 

data/lib/cucumber/formatter/pretty.rb

@@ -32,7 +32,7 @@ module Cucumber
       private :in_scenario_outline, :print_background_steps
 
       def initialize(config)
-        @io = ensure_io(config.out_stream)
+        @io = ensure_io(config.out_stream, config.error_stream)
         @config = config
         @options = config.to_hash
         @snippets_input = []

data/lib/cucumber/formatter/progress.rb

@@ -19,7 +19,7 @@ module Cucumber
 
       def initialize(config)
         @config = config
-        @io = ensure_io(config.out_stream)
+        @io = ensure_io(config.out_stream, config.error_stream)
         @snippets_input = []
         @undefined_parameter_types = []
         @total_duration = 0

data/lib/cucumber/formatter/publish_banner_printer.rb

@@ -30,7 +30,9 @@ module Cucumber
             ],
             [
               'Environment variable:   ',
-              highlight('CUCUMBER_PUBLISH_ENABLED=true')
+              highlight('CUCUMBER_PUBLISH_ENABLED'),
+              '=',
+              highlight('true')
             ],
             [
               'cucumber.yml:           ',

data/lib/cucumber/formatter/rerun.rb

@@ -8,7 +8,7 @@ module Cucumber
       include Formatter::Io
 
       def initialize(config)
-        @io = ensure_io(config.out_stream)
+        @io = ensure_io(config.out_stream, config.error_stream)
         @config = config
         @failures = {}
         config.on_event :test_case_finished do |event|

data/lib/cucumber/formatter/steps.rb

@@ -5,7 +5,7 @@ module Cucumber
     # The formatter used for <tt>--format steps</tt>
     class Steps
       def initialize(runtime, path_or_io, options)
-        @io = ensure_io(path_or_io)
+        @io = ensure_io(path_or_io, nil)
         @options = options
         @step_definition_files = collect_steps(runtime)
       end

data/lib/cucumber/formatter/summary.rb

@@ -16,7 +16,7 @@ module Cucumber
 
       def initialize(config)
         @config = config
-        @io = ensure_io(config.out_stream)
+        @io = ensure_io(config.out_stream, config.error_stream)
         @ast_lookup = AstLookup.new(config)
         @counts = ConsoleCounts.new(@config)
         @issues = ConsoleIssues.new(@config, @ast_lookup)

data/lib/cucumber/formatter/url_reporter.rb

@@ -1,30 +1,17 @@
-require 'cucumber/term/banner'
-
 module Cucumber
   module Formatter
     class URLReporter
-      include Term::Banner
-
       def initialize(io)
         @io = io
       end
 
-      def report(url)
-        uri = URI(url)
-        display_banner(
-          [
-            'View your Cucumber Report at:',
-            [["https://reports.cucumber.io#{uri.path}", :cyan, :bold, :underline]],
-            '',
-            [['This report will self-destruct in 24h unless it is claimed or deleted.', :green, :bold]]
-          ],
-          @io
-        )
+      def report(banner)
+        @io.puts(banner)
       end
     end
 
     class NoReporter
-      def report(url); end
+      def report(banner); end
     end
   end
 end

data/lib/cucumber/glue/dsl.rb

@@ -137,4 +137,4 @@ module Cucumber
 end
 
 # TODO: can we avoid adding methods to the global namespace (Kernel)
-extend(Cucumber::Glue::Dsl) # rubocop:disable Style/MixinUsage
+extend(Cucumber::Glue::Dsl)

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,47 +73,28 @@ 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)
-        super
+      # 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)
       end
 
       # Mark the matched step as pending.