Fix reflection-docblock deprecation warnings #64
Conversation
WalkthroughThe changes update the instantiation of the PHPDoc parser throughout several model classes. The code now uses Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (6)
💤 Files with no reviewable changes (1)
🚧 Files skipped from review as they are similar to previous changes (5)
⏰ Context from checks skipped due to timeout of 90000ms (1)
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @BrianHenryIE, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request aims to resolve deprecation warnings related to the phpdocumentor/reflection-docblock dependency. It updates the code to use the current recommended way of instantiating the DocBlock factory, ensuring compatibility and removing warnings.
Highlights
- Dependency Usage Update: Updated the usage of
phpdocumentor/reflection-docblockto use the recommendedDocBlockFactory::createInstance()method instead of the deprecatedUtils::createDocBlockInstance(). - Deprecation Warning Fix: Addressed deprecation warnings originating from the
phpdocumentor/reflection-docblocklibrary by switching to the non-deprecated factory method.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configureGemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request addresses deprecation warnings by updating how phpDocumentor\Reflection\DocBlockFactory instances are created. It is suggested to use the existing voku\SimplePhpParser\Parsers\Helper\DocFactoryProvider::getDocFactory() instead of DocBlockFactory::createInstance() directly to leverage the cached factory instance for better performance.
| @@ -385,7 +386,7 @@ private function readPhpDocProperties($doc): void | |||
| } | |||
|
|
|||
| try { | |||
| $phpDoc = Utils::createDocBlockInstance()->create($docComment); | |||
| $phpDoc = DocBlockFactory::createInstance()->create($docComment); | |||
There was a problem hiding this comment.
Consider using DocFactoryProvider::getDocFactory() instead to leverage the cached factory instance for better performance.
$phpDoc = DocFactoryProvider::getDocFactory()->create($docComment);| @@ -76,7 +76,7 @@ public function readObjectFromPhpNode($node, $dummy = null): self | |||
| $docComment = $node->getDocComment(); | |||
| if ($docComment) { | |||
| try { | |||
| $phpDoc = Utils::createDocBlockInstance()->create($docComment->getText()); | |||
| $phpDoc = DocBlockFactory::createInstance()->create($docComment->getText()); | |||
There was a problem hiding this comment.
Use DocFactoryProvider::getDocFactory() to utilize the cached factory instance, improving performance.
$phpDoc = DocFactoryProvider::getDocFactory()->create($docComment->getText());![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (1)
src/voku/SimplePhpParser/Model/PHPFunction.php (1)
231-235: Second occurrence – consider a cached factoryYou create a new factory again here. After adding the import, this works, but repeatedly instantiating a factory is unnecessary.
Consider replacing both calls with the already-presentDocFactoryProvider::getDocFactory()for consistency and less overhead.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
src/voku/SimplePhpParser/Model/PHPClass.php(2 hunks)src/voku/SimplePhpParser/Model/PHPFunction.php(2 hunks)src/voku/SimplePhpParser/Model/PHPMethod.php(1 hunks)src/voku/SimplePhpParser/Model/PHPParameter.php(1 hunks)src/voku/SimplePhpParser/Model/PHPProperty.php(1 hunks)src/voku/SimplePhpParser/Model/PHPTrait.php(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (2)
src/voku/SimplePhpParser/Model/PHPClass.php (2)
7-8: Import looks good
DocBlockFactoryis correctly imported and fully qualifies the class; no issues here.
389-390: Consistent factory usageNice job updating to
DocBlockFactory::createInstance()here; once the other models add the missing import, all classes will be consistent.
|
Fix deprecation warnings in
phpdocumentor/reflection-docblockphpDocumentor/ReflectionDocBlock#361
Proposed Changes
Summary by CodeRabbit