Warn when replacing placeholders #219
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
graemeboyd
changed the title
hanachin
reviewed
Jan 8, 2020
lib/turnip/placeholder.rb
Outdated
| @@ -19,6 +20,10 @@ def find(name) | |||
| placeholders[name] or default | |||
| end | |||
|
|
|||
| def clear | |||
There was a problem hiding this comment.
IMHO adding a new public API to eliminate warnings doesn't make sense to me.
How about define the clear method in a Refinement and using it in the test instead?
@gongo What do you think?
# spec/support/clear_place_holders
module ClearPlaceHolders
refine(Turnip::Placeholder) do
def clear
placeholders.clear
end
end
end
# spec/placeholder_spec.rb
using ClearPlaceHolders
describe Turnip::Placeholder do
after do
described_class.clear
end
# ...
end
There was a problem hiding this comment.
@hanachin Thanks! I think it's good
@graemeboyd I don't think it's good to make it Public API if Placeholder.clear just code for testing.
graemeboyd
commented
Jan 8, 2020
gongo
reviewed
Jan 14, 2020
If a placeholder is replaced a warning is now emitted. As the test suite relied on placeholder replacements being silent, placeholders are now cleared to defaults after each test case. Internal calls made from dsl.rb are filtered out in order to show the real location of the replacement.
graemeboyd
force-pushed
the
disallow-redefining-placeholders
branch
from
f36255e
to
70bb287
Compare
|
@graemeboyd @hanachin Thanks for good change and comments! |
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 PR addresses an issue we've faced with a large Turnip codebase using placeholders with generic names like
:objectin multiple helpers across multiple files. This led to the placeholders being easily overridden and producing obscure and hard to track down bugs in our test suite.The main change is to issue a warning that a a placeholder is being replaced if there's already a non-default placeholder. The warning includes the file and line using
caller_locationswhich is supported in Ruby 2.2 onwards.With just this change the Turnip test suite now issues warnings as it runs as it relies on replacing placeholders being silent. To address this I've added a
.clearconvenience method which removes all the added placeholders reverting them to the original default.