Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cucumber/aruba
Test command-line applications with Cucumber-Ruby, RSpec or Minitest.
https://github.com/cucumber/aruba
bdd cucumber ruby shell tdd tidelift
Last synced: 5 days ago
JSON representation
Test command-line applications with Cucumber-Ruby, RSpec or Minitest.
- Host: GitHub
- URL: https://github.com/cucumber/aruba
- Owner: cucumber
- License: mit
- Created: 2010-02-12T19:06:31.000Z (over 14 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T20:54:02.000Z (7 months ago)
- Last Synced: 2024-04-14T02:22:31.461Z (7 months ago)
- Topics: bdd, cucumber, ruby, shell, tdd, tidelift
- Language: Ruby
- Homepage:
- Size: 3.2 MB
- Stars: 950
- Watchers: 92
- Forks: 163
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ruby-toolbox - aruba - Extension for popular TDD and BDD frameworks like "Cucumber", "RSpec" and "Minitest" to make testing commandline applications meaningful, easy and fun. (Testing / Cucumber Steps)
README
[](https://raw.githubusercontent.com/cucumber/aruba/main/LICENSE)
[](http://badge.fury.io/rb/aruba)
[](https://cucumber.io/support)
[](https://github.com/cucumber/aruba/actions/workflows/ruby.yml)
## Install
Add this line to your application's `Gemfile`:
```ruby
gem 'aruba'
```
And then execute:
```bash
bundle
```
Or install it yourself as:
```bash
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/](https://github.com/cucumber/aruba/tree/main/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](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
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 would be using the [Community Discord](https://github.com/cucumber#get-in-touch).
Concrete issues can be reported via the
[Issues page on GitHub](https://github.com/cucumber/aruba/issues).
## Maintainers
Currently, this gem is mainly maintained by this group of people:
* [@mvz](https://github.com/mvz)
## Release Policy
We use [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html). 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.7 and up, and tested against CRuby 2.7, 3.0,
3.1 and 3.2, and JRuby 9.4.
## Supported Cucumber versions
Aruba is supported on and tested with Cucumber versions 8 and 9.
## 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.
## 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](LICENSE).