m-spec

Mspec

The lightest-weight spec framework in ruby. Built for learning at Makers. You have three matchers, an equality matcher, an output matcher and an error matcher. Test setup and teardown is your responsibility. For additional features, you must extend the gem.

Installation

Add this line to your application's Gemfile:

gem 'm-spec'

And then execute:

$ bundle

Or install it yourself as:

$ gem install m-spec

Setup

Initialize m-spec with a .m-spec and a .rubocop.yml file

m-spec --init

Usage

We care about isolating unit tests, so there's a very simple mocking library.

# source code
class Animal
  def roar
    "ROAAAARRRR!"
  end
end

# test code
describe 'The Animal' do
  it 'can roar' do
    animal = Animal.new
    expect(animal.roar).to eq "ROAAAARRRR!"
  end

  it 'fails nicely' do
    animal = Animal.new
    expect(animal.roar).to eq "little roar!"
  end
end

describe 'test doubles' do
  it 'can be stubbed' do
    mock = test_double
    allow(mock).to receive(:speak) { 'Hello!' }
    expect(mock.speak).to eq 'Hello!'
  end
  it 'can have optional names' do
    mock = test_double('a name')
    allow(mock).to receive(:speak) { 'Hello!' }
    expect(mock.speak).to eq 'Hello!'
  end

  it 'can be sent messages with any args' do
    mock = test_double('a name')
    allow(mock).to receive(:speak) { 'Hello!' }
    expect(mock.speak('example arg')).to eq 'Hello!'
  end
end

describe 'testing output' do
  it 'captures strings' do
    expect { puts('hello') }.to output("hello\n")
  end
end

To run your specs, pass the spec file directly as an argument. You have to run individual spec files, or create a file that requires your specs.

$ m-spec ./spec/animal_spec.rb
# or
$ m-spec ./spec_runner.rb

The Animal
  returns a string
  fails nicely
    Expected: ROAAAARRRR!
    Got: little roar!
    # /path/to/directory/spec/animal_spec.rb:11:in `block (2 levels) in <top (required)>'
stubbing
  we can mock too!

Inspecting 3 files
...

3 files inspected, no offenses detected

It's got simple one-level indentation, simple colour coding for test passes and failures, and simple failure messages with expected and actual values and the failing spec file path and line number.

Remember - you'll have to manage yourself: test setup and teardown, keeping test code dry, each test running in isolation, and loading source code properly.

Rubocop

M-spec comes with rubocop by default, using this set of rules. To configure your test suite to disable rubocop or to only run rubcop, add an optional configuration file named .m-spec to your project root where you run your specs from. You don't need the configuration file - by default your specs will run first, followed by rubocop.

You can add either of two options

• --no-rubocop which will ignore running rubocop
• --only-rubocop which will ignore running your tests

See rubocop documentation for more info - you might be interested in reading about rubocop's autocorrect command.

Extending

After checking out the repo

$ git clone [e-mail]:dearshrewdwit/m-spec.git
$ cd m-spec

Add more matchers, or extend the mocking library. Then build locally and use.

bundle exec rake build --trace
gem install pkg/m-spec-[version].gem
m-spec [spec-file]

Pushing to Rubygems

Sign up for an account, check for the gem name you want, change the gem metadata to represent what you want, and then follow the hints and errors when you

$ bundle exec rake release

Bundler docs are a good resource, as are the rubygems docs

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/dearshrewdwit/m-spec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Mspec project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.