cucumber 5.1.2 → 6.1.0

data/CONTRIBUTING.md

@@ -2,14 +2,14 @@
 
 We appreciate that. But before you do, please learn our basic rules:
 
-* This is not a support forum. If you have a question, please go to [The Cukes Google Group](http://groups.google.com/group/cukes).
-* Do you have an idea for a new feature? Then don't expect it to be implemented unless you or someone else sends a [pull request](https://help.github.com/articles/using-pull-requests). You might be better to start a discussion on [the google group](http://groups.google.com/group/cukes).
-* Reporting a bug? Please tell us:
-  * which version of Cucumber you're using
-  * which version of Ruby you're using.
-  * How to reproduce it. Bugs with a failing test in a [pull request](https://help.github.com/articles/using-pull-requests) get fixed much quicker. Some bugs may never be fixed.
-* Want to paste some code or output? Put \`\`\` on a line above and below your code/output. See [GFM](https://help.github.com/articles/github-flavored-markdown)'s *Fenced Code Blocks* for details.
-* We love [pull requests](https://help.github.com/articles/using-pull-requests). But if you don't have a test to go with it we probably won't merge it.
+- This is not a support forum. If you have a question, please go to [The Cukes Google Group](http://groups.google.com/group/cukes).
+- Do you have an idea for a new feature? Then don't expect it to be implemented unless you or someone else sends a [pull request](https://help.github.com/articles/using-pull-requests). You might be better to start a discussion on [the google group](http://groups.google.com/group/cukes).
+- Reporting a bug? Please tell us:
+  - which version of Cucumber you're using
+  - which version of Ruby you're using.
+  - How to reproduce it. Bugs with a failing test in a [pull request](https://help.github.com/articles/using-pull-requests) get fixed much quicker. Some bugs may never be fixed.
+- Want to paste some code or output? Put \`\`\` on a line above and below your code/output. See [GFM](https://help.github.com/articles/github-flavored-markdown)'s _Fenced Code Blocks_ for details.
+- We love [pull requests](https://help.github.com/articles/using-pull-requests). But if you don't have a test to go with it we probably won't merge it.
 
 # Contributing to Cucumber
 
@@ -21,26 +21,38 @@ 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'
-~~~
+```ruby
+# 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/main/docs/vscode-example-launch-configuration.md)
 
 ## Note on Patches/Pull Requests
 
-* Fork the project. Make a branch for your change.
-* Make your feature addition or bug fix.
-* Make sure your patch is well covered by tests. We don't accept changes to Cucumber that aren't tested.
-* Please do not change the Rakefile, version, or history.
+- Fork the project. Make a branch for your change.
+- Make your feature addition or bug fix.
+- Make sure your patch is well covered by tests. We don't accept changes to Cucumber that aren't tested.
+- Please do not change the Rakefile, version, or history.
   (if you want to have your own version, that is fine but
   bump version in a commit by itself so we can ignore when we merge your change)
-* Send us a pull request.
+- Send us a pull request.
 
 ## Running tests
 
@@ -50,24 +62,24 @@ gem 'byebug'
 
     To get code coverage results, run `bundle exec rake cov`
 
-## First timer? No problem!
+## First timer? Welcome!
 
 If you are new to the project or to OSS, check the label
 [Easy](https://github.com/cucumber/cucumber-ruby/labels/Easy). Also, you can
 help us to correct style violations reported here:
-[.rubocop_todo.yml](https://github.com/cucumber/cucumber-ruby/blob/master/.rubocop_todo.yml).
+[.rubocop_todo.yml](https://github.com/cucumber/cucumber-ruby/blob/main/.rubocop_todo.yml).
 
 ## Release Process
 
-* Upgrade gems with `scripts/update-gemspec`
-* Bump the version number in `lib/cucumber/version`
-* Update `CHANGELOG.md` with the upcoming version number and create a new `In Git` section
-* Remove empty sections from `CHANGELOG.md`
-* Now release it:
+- Upgrade gems with `scripts/update-gemspec`
+- Bump the version number in `lib/cucumber/version`
+- Update `CHANGELOG.md` with the upcoming version number and create a new `In Git` section
+- Remove empty sections from `CHANGELOG.md`
+- Now release it:
 
   ```
   git commit -am "Release X.Y.Z"
   make release
   ```
 
-* Finally, update the cucumber-ruby version in the [documentation project](https://cucumber.io/docs/installation/) in [versions.yaml](https://github.com/cucumber/docs.cucumber.io/blob/master/data/versions.yaml) file.
+- Finally, update the cucumber-ruby version in the [documentation project](https://cucumber.io/docs/installation/) in [versions.yaml](https://github.com/cucumber/docs/blob/master/data/versions.yaml) file.

data/README.md

@@ -1,10 +1,10 @@
 [![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)
+[![Coverage Status](https://coveralls.io/repos/cucumber/cucumber-ruby/badge.svg?branch=main)](https://coveralls.io/r/cucumber/cucumber-ruby?branch=main)
 
 # Cucumber
 
@@ -15,24 +15,27 @@ your team.
 
 Where to get more info:
 
- * The main website: https://cucumber.io/
- * Documentation: https://cucumber.io/docs
- * Ruby API Documentation: http://www.rubydoc.info/github/cucumber/cucumber-ruby/
- * Support forum: https://groups.google.com/group/cukes
- * Chat: ([Slack](https://cucumber.io/support#slack) and [Gitter](https://cucumber.io/support#gitter))
+- The main website: https://cucumber.io/
+- Documentation: https://cucumber.io/docs
+- Ruby API Documentation: http://www.rubydoc.info/github/cucumber/cucumber-ruby/
+- Support forum: https://groups.google.com/group/cukes
+- Chat: ([Slack](https://cucumber.io/support#slack) and [Gitter](https://cucumber.io/support#gitter))
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for info on contributing to Cucumber.
 
 ## Supported platforms
-* Ruby 2.6
-* Ruby 2.5
-* Ruby 2.4
-* Ruby 2.3
-* JRuby 9.2 (with [some limitations](https://github.com/cucumber/cucumber-ruby/blob/master/docs/jruby-limitations.md))
+
+- Ruby 3.0
+- Ruby 2.7
+- Ruby 2.6
+- Ruby 2.5
+- Ruby 2.4
+- Ruby 2.3
+- JRuby 9.2 (with [some limitations](https://github.com/cucumber/cucumber-ruby/blob/main/docs/jruby-limitations.md))
 
 ## Code of Conduct
 
-Everyone interacting in this codebase and issue tracker is expected to follow the Cucumber [code of conduct](https://github.com/cucumber/cucumber/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in this codebase and issue tracker is expected to follow the Cucumber [code of conduct](https://cucumber.io/conduct).
 
 ## Copyright
 

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,8 +22,13 @@ 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.'],
-        'json'        => ['Cucumber::Formatter::Json',        '[DEPRECATED] Prints the feature as JSON'],
+        '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',        "Prints the feature as JSON.\n" \
+                                                              "#{INDENT}The JSON format is in maintenance mode.\n" \
+                                                              "#{INDENT}Please consider using the message formatter\n"\
+                                                              "#{INDENT}with the standalone json-formatter\n" \
+                                                              "#{INDENT}(https://github.com/cucumber/cucumber/tree/master/json-formatter)."],
         'message'     => ['Cucumber::Formatter::Message',     'Outputs protobuf messages'],
         'html'        => ['Cucumber::Formatter::HTML',        'Outputs HTML report'],
         'summary'     => ['Cucumber::Formatter::Summary',     'Summary output of feature and scenarios']
@@ -335,7 +340,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', {}, 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

@@ -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,15 +13,7 @@ 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)
+        @io = ensure_io(config.out_stream, config.error_stream)
         @ast_lookup = AstLookup.new(config)
         @feature_hashes = []
         @step_or_hook_hash = {}
@@ -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