aruba 1.0.0.pre.alpha.2 → 1.0.1

data/CONTRIBUTING.md

@@ -2,15 +2,15 @@
 
 ## Introduction
 
-We would love to get help from you as "user" and "contributor".
+We would love to get help from you as a **user** and a **contributor**.
 
-**Users**
+### As a **User**
 
 * Tell us how "Aruba" works for you
-* Spread the word if you like our work and please tell us if somethings is (utterly) wrong
+* Spread the word if you like our work and please tell us if something is (utterly) wrong
 * Encourage people in testing their code and keep communicating their needs
 
-**Contributors**
+### As a **Contributor**
 
 * Send us bug fixes
 * Add new features to the code
@@ -18,55 +18,82 @@ We would love to get help from you as "user" and "contributor".
 * Add missing documentation
 * Improve our test coverage
 
-The rest of this document is a guide for those maintaining Aruba, and others who would like to submit patches.
+The rest of this document is a guide for those maintaining Aruba, and others
+who would like to submit patches.
 
-## Contributing to the "aruba" project
+## Contributing to the Aruba project
 
-It would be great if all people who want to contribute to the "aruba" project – contributors and maintiners – follow the guidelines in this section. There are also "Getting started"-sections both for [contributors](#getting-started-as-a-contributor) and [maintainers]((#getting-started-as-a-maintainer).
+It would be great if all people who want to contribute to the Aruba project
+— contributors and maintainers — follow the guidelines in this
+section. There are also "Getting started" sections both for
+[contributors](#getting-started-as-a-contributor) and
+[maintainers](#getting-started-as-a-maintainer).
 
 ### Issues
 
-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? Just follow our comments in the issue template
-* We love [pull requests](https://help.github.com/articles/using-pull-requests). The same here: Please consider our comments within the template we provide for your pull request(s).
-
+About to create a new GitHub Issue? 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 submits a
+  [pull request](https://help.github.com/articles/using-pull-requests). It
+  might be better to start a discussion on
+  [the Google Group](http://groups.google.com/group/cukes).
+* Reporting a bug? Follow our comments in the Issue Template, which is
+  pre-filled when you create the new GitHub Issue.
+* We love [pull requests](https://help.github.com/articles/using-pull-requests).
+  The same here: Please consider our comments within the pull request template.
 
 ### Pull Requests
 
-**Contributors**
+#### Contributors
 
 Please...
 
 * Fork the project. Make a branch for your change.
-* Make your feature addition or bug fix – if you're unsure if your addition will be accepted, open an issue for discussion first
-* Make sure your patch is well covered by tests. We don't accept changes 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)
-* Make sure your pull request complies to our development style
-* Rebase your branch if needed to reduce clutter in our git history
-* Make sure you don't break other people's code – On major changes: First deprecated, than bump major version, than make breaking changes
-* Split up your changes into reviewable "git"-commits which combine all lines/files relevant for a single change
+* Make your feature addition or bug fix — if you're unsure if your
+  addition will be accepted, open a GitHub Issue for discussion first
+* Make sure your patch is well covered by tests. We don't accept changes that
+  aren't tested.
+* Do not change the `Rakefile`, gem version number in `version.rb`, or
+  [`CHANGELOG.md`][].
+  (If you want to have your own version, that is fine but bump version in a
+  separate commit, so that we can ignore that commit when we merge your change.)
+* Make sure your pull request complies with our development style guidelines.
+* Rebase your branch if needed. This reduces clutter in our git history.
+* Make sure you don't break other people's code. On major changes: First
+  deprecate, then bump major version, then make breaking changes,
+* Split up your changes into reviewable git commits which combine all
+  lines/files relevant for a single change.
 * Send us a pull request.
 
-**Maintainers**
-
-* Use pull requests for larger or controversial changes made by yourself or changes you might expected to break the build
-* Commit smaller changes directly to master, e.g. fixing typos, adding tests or adding documentation
-* Update [History.md](History.md) when a pull request is merged
-* Make sure all tests are green before merging a pull request
-
-### Development style
-
-* We try to follow the recommendations in the [Ruby Community Style Guide](https://github.com/bbatsov/ruby-style-guide) and use [`rubocop`](https://github.com/bbatsov/rubocop) to "enforce" it. Please see [.rubocop.yml](.rubocop.yml) for exceptions.
-* There should be `action`-methods and `getter`-methods in `aruba`. Only the latter should return values. Please expect the first ones to return `nil`.
-* Add documentation (aka acceptance tests) for new features using `aruba`'s steps and place them some where suitable in [here](features/).
-* Add unit tests where needed to cover edge cases which are not (directly) relevant for users
-* Add developer documentation in [`yardoc`](http://yardoc.org/) to all relevant methods added
-* Format your commits messages following those seven rules -- see [this blog post](http://chris.beams.io/posts/git-commit/) for a well written explanation about the why.
+#### Maintainers
+
+* Use pull requests for larger or controversial changes made by yourself or
+  changes you might expected to break the build.
+* Commit smaller changes directly to master, e.g. fixing typos, adding tests or
+  adding documentation.
+* Update [`CHANGELOG.md`][] when a pull request is merged.
+* Make sure all tests are green before merging a pull request.
+
+### Development style guidelines
+
+* We try to follow the recommendations in the
+  [Ruby Community Style Guide][] and use
+  [`rubocop`][] to "enforce" it. Please see
+  [.rubocop.yml][] for exceptions.
+* There should be `action` methods and `getter` methods in Aruba. Only the
+  latter should return values. Please expect the first ones to return `nil`.
+* Add documentation — aka acceptance tests — for new features
+  using Aruba's Cucumber steps. Place them somewhere suitable in [features/].
+* Add unit tests where needed to cover edge cases which are not (directly)
+  relevant for users.
+* Add [YARD] developer documentation to all relevant methods added.
+* Format your commit messages following these seven rules — see
+  the ["How to Write a Git Commit Message"] blog post for a well-written
+  explanation about the why.
   1. Separate subject from body with a blank line
   2. Limit the subject line to 50 characters
   3. Capitalize the subject line
@@ -74,71 +101,119 @@ Please...
   5. Use the imperative mood in the subject line
   6. Wrap the body at 72 characters
   7. Use the body to explain what and why vs. how (optional if subject is self-explanatory)
-  8. Use Markdown Markup to style your message (only if required)
-
 
 ## Getting started as a "Contributor"
 
-### Bootstrap environment
+### Requirements
 
-To get started with `aruba`, you just need to bootstrap the environment by
-running the following command.
+To get started with Aruba, you only need [Bundler].
 
-~~~bash
-# Bootstrap environment
-bin/bootstrap
-~~~
+Install Aruba's dependencies:
+
+```bash
+bundle install
+```
 
 ### Running tests
 
-Make sure you bootstrap the environment first. Then run the following command
-to run the test suite.
+Run the following command to run the test suite.
 
-~~~bash
+```bash
 # Run the test suite
 bin/test
-~~~
-
-If you have problems because our assumptions about your local setup are wrong.
-Try this instead. This requires the `docker`-command/project to be installed on
-your local system.
-
-~~~bash
+```
+
+Or use these Rake tasks:
+
+```bash
+# Run the whole test suite
+rake test
+# Run RSpec tests
+rake spec
+# Run Cucumber features
+rake cucumber
+# Run Cucumber features which are "WORK IN PROGRESS" and are allowed to fail
+rake cucumber:wip
+```
+
+If you have problems because our assumptions about your local setup are wrong,
+perhaps you can use this Docker workflow. This requires [Docker] to be
+installed on your local system.
+
+```bash
 # Build the docker container
 bundle exec rake docker:build
 
+# Alternative: Build with disabled cache
+bundle exec rake 'docker:build[false]'
+
+# Build image with version tag
+bundle exec rake 'docker:build[false, 0.1.0]'
+
 # Run the whole test suite in "docker"-container
 RUN_IN_DOCKER=1 bin/test
 
 # Run only selected scenario
 RUN_IN_DOCKER=1 bin/test cucumber features/steps/command/shell.feature:14
-~~~
+```
 
-## Installing your own gems used for development
+### Installing your own gems used for development
 
-A `Gemfile.local`-file can be used to have your own gems installed to support
+A `Gemfile.local` file can be used, to have your own gems installed to support
 your normal development workflow.
 
-Example:
+Example `Gemfile.local`:
 
-~~~ruby
+```ruby
 gem 'pry'
 gem 'pry-byebug'
 gem 'byebug'
-~~~
+```
+
+### Running a developer console
+
+The interactive Aruba console starts an IRB console with Aruba's API loaded:
+
+```bash
+bin/console
+```
+
+### Linting
+
+Aruba's Rakefile provides the following linting tasks
+
+```bash
+bundle exec rake lint                         # Run all linters
+bundle exec rake lint:coding_guidelines       # Lint our code with "rubocop"
+bundle exec rake lint:licenses                # Check for relevant licenses in project
+```
+
+### Building and installing your local Aruba version
+
+You can use the following Rake tasks to build and install your work-in-progress locally:
+
+```bash
+# Build your copy
+bundle exec rake build
+# Build and install your copy
+bundle exec rake install
+# Build and install your copy without network access
+bundle exec rake install:local
+```
 
 ## Getting started as a "Maintainer"
 
 ### Release Process
 
 * Bump the version number in `lib/aruba/version.rb`
-* Make sure `History.md` is updated with the upcoming version number, and has entries for all fixes.
-* No need to add a `History.md` header at this point - this should be done when a new change is made, later.
-* If a major version is released, update the `still`-branch which points to "old" major version
+* Make sure [`CHANGELOG.md`] is updated with the upcoming version number, and has
+  entries for all fixes.
+* No need to add a [`CHANGELOG.md`] header at this point - this should be done
+  later, when a new change is made.
 
-Now release it
+Now release it:
 
-~~~bash
+```bash
 # update dependencies
 bundle update
 
@@ -147,27 +222,44 @@ bin/test
 
 # Release gem
 git commit -m "Version bump"
-bin/release
+bundle exec rake release
+```
 
-# If it's a major relase:
-# Merge changes back to have an correct documentation
-git checkout still
-git merge master
-git push
-~~~
+Now send a PR to [cucumber/website] adding an article
+with details of the new release. Then merge it - an aruba maintainer should
+normally be allowed to merge PRs on [cucumber/website]. A copy of an old
+announcement can be used as basis for the new article.
 
-Now send a PR to https://github.com/cucumber/website adding an article about the with details of the new release and merge it - an aruba maintainer should normally allowed to merge PRs on `cucumber/website`. A copy of an old announcement can be used as basis for the new article. After this send an email with the link to the article to cukes@googlegroups.com. 
+Now, send an email with the link to the article to `cukes@googlegroups.com`.
 
 ### Gaining Release Karma
 
-To become a release manager, create a pull request adding your name to the list below, and include your Rubygems email address in the ticket. One of the existing Release managers will then add you.
+To become a release manager, create a pull request adding your name to the list
+below, and include your Rubygems email address in the ticket. One of the
+existing Release managers will then add you.
 
 Current release managers:
-  * Aslak Hellesøy ([@aslakhellesoy](http://github.com/aslakhellesoy))
-  * Dennis Günnewig ([@maxmeyer](http://github.com/maxmeyer), [@dg-rationdata](http://github.com/dg-rationdata))
-  * Jarl Friis ([@jarl-dk](https://github.com/jarl-dk))
-  * Matt Wynne ([@mattwynne](http://github.com/mattwynne))
+  * Aslak Hellesøy ([@aslakhellesoy](https://github.com/aslakhellesoy))
+  * Matt Wynne ([@mattwynne](https://github.com/mattwynne))
+  * Matijs van Zuijlen ([@mvz](https://github.com/mvz))
 
 To grant release karma, issue the following command:
 
-    gem owner aruba --add <NEW OWNER RUBYGEMS EMAIL>
+```bash
+gem owner aruba --add <NEW OWNER RUBYGEMS EMAIL>
+```
+
+[`CHANGELOG.md`]: CHANGELOG.md
+[CHANGELOG.md]: CHANGELOG.md
+
+[`rubocop`]: https://github.com/bbatsov/rubocop
+[Ruby Community Style Guide]: https://github.com/bbatsov/ruby-style-guide
+[.rubocop.yml]: .rubocop.yml
+[features/]: features/
+
+[Bundler]: https://bundler.io/
+
+[Docker]: https://docs.docker.com/
+[YARD]: http://yardoc.org/
+["How to Write a Git Commit Message"]: http://chris.beams.io/posts/git-commit/
+[cucumber/website]: https://github.com/cucumber/website

data/Gemfile

@@ -4,75 +4,11 @@ source 'https://rubygems.org'
 gemspec
 
 # Load local Gemfile
-load File.expand_path('../Gemfile.local', __FILE__) if File.file? File.expand_path('../Gemfile.local', __FILE__)
-
-# Debug aruba
-group :debug do
-  if RUBY_VERSION >= '2' && !RUBY_PLATFORM.include?('java')
-    gem 'byebug', '~> 9.0'
-    gem 'pry-byebug', '~> 3.4'
-  end
-
-  if RUBY_VERSION < '2' && !RUBY_PLATFORM.include?('java')
-    gem 'debugger', '~> 1.6.8'
-    gem 'pry-debugger', '~> 0.2.3'
-  end
-
-  gem 'pry-doc', '~> 0.8.0'
-end
-
-group :development, :test do
-  # we use this to demonstrate interactive debugging within our feature tests
-  if RUBY_VERSION >= '2'
-    gem 'pry', '~> 0.10.1'
-  else
-    gem 'pry', '~>0.9.12'
-  end
-
-  # Run development tasks
-  gem 'rake', '~> 10.4.2'
-
-  if RUBY_VERSION >= '2.0.0'
-    # Lint travis yaml
-    gem 'travis-yaml'
-
-    # Reporting
-    gem 'bcat', '~> 0.6.2'
-    gem 'kramdown', '~> 1.14'
-  end
-
-  # Code Coverage
-  gem 'simplecov', '~> 0.10'
-
-  # Test api
-  gem 'rspec', '~> 3.4'
-  gem 'fuubar', '~> 2.2.0'
-
-  # using platform for this makes bundler complain about the same gem given
-  # twice
-  gem 'cucumber', '~> 2.0'
-
-  # Make aruba compliant to ruby community guide
-  gem 'rubocop', '~> 0.32', '< 0.41.1'
-
-  # gem 'cucumber-pro', '~> 0.0'
-
-  # License compliance
-  if RUBY_VERSION < '2.3'
-    gem 'license_finder', '~> 2.0'
-  else
-    gem 'license_finder', '~> 3.0'
-  end
-
-  # Upload documentation
-  # gem 'relish', '~> 0.7.1'
-
-  gem 'minitest', '~> 5.8.0'
-
-  gem 'json', '~>2.1'
+if File.file? File.expand_path('Gemfile.local', __dir__)
+  load File.expand_path('Gemfile.local', __dir__)
 end
 
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'rubinius-developer_tools'
+unless RUBY_PLATFORM.include?('java')
+  gem 'byebug', '~> 11.0'
+  gem 'pry-byebug', '~> 3.4'
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2016 Aslak Hellesøy, David Chelimsky, Mike Sassak, Jarl Friis, Matt Wynne, Dennis Günnewig
+Copyright (c) 2010-2020 Aslak Hellesøy, David Chelimsky, Mike Sassak, Jarl Friis, Matt Wynne, Dennis Günnewig and Matijs van Zuijlen
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,49 +1,76 @@
-[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/cucumber/aruba/master/LICENSE)
+[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/cucumber/aruba/master/LICENSE)
 [![Docs](https://img.shields.io/badge/cucumber.pro-aruba-3d10af.svg)](https://app.cucumber.pro/projects/aruba)
 [![Gem Version](https://badge.fury.io/rb/aruba.svg)](http://badge.fury.io/rb/aruba)
-[![Dependency Status](https://gemnasium.com/cucumber/aruba.svg)](https://gemnasium.com/cucumber/aruba)
 [![Code Climate](https://codeclimate.com/github/cucumber/aruba.svg)](https://codeclimate.com/github/cucumber/aruba)
 [![Support](https://img.shields.io/badge/cucumber-support-orange.svg)](https://cucumber.io/support)
 
-**This is the [latest](https://github.com/cucumber/aruba/blob/master/README.md) version of our README.md. There is also [the README of the latest released version of "aruba"](https://github.com/cucumber/aruba/blob/still/README.md).**
+[![Travis CI build status](https://travis-ci.org/cucumber/aruba.svg)](https://travis-ci.org/cucumber/aruba) 
+[![Appveyor build status](https://ci.appveyor.com/api/projects/status/jfo2tkqhnrqqcivl?svg=true)](https://ci.appveyor.com/project/cucumberbdd/aruba)
 
 ## Install
 
 Add this line to your application's `Gemfile`:
 
-~~~
+```ruby
 gem 'aruba'
-~~~
+```
 
 And then execute:
 
-~~~
-$ bundle
-~~~
+```bash
+bundle
+```
 
 Or install it yourself as:
 
-~~~
-$ gem install aruba
-~~~
+```bash
+gem install aruba
+```
 
 ## Usage
 
-### As a user getting started with "aruba"
+### As a user getting started with Aruba
 
-Our most current documentation to get started with `aruba` can be found on [![See our documentation on Cucumber Pro](https://github.com/cucumber-ltd/brand/raw/master/images/png/notm/cucumber-pro-black/cucumber-pro-black-32.png)](https://app.cucumber.pro/projects/aruba). It is generated from our feature files describing the use of `aruba`.
+Our most current documentation to get started with Aruba as a user can be
+found on [Cucumber Jam](https://app.cucumber.pro/projects/aruba).
+It is generated from our feature files describing the use of Aruba.
+
+### As a user getting started with a ruby testing framework
+
+* **Cucumber**:
+
+    If you're new to the Cucumber ecosystem, it's worth to visit
+[the project's documentation site](https://cucumber.io/docs). This also includes
+information about how to write feature files in Gherkin.
+
+* **RSpec**:
+
+    If you want to use Aruba with RSpec and you need some information about how to use RSpec, please visit [their website](http://rspec.info/documentation/).
+
+* **minitest**:
+
+    The documentation for minitest can be found [here](http://docs.seattlerb.org/minitest/).
+
+### As a developer getting started with Aruba
+
+A full documentation of the API for developers can be found on
+[RubyDoc](http://www.rubydoc.info/gems/aruba).
 
 ## Support
 
 ### Channels
 
-For support, please have a look at the ["support website"](https://cucumber.io/support) of "Cucumber". You have different options to reach out for help: Recommended for `aruba` are using the "Slack" channels - e.g. "aruba-devs" or "general" ([Register account](https://cucumberbdd-slack-invite.herokuapp.com/)) and the "Issues" page on [GitHub](https://github.com/cucumber/aruba/issues). Addressing one of the maintainers directly would be helpful.
+For support, please have a look at the [support website](https://cucumber.io/support)
+of Cucumber. You have different options to reach out for help: Recommended for
+Aruba are using the Slack channels — e.g. `committers-aruba` or `help-cucumber-ruby`
+— ([register account](https://cucumberbdd-slack-invite.herokuapp.com/)), and the
+[Issues page on GitHub](https://github.com/cucumber/aruba/issues).
 
 ### Maintainers
 
 Currently, this gem is mainly maintained by this group of people:
 
-* [@maxmeyer](https://github.com/maxmeyer)
+* [@mvz](https://github.com/mvz)
 
 ## Release Policy
 
@@ -51,15 +78,25 @@ We try to comply with [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.
 
 ## Supported Ruby versions
 
-For an up-to-date list of all supported Ruby versions, please see our [`.travis.yml`](https://github.com/cucumber/aruba/blob/master/.travis.yml). We only test against the latest version of a version branch - most times.
+Aruba is supported on Ruby 2.4 and up, and tested against CRuby 2.4, 2.5, 2.6
+and 2.7, and JRuby 9.2.
+
+## Supported operating systems
+
+Aruba is fully tested in CI on Linux and MacOS. On Windows, only RSpec tests
+are run, so YMMV. Full Windows support is a work in progress.
 
 ## Contributing
 
 Please see the [CONTRIBUTING](CONTRIBUTING.md) file.
 
-## Build Status
+## Code branches
+
+Development takes place in the `master` branch and currently targets the 1.x
+releases. If necessary, maintenance of the old 0.14.x releases takes place in
+the `0-14-stable` branch. Stable branches will not be created until absolutely
+necessary.
+
+## License
 
-|Version|Linux / OS X|Windows|
-| ------ | ------ | ------ |
-| master | [![Build Status](https://travis-ci.org/cucumber/aruba.svg?branch=master)](https://travis-ci.org/cucumber/aruba) | [![Build status](https://ci.appveyor.com/api/projects/status/jfo2tkqhnrqqcivl?svg=true)](https://ci.appveyor.com/project/cucumberbdd/aruba/branch/master)|
-| still | [![Build Status](https://travis-ci.org/cucumber/aruba.svg?branch=still)](https://travis-ci.org/cucumber/aruba) | [![Build status](https://ci.appveyor.com/api/projects/status/jfo2tkqhnrqqcivl?svg=true)](https://ci.appveyor.com/project/cucumberbdd/aruba/branch/still)
+See the file [LICENSE](LICENSE).