Deprecate SpecificationInterface in FileCollector and ParseDirectoryCommand#1334
Open
lacatoire wants to merge 3 commits intophpDocumentor:mainfrom
Open
Deprecate SpecificationInterface in FileCollector and ParseDirectoryCommand#1334lacatoire wants to merge 3 commits intophpDocumentor:mainfrom
lacatoire wants to merge 3 commits intophpDocumentor:mainfrom
Conversation
…ommand Emit a deprecation notice when phpDocumentor\Guides\FileCollector::collect() receives a Flyfinder SpecificationInterface, and avoid spuriously firing the existing ParseDirectoryCommand deprecation when no exclusion was supplied. Closes phpDocumentor#1209
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #1209.
FileCollector::collect()now emits a deprecation when aFlyfinder\Specification\SpecificationInterfaceis passed; users should switch tophpDocumentor\FileSystem\Finder\Exclude(which the collector already supports). The deprecation message inParseDirectoryCommandis also fixed (concatenation typos, missing spaces) and uses sprintf placeholders.Side bugfix:
ParseDirectoryHandlerno longer triggers the deprecation when no exclusion is supplied. It used to callgetExcludedSpecification()unconditionally on the fallback branch, which fired the deprecation even when the caller did nothing wrong. A newhasExcludedSpecification()getter on the command lets the handler choose without touching the deprecated path. Internal call sites useDeprecation::triggerIfCalledFromOutside()so user-facing notices stay scoped to actual user code.Tests added for both
FileCollector::collect()andParseDirectoryCommandcovering the three input variants (null, Exclude, SpecificationInterface).