compostbrain / aruba

Test command-line applications with Cucumber-Ruby, RSpec or Minitest. The most up to date documentation can be found on Cucumber.Pro (https://app.cucumber.pro/projects/aruba)

This is the latest version of our README.md (Branch: "master"). There is also the README of the latest released version of "aruba" (Branch: "still").

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

Channels

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. "aruba-devs" or "general" (Register account) and the "Issues" page on GitHub. Addressing one of the maintainers directly would be helpful.

Maintainers

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

• @mvz

Release Policy

We try to comply with Semantic Versioning 2.0.0.

Supported Ruby versions

For an up-to-date list of all supported Ruby versions, please see our .travis.yml. We only test against the latest version of a version branch - most times.

Contributing

Please see the CONTRIBUTING file.

Code branches

We use two branches for development: "master" and "still". The "master" branch contains the code of the current major version. The "still" branch is used for the old major version. New features are only added to "master". The "still" branch is still maintained, but only get fixes for major bugs. The "still" branch should be considered as experimental, as we need to find out how much work it is to maintain two branches of code.

Build Status

Version	Linux / OS X	Windows
master
still