Log a message when view rendering is intercepted #1732
Merged
Conversation
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
andymorris
force-pushed
the
log-no-render-views
branch
from
8f20e94 to
ee0cb7d
Compare
fables-tales
requested changes
Oct 29, 2016
|
|
||
| def render_template(event) | ||
| unless current_example_group.render_views? | ||
| info " Template rendering was prevented by rspec-rails. Use `render_views` to verify rendered view contents if necessary." |
There was a problem hiding this comment.
could you add parentheses here?
| end | ||
| end | ||
|
|
||
| LogSubscriber.attach_to :action_view |
There was a problem hiding this comment.
Also could you add parentheses here?
fables-tales
requested changes
Oct 29, 2016
| end | ||
|
|
||
| def render_template(event) | ||
| unless current_example_group.render_views? |
There was a problem hiding this comment.
Our rubocop configuration would like you to change this to
return if current_example.render_views? and then flatten the conditional. Could you do that?
| RSpec.current_example.example_group | ||
| end | ||
|
|
||
| def render_template(event) |
There was a problem hiding this comment.
Can you change this to _event to pass the rubocop review?
|
@andymorris thanks for submitting this! Looks like a good solution to the problem. I've left you some review comments, if you address those, I'd love to merge this in ✨ |
andymorris
force-pushed
the
log-no-render-views
branch
from
ee0cb7d to
938095a
Compare
|
Changes made, and rubocop no longer shows any issues. Let me know if there is anything else. |
fables-tales
approved these changes
Oct 31, 2016
|
LGTM |
This was referenced May 31, 2017
Closed
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.
This is an attempt at #1332, to clarify test logs when view rendering is prevented. Without calling
render_views, logs currently look something like:...even though the template was not actually rendered. With this change the logs look like:
I struggled a little bit with how to write the specs for this. The LogSubscriber is attached and created independent of any examples/groups, but still needs to know the current example group's
render_views?to decide whether or not to log the message, though whenrspec-railsspecs are running the current example is in therspec-railssuite and not a controller spec. I'd be happy to take a different approach if someone points me in the right direction.