Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alexb52/retest

A trusty CLI companion to monitor file changes and automatically run the corresponding Ruby specs. Ready to assist on any Ruby project, no setup needed!
https://github.com/alexb52/retest

bundler cli file-changes hanami rails refactoring refactoring-tools ruby task-runner test testing testing-tools tests

Last synced: 2 days ago
JSON representation

A trusty CLI companion to monitor file changes and automatically run the corresponding Ruby specs. Ready to assist on any Ruby project, no setup needed!

Host: GitHub
URL: https://github.com/alexb52/retest
Owner: AlexB52
License: mit
Created: 2020-08-30T04:11:46.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2025-01-09T21:08:34.000Z (11 days ago)
Last Synced: 2025-01-11T05:58:18.396Z (10 days ago)
Topics: bundler, cli, file-changes, hanami, rails, refactoring, refactoring-tools, ruby, task-runner, test, testing, testing-tools, tests
Language: Ruby
Homepage:
Size: 18.5 MB
Stars: 156
Watchers: 4
Forks: 4
Open Issues: 12
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

awesome-ruby - Retest - A simple CLI to watch file changes and run their matching Ruby specs. Works on any ruby projects with no setup. (File System Listener)

README

[![Gem Version](https://badge.fury.io/rb/retest.svg)](https://badge.fury.io/rb/retest)

# Retest: Your Go-To Testing Assistant for Ruby Projects

Retest is the ultimate CLI tool for Ruby developers, designed to make your testing workflow seamless and efficient. It monitors file changes and automatically runs relevant tests, ensuring that your code remains solid as you refactor and develop.

With **zero setup required**, Retest works right out of the box on any Ruby project—no changes to your Gemfile, no unnecessary repo clutter, and no configuration headaches. It's lightweight, dev-centric, and ready to integrate into your workflow instantly.

## 🚀 **What Makes Retest Awesome?**

- **Plug-and-Play:** Start testing immediately—no installation hassles or setup scripts.
- **Project Independence:** Works with any Ruby project, no Gemfile modifications required.
- **Time-Saving Automation:** Automatically identifies and runs relevant tests as you code.
- **Customizable Workflows:** Tailor commands to your needs with placeholders, options, and interactive features.
- **Sound Notifications:** Get audible feedback for test results.

## 🎥 Demo

Discover Retest main functionalities in this small presentation

https://github.com/user-attachments/assets/5491bcad-134f-4843-9a6f-a474a1394e87

## 💡 **Why Use Retest?**

Testing frequently is the cornerstone of safe refactoring. Retest eliminates the friction of manual test execution by running tests after every file change, helping you stay just one `cmd + z` away from green tests.

## 🔧 **Quick Installation**

Install Retest globally in seconds:

```bash
gem install retest
```

No need to add it to your Gemfile—just install and go!

## 🛠️ **Key Features**

### **Flexible Commands**
Run tests with your preferred commands, placeholders, or patterns:
```bash
retest 'bin/rails test && rubocop ' # Flexible placeholders
retest --all # Run all tests on every file change
retest --diff origin/main # Test changes from a branch
```

### **Interactive Companion**
Stay in control with an interactive shell for test management. Start Retest and enter `h` to explore available commands.

```
Setup identified: [RAKE]. Using command: 'bundle exec rake test TEST='
Watcher: [WATCHEXEC]
Launching Retest...
Ready to refactor! You can make file changes now

Type interactive command and press enter. Enter 'h' for help.
> h

* 'h', 'help' # Prints help.
* 'p', 'pause' # Pauses Retest. Tests aren't run on file change events until unpaused.
* 'u', 'unpause' # Unpauses Retest.
* # Runs last changed triggered command.
* 'ra, 'run all' # Runs all tests.
* 'f', 'force' # Forces a selection of test to run on every file change.
* 'r', 'reset' # Disables forced selection.
* 'd', 'diff' [GIT BRANCH] # Runs matching specs that changed from a target branch.
* 'c' # Clears window.
* 'e', 'exit' # Exits Retest.

```
### **Supports Multiple Watchers**
Retest ships with [Listen](https://github.com/guard/listen) for file monitoring but can use the more performant [Watchexec](https://github.com/watchexec/watchexec) if installed.

To force a specific watcher:
```bash
retest -w watchexec
```

## 🐳 **Works with Docker**

Retest can run inside Docker containers, ensuring your testing workflow stays consistent across environments.

```bash
# Inside your container shell
gem install retest
retest 'bundle exec rails test '
```

## ❤️ **Contributing**

Got feedback or ideas? Join the discussion for Retest 2.0 and share your thoughts:
[Discussion - Retest V2.0 - Interactive Panel](https://github.com/AlexB52/retest/discussions/216)

Bug reports and pull requests are welcome at [GitHub](https://github.com/alexb52/retest).

## 🛠️ **Development**

Want to contribute to Retest? Follow these steps to set up your environment

1. Clone the repo and install dependencies: `bin/setup`
2. Run tests to ensure everything is working: `rake test`
3. Experiment with an interactive console: `bin/console`
4. To run integration tests (e.g., for a Hanami app): `bin/test/hanami-app`

## 📜 **License**

Retest is open-source and available under the [MIT License](https://opensource.org/licenses/MIT).