[FrameworkBundle] decouple debug:autowiring from phpdocumentor/reflection-docblock #29569

SerkanYildiz · 2018-12-11T14:00:56Z

Q	A
Branch?	4.2
Bug fix?	yes
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	/
License	MIT

When phpDocumentor isn't installed the debug:autowiring returns an empty string for class description. With this fallback the end user will get a description even phpDocumentor isn't installed.

Edit: Usage of phpDocumentor is completely removed from debug:autowiring command.

nicolas-grekas · 2018-12-11T14:25:21Z

Thanks for submitting! During the SymfonyCon hackday last Saturday, someone worked exactly on this - except that they opened no PR so the code might be lost :)

Here are my suggestions:

consider this requirement for phpDocumentor as a bug - it's really broken to rely on it, DX wise
thus, rebase/retarget this for 4.2
let's completely remove the code path that uses phpDocumentor and parse inline ourselves - that's simple enough.

SerkanYildiz · 2018-12-11T15:58:23Z

Hi @nicolas-grekas,

It was me during the SymfonyCon who started with this patch. Will apply your comments and update this PR. Thanks for your review!

ro0NL · 2018-12-11T17:22:43Z

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php

+            $summary = str_replace(
+                array('/', '*', "\t", "\r\n", "\n", "\r", '  '),
+                '',
+                substr($docComment, 0, strpos($docComment, '@'))


this seems very fragile (perhaps * @ works better). But tend to prefer an explicit regex to capture the short description as a sentence.

This captures both short+long description and removes newlines in between.

@ro0NL Can you help me with a regex to get the description? Would be great!

@SerkanYildiz something like https://regex101.com/r/Sqcmmf/1/

It matches the first sentence per https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md#51-summary

A Summary MUST end with two sequential line breaks, unless it is the only content in the PHPDoc.

The current regex does not include single new lines, e.g. short line 1\nshort line 2 would only match short line 1. AFAIK it's OK.

nicolas-grekas · 2018-12-11T17:23:58Z

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php

-                    ->getSummary();
-            }
-        } catch (\ReflectionException | \InvalidArgumentException $e) {
+            $docComment = $r->getDocComment();


if ($docComment = $r->getDocComment()) { should be kept imho

re-added the if statement thanks @nicolas-grekas

SerkanYildiz · 2018-12-12T09:45:12Z

@ro0NL Your regex worked and made the tests pass (at least locally.) Thank You!

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php

nicolas-grekas

could you please add tests with several variants of class descriptions (or missing ones)?

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php

SerkanYildiz · 2018-12-13T14:35:49Z

@nicolas-grekas I don't now if it's necessary to add more tests. There were existing tests for the old implementation. We just changed the logic and IMO we just had to ensure that the tests should still pass

ro0NL · 2018-12-13T16:11:48Z

we should add a test for

/**
 * line1
 * line2
 *
 * line 4
 */

resulting in line1 line2

and

/**
 *oops
 *
 * @annot
 */

resulting in oops

SerkanYildiz · 2018-12-13T22:39:35Z

@nicolas-grekas failing test is not related to this PR

src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/AbstractDescriptorTest.php

ro0NL

i think we're there :) last minor comments from me.

src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/ObjectsProvider.php

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php

src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/ObjectsProvider.php

SerkanYildiz · 2018-12-17T09:01:41Z

ping @nicolas-grekas , failing AppVeyor seems unrelated. Can we retrigger AppVeyor build?

…tion-docblock

nicolas-grekas · 2018-12-17T14:26:29Z

Thank you @SerkanYildiz.

…ntor/reflection-docblock (SerkanYildiz) This PR was merged into the 4.2 branch. Discussion ---------- [FrameworkBundle] decouple debug:autowiring from phpdocumentor/reflection-docblock | Q | A | ------------- | --- | Branch? | 4.2 | Bug fix? | yes New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | / | License | MIT When phpDocumentor isn't installed the *debug:autowiring* returns an empty string for class description. With this fallback the end user will get a description even phpDocumentor isn't installed. **Edit:** Usage of phpDocumentor is completely removed from debug:autowiring command. Commits ------- 485ed4d [FrameworkBundle] decouple debug:autowiring from phpdocumentor/reflection-docblock

carsonbot added Status: Needs Review FrameworkBundle Feature labels Dec 11, 2018

SerkanYildiz changed the base branch from master to 4.2 December 11, 2018 16:00

SerkanYildiz changed the base branch from 4.2 to master December 11, 2018 16:00

SerkanYildiz requested review from dunglas, lyrixx, sroze and xabbuh as code owners December 11, 2018 16:09

SerkanYildiz changed the base branch from master to 4.2 December 11, 2018 16:10

ro0NL reviewed Dec 11, 2018

View reviewed changes

nicolas-grekas reviewed Dec 11, 2018

View reviewed changes

ro0NL reviewed Dec 12, 2018

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php Outdated Show resolved Hide resolved

ro0NL reviewed Dec 12, 2018

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php Outdated Show resolved Hide resolved

ro0NL reviewed Dec 12, 2018

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php Outdated Show resolved Hide resolved

nicolas-grekas added this to the 4.2 milestone Dec 12, 2018

nicolas-grekas reviewed Dec 12, 2018

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/Descriptor.php Outdated Show resolved Hide resolved

nicolas-grekas reviewed Dec 14, 2018

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/AbstractDescriptorTest.php Outdated Show resolved Hide resolved

ro0NL reviewed Dec 14, 2018

View reviewed changes

ro0NL approved these changes Dec 14, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Dec 14, 2018

nicolas-grekas changed the title ~~[FrameworkBundle] Implement fallback for class descriptor in debug:autowiring~~ [FrameworkBundle] decouple debug:autowiring from phpdocumentor/reflection-docblock Dec 17, 2018

[FrameworkBundle] decouple debug:autowiring from phpdocumentor/reflec…

485ed4d

…tion-docblock

nicolas-grekas merged commit 485ed4d into symfony:4.2 Dec 17, 2018

SerkanYildiz deleted the add-fallback-debug-autowiring-command-class-descriptions branch December 17, 2018 14:34

fabpot mentioned this pull request Jan 6, 2019

Release v4.2.2 #29803

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FrameworkBundle] decouple debug:autowiring from phpdocumentor/reflection-docblock #29569

[FrameworkBundle] decouple debug:autowiring from phpdocumentor/reflection-docblock #29569

SerkanYildiz commented Dec 11, 2018 •

edited

nicolas-grekas commented Dec 11, 2018 •

edited

SerkanYildiz commented Dec 11, 2018

ro0NL Dec 11, 2018 •

edited

SerkanYildiz Dec 12, 2018 •

edited

ro0NL Dec 12, 2018

nicolas-grekas Dec 11, 2018

SerkanYildiz Dec 12, 2018

SerkanYildiz commented Dec 12, 2018

nicolas-grekas left a comment

SerkanYildiz commented Dec 13, 2018

ro0NL commented Dec 13, 2018

SerkanYildiz commented Dec 13, 2018

ro0NL left a comment

SerkanYildiz commented Dec 17, 2018

nicolas-grekas commented Dec 17, 2018

[FrameworkBundle] decouple debug:autowiring from phpdocumentor/reflection-docblock #29569

[FrameworkBundle] decouple debug:autowiring from phpdocumentor/reflection-docblock #29569

Conversation

SerkanYildiz commented Dec 11, 2018 • edited

nicolas-grekas commented Dec 11, 2018 • edited

SerkanYildiz commented Dec 11, 2018

ro0NL Dec 11, 2018 • edited

Choose a reason for hiding this comment

SerkanYildiz Dec 12, 2018 • edited

Choose a reason for hiding this comment

ro0NL Dec 12, 2018

Choose a reason for hiding this comment

nicolas-grekas Dec 11, 2018

Choose a reason for hiding this comment

SerkanYildiz Dec 12, 2018

Choose a reason for hiding this comment

SerkanYildiz commented Dec 12, 2018

nicolas-grekas left a comment

Choose a reason for hiding this comment

SerkanYildiz commented Dec 13, 2018

ro0NL commented Dec 13, 2018

SerkanYildiz commented Dec 13, 2018

ro0NL left a comment

Choose a reason for hiding this comment

SerkanYildiz commented Dec 17, 2018

nicolas-grekas commented Dec 17, 2018

SerkanYildiz commented Dec 11, 2018 •

edited

nicolas-grekas commented Dec 11, 2018 •

edited

ro0NL Dec 11, 2018 •

edited

SerkanYildiz Dec 12, 2018 •

edited