deprecate _show_tools partial #3039
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
jcoyne
reviewed
Mar 20, 2023
| @@ -181,6 +181,9 @@ def initialized_default_configuration? | |||
| # document presenter class used by helpers and views | |||
| document_presenter_class: nil, | |||
| document_component: Blacklight::DocumentComponent, | |||
| # in Blacklight 9, the default show_tools_component configuration will | |||
| # be Blacklight::Document::ShowToolsComponent | |||
| show_tools_component: nil, | |||
There was a problem hiding this comment.
Can we set this as the default right now? I don't like how this forces people to set a component that would otherwise be the default. On the other hand, I can't think of a more backward-compatible mechanism for handling this.
There was a problem hiding this comment.
If we set it now, we have to do a partial lookup first to see if an install has overridden the partial and render it rather than the component, instead of only looking it up if there's no configured component. I used nil here to avoid that overhead for installs that notice this and fix it without breaking the API. I don't think that's an perfect solution, but that's why I took that approach.
jcoyne
approved these changes
Mar 20, 2023
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.
Deprecate the _show_tools partial in favor of a configurable component
fixes #3038
This PR also restores the helper method for inspecting whether a partial was overridden to minimize log noise when a Blacklight app is using default behaviors