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

Updated documentation to the current syntax, no need to confuse people with deprecated stuff.

Browse source
This commit is contained in:
iain barnett 2021-09-25 13:56:49 +09:00
parent 83fa0499d3
commit 458d01394c
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -142,26 +142,26 @@ sample various_integers do |int|
end end
``` ```
Another context type is `given`. Another context type is `provided`.
This context drastically reduces the amount of code needed in some scenarios. This context drastically reduces the amount of code needed in some scenarios.
It can be used where one (or more inputs) changes the output of multiple methods. It can be used where one (or more inputs) changes the output of multiple methods.
The `given` context gives a concise syntax for this use case. The `provided` context gives a concise syntax for this use case.
```crystal ```crystal
subject(user) { User.new(age) } subject(user) { User.new(age) }
# Each expression in the `given` block is its own test. # Each expression in the `provided` block is its own test.
given age = 10 do provided age = 10 do
expect(user.can_drive?).to be_false expect(user.can_drive?).to be_false
expect(user.can_vote?).to be_false expect(user.can_vote?).to be_false
end end
given age = 16 do provided age = 16 do
expect(user.can_drive?).to be_true expect(user.can_drive?).to be_true
expect(user.can_vote?).to be_false expect(user.can_vote?).to be_false
end end
given age = 18 do provided age = 18 do
expect(user.can_drive?).to be_true expect(user.can_drive?).to be_true
expect(user.can_vote?).to be_true expect(user.can_vote?).to be_true
end end
@ -295,7 +295,7 @@ Items not marked as completed may have partial implementations.
- [X] `describe` and `context` blocks - [X] `describe` and `context` blocks
- [X] Contextual values with `let`, `let!`, `subject`, `described_class` - [X] Contextual values with `let`, `let!`, `subject`, `described_class`
- [X] Test multiple and generated values - `sample`, `random_sample` - [X] Test multiple and generated values - `sample`, `random_sample`
- [X] Concise syntax - `given` - [X] Concise syntax - `provided` (was the now deprecated `given`)
- [X] Before and after hooks - `before_each`, `before_all`, `after_each`, `after_all`, `around_each` - [X] Before and after hooks - `before_each`, `before_all`, `after_each`, `after_all`, `around_each`
- [X] Pre- and post-conditions - `pre_condition`, `post_condition` - [X] Pre- and post-conditions - `pre_condition`, `post_condition`
- [ ] Other hooks - `on_success`, `on_failure`, `on_error` - [ ] Other hooks - `on_success`, `on_failure`, `on_error`