iv-org-mirror/shard-spectator
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/shard-spectator.git synced 2024-08-15 00:53:35 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge branch 'release/0.9' into mocks-and-doubles

Browse source
This commit is contained in:
Michael Miller 2019-08-28 11:17:48 -06:00
commit 00ebd5849a
1 changed files with 12 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -2,9 +2,9 @@ Spectator
========= =========
Spectator is a fully-featured spec-based test framework for Crystal. Spectator is a fully-featured spec-based test framework for Crystal.
It provides more functionality from [RSpec](http://rspec.info/) It mimics features from [RSpec](http://rspec.info/).
than the built-in Crystal [Spec](https://crystal-lang.org/api/latest/Spec.html) utility. Developers coming from Ruby and RSpec will feel right at home.
Additionally, Spectator provides extra features to make testing easier and more fluent. Spectator provides additional functionality to make testing easier and more fluent.
**Goal:** **Goal:**
@ -34,8 +34,8 @@ If it doesn't exist already, create a `spec/spec_helper.cr` file.
In it, place the following: In it, place the following:
```crystal ```crystal
require "spectator"
require "../src/*" require "../src/*"
require "spectator"
``` ```
This will include Spectator and the source code for your shard. This will include Spectator and the source code for your shard.
@ -310,10 +310,13 @@ Items not marked as completed may have partial implementations.
- [X] `have_attributes` - [X] `have_attributes`
- [ ] Compound - `and`, `or` - [ ] Compound - `and`, `or`
- [ ] Mocks and Doubles - [ ] Mocks and Doubles
- [ ] Mocks (Stub real types) - [ ] Mocks (Stub real types) - `mock TYPE { }`
- [ ] Doubles (Stand-ins for real types) - [ ] Doubles (Stand-ins for real types) - `double NAME { }`
- [ ] Method stubs - [ ] Method stubs - `allow().to receive()`, `allow().to receive().and_return()`
- [ ] Spies - [ ] Spies - `expect().to receive()`
- [ ] Message expectations - `expect().to receive().at_least()`
- [ ] Argument expectations - `expect().to receive().with()`
- [ ] Message ordering - `expect().to receive().ordered`
- [ ] Null doubles - [ ] Null doubles
- [ ] Runner - [ ] Runner
- [X] Fail fast - [X] Fail fast
@ -348,7 +351,7 @@ Contributing
Please make sure to run `crystal tool format` before submitting. Please make sure to run `crystal tool format` before submitting.
The CI build checks for properly formatted code. The CI build checks for properly formatted code.
[Ameba](https://github.com/veelenga/ameba) is run to check for code style. [Ameba](https://crystal-ameba.github.io/) is run to check for code style.
Tests must be written for any new functionality. Tests must be written for any new functionality.
Macros that create types are not as easy to test, Macros that create types are not as easy to test,