0.0
No commit activity in last 3 years
No release in over 3 years
Guard::RackUnit runs Racket RackUnit tests
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.6.5
~> 4.2.3
~> 2.14.1

Runtime

~> 2.5.1
 Project Readme

Guard::RackUnit

Guard::RackUnit is a Guard plugin to run Racket's RackUnit unit tests.

By default, Guard::RackUnit uses the raco test command to run tests. Consequently, your RackUnit tests should be placed in Racket test modules: (module+ test ...).

guard init rackunit

Setup

There are many ways to set up Guard. For the non-Rubyist, the ceremony described below is a typical setup.

  1. Install a relatively recent version of Ruby.
  2. Install bundler
  3. Install rvm
  4. Create a Gemfile in your Racket project's root directory. To the Gemfile, add both the guard gem and the guard-rackunit gem. See the example below.
  5. In the directory where the Gemfile is stored, run bundle install

If everything successfully installs, you are now ready to use Guard. Consult the usage section below on how to use the RackUnit plugin.

Example Gemfile

source 'https://www.rubygems.org'
gem "guard", "~> 2.5.1"
gem 'guard-rackunit', path: '/home/calbers/src/mine/guard-rackunit'

Usage

To use the RackUnit Guard plugin, Guard must be initialized. To do so, execute the following command in your project's root directory: bundle exec guard init. This should create a Guardfile with a default setup for RackUnit.

Now, to start Guard, execute the following command: bundle exec guard start.

Please consult Guard's own usage notes for more information.

##List of available options:

test_paths: ['tests/']  # Specify an array of paths that contain unit test files
all_on_start: true      # Run all the tests at startup, default: false

Support and Issues

Please submit support questions, feature requests, and issues to the Github repository's issue tracker.

Updates

Consult the ChangeLog when upgrading to newer versions.

Development

The source code is hosted at GitHub.

Pull requests are more than welcome. To contribute, please add new unit tests to the existing suite of Ruby rspec unit tests.

Requirements

  1. Racket, with raco test support
  2. Ruby, and the gems which Guard::RackUnit depends on.

Author

Chad Albers

License

This Guard plugin is released under the GPLv3. Consult the LICENSE file for more details