Repository navigation
docs(ruby): add multiple expectations guide #168
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
kfitzpatrick
wants to merge
2
commits into
habit-hooks:main
Choose a base branch
from
kfitzpatrick:codex-rubocop-multiple-expectations-guide
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
46 changes: 46 additions & 0 deletions
46
plugins/ruby/src/habit_hooks_ruby/guides/multiple-expectations.md
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| Keep each example focused on one behavior and one clear reason to fail. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. When creating guides, where possible we should aim for generic wording that works for any language, and move the guide to generic. Example code is discouraged in prompts for the same reason. Here is an alternative draft for this prompt: |
||
| Split unrelated expectations into separate examples, sharing setup through | ||
| `before`, helpers, or `let` where useful. | ||
|
|
||
| Bad — unrelated behavior is bundled into one example: | ||
|
|
||
| ```ruby | ||
| it "creates and announces the account" do | ||
| account = create_account | ||
|
|
||
| expect(account).to be_persisted | ||
| expect(account.plan).to eq("free") | ||
| expect(Mailer).to have_received(:welcome).with(account) | ||
| end | ||
| ``` | ||
|
|
||
| Good — each behavior has its own example: | ||
|
|
||
| ```ruby | ||
| subject(:create_account) { described_class.call } | ||
|
|
||
| it "persists the account" do | ||
| expect(create_account).to be_persisted | ||
| end | ||
|
|
||
| it "assigns the free plan" do | ||
| expect(create_account.plan).to eq("free") | ||
| end | ||
|
|
||
| it "sends the welcome email" do | ||
| account = create_account | ||
|
|
||
| expect(Mailer).to have_received(:welcome).with(account) | ||
| end | ||
| ``` | ||
|
|
||
| Multiple expectations can be appropriate when they jointly describe one | ||
| inseparable outcome. Use judgment: improve the test’s focus and diagnostic value; | ||
| do not combine assertions, add `aggregate_failures`, or disable the cop merely to | ||
| silence RuboCop. | ||
|
|
||
| Locations reported: | ||
|
|
||
| {% for issue in issues -%} | ||
| {{ issue.details.file }}:{{ issue.details.line }} — {{ issue.details.message }} | ||
| {% endfor %} | ||
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One thing I'm not sure about is this line here. I suspect this is not a warning that will be in most tools and is ruby specific. It's not bad practice, but it's BDD specific.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the smell, I'm not sure about the name for now. However I would definitely move this one to be suggested instead of enforced. It's too subjective.