https://github.com/toptal/crystalball

Regression Test Selection library for your RSpec test suite
https://github.com/toptal/crystalball

rails regression-test-selection rspec ruby tests

Last synced: 21 days ago
JSON representation

Regression Test Selection library for your RSpec test suite

• Host: GitHub
• URL: https://github.com/toptal/crystalball
• Owner: toptal
• License: mit
• Created: 2017-04-03T14:10:50.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-09-13T14:35:29.000Z (about 1 year ago)
• Last Synced: 2024-10-01T03:41:21.080Z (about 1 month ago)
• Topics: rails, regression-test-selection, rspec, ruby, tests
• Language: Ruby
• Homepage: https://toptal.github.io/crystalball/
• Size: 957 KB
• Stars: 323
• Watchers: 141
• Forks: 41
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-rspec - crystallball - Regression Test Selection library for your RSpec test suite. (Tools)

README

        
# Crystalball

Crystalball is a Ruby library which implements [Regression Test Selection mechanism](https://tenderlovemaking.com/2015/02/13/predicting-test-failues.html) originally published by Aaron Patterson.

Its main purpose is to select a minimal subset of your test suite which should be run to ensure your changes didn't break anything.

[![Build Status](https://travis-ci.org/toptal/crystalball.svg?branch=master)](https://travis-ci.org/toptal/crystalball)

[![Maintainability](https://api.codeclimate.com/v1/badges/c8bfc25a43a1a2ecf964/maintainability)](https://codeclimate.com/github/toptal/crystalball/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/c8bfc25a43a1a2ecf964/test_coverage)](https://codeclimate.com/github/toptal/crystalball/test_coverage)

## Installation

Add this line to your application's Gemfile:

```ruby

group :test do

  gem 'crystalball'

end

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install crystalball

## Usage

Please see our [official documentation](https://toptal.github.io/crystalball/).

### Versioning

We use [semantic versioning](https://semver.org/) for our [releases](https://github.com/toptal/crystalball/releases).

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/toptal/crystalball.

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

Crystalball is released under the [MIT License](https://opensource.org/licenses/MIT).