Getting Started

To run the RubySpecs, you need to get MSpec and the RubySpec files.

Getting MSpec

MSpec is the framework and scripts for running the RubySpecs. It is available as a gem or directly from Github.

$ sudo gem install mspec

OR

$ git clone git://github.com/rubyspec/mspec.git

If you are going to be working on the RubySpecs, you are strongly encouraged to always use the latest MSpec from Github.

Getting the RubySpecs

The RubySpec source is available from Github.

$ git clone git://github.com/rubyspec/rubyspec.git

If you are not working on the RubySpecs, you can checkout a particular version with the following command:

$ git checkout -f -b stable v0.7.3

Check the News page for the most recent stable release.

Running the RubySpecs

If you cloned MSpec from Github, put the mspec/bin directory in your PATH. The simplest way to run the specs is to change to the RubySpec directory and invoke mspec.

$ cd rubyspec
$ mspec

This will run the specs with the ruby executable on PATH. To run the specs with a different implementation, see the -t or --target option to mspec. See mspec -h for more details. Read the Runners documentation for complete details on all the runner scripts.

To run a single directory of specs, pass the path to the directory to mspec. To run a single file, pass the name of the file.

$ cd rubyspec
$ mspec core/array
$ mspec core/array/append_spec.rb

The ruby.1.8.mspec and ruby.1.9.mspec config files also provide psuedo-directories that will include all the appropriate files for the version.

$ mspec :core
$ mspec :library
$ mspec :language

The psuedo-directory for :library is the most useful since there are both 1.8 and 1.9 specific libraries in the rubyspec/library directory.

Runner script help

To see more help for the particular runner scripts:

$ mspec run -h
$ mspec ci -h
$ mspec tag -h