GH-1445 - Make DocumentationSource configurable #1446
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
Introduces a generic StrategyLookup utility and makes DocumentationSource configurable via the spring.modulith.documentation-source property, following the same pattern as ApplicationModuleDetectionStrategy. Key changes: - Create generic StrategyLookup<T> utility in spring-modulith-core for reusable configuration-based strategy lookups - Refactor ApplicationModuleDetectionStrategyLookup to use the generic StrategyLookup utility, reducing code duplication - Add DocumentationSourceLookup with support for predefined strategies and custom implementations via property configuration - Add NoOpDocumentationSource as fallback implementation - Update Asciidoctor to use DocumentationSourceLookup instead of hardcoded static field - Make DocumentationSource interface public (was package-private) and add getDocumentation(JavaPackage) method for package-level docs - Add spring-configuration-metadata.json for IDE autocomplete support - Add comprehensive test coverage with DocumentationSourceLookupTests The implementation supports: - Predefined strategy: 'spring-modulith' (uses SpringModulithDocumentationSource) - Custom implementations via fully qualified class name - SpringFactoriesLoader fallback with deprecation warning (for compatibility) - IDE autocomplete via configuration metadata Signed-off-by: Yevhenii Semenov <zhe.semenov@gmail.com>
Member
|
Can we change this to not affect |
Author
|
Yes, we can, but that would result in essentially duplicating the ApplicationModuleDetectionStrategyLookup code in the docs module. Would this approach be acceptable? |
Member
|
That's fine for now. I'd like to see how that looks before prematurely introducing an abstraction over an abstraction. |
Reverts the generic StrategyLookup<T> utility and restores the original ApplicationModuleDetectionStrategyLookup implementation in the core module. The DocumentationSourceLookup now contains an inline implementation of the lookup pattern, removing the dependency on the core module's generic utility. Key changes: - Restore ApplicationModuleDetectionStrategyLookup to original implementation with static initializer, Logger field, and switch statement - Delete generic StrategyLookup<T> utility class from core/config package - Duplicate lookup pattern inline in DocumentationSourceLookup with private helper method for SpringFactoriesLoader fallback This approach favors module independence over code reuse, keeping the core module unchanged while maintaining all documentation source functionality. All tests pass: 84 tests in core module, 15 tests in docs module. Signed-off-by: Yevhenii Semenov <zhe.semenov@gmail.com>
Author
|
Done. The core module is now unaffected by changes. Please let me know if any other changes are needed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Introduces a generic StrategyLookup utility and makes DocumentationSource configurable via the spring.modulith.documentation-source property, following the same pattern as ApplicationModuleDetectionStrategy.
Key changes: