Merge pull request #60 from cspray/replace-evenement

refactor to use league/event

composer.json

@@ -23,7 +23,7 @@
     "require": {
         "php": "~7.0",
         "rdlowrey/auryn": "~1.0",
-        "evenement/evenement": "~2.0",
+        "league/event": "~2.1",
         "morrisonlevi/ardent": "dev-master",
         "cspray/telluris": "dev-master",
         "filp/whoops": "~1.1"

src/Cspray/Labrador/CoreEngine.php

@@ -20,7 +20,7 @@
     StandardEventFactory
 };
 use Cspray\Labrador\Plugin\Plugin;
-use Evenement\EventEmitterInterface;
+use League\Event\EmitterInterface;
 use Telluris\Environment;
 
 class CoreEngine implements Engine {
@@ -33,13 +33,13 @@ class CoreEngine implements Engine {
     /**
      * @param Environment $environment
      * @param PluginManager $pluginManager
-     * @param EventEmitterInterface $emitter
+     * @param EmitterInterface $emitter
      * @param EventFactory $eventFactory
      */
     public function __construct(
         Environment $environment,
         PluginManager $pluginManager,
-        EventEmitterInterface $emitter,
+        EmitterInterface $emitter,
         EventFactory $eventFactory = null
     ) {
         $this->environment = $environment;
@@ -48,26 +48,16 @@ public function __construct(
         $this->eventFactory = $eventFactory ?? new StandardEventFactory();
     }
 
-    /**
-     * @return string
-     */
-    public function getName() : string {
-        return 'labrador-core';
-    }
-
-    /**
-     * @return string
-     */
-    public function getVersion() : string {
-        return '0.1.0-alpha';
+    public function getEmitter() : EmitterInterface {
+        return $this->emitter;
     }
 
     public function getEnvironment() : Environment {
         return $this->environment;
     }
 
     public function onEnvironmentInitialize(callable $cb) : self {
-        $this->emitter->on(self::ENVIRONMENT_INITIALIZE_EVENT, $cb);
+        $this->emitter->addListener(self::ENVIRONMENT_INITIALIZE_EVENT, $cb);
         return $this;
     }
 
@@ -76,7 +66,7 @@ public function onEnvironmentInitialize(callable $cb) : self {
      * @return $this
      */
     public function onAppExecute(callable $cb) : self {
-        $this->emitter->on(self::APP_EXECUTE_EVENT, $cb);
+        $this->emitter->addListener(self::APP_EXECUTE_EVENT, $cb);
         return $this;
     }
 
@@ -85,7 +75,7 @@ public function onAppExecute(callable $cb) : self {
      * @return $this
      */
     public function onAppCleanup(callable $cb) : self {
-        $this->emitter->on(self::APP_CLEANUP_EVENT, $cb);
+        $this->emitter->addListener(self::APP_CLEANUP_EVENT, $cb);
         return $this;
     }
 
@@ -94,7 +84,7 @@ public function onAppCleanup(callable $cb) : self {
      * @return $this
      */
     public function onExceptionThrown(callable $cb) : self {
-        $this->emitter->on(self::EXCEPTION_THROWN_EVENT, $cb);
+        $this->emitter->addListener(self::EXCEPTION_THROWN_EVENT, $cb);
         return $this;
     }
 
@@ -106,16 +96,16 @@ public function onExceptionThrown(callable $cb) : self {
     public function run() {
         try {
             $envInitEvent = $this->eventFactory->create(self::ENVIRONMENT_INITIALIZE_EVENT, $this->environment);
-            $this->emitter->emit(self::ENVIRONMENT_INITIALIZE_EVENT, [$envInitEvent, $this]);
+            $this->emitter->emit($envInitEvent, $this);
 
             $appExecuteEvent = $this->eventFactory->create(self::APP_EXECUTE_EVENT);
-            $this->emitter->emit(self::APP_EXECUTE_EVENT, [$appExecuteEvent, $this]);
+            $this->emitter->emit($appExecuteEvent, $this);
         } catch (\Exception $exception) {
             $exceptionEvent = $this->eventFactory->create(self::EXCEPTION_THROWN_EVENT, $exception);
-            $this->emitter->emit(self::EXCEPTION_THROWN_EVENT, [$exceptionEvent, $this]);
+            $this->emitter->emit($exceptionEvent, $this);
         } finally {
             $appCleanupEvent = $this->eventFactory->create(self::APP_CLEANUP_EVENT);
-            $this->emitter->emit(self::APP_CLEANUP_EVENT, [$appCleanupEvent, $this]);
+            $this->emitter->emit($appCleanupEvent, $this);
         }
     }
 

src/Cspray/Labrador/Engine.php

@@ -11,6 +11,7 @@
 namespace Cspray\Labrador;
 
 use Cspray\Labrador\Plugin\Pluggable;
+use League\Event\EmitterInterface;
 
 interface Engine extends Pluggable {
 
@@ -22,18 +23,15 @@ interface Engine extends Pluggable {
     const EXCEPTION_THROWN_EVENT = 'labrador.exception_thrown';
 
     /**
-     * @return string
-     */
-    public function getName() : string;
-
-    /**
-     * Return the version of the Engine; this should be in semver format.
+     * Return the event emitter that will emit the events for this Engine.
      *
-     * @return string
+     * @return EmitterInterface
      */
-    public function getVersion() : string;
+    public function getEmitter() : EmitterInterface;
 
     /**
+     * Perform whatever actions are necessary for this implementation.
+     *
      * @return mixed
      */
     public function run();

src/Cspray/Labrador/Event/AppCleanupEvent.php

@@ -13,6 +13,7 @@
 namespace Cspray\Labrador\Event;
 
 use Cspray\Labrador\Engine;
+use League\Event\Event;
 
 class AppCleanupEvent extends Event {
 

src/Cspray/Labrador/Event/AppExecuteEvent.php

@@ -12,6 +12,7 @@
 namespace Cspray\Labrador\Event;
 
 use Cspray\Labrador\Engine;
+use League\Event\Event;
 
 class AppExecuteEvent extends Event {
 

src/Cspray/Labrador/Event/EnvironmentInitializeEvent.php

@@ -10,6 +10,7 @@
 
 use Cspray\Labrador\Engine;
 use Telluris\Environment;
+use League\Event\Event;
 
 class EnvironmentInitializeEvent extends Event {
 

src/Cspray/Labrador/Event/EventFactory.php

@@ -8,8 +8,10 @@
 
 namespace Cspray\Labrador\Event;
 
+use League\Event\EventInterface;
+
 interface EventFactory {
 
-    public function create(string $eventName, ...$args) : Event;
+    public function create(string $eventName, ...$args) : EventInterface;
 
 }

src/Cspray/Labrador/Event/ExceptionThrownEvent.php

@@ -11,6 +11,7 @@
 namespace Cspray\Labrador\Event;
 
 use Cspray\Labrador\Engine;
+use League\Event\Event;
 use Exception;
 
 class ExceptionThrownEvent extends Event {