8000 bug #27177 Rename middlewares to middleware (fabpot, sroze) · symfony/symfony@388d684 · GitHub
[go: up one dir, main page]
Skip to content

Commit 388d684

Browse files
srozesroze
committed
bug #27177 Rename middlewares to middleware (fabpot, sroze)
This PR was merged into the 4.1-dev branch. Discussion ---------- Rename middlewares to middleware | Q | A | ------------- | --- | Branch? | master | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a `middleware` is uncountable in English (like software or information). So, I've removed the `s` everywhere. We can probably be a bit more explicit if we think it makes thing easier to understand like I've done in one class, like `middlewareHandler`. Commits ------- 9ae7c11 Do not fix the `middleware` XML name anymore 52e7500 removed usage of middlewares
2 parents 559c914 + 9ae7c11 commit 388d684

File tree

13 files changed

+45
-40
lines changed

13 files changed

+45
-40
lines changed

‎src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1047,14 +1047,19 @@ function ($a) {
10471047
->end()
10481048
->scalarNode('default_bus')->defaultValue(null)->end()
10491049
->arrayNode('buses')
1050-
->defaultValue(array('default' => array('default_middlewares' => true, 'middlewares' => array())))
1050+
->defaultValue(array('default' => array('default_middleware' => true, 'middleware' => array())))
10511051
->useAttributeAsKey('name')
10521052
->prototype('array')
1053-
->fixXmlConfig('middleware')
10541053
->addDefaultsIfNotSet()
10551054
->children()
1056-
->booleanNode('default_middlewares')->defaultTrue()->end()
1057-
->arrayNode('middlewares')
1055+
->booleanNode('default_middleware')->defaultTrue()->end()
1056+
->arrayNod B41A e('middleware')
1057+
->beforeNormalization()
1058+
->ifString()
1059+
->then(function (string $middleware) {
1060+
return array($middleware);
1061+
})
1062+
->end()
10581063
->defaultValue(array())
10591064
->prototype('scalar')->end()
10601065
->end()

‎src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1469,15 +1469,15 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder
14691469
$config['default_bus'] = key($config['buses']);
14701470
}
14711471

1472-
$defaultMiddlewares = array('before' => array('logging'), 'after' => array('route_messages', 'call_message_handler'));
1472+
$defaultMiddleware = array('before' => array('logging'), 'after' => array('route_messages', 'call_message_handler'));
14731473
foreach ($config['buses'] as $busId => $bus) {
1474-
$middlewares = $bus['default_middlewares'] ? array_merge($defaultMiddlewares['before'], $bus['middlewares'], $defaultMiddlewares['after']) : $bus['middlewares'];
1474+
$middleware = $bus['default_middleware'] ? array_merge($defaultMiddleware['before'], $bus['middleware'], $defaultMiddleware['after']) : $bus['middleware'];
14751475

1476-
if (!$validationConfig['enabled'] && \in_array('messenger.middleware.validation', $middlewares, true)) {
1476+
if (!$validationConfig['enabled'] && \in_array('messenger.middleware.validation', $middleware, true)) {
14771477
throw new LogicException('The Validation middleware is only available when the Validator component is installed and enabled. Try running "composer require symfony/validator".');
14781478
}
14791479

1480-
$container->setParameter($busId.'.middlewares', $middlewares);
1480+
$container->setParameter($busId.'.middleware', $middleware);
14811481
$container->setDefinition($busId, (new Definition(MessageBus::class, array(array())))->addTag('messenger.bus'));
14821482

14831483
if ($busId === $config['default_bus']) {

‎src/Symfony/Bundle/FrameworkBundle/Resources/config/messenger.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<argument type="collection" /> <!-- Context -->
2929
</service>
3030

31-
<!-- Middlewares -->
31+
<!-- Middleware -->
3232
<service id="messenger.middleware.allow_no_handler" class="Symfony\Component\Messenger\Middleware\AllowNoHandlerMiddleware" abstract="true" />
3333
<service id="messenger.middleware.call_message_handler" class="Symfony\Component\Messenger\Middleware\HandleMessageMiddleware" abstract="true">
3434
<argument type="service" id="messenger.handler_resolver" />

‎src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -394,6 +394,6 @@
394394
<xsd:element name="middleware" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
395395
</xsd:sequence>
396396
<xsd:attribute name="name" type="xsd:string" use="required"/>
397-
<xsd:attribute name="default-middlewares" type="xsd:boolean"/>
397+
<xsd:attribute name="default-middleware" type="xsd:boolean"/>
398398
</xsd:complexType>
399399
</xsd:schema>

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ class_exists(SemaphoreStore::class) && SemaphoreStore::isSupported() ? 'semaphor
263263
'encoder' => 'messenger.transport.serializer',
264264
'decoder' => 'messenger.transport.serializer',
265265
'default_bus' => null,
266-
'buses' => array('default' => array('default_middlewares' => true, 'middlewares' => array())),
266+
'buses' => array('default' => array('default_middleware' => true, 'middleware' => array())),
267267
),
268268
);
269269
}

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/messenger_multiple_buses.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66
'buses' => array(
77
'messenger.bus.commands' => null,
88
'messenger.bus.events' => array(
9-
'middlewares' => array(
9+
'middleware' => array(
1010
'allow_no_handler',
1111
),
1212
),
1313
'messenger.bus.queries' => array(
14-
'default_middlewares' => false,
15-
'middlewares' => array(
14+
'default_middleware' => false,
15+
'middleware' => array(
1616
'route_messages',
1717
'allow_no_handler',
1818
'call_message_handler',

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/messenger_multiple_buses.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<framework:bus name="messenger.bus.events">
1212
<framework:middleware>allow_no_handler</framework:middleware>
1313
</framework:bus>
14-
<framework:bus name="messenger.bus.queries" default-middlewares="false">
14+
<framework:bus name="messenger.bus.queries" default-middleware="false">
1515
<framework:middleware>route_messages</framework:middleware>
1616
<framework:middleware>allow_no_handler</framework:middleware>
1717
<framework:middleware>call_message_handler</framework:middleware>

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/messenger_multiple_buses.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ framework:
44
buses:
55
messenger.bus.commands: ~
66
messenger.bus.events:
7-
middlewares:
7+
middleware:
88
- "allow_no_handler"
99
messenger.bus.queries:
10-
default_middlewares: false
11-
middlewares:
10+
default_middleware: false
11+
middleware:
1212
- "route_messages"
1313
- "allow_no_handler"
1414
- "call_message_handler"

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -611,13 +611,13 @@ public function testMessengerWithMultipleBuses()
611611

612612
$this->assertTrue($container->has('messenger.bus.commands'));
613613
$this->assertSame(array(), $container->getDefinition('messenger.bus.commands')->getArgument(0));
614-
$this->assertEquals(array('logging', 'route_messages', 'call_message_handler'), $container->getParameter('messenger.bus.commands.middlewares'));
614+
$this->assertEquals(array('logging', 'route_messages', 'call_message_handler'), $container->getParameter('messenger.bus.commands.middleware'));
615615
$this->assertTrue($container->has('messenger.bus.events'));
616616
$this->assertSame(array(), $container->getDefinition('messenger.bus.events')->getArgument(0));
617-
$this->assertEquals(array('logging', 'allow_no_handler', 'route_messages', 'call_message_handler'), $container->getParameter('messenger.bus.events.middlewares'));
617+
$this->assertEquals(array('logging', 'allow_no_handler', 'route_messages', 'call_message_handler'), $container->getParameter('messenger.bus.events.middleware'));
618618
$this->assertTrue($container->has('messenger.bus.queries'));
619619
$this->assertSame(array(), $container->getDefinition('messenger.bus.queries')->getArgument(0));
620-
$this->assertEquals(array('route_messages', 'allow_no_handler', 'call_message_handler'), $container->getParameter('messenger.bus.queries.middlewares'));
620+
$this->assertEquals(array('route_messages', 'allow_no_handler', 'call_message_handler'), $container->getParameter('messenger.bus.queries.middleware'));
621621

622622
$this->assertTrue($container->hasAlias('message_bus'));
623623
$this->assertSame('messenger.bus.commands', (string) $container->getAlias('message_bus'));

‎src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@ public function process(ContainerBuilder $container)
5454
}
5555

5656
foreach ($container->findTaggedServiceIds($this->busTag) as $busId => $tags) {
57-
if ($container->hasParameter($busMiddlewaresParameter = $busId.'.middlewares')) {
58-
$this->registerBusMiddlewares($container, $busId, $container->getParameter($busMiddlewaresParameter));
57+
if ($container->hasParameter($busMiddlewareParameter = $busId.'.middleware')) {
58+
$this->registerBusMiddleware($container, $busId, $container->getParameter($busMiddlewareParameter));
5959

60-
$container->getParameterBag()->remove($busMiddlewaresParameter);
60+
$container->getParameterBag()->remove($busMiddlewareParameter);
6161
}
6262

6363
if ($container->hasDefinition('messenger.data_collector')) {
@@ -200,7 +200,7 @@ private function registerBusToCollector(ContainerBuilder $container, string $bus
200200
$container->getDefinition('messenger.data_collector')->addMethodCall('registerBus', array($busId, new Reference($tracedBusId)));
201201
}
202202

203-
private function registerBusMiddlewares(ContainerBuilder $container, string $busId, array $middlewares)
203+
private function registerBusMiddleware(ContainerBuilder $container, string $busId, array $middleware)
204204
{
205205
$container->getDefinition($busId)->replaceArgument(0, array_map(function (string $name) use ($container, $busId) {
206206
if (!$container->has($messengerMiddlewareId = 'messenger.middleware.'.$name)) {
@@ -218,6 +218,6 @@ private function registerBusMiddlewares(ContainerBuilder $container, string $bus
218218
}
219219

220220
return new Reference($messengerMiddlewareId);
221-
}, $middlewares));
221+
}, $middleware));
222222
}
223223
}

‎src/Symfony/Component/Messenger/MessageBus.php

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,19 @@
1919
*/
2020
class MessageBus implements MessageBusInterface
2121
{
22-
private $middlewares;
22+
private $middlewareHandlers;
2323

2424
/**
2525
* @var MiddlewareInterface[]|null
2626
*/
27-
private $indexedMiddlewares;
27+
private $indexedMiddlewareHandlers;
2828

2929
/**
30-
* @param MiddlewareInterface[]|iterable $middlewares
30+
* @param MiddlewareInterface[]|iterable $middlewareHandlers
3131
*/
32-
public function __construct(iterable $middlewares = array())
32+
public function __construct(iterable $middlewareHandlers = array())
3333
{
34-
$this->middlewares = $middlewares;
34+
$this->middlewareHandlers = $middlewareHandlers;
3535
}
3636

3737
/**
@@ -44,15 +44,15 @@ public function dispatch($message)
4444

4545
private function callableForNextMiddleware(int $index): callable
4646
{
47-
if (null === $this->indexedMiddlewares) {
48-
$this->indexedMiddlewares = \is_array($this->middlewares) ? array_values($this->middlewares) : iterator_to_array($this->middlewares, false);
47+
if (null === $this->indexedMiddlewareHandlers) {
48+
$this->indexedMiddlewareHandlers = \is_array($this->middlewareHandlers) ? array_values($this->middlewareHandlers) : iterator_to_array($this->middlewareHandlers, false);
4949
}
5050

51-
if (!isset($this->indexedMiddlewares[$index])) {
51+
if (!isset($this->indexedMiddlewareHandlers[$index])) {
5252
return function () {};
5353
}
5454

55-
$middleware = $this->indexedMiddlewares[$index];
55+
$middleware = $this->indexedMiddlewareHandlers[$index];
5656

5757
return function ($message) use ($middleware, $index) {
5858
return $middleware->handle($message, $this->callableForNextMiddleware($index + 1));

‎src/Symfony/Component/Messenger/Tests/DependencyInjection/MessengerPassTest.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -257,20 +257,20 @@ public function testRegistersTraceableBusesToCollector()
257257
$this->assertEquals(array(array('registerBus', array($fooBusId, new Reference($debuggedFooBusId)))), $container->getDefinition('messenger.data_collector')->getMethodCalls());
258258
}
259259

260-
public function testRegistersMiddlewaresFromServices()
260+
public function testRegistersMiddlewareFromServices()
261261
{
262262
$container = $this->getContainerBuilder();
263263
$container->register($fooBusId = 'messenger.bus.foo', MessageBusInterface::class)->setArgument(0, array())->addTag('messenger.bus');
264264
$container->register('messenger.middleware.allow_no_handler', AllowNoHandlerMiddleware::class)->setAbstract(true);
265265
$container->register(UselessMiddleware::class, UselessMiddleware::class);
266266

267-
$container->setParameter($middlewaresParameter = $fooBusId.'.middlewares', array(UselessMiddleware::class, 'allow_no_handler'));
267+
$container->setParameter($middlewareParameter = $fooBusId.'.middleware', array(UselessMiddleware::class, 'allow_no_handler'));
268268

269269
(new MessengerPass())->process($container);
270270

271271
$this->assertTrue($container->hasDefinition($childMiddlewareId = $fooBusId.'.middleware.allow_no_handler'));
272272
$this->assertEquals(array(new Reference(UselessMiddleware::class), new Reference($childMiddlewareId)), $container->getDefinition($fooBusId)->getArgument(0));
273-
$this->assertFalse($container->hasParameter($middlewaresParameter));
273+
$this->assertFalse($container->hasParameter($middlewareParameter));
274274
}
275275

276276
/**
@@ -281,7 +281,7 @@ public function testCannotRegistersAnUndefinedMiddleware()
281281
{
282282
$container = $this->getContainerBuilder();
283283
$container->register($fooBusId = 'messenger.bus.foo', MessageBusInterface::class)->setArgument(0, array())->addTag('messenger.bus');
284-
$container->setParameter($middlewaresParameter = $fooBusId.'.middlewares', array('not_defined_middleware'));
284+
$container->setParameter($middlewareParameter = $fooBusId.'.middleware', array('not_defined_middleware'));
285285

286286
(new MessengerPass())->process($container);
287287
}

‎src/Symfony/Component/Messenger/Tests/MessageBusTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public function testItHasTheRightInterface()
2626
$this->assertInstanceOf(MessageBusInterface::class, $bus);
2727
}
2828

29-
public function testItCallsTheMiddlewaresAndChainTheReturnValue()
29+
public function testItCallsMiddlewareAndChainTheReturnValue()
3030
{
3131
$message = new DummyMessage('Hello');
3232
$responseFromDepthMiddleware = 1234;

0 commit comments

Comments
 (0)
0