Merge pull request #261 from gsteel/filter-chain-and-build-vs-get

Fix filters registered under `services` cannot be found (no factory)

Author: gsteel

composer.json

@@ -46,13 +46,13 @@
         "ext-bz2": "*",
         "ext-zlib": "*",
         "ext-zip": "*",
-        "laminas/laminas-coding-standard": "^3.0.1",
+        "laminas/laminas-coding-standard": "^3.1.0",
         "laminas/laminas-diactoros": "^3.6",
-        "pear/archive_tar": "^1.5.0",
+        "pear/archive_tar": "^1.6.0",
         "pear/pear": "^1.10.16",
-        "phpunit/phpunit": "^10.5.46",
+        "phpunit/phpunit": "^10.5.51",
         "psalm/plugin-phpunit": "^0.19.5",
-        "vimeo/psalm": "^6.10.3"
+        "vimeo/psalm": "^6.13.1"
     },
     "suggest": {
         "laminas/laminas-i18n": "Laminas\\I18n component for filters depending on i18n functionality",

composer.lock

@@ -84,8 +84,13 @@ public function attach(FilterInterface|callable $callback, int $priority = self:
 
     public function attachByName(string $name, array $options = [], int $priority = self::DEFAULT_PRIORITY): self
     {
-        /** @psalm-var FilterInterface $filter */
-        $filter = $this->plugins->build($name, $options);
+        if ($options === []) {
+            /** @psalm-var FilterInterface $filter */
+            $filter = $this->plugins->get($name);
+        } else {
+            /** @psalm-var FilterInterface $filter */
+            $filter = $this->plugins->build($name, $options);
+        }
 
         return $this->attach($filter, $priority);
     }

src/FilterChain.php

@@ -96,8 +96,14 @@ public function attach(FilterInterface|callable $callback, int $priority = self:
 
     public function attachByName(string $name, array $options = [], int $priority = self::DEFAULT_PRIORITY): self
     {
-        /** @psalm-var FilterInterface $filter */
-        $filter  = $this->pluginManager->build($name, $options);
+        if ($options === []) {
+            /** @psalm-var FilterInterface $filter */
+            $filter = $this->pluginManager->get($name);
+        } else {
+            /** @psalm-var FilterInterface $filter */
+            $filter = $this->pluginManager->build($name, $options);
+        }
+
         $filters = clone $this->filters;
         $filters->insert($filter, $priority);
 

src/ImmutableFilterChain.php

@@ -23,14 +23,21 @@
 
 /**
  * @psalm-import-type FilterChainConfiguration from FilterChain
+ * @psalm-import-type ServiceManagerConfiguration from ServiceManager
  */
 final class FilterChainTest extends TestCase
 {
     private FilterPluginManager $plugins;
 
     protected function setUp(): void
     {
-        $this->plugins = new FilterPluginManager(new ServiceManager());
+        $this->plugins = self::pluginManagerWithConfig();
+    }
+
+    /** @param ServiceManagerConfiguration $config */
+    private static function pluginManagerWithConfig(array $config = []): FilterPluginManager
+    {
+        return new FilterPluginManager(new ServiceManager(), $config);
     }
 
     public function testEmptyFilterChainReturnsOriginalValue(): void
@@ -238,4 +245,24 @@ public function testFilterChainSpecAcceptsFilterInstances(): void
         $filters = iterator_to_array($chain);
         self::assertSame([0 => $filter], $filters);
     }
+
+    public function testServiceManagerServicesCanBeUsedInChains(): void
+    {
+        $closure = static fn (mixed $value): mixed => $value;
+        $plugins = self::pluginManagerWithConfig([
+            'services' => [
+                'custom' => $closure,
+            ],
+        ]);
+
+        $chain = iterator_to_array(new FilterChain($plugins, [
+            'filters' => [
+                ['name' => StringTrim::class],
+                ['name' => 'custom'],
+            ],
+        ]), false);
+
+        self::assertCount(2, $chain);
+        self::assertSame($closure, $chain[1]);
+    }
 }

test/FilterChainTest.php

@@ -8,21 +8,32 @@
 use Laminas\Filter\ImmutableFilterChain;
 use Laminas\Filter\StringPrefix;
 use Laminas\Filter\StringToLower;
+use Laminas\Filter\StringTrim;
 use Laminas\ServiceManager\ServiceManager;
 use PHPUnit\Framework\TestCase;
 
 use function implode;
 use function str_replace;
 use function str_split;
+use function strrev;
 
-/** @psalm-import-type InstanceType from ImmutableFilterChain */
+/**
+ * @psalm-import-type InstanceType from ImmutableFilterChain
+ * @psalm-import-type ServiceManagerConfiguration from ServiceManager
+ */
 final class ImmutableFilterChainTest extends TestCase
 {
     private FilterPluginManager $plugins;
 
     protected function setUp(): void
     {
-        $this->plugins = new FilterPluginManager(new ServiceManager());
+        $this->plugins = self::pluginManagerWithConfig();
+    }
+
+    /** @param ServiceManagerConfiguration $config */
+    private static function pluginManagerWithConfig(array $config = []): FilterPluginManager
+    {
+        return new FilterPluginManager(new ServiceManager(), $config);
     }
 
     public function testThatFiltersWillBeRetrievedFromThePluginManager(): void
@@ -145,4 +156,22 @@ public function testSpecificationWithFilterInstancesInCallbacks(): void
 
         self::assertSame('Foofoo', $chain->filter('Foo'));
     }
+
+    public function testServiceManagerServicesCanBeUsedInChains(): void
+    {
+        $plugins = self::pluginManagerWithConfig([
+            'services' => [
+                'custom' => static fn (string $value): string => strrev($value),
+            ],
+        ]);
+
+        $chain = ImmutableFilterChain::fromArray([
+            'filters' => [
+                ['name' => StringTrim::class],
+                ['name' => 'custom'],
+            ],
+        ], $plugins);
+
+        self::assertSame('oof', $chain->filter('  foo  '));
+    }
 }