cucumber 6.0.0 → 8.0.0.rc.1

data/CONTRIBUTING.md

@@ -1,85 +1,246 @@
-## About to create a new Github Issue?
+# Contributing to Cucumber
 
-We appreciate that. But before you do, please learn our basic rules:
+Thank you for considering contributing to Cucumber!
 
-* 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 document will first introduce different ways to get involved before
+focusing on how to contribute to the code.
 
-# Contributing to Cucumber
+## Code of Conduct
+
+Everyone interacting in this codebase and issue tracker is expected to follow
+the Cucumber [code of conduct](https://cucumber.io/conduct).
+
+## How can I contribute?
+
+If you're reading this, you are certainly looking to contribute to the code. Cucumber
+is not this single repository. It is made up of several packages around several
+repositories. So before going further with the code, you may consider the
+following first, in order to get your bearings.
+
+If you just want to know how to contribute to the code, go to
+[Contribute to the code](#contribute-to-the-code).
+
+If you want to report an issue, or suggest an enhancement, go to
+[Report bugs and submit feature requests](#report-bugs-and-submit-feature-requests).
+
+### Meet the community, the maintainers, and other Cucumber developers
+
+Smartbear hosts a [community message board].
+This is a good place to meet users, the community, and to ask questions.
+
+You can also join the Cucumber Community Slack:
+[register for an account][register-slack] then head over to [#intro][slack-intro].
+This is the place to be to meet other contributors and find a mentor to help you
+get started.
+
+### Test Cucumber
+
+Testing Cucumber, especially new features, is a great way to contribute. We
+cannot put a price on (early) feedback.
+
+Keep an eye on our CHANGELOGS to discover new features. Test and experiment, and
+submit your feedback through [issues](#report-bugs-and-submit-feature-requests),
+the [community message board], or [Slack][community-slack].
+
+### Contribute to the documentation
+
+[The documentation][cucumber-docs] is an important part of Cucumber. It is
+essential that it remains simple and accurate. You can contribute to it via
+[github.com/cucumber/docs](https://github.com/cucumber/docs).
+
+### Promote Cucumber
+
+You don't know how to contribute but would like to help? Telling other people
+about Cucumber on the Internet - social media, reviews, blogs - but also in real
+life is already a big help! Join us on [Slack][community-slack] to share your
+publication and to discover new ones.
+
+## Report bugs and submit feature requests
+
+The short version is:
+
+- Find the appropriate repository
+- Try to check there is not already an issue or pull request that deals with
+  your bug or request
+- Explain your issue and include as much details as possible to help other
+  people reproduce your problem or understand your request
+- Consider submitting a pull request if you feel confident enough
+
+You can find more details for each of these steps in the following sections.
+
+### Find the appropriate repository
+
+The current repository, `cucumber-ruby`, is actually the tip of the iceberg. It
+provides a user interface through a CLI, some built-in formatters, and the
+execution environment you may know as the `World` object.
+
+An important repository is [cucumber/common]. It is a mono-repo
+with a lot of libraries. You will find there what is related to:
+
+- parsing Gherkin documents - aka `.feature` files
+- parsing tag expressions - the options you use to filter an execution with tags
+- parsing Cucumber expressions - the expressions that link a Gherkin step to a
+  step definition
+- everyting related to the HTML formatter
+
+`cucumber-ruby` is also composed of [cucumber-ruby-core]: this is the engine that
+will execute the test cases computed from a parsed Gherkin document
+
+Last but not least, there is also a repository for [cucumber-rails], the gem
+that brings Cucumber to Rails 5.x and 6.x.
 
-The rest of this document is a guide for those maintaining Cucumber, and others who would like to submit patches.
+In any case, if your are not sure, best places to open an issue are the current
+repository - `cucumber-ruby` - and the mono-repo at [cucumber/common].
 
-## Talking with other devs
+### Look for existing issues and pull requests
 
-You can chat with the core team on https://gitter.im/cucumber/contributors. We try to have office hours on Fridays.
+Search in [the current repository][cucumber-ruby-issues], in the
+[mono-repo][cucumber/common-issues], but also in the
+[whole cucumber organization][cucumber-issues] if the problem or feature has already
+been reported. If you find an issue or pull request which is still open, add
+comments to it instead of opening a new one.
 
-## Installing your own gems
+If you're not sure, don't hesitate to just open a new issue. We can always merge
+and de-duplicate later.
 
-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.
+### Submitting a pull request
 
-Example:
+When submitting a pull request:
+
+- create a [draft pull request][how-to-create-a-draft-pr]
+- try to follow the instructions in the [template](.github/PULL_REQUEST_TEMPLATE.md)
+- if possible, [sign your commits]
+- update CHANGELOG.md with your changes
+- once the PR is ready, request for reviews
+
+More info on [how to contribute to the code](#contribute-to-the-code) can be
+found below.
+
+### Opening a new issue
+
+To open a good issue, be clear and precise.
+
+If you report a problem, the reader must be able to reproduce it easily.
+Please do your best to create a [minimal, reproducible example][minimal-reproducible-example].
+
+Consider submitting a pull request. Even if you think you cannot fix it by
+yourself, a pull request with a failing test is always welcome.
+
+If you request is for an enhancement - a new feature - try to be specific and
+support your request with referenced facts and include examples to illustrate
+your proposal.
+
+## Contribute to the code
+
+### Development environment
+
+Development environment for `cucumber-ruby` is a simple Ruby environment with
+Bundler. Use a [supported Ruby version](./README.md#supported-platforms), make
+sure [Bundler] is set-up, and voilà!
+
+You can then [fork][how-to-fork] and clone the repository. If your environment
+is set-up properly, the following commands should install the dependencies and
+execute all the tests successfully.
+
+```shell
+bundle install
+bundle exec rake
+```
+
+You can now create a branch for your changes and [submit a pull request](#submitting-a-pull-request)!
+
+If you want to check the code coverage during your development, execute
+`bundle exec rake cov`.
+
+### Cucumber-ruby-core
+
+As seen here: [Find the appropriate repository](#find-the-appropriate-repository),
+you may need to work with other repositories in order to accomplish your
+development. Beside the mono-repo in [cucumber/common], [cucumber-ruby-core] is
+also a big piece of `cucumber-ruby`.
+
+### Using a local Gemfile
+
+A local Gemfile allows you to use your prefer set of gems for your own
+development workflow, like gems dedicated to debugging. Such gems are not part
+of `cucumber-ruby` standard `Gemfile`.
+
+`Gemfile.local`, `Gemfile.local.lock` and `.bundle` have been added to
+`.gitignore` so local changes cannot be accidentaly commited and pushed to the
+repository.
+
+A `Gemfile.local` may look like this:
+
+```ruby
+# Gemfile.local
 
-~~~ruby
 # Include the regular Gemfile
 eval File.read('Gemfile')
 
+# Include your favorites development gems
 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?
+  gem 'debase', require: false
+  gem 'ruby-debug-ide', require: false
+end
+```
+
+Then you can execute bundler with the `--gemfile` flag:
+`bundle install --gemfile Gemfile.local`, or with an environment variable:
+`BUNDLE_GEMFILE=Gemfile.local bundle [COMMAND]`.
+
+To use your local Gemfile per default, you can also execute
+`bundle config set --local gemfile Gemfile.local`.
 
-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)
+### First timer? Welcome!
 
-## Note on Patches/Pull Requests
+Looking for something simple to begin with? Look at issues with the label
+'[good first issue](https://github.com/cucumber/cucumber-ruby/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)'.
 
-* 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.
+Remember: Cucumber is more than `cucumber-ruby`. You can look for good first
+issues in [other cucumber reporistories](#find-the-appropriate-repository).
 
-## Running tests
+### Having trouble getting started with the code? We're here to help!
 
-    gem install bundler
-    bundle install
-    bundle exec rake
+If you have trouble setting-up your development environment, or getting started
+with the code, you can join us on [Slack][community-slack]. You will find there
+a lot of contributors.
 
-    To get code coverage results, run `bundle exec rake cov`
+Full-time maintainers are also available. We would be please to have 1:1 pairing
+sessions to help you getting started. Look for
+[Matt Wynne](https://cucumberbdd.slack.com/team/U590XDLF3) or
+[Aurélien Reeves](https://cucumberbdd.slack.com/team/U011BB95MC7) on
+[Slack][community-slack].
 
-## First timer? No problem!
+### Additional documentation and notice
 
-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).
+You can find additional documentation in the [docs](./docs) directory such as
+(non-exhaustive list):
 
-## Release Process
+- [How to release cucumber-ruby](./docs/RELEASE_PROCESS.md) (for maintainers)
+- [How to set-up a launch.json configuration for Visual Studio Code](./docs/vscode-example-launch-configuration.md)
 
-* 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
-  ```
+<!-- Links -->
 
-* 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.
+[community message board]: https://community.smartbear.com/t5/Cucumber-Open/bd-p/CucumberOS
+[register-slack]: https://cucumberbdd-slack-invite.herokuapp.com/
+[slack-intro]: https://cucumberbdd.slack.com/messages/C5WD8SA21/
+[community-slack]: https://cucumberbdd.slack.com/
+[cucumber-docs]: https://cucumber.io/docs/cucumber
+[cucumber/common]: https://github.com/cucumber/common
+[cucumber-ruby-core]: https://github.com/cucumber/cucumber-ruby-core
+[cucumber-rails]: https://github.com/cucumber/cucumber-rails
+[cucumber-ruby-issues]: https://github.com/cucumber/cucumber-ruby/search?q=is%3Aissue
+[cucumber/common-issues]: https://github.com/cucumber/common/search?q=is%3Aissue
+[cucumber-issues]: https://github.com/search?q=is%3Aissue+user%3Acucumber
+[how-to-create-a-draft-pr]: https://docs.github.com/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests
+[how-to-fork]: https://docs.github.com/github/collaborating-with-pull-requests/working-with-forks/about-forks
+[sign your commits]: https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/signing-commits
+[minimal-reproducible-example]: https://stackoverflow.com/help/minimal-reproducible-example
+[RVM]: https://rvm.io/
+[rbenv]: https://github.com/rbenv/rbenv
+[Bundler]: https://bundler.io/

data/README.md

@@ -1,40 +1,158 @@
+<p align="center">
+  <img src="./.github/img/cucumber-open-logo.png" alt="Cucumber Open - Supported by Smartbear" width="428" />
+</p>
+
+# Cucumber
+
 [![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)
+[![Test cucumber](https://github.com/cucumber/cucumber-ruby/actions/workflows/cucumber-ruby.yml/badge.svg)](https://github.com/cucumber/cucumber-ruby/actions/workflows/cucumber-ruby.yml)
 [![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)
-
-# Cucumber
+[![Coverage Status](https://coveralls.io/repos/cucumber/cucumber-ruby/badge.svg?branch=main)](https://coveralls.io/r/cucumber/cucumber-ruby?branch=main)
 
 Cucumber is a tool for running automated tests written in plain language. Because they're
 written in plain language, they can be read by anyone on your team. Because they can be
 read by anyone, you can use them to help improve communication, collaboration and trust on
 your team.
 
-Where to get more info:
+<p align="center">
+  <img src="./.github/img/gherkin-example.png" alt="Cucumber Gherkin Example" width="728" />
+</p>
+
+This is the Ruby implementation of Cucumber. Cucumber is also available for [JavaScript](https://github.com/cucumber/cucumber-js),
+[Java](https://github.com/cucumber/cucumber-jvm), and a lot of other languages. You can find a list of implementations here: https://cucumber.io/docs/installation/.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for info on contributing to Cucumber (issues, PRs, etc.).
+
+Everyone interacting in this codebase and issue tracker is expected to follow the
+Cucumber [code of conduct](https://cucumber.io/conduct).
+
+## Installation
+
+Cucumber for Ruby is a Ruby gem. Install it as you would install any gem: add
+`cucumber` to your Gemfile:
+
+    gem 'cucumber'
+
+then install it:
+
+    $ bundle
+
+or install the gem directly:
+
+    $ gem install cucumber
+
+Later in this document, bundler is considered being used so all commands are using
+`bundle exec`. If this is not the case for you, execute `cucumber` directly, without
+`bundle exec`.
+
+### Supported platforms
+
+- Ruby 3.1
+- Ruby 3.0
+- Ruby 2.7
+- Ruby 2.6
+- JRuby (with [some limitations](https://github.com/cucumber/cucumber-ruby/blob/main/docs/jruby-limitations.md))
+  - 9.3 >= 9.3.1 (there is a known issue with JRuby 9.3.0. More info can
+    be found in the [PR#1571](https://github.com/cucumber/cucumber-ruby/pull/1571).)
+
+### Ruby on Rails
+
+Using Ruby on Rails? You can use [cucumber-rails](https://github.com/cucumber/cucumber-rails)
+to bring Cucumber into your Rails project.
+
+## Usage
+
+### Initialization
+
+If you need to, initialize your `features` directory with
+
+    $ bundle exec cucumber --init
+
+This will create the following directories and files if they do not exist already:
+
+    features
+    ├── step_definitions
+    └── support
+        └── env.rb
+
+### Create your specification
+
+Create a file named `rule.feature` in the `features` directory with:
+
+```gherkin
+# features/rule.feature
+
+Feature: Rule Sample
+
+  Rule: This is a rule
+
+    Example: A passing example
+      Given this will pass
+      When I do an action
+      Then some results should be there
+
+    Example: A failing example
+      Given this will fail
+      When I do an action
+      Then some results should be there
+
+```
+
+### Automate your specification
+
+And a file named `steps.rb` in `features/step_definitions` with:
+
+```ruby
+# features/step_definitions/steps.rb
+
+Given("this will pass") do
+  @this_will_pass = true
+end
+
+Given("this will fail") do
+  @this_will_pass = false
+end
+
+When("I do an action") do
+end
+
+Then("some results should be there") do
+  expect(@this_will_pass)
+end
+```
+
+### Run Cucumber
+
+    $ bundle exec cucumber
+
+To execute a single feature file:
+
+    $ bundle exec cucumber features/rule.feature
+
+To execute a single example, indicates the line of the name of the example:
+
+    $ bundle exec cucumber features/rule.feature:7
+
+To summarize the results on the standard output, and writte a HTML report on disk:
+
+    $ bundle exec cucumber --format summary --format html --out report.html
 
- * 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))
+For more command line options
 
-See [CONTRIBUTING.md](CONTRIBUTING.md) for info on contributing to Cucumber.
+    $ bundle exec cucumber --help
 
-## Supported platforms
-* 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/master/docs/jruby-limitations.md))
+You can also find documentation on the command line possibilities in
+[features/docs/cli](features/docs/cli).
 
-## Code of Conduct
+## Documentation and support
 
-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).
+- Getting started, writing features, step definitions, and more: https://cucumber.io/docs
+- Ruby API Documentation: http://www.rubydoc.info/github/cucumber/cucumber-ruby/
+- Community support forum: https://community.smartbear.com/t5/Cucumber-Open/bd-p/CucumberOS
+- Slack: [register for an account](https://cucumberbdd-slack-invite.herokuapp.com/) then head over to [#intro](https://cucumberbdd.slack.com/messages/C5WD8SA21/)
 
 ## Copyright
 

data/lib/autotest/cucumber_mixin.rb

@@ -24,7 +24,7 @@ module Autotest::CucumberMixin
     add_sigint_handler
 
     loop do # ^c handler
-      get_to_green
+      wait_for_green
       if tainted
         rerun_all_tests
         rerun_all_features if all_good
@@ -37,6 +37,7 @@ module Autotest::CucumberMixin
       reset_features
     rescue Interrupt
       break if wants_to_quit
+
       reset
       reset_features
     end
@@ -47,7 +48,7 @@ module Autotest::CucumberMixin
     features_to_run == ''
   end
 
-  def get_to_green # rubocop:disable Naming/AccessorMethodName
+  def wait_for_green
     loop do
       super
       run_features
@@ -70,6 +71,7 @@ module Autotest::CucumberMixin
     Tempfile.open('autotest-cucumber') do |dirty_features_file|
       cmd = make_cucumber_cmd(features_to_run, dirty_features_file.path)
       break if cmd.empty?
+
       old_sync = $stdout.sync
       $stdout.sync = true
       self.results = []
@@ -81,6 +83,7 @@ module Autotest::CucumberMixin
             print(c)
             line << c
             next unless c == "\n"
+
             results << line.join
             line.clear
           end

data/lib/autotest/discover.rb

@@ -2,9 +2,10 @@
 
 Autotest.add_discovery do
   if File.directory?('features')
-    if ENV['AUTOFEATURE'] =~ /true/i
+    case ENV['AUTOFEATURE']
+    when /true/i
       'cucumber'
-    elsif ENV['AUTOFEATURE'] =~ /false/i
+    when /false/i
       # noop
     else
       puts '(Not running features.  To run features in autotest, set AUTOFEATURE=true.)'

data/lib/cucumber/cli/configuration.rb

@@ -9,7 +9,9 @@ require 'cucumber'
 module Cucumber
   module Cli
     class YmlLoadError < StandardError; end
+
     class ProfilesNotDefinedError < YmlLoadError; end
+
     class ProfileNotFound < StandardError; end
 
     class Configuration
@@ -17,7 +19,7 @@ module Cucumber
 
       attr_reader :out_stream
 
-      def initialize(out_stream = STDOUT, error_stream = STDERR)
+      def initialize(out_stream = $stdout, error_stream = $stderr)
         @out_stream   = out_stream
         @error_stream = error_stream
         @options = Options.new(@out_stream, @error_stream, default_profile: 'default')
@@ -28,6 +30,7 @@ module Cucumber
         @options.parse!(args)
         arrange_formats
         raise("You can't use both --strict and --wip") if strict.strict? && wip?
+
         set_environment_variables
       end
 

data/lib/cucumber/cli/main.rb

@@ -14,7 +14,7 @@ module Cucumber
         end
       end
 
-      def initialize(args, _ = nil, out = STDOUT, err = STDERR, kernel = Kernel)
+      def initialize(args, out = $stdout, err = $stderr, kernel = Kernel)
         @args   = args
         @out    = out
         @err    = err
@@ -41,7 +41,7 @@ module Cucumber
         @err.puts("Couldn't open #{e.path}")
         exit_unable_to_finish
       rescue FeatureFolderNotFoundException => e
-        @err.puts(e.message + '. You can use `cucumber --init` to get started.')
+        @err.puts("#{e.message}. You can use `cucumber --init` to get started.")
         exit_unable_to_finish
       rescue ProfilesNotDefinedError, YmlLoadError, ProfileNotFound => e
         @err.puts(e.message)
@@ -85,13 +85,14 @@ module Cucumber
         trap('INT') do
           exit_unable_to_finish! if Cucumber.wants_to_quit
           Cucumber.wants_to_quit = true
-          STDERR.puts "\nExiting... Interrupt again to exit immediately."
+          $stderr.puts "\nExiting... Interrupt again to exit immediately."
           exit_unable_to_finish
         end
       end
 
       def runtime(existing_runtime)
         return Runtime.new(configuration) unless existing_runtime
+
         existing_runtime.configure(configuration)
         existing_runtime
       end