[DI][DX] Allow exclude to be an array of patterns #27075

magnetik · 2018-04-27T13:46:13Z

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

This is basically continuing #24428.

In YAML before:

AppBundle\:
  resource: '../../src/AppBundle/*'
  exclude: '../../src/AppBundle/{Entity,Payload,Repository}'

in YAML after:

AppBundle\:
  resource: '../../src/AppBundle/*'
  exclude:
    - '../../src/AppBundle/{Entity,Payload,Repository}'
    - '../../src/AppBundle/Event/*Event.php'

In XML before:

<prototype namespace="App\" resource="../src/*" exclude="../src/{Entity,Migrations,Tests}" />

in XML after:

<prototype namespace="App\" resource="../src/*">
  <exclude>../src/{Entity,Migrations,Tests}</exclude>
  <exclude>../src/Yolo</exclude>
</prototype>

In PHP before:

$di->load(Prototype::class.'\\', '../Prototype')
        ->autoconfigure()
        ->exclude('../Prototype/{OtherDir,BadClasses}')

In PHP after:

    $di->load(Prototype::class.'\\', '../Prototype')
        ->autoconfigure()
        ->exclude(['../Prototype/OtherDir', '../Prototype/BadClasses'])

Everything is backward compatible.
Maybe a decision about handling both attribute exclude and element exclude in XML should be taken.

linaori · 2018-04-27T20:37:43Z

Ah nice, this will make life a lot easier for complex exclusion rules in existing codebases!

nicolas-grekas

looks great, thanks for taking over!

nicolas-grekas · 2018-04-27T20:53:59Z

src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php

@@ -146,7 +146,16 @@ private function parseDefinitions(\DOMDocument $xml, $file, $defaults)
        foreach ($services as $service) {
            if (null !== $definition = $this->parseDefinition($service, $file, $defaults)) {
                if ('prototype' === $service->tagName) {
-                    $this->registerClasses($definition, (string) $service->getAttribute('namespace'), (string) $service->getAttribute('resource'), (string) $service->getAttribute('exclude'));
+                    $excludes = array_map(function ($node) { return $node->nodeValue; }, $this->getChildren($service, 'exclude'));


would array_column work here instead of array_map?

nope. We need a property access, not an array access

nicolas-grekas · 2018-04-27T20:55:05Z

src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php

+                    if ($service->hasAttribute('exclude')) {
+                        $excludes[] = (string) $service->getAttribute('exclude');
+                    }
+                    $this->registerClasses(


should be kept on one line - it would better fit our CS IMHO

nicolas-grekas · 2018-04-27T20:55:28Z

src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php

+                        $definition,
+                        (string) $service->getAttribute('namespace'),
+                        (string) $service->getAttribute('resource'),
+                        (array) $excludes


it's already an array, no need to cast I suppose

nicolas-grekas · 2018-04-27T20:56:04Z

src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php

@@ -146,7 +146,16 @@ private function parseDefinitions(\DOMDocument $xml, $file, $defaults)
        foreach ($services as $service) {
            if (null !== $definition = $this->parseDefinition($service, $file, $defaults)) {
                if ('prototype' === $service->tagName) {
-                    $this->registerClasses($definition, (string) $service->getAttribute('namespace'), (string) $service->getAttribute('resource'), (string) $service->getAttribute('exclude'));
+                    $excludes = array_map(function ($node) { return $node->nodeValue; }, $this->getChildren($service, 'exclude'));
+                    if ($service->hasAttribute('exclude')) {


I would allow only tags XOR attribute (like done in similar cases in the loader AFAIK

So in cas both are present, should I throw an exception?

I would say yes

TomasVotruba · 2018-05-01T20:51:05Z

This is awesome, great job!

magnetik · 2018-05-02T12:26:42Z

I've updated the PR according to the changes. I'll do a PR for symfony doc too if needed.

stof · 2018-05-02T12:29:25Z

src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php

+                    $excludes = array_column($this->getChildren($service, 'exclude'), 'nodeValue');
+                    if ($service->hasAttribute('exclude')) {
+                        if (count($excludes) > 0) {
+                            throw new InvalidArgumentException('You cannot use both attribute "exclude" and <exclude> tags at the same time.');


both the "exclude" attribute and ...

nicolas-grekas

(would be OK on 4.1 on my side, the topic has been on the table for a few months already).

ogizanagi

Same, would be great to have this in 4.1. We already missed the opportunity to have it in 3.4/4.0.
Thanks for taking over @magnetik .

chalasr

👍 for 4.1

fabpot · 2018-05-09T15:52:15Z

src/Symfony/Component/DependencyInjection/Loader/FileLoader.php

+     * @param Definition           $prototype A definition to use as template
+     * @param string               $namespace The namespace prefix of classes in the scanned directory
+     * @param string               $resource  The directory to look for classes, glob-patterns allowed
+     * @param string|string[]|null $exclude   A globed path of files to exclude or an array of globed paths of files to exclude


globbed? (not sure but I think so)

done (both occurrences)

… over)

fabpot · 2018-05-09T16:25:36Z

Thank you @magnetik.

…netik) This PR was merged into the 4.2-dev branch. Discussion ---------- [DI][DX] Allow exclude to be an array of patterns | Q | A | ------------- | --- | Branch? | 4.2 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #23956 | License | MIT This is basically continuing #24428. In YAML before: ```yaml AppBundle\: resource: '../../src/AppBundle/*' exclude: '../../src/AppBundle/{Entity,Payload,Repository}' ``` in YAML after: ```yaml AppBundle\: resource: '../../src/AppBundle/*' exclude: - '../../src/AppBundle/{Entity,Payload,Repository}' - '../../src/AppBundle/Event/*Event.php' ``` In XML before: ```xml <prototype namespace="App\" resource="../src/*" exclude="../src/{Entity,Migrations,Tests}" /> ``` in XML after: ```xml <prototype namespace="App\" resource="../src/*"> <exclude>../src/{Entity,Migrations,Tests}</exclude> <exclude>../src/Yolo</exclude> </prototype> ``` In PHP before: ```php $di->load(Prototype::class.'\\', '../Prototype') ->autoconfigure() ->exclude('../Prototype/{OtherDir,BadClasses}') ``` In PHP after: ```php $di->load(Prototype::class.'\\', '../Prototype') ->autoconfigure() ->exclude(['../Prototype/OtherDir', '../Prototype/BadClasses']) ``` Everything is backward compatible. Maybe a decision about handling both attribute exclude and element exclude in XML should be taken. Commits ------- 3ae3a03 [DI][DX] Allow exclude to be an array of patterns (taking #24428 over)

carsonbot added Status: Needs Review DependencyInjection DX DX = Developer eXperience (anything that improves the experience of using Symfony) Feature Deprecation labels Apr 27, 2018

magnetik force-pushed the exclude-array branch 2 times, most recently from a879aad to 029b553 Compare April 27, 2018 13:59

nicolas-grekas reviewed Apr 27, 2018

View reviewed changes

nicolas-grekas mentioned this pull request Apr 27, 2018

[DI][DX] Allow exclude to be an array of patterns #24428

Closed

nicolas-grekas added this to the next milestone Apr 29, 2018

magnetik force-pushed the exclude-array branch 2 times, most recently from 3a287e2 to 246640f Compare May 2, 2018 12:14

stof reviewed May 2, 2018

View reviewed changes

magnetik force-pushed the exclude-array branch from 246640f to c8e2f67 Compare May 2, 2018 12:32

carsonbot added Status: Reviewed and removed Status: Needs Review labels May 4, 2018

nicolas-grekas approved these changes May 4, 2018

View reviewed changes

nicolas-grekas changed the title ~~[DI][DX] Allow exclude to be an array of patterns (taking #24428 over)~~ [DI][DX] Allow exclude to be an array of patterns May 4, 2018

ogizanagi approved these changes May 4, 2018

View reviewed changes

ogizanagi removed the Deprecation label May 4, 2018

chalasr approved these changes May 4, 2018

View reviewed changes

fabpot requested changes May 9, 2018

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Reviewed labels May 9, 2018

magnetik force-pushed the exclude-array branch from c8e2f67 to 9f72b8d Compare May 9, 2018 15:58

[DI][DX] Allow exclude to be an array of patterns (taking symfony#24428…

3ae3a03

… over)

magnetik force-pushed the exclude-array branch from 9f72b8d to 3ae3a03 Compare May 9, 2018 16:01

fabpot approved these changes May 9, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels May 9, 2018

fabpot merged commit 3ae3a03 into symfony:master May 9, 2018

weaverryan mentioned this pull request May 10, 2018

[DI] Ability to exclude an array of paths when auto-registering resources symfony/symfony-docs#9758

Closed

vyshkant mentioned this pull request Oct 12, 2018

Exclude alpha-import entities from services container inslav/polesian-archive#4

Closed

1 task

nicolas-grekas modified the milestones: next, 4.1 Nov 1, 2018

This was referenced Nov 3, 2018

Release v4.2.0-BETA1 #29072

Closed

Release v4.2.0-BETA1 #29073

Merged

nicolas-grekas mentioned this pull request Apr 4, 2019

[DI] Have a better DX for excluded resources #30865

Closed

ogizanagi mentioned this pull request Jul 16, 2020

[FrameworkBundle] Use an array for exclude directive symfony/recipes#802

Merged

ogizanagi mentioned this pull request Jul 6, 2021

[DI][DX] Allow exclude to be an array of patterns #23956

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DI][DX] Allow exclude to be an array of patterns #27075

[DI][DX] Allow exclude to be an array of patterns #27075

magnetik commented Apr 27, 2018 •

edited by stof

Loading

linaori commented Apr 27, 2018

nicolas-grekas left a comment

nicolas-grekas Apr 27, 2018

stof May 2, 2018

nicolas-grekas Apr 27, 2018

nicolas-grekas Apr 27, 2018

nicolas-grekas Apr 27, 2018

magnetik May 2, 2018

stof May 2, 2018

TomasVotruba commented May 1, 2018

magnetik commented May 2, 2018

stof May 2, 2018

magnetik May 2, 2018

nicolas-grekas left a comment

ogizanagi left a comment

chalasr left a comment

fabpot May 9, 2018

magnetik May 9, 2018 •

edited

Loading

fabpot commented May 9, 2018

[DI][DX] Allow exclude to be an array of patterns #27075

[DI][DX] Allow exclude to be an array of patterns #27075

Conversation

magnetik commented Apr 27, 2018 • edited by stof Loading

linaori commented Apr 27, 2018

nicolas-grekas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TomasVotruba commented May 1, 2018

magnetik commented May 2, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas left a comment

Choose a reason for hiding this comment

ogizanagi left a comment

Choose a reason for hiding this comment

chalasr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

magnetik May 9, 2018 • edited Loading

Choose a reason for hiding this comment

fabpot commented May 9, 2018

magnetik commented Apr 27, 2018 •

edited by stof

Loading

magnetik May 9, 2018 •

edited

Loading