Merge pull request #113 from php-school/hotfix/event-trigger-order

verifiers and events should trigger in correct order

Author: AydinHassan

src/Event/EventDispatcher.php

@@ -2,7 +2,6 @@
 
 namespace PhpSchool\PhpWorkshop\Event;
 
-use Assert\Assertion;
 use PhpSchool\PhpWorkshop\Result\ResultInterface;
 use PhpSchool\PhpWorkshop\ResultAggregator;
 
@@ -18,11 +17,6 @@ class EventDispatcher
      */
     private $listeners = [];
 
-    /**
-     * @var array
-     */
-    private $verifiers = [];
-
     /**
      * @var ResultAggregator
      */
@@ -48,19 +42,6 @@ public function dispatch(EventInterface $event)
             }
         }
 
-        if (array_key_exists($event->getName(), $this->verifiers)) {
-            foreach ($this->verifiers[$event->getName()] as $verifier) {
-                $result = $verifier($event);
-
-                //return type hints pls
-                if ($result instanceof ResultInterface) {
-                    $this->resultAggregator->add($result);
-                } else {
-                    //??!!
-                }
-            }
-        }
-
         return $event;
     }
 
@@ -94,14 +75,19 @@ private function attachListener($eventName, callable $callback)
 
     /**
      * @param string $eventName
-     * @param callable $callback
+     * @param callable $verifier
      */
-    public function insertVerifier($eventName, callable $callback)
+    public function insertVerifier($eventName, callable $verifier)
     {
-        if (!array_key_exists($eventName, $this->verifiers)) {
-            $this->verifiers[$eventName] = [$callback];
-        } else {
-            $this->verifiers[$eventName][] = $callback;
-        }
+        $this->attachListener($eventName, function (EventInterface $event) use ($verifier) {
+            $result = $verifier($event);
+
+            //return type hints pls
+            if ($result instanceof ResultInterface) {
+                $this->resultAggregator->add($result);
+            } else {
+                //??!!
+            }
+        });
     }
 }

test/Event/EventDispatcherTest.php

@@ -4,6 +4,7 @@
 
 use PhpSchool\PhpWorkshop\Event\Event;
 use PhpSchool\PhpWorkshop\Event\EventDispatcher;
+use PhpSchool\PhpWorkshop\Event\EventInterface;
 use PhpSchool\PhpWorkshop\Result\ResultInterface;
 use PhpSchool\PhpWorkshop\ResultAggregator;
 use PHPUnit_Framework_TestCase;
@@ -44,9 +45,15 @@ public function testOnlyAppropriateListenersAreCalledForEvent()
         $mockCallback2->expects($this->never())
             ->method('doNotInvokeMe');
 
-        $this->eventDispatcher->listen('some-event', [$mockCallback1, 'callback']);
-        $this->eventDispatcher->listen('some-event', [$mockCallback1, 'callback']);
-        $this->eventDispatcher->listen('different-event', [$mockCallback2, 'doNotInvokeMe']);
+        $cb = function (Event $e) use ($mockCallback1) {
+            $mockCallback1->callback($e);
+        };
+
+        $this->eventDispatcher->listen('some-event', $cb);
+        $this->eventDispatcher->listen('some-event', $cb);
+        $this->eventDispatcher->listen('different-event', function (Event $e) use ($mockCallback2) {
+            $mockCallback2->doNotInvokeMe($e);
+        });
         $this->eventDispatcher->dispatch($e);
     }
 
@@ -61,8 +68,12 @@ public function testOnlyAppropriateVerifiersAreCalledForEvent()
             ->with($e)
             ->will($this->returnValue($result));
 
-        $this->eventDispatcher->insertVerifier('some-event', [$mockCallback1, 'callback']);
-        $this->eventDispatcher->insertVerifier('some-event', [$mockCallback1, 'callback']);
+        $cb = function (Event $e) use ($mockCallback1) {
+            return $mockCallback1->callback($e);
+        };
+
+        $this->eventDispatcher->insertVerifier('some-event', $cb);
+        $this->eventDispatcher->insertVerifier('some-event', $cb);
         $this->eventDispatcher->dispatch($e);
 
         $this->assertEquals([$result, $result], iterator_to_array($this->results));
@@ -77,7 +88,9 @@ public function testVerifyReturnIsSkippedIfNotInstanceOfResult()
             ->with($e)
             ->will($this->returnValue(null));
 
-        $this->eventDispatcher->insertVerifier('some-event', [$mockCallback1, 'callback']);
+        $this->eventDispatcher->insertVerifier('some-event', function (Event $e) use ($mockCallback1) {
+            $mockCallback1->callback($e);
+        });
         $this->eventDispatcher->dispatch($e);
 
         $this->assertEquals([], iterator_to_array($this->results));
@@ -97,4 +110,23 @@ public function testListenWithMultipleEvents()
         $this->eventDispatcher->dispatch($e1);
         $this->eventDispatcher->dispatch($e2);
     }
+
+    public function testListenersAndVerifiersAreCalledInOrderOfAttachment()
+    {
+        $e1 = new Event('first-event', ['arg1' => 1, 'arg2' => 2]);
+
+
+        $counter = 0;
+        $this->eventDispatcher->insertVerifier('first-event', function (Event $e) use (&$counter) {
+            $this->assertEquals(0, $counter);
+            $counter++;
+        });
+
+        $this->eventDispatcher->listen('first-event', function (Event $e) use (&$counter) {
+            $this->assertEquals(1, $counter);
+            $counter++;
+        });
+
+        $this->eventDispatcher->dispatch($e1);
+    }
 }