corgibytes / aruba

Test command-line applications with Cucumber-Ruby, RSpec or Minitest.

Install

Add this line to your application's Gemfile:

gem 'aruba'

And then execute:

bundle

Or install it yourself as:

gem install aruba

Usage

As a user getting started with Aruba

Our most current documentation to get started with Aruba as a user can be found in ./features/.

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. 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.

• minitest:

  The documentation for minitest can be found here.

As a developer getting started with Aruba

A full documentation of the API for developers can be found on RubyDoc.

Support

For support, please have a look at the support website 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)

Concrete issues can be reported via the Issues page on GitHub.

Maintainers

Currently, this gem is mainly maintained by this group of people:

• @mvz

Release Policy

We use Semantic Versioning 2.0.0. We depend on rubygems to ensure correct dependency versions, so dropping support for older dependencies and Ruby versions will not result in a major version bump.

Supported Ruby versions

Aruba is supported on Ruby 2.6 and up, and tested against CRuby 2.6, 2.7, 3.0, 3.1 and 3.2, and JRuby 9.3 and 9.4.

Supported Cucumber versions

Aruba is supported on and tested with Cucumber versions 4 through 8.

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 file.

Code branches

Development takes place in the main branch and currently targets the 2.x releases. If necessary, maintenance of the old 1.1.x releases will take place in a 1-1-stable branch, and of 0.14.x releases in the 0-14-stable branch. Stable branches will not be created until absolutely necessary.

License

See the file LICENSE.