Prefer block name 'given' over 'setup' #786
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #786 +/- ##
============================================
+ Coverage 74.36% 74.38% +0.02%
- Complexity 3212 3218 +6
============================================
Files 347 348 +1
Lines 9931 9964 +33
Branches 1233 1236 +3
============================================
+ Hits 7385 7412 +27
- Misses 2103 2107 +4
- Partials 443 445 +2
Continue to review full report at Codecov.
|
leonard84
reviewed
Nov 15, 2017
docs/spock_primer.adoc
Outdated
| or the end of the method. There are six kinds of blocks: `setup`, `when`, `then`, `expect`, `cleanup`, and `where` blocks. | ||
| Any statements between the beginning of the method and the first explicit block belong to an implicit `setup` block. | ||
| or the end of the method. There are six kinds of blocks: `given`, `when`, `then`, `expect`, `cleanup`, and `where` blocks. | ||
| Any statements between the beginning of the method and the first explicit block belong to an implicit `given` given block. |
leonard84
requested changes
Nov 15, 2017
docs/spock_primer.adoc
Outdated
| other blocks, and may not be repeated. A `setup` block doesn't have any special semantics. The `setup:` label is | ||
| optional and may be omitted, resulting in an _implicit_ `setup` block. The `given:` label is an alias for `setup:`, | ||
| and sometimes leads to a more readable feature method description (see <<specs-as-doc,Specifications as Documentation>>). | ||
| The `given` block is where you do any configuration for the feature that you are describing. It may not be preceded by |
There was a problem hiding this comment.
I think setup work is better than configuration
docs/spock_primer.adoc
Outdated
|
|
||
| `@IgnoreRest`:: Ignores all feature methods not carrying this annotation. Useful for quickly running just a single method. | ||
| `@IgnoreRest`:: Any feature method carrying this annotation will be executed, all others will be ignored. Useful |
There was a problem hiding this comment.
Please set your IDE to softwraps instead of introducing needless newlines. Also fix the other additional line breaks.
There was a problem hiding this comment.
Change made to align with current line breaks.
BurkHufnagel
added a commit
to BurkHufnagel/spock
that referenced
this pull request
Nov 21, 2017
leonard84
approved these changes
Nov 22, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prefer block name 'given' over 'setup'
With the growing popularity of the given-when-then style of specification writing, I think it makes sense to have most of the example specifications use 'given:' instead of 'setup:'
Docs have been reworked so that they show 'given:' in place of 'setup:' everywhere except the part that explains that 'setup:' was the original name for the block and is now an alias for 'given"'.
Also reordered the listing of setup, cleanup, setupSpec, and cleanupSpec to reflect the order in which they are executed, and some rewording in the interaction_nased_testing.adoc file to make things clearer.