Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davidcelis/spec-me-maybe
:question: Introduces the `maybe` syntax to RSpec.
https://github.com/davidcelis/spec-me-maybe
Last synced: 3 days ago
JSON representation
:question: Introduces the `maybe` syntax to RSpec.
- Host: GitHub
- URL: https://github.com/davidcelis/spec-me-maybe
- Owner: davidcelis
- License: other
- Created: 2014-09-25T23:54:50.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2014-10-29T03:35:15.000Z (about 10 years ago)
- Last Synced: 2024-12-13T07:35:48.727Z (10 days ago)
- Language: Ruby
- Homepage:
- Size: 240 KB
- Stars: 167
- Watchers: 4
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# spec-me-maybe [![Build Status][travis-badge]][travis]
Are your tests order-dependent? Tired of all those randomly failing specs? Can't be bothered to use [Timecop][timecop]? Just give up and surrender. But at least use a proper syntax.
Introducing the `maybe` syntax for RSpec.
[timecop]: https://github.com/travisjeffery/timecop
[travis]: https://travis-ci.org/davidcelis/spec-me-maybe
[travis-badge]: http://img.shields.io/badge/build-probably-yellow.svg
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'spec-me-maybe'
```
And then execute:
```sh
$ bundle
```
Or install it yourself as:
```sh
$ gem install spec-me-maybe
```
Then, in your `spec_helper.rb` file:
```ruby
require 'rspec/maybes'
RSpec.configure do |config|
config.expect_with :rspec do |expectations|
# Enable the `maybe` syntax from spec-me-maybe, e.g.:
# maybe(actual).will eq(expected)
expectations.syntax = :maybe
end
end
```
## Usage
The "maybe" syntax looks and feels almost exactly like the "expect" syntax:
```ruby
describe User do
describe '#initialize' do
let(:user) { User.new(name: 'David Celis') }
it 'should set up a name' do
maybe(user.name).will eq 'David Celis'
end
it 'probably should not raise any sort of error' do
maybe { user }.will_not raise_error
end
end
end
```
Whereas `expect` would set up an `RSpec::Expectations::ExpectationTarget`, `maybe` will instead set up an `RSpec::Maybe::MaybeTarget`. Like expectations, maybes may or may not fail. In the case of maybes, however, they will fail randomly regardless of your code. But hey, maybe your Expectations were like that too.
If your colleagues' complaints of broken specs are totally bullshit because you're _super_ sure they work on your machine, we've got you covered. Here's the above example again, but this time it'll totally always pass:
```ruby
describe User do
describe '#initialize' do
let(:user) { User.new(name: 'David Celis') }
it 'should set up a name' do
maybe(user.name).will eq('David Celis').on_my_machine
end
it 'probably should not raise any sort of error' do
maybe { user }.will_not raise_error.on_my_machine
end
end
end
```
## Contributing
1. [Fork it](https://github.com/davidcelis/spec-me-maybe/fork)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request