Simplify featured images by splitting into new classes #619
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
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.
The featured image class is one of rather high complexity, most of which is due to the fact that it supports two wildly different storage adapters. This PR keeps the shared logic in a base class, and the differential logic in child classes.
It also very strictly enforces the internal data structure, and has explicit constructors with data validation, paired with a scoped public API. This makes the whole system more maintainable and predictable.
As the constructors now require all parameters to be set, the classes will require a factory, however since the data logic is now easily decouplable this is not a problem; in fact it may even prove more useful as it will be easier to support multiple front matter keys, allowing for much better interoperability.