qa: provide tests for ReflectionBasedListenerProvider

Creates ReflectionBasedListenerProviderTest to test the various
behaviors of the provider. Discovered a typo in a function name, which
led to a fix. Added `PhlyTest\EventDispatcher\TestAsset\Listener` and
`listenerFunction` to help test the class.

Author: weierophinney

composer.json

@@ -37,6 +37,9 @@
         }
     },
     "autoload-dev": {
+        "files": [
+            "test/TestAsset/listener_function.php"
+        ],
         "psr-4": {
             "PhlyTest\\EventDispatcher\\": "test/"
         }

src/ListenerProvider/ReflectionBasedListenerProvider.php

@@ -25,6 +25,7 @@
 
 class ReflectionBasedListenerProvider implements ReflectableListenerProviderInterface
 {
+    /** @var array<string, callable[]> */
     private $listeners = [];
 
     public function getListenersForEvent(object $event) : iterable
@@ -80,7 +81,7 @@ private function getReflector(callable $listener) : ReflectionFunctionAbstract
             return new ReflectionMethod($listener, '__invoke');
         }
 
-        if (is_string($listener) && false !== stpros($listener, '::')) {
+        if (is_string($listener) && false !== strpos($listener, '::')) {
             $listener = explode('::', $listener, 2);
         }
 

test/ListenerProvider/ReflectionBasedListenerProviderTest.php

@@ -0,0 +1,111 @@
+<?php
+/**
+ * @see       https://github.com/phly/phly-event-dispatcher for the canonical source repository
+ * @copyright Copyright (c) 2018-2019 Matthew Weier O'Phinney (https:/mwop.net)
+ * @license   https://github.com/phly/phly-event-dispatcher/blob/master/LICENSE.md New BSD License
+ */
+
+declare(strict_types=1);
+
+namespace PhlyTest\EventDispatcher\ListenerProvider;
+
+use InvalidArgumentException;
+use Phly\EventDispatcher\ListenerProvider\ReflectionBasedListenerProvider;
+use PhlyTest\EventDispatcher\TestAsset\TestEvent;
+use PhlyTest\EventDispatcher\TestAsset\Listener;
+use PHPUnit\Framework\TestCase;
+
+use function PhlyTest\EventDispatcher\TestAsset\listenerFunction;
+
+class ReflectionBasedListenerProviderTest extends TestCase
+{
+    public function testCanAttachWithExplicitType()
+    {
+        $listener = function ($event) {
+        };
+        $provider = new ReflectionBasedListenerProvider();
+        $provider->listen($listener, TestEvent::class);
+
+        $listeners = iterator_to_array($provider->getListenersForEvent(new TestEvent()));
+
+        $this->assertSame([$listener], $listeners);
+    }
+
+    public function testProviderDetectsTypeFromClosure()
+    {
+        $listener = function (TestEvent $event) {
+        };
+        $provider = new ReflectionBasedListenerProvider();
+        $provider->listen($listener);
+
+        $listeners = iterator_to_array($provider->getListenersForEvent(new TestEvent()));
+
+        $this->assertSame([$listener], $listeners);
+    }
+
+    public function testProviderDetectsTypeFromFunctionName()
+    {
+        $provider = new ReflectionBasedListenerProvider();
+        $provider->listen('PhlyTest\EventDispatcher\TestAsset\listenerFunction');
+
+        $listeners = iterator_to_array($provider->getListenersForEvent(new TestEvent()));
+
+        $this->assertSame(['PhlyTest\EventDispatcher\TestAsset\listenerFunction'], $listeners);
+    }
+
+    public function testProviderDetectsTypeFromStaticMethodName()
+    {
+        $listener = Listener::class . '::onStatic';
+        $provider = new ReflectionBasedListenerProvider();
+        $provider->listen($listener);
+
+        $listeners = iterator_to_array($provider->getListenersForEvent(new TestEvent()));
+
+        $this->assertSame([$listener], $listeners);
+    }
+
+    public function testProviderDetectsTypeFromArrayStaticMethod()
+    {
+        $listener = [Listener::class, 'onStatic'];
+        $provider = new ReflectionBasedListenerProvider();
+        $provider->listen($listener);
+
+        $listeners = iterator_to_array($provider->getListenersForEvent(new TestEvent()));
+
+        $this->assertSame([$listener], $listeners);
+    }
+
+    public function testProviderDetectsTypeFromArrayInstanceMethod()
+    {
+        $instance = new Listener();
+        $listener = [$instance, 'onTest'];
+        $provider = new ReflectionBasedListenerProvider();
+        $provider->listen($listener);
+
+        $listeners = iterator_to_array($provider->getListenersForEvent(new TestEvent()));
+
+        $this->assertSame([$listener], $listeners);
+    }
+
+    public function testProviderDetectsTypeFromInvokableInstance()
+    {
+        $listener = new Listener();
+        $provider = new ReflectionBasedListenerProvider();
+        $provider->listen($listener);
+
+        $listeners = iterator_to_array($provider->getListenersForEvent(new TestEvent()));
+
+        $this->assertSame([$listener], $listeners);
+    }
+
+    public function testListenRaisesExceptionIfUnableToDetermineEventType()
+    {
+        $listener = function ($event) {
+        };
+        $provider = new ReflectionBasedListenerProvider();
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Missing event parameter for listener');
+        $provider->listen($listener);
+    }
+}

test/TestAsset/Listener.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * @see       https://github.com/phly/phly-event-dispatcher for the canonical source repository
+ * @copyright Copyright (c) 2018-2019 Matthew Weier O'Phinney (https:/mwop.net)
+ * @license   https://github.com/phly/phly-event-dispatcher/blob/master/LICENSE.md New BSD License
+ */
+
+declare(strict_types=1);
+
+namespace PhlyTest\EventDispatcher\TestAsset;
+
+class Listener
+{
+    public function __invoke(TestEvent $e) : void
+    {
+    }
+
+    public function onTest(TestEvent $e) : void
+    {
+    }
+
+    public static function onStatic(TestEvent $e) : void
+    {
+    }
+}

test/TestAsset/listener_function.php

@@ -0,0 +1,14 @@
+<?php
+/**
+ * @see       https://github.com/phly/phly-event-dispatcher for the canonical source repository
+ * @copyright Copyright (c) 2018-2019 Matthew Weier O'Phinney (https:/mwop.net)
+ * @license   https://github.com/phly/phly-event-dispatcher/blob/master/LICENSE.md New BSD License
+ */
+
+declare(strict_types=1);
+
+namespace PhlyTest\EventDispatcher\TestAsset;
+
+function listenerFunction(TestEvent $e) : void
+{
+}