diff options
Diffstat (limited to 'spec/mspec/README.md')
| -rw-r--r-- | spec/mspec/README.md | 37 |
1 files changed, 15 insertions, 22 deletions
diff --git a/spec/mspec/README.md b/spec/mspec/README.md index 18ca8fcdd3..94ab608031 100644 --- a/spec/mspec/README.md +++ b/spec/mspec/README.md @@ -1,14 +1,13 @@ -[](https://travis-ci.org/ruby/mspec) - ## Overview -MSpec is a specialized framework that is syntax-compatible with RSpec for -basic things like 'describe', 'it' blocks and 'before', 'after' actions. MSpec -contains additional features that assist in writing the RubySpecs used by -multiple Ruby implementations. +MSpec is a specialized framework that is syntax-compatible with RSpec 2 for +basic things like `describe`, `it` blocks and `before`, `after` actions. +MSpec contains additional features that assist in writing specs for +Ruby implementations in [ruby/spec](https://github.com/ruby/spec). MSpec attempts to use the simplest Ruby language features so that beginning -Ruby implementations can run the Ruby specs. +Ruby implementations can run the Ruby specs. For example, no file from the +standard library or RubyGems is necessary to run MSpec. MSpec is not intended as a replacement for RSpec. MSpec attempts to provide a subset of RSpec's features in some cases and a superset in others. It does not @@ -23,8 +22,6 @@ specs in a manner compatible with multiple Ruby implementations. 2. MSpec provides a different shared spec implementation specifically designed to ease writing specs for the numerous aliased methods in Ruby. - The MSpec shared spec implementation should not conflict with RSpec's own - shared behavior facility. 3. MSpec provides various helper methods to simplify some specs, for example, creating temporary file names. @@ -33,9 +30,13 @@ specs in a manner compatible with multiple Ruby implementations. configuration facility with a default project file and user-specific overrides. + 5. MSpec support "tagging", that is excluding specs known as failing on + a particular Ruby implementation, and automatically adding and removing tags + while running the specs. + ## Requirements -MSpec requires Ruby 2.2 or more recent. +MSpec requires Ruby 2.6 or more recent. ## Bundler @@ -52,10 +53,10 @@ To install the gem dependencies with Bundler, run the following: ruby -S bundle install ``` -## Running Specs +## Development Use RSpec to run the MSpec specs. There are no plans currently to make the -MSpec specs runnable by MSpec. +MSpec specs runnable by MSpec: https://github.com/ruby/mspec/issues/19. After installing the gem dependencies, the specs can be run as follows: @@ -63,29 +64,21 @@ After installing the gem dependencies, the specs can be run as follows: ruby -S bundle exec rspec ``` -Or - -```bash -ruby -S rake -``` - To run an individual spec file, use the following example: ```bash ruby -S bundle exec rspec spec/helpers/ruby_exe_spec.rb ``` - ## Documentation -See http://ruby.github.io/rubyspec.github.io/ - +See [CONTRIBUTING.md](https://github.com/ruby/spec/blob/master/CONTRIBUTING.md) in ruby/spec +for a list of matchers and how to use `mspec`. ## Source Code See https://github.com/ruby/mspec - ## License See the LICENSE in the source code. |