Rename EventManager to Events, exception too, add psalm

.github/workflows/tests.yml

@@ -32,3 +32,6 @@ jobs:
 
     - name: Run test suite
       run: vendor/bin/phpunit tests
+
+    - name: Run static analysis
+      run: vendor/bin/psalm

.gitignore

@@ -1,4 +1,5 @@
+.DS_Store
 .idea
 composer.lock
 vendor
-coverage
+coverage

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Parable Event
 
+## 0.4.0
+
+_Changes_
+- Add static analysis using psalm.
+- `EventManager` has been renamed to `Events`.
+- `Exception` has been renamed to `EventsException` for clarity.
+
 ## 0.3.0
 
 _Changes_

Makefile

@@ -4,16 +4,20 @@ dependencies:
 		--no-plugins \
 		--no-scripts
 
+psalm:
+	vendor/bin/psalm --clear-cache
+	vendor/bin/psalm
+
 tests: dependencies
 	vendor/bin/phpunit --verbose tests
 
 coverage: dependencies
 	rm -rf ./coverage
-	vendor/bin/phpunit --coverage-html ./coverage tests
+	XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-html ./coverage tests
 
 tests-clean:
 	vendor/bin/phpunit --verbose tests
 
 coverage-clean:
 	rm -rf ./coverage
-	vendor/bin/phpunit --coverage-html ./coverage tests
+	XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-html ./coverage tests

README.md

@@ -18,12 +18,12 @@ $ composer require parable-php/event
 ## Usage
 
 Events are very simple. You add listeners to events (`string` values) and then trigger an update with those events. You 
-can pass payloads into the `trigger` calls, which will get passed to all relevant listeners. 
+can pass payloads into the `trigger` calls, which will get passed to all relevant listeners.
 
 ```php
-use \Parable\Event\EventManager;
+use \Parable\Event\Events;
 
-$eventManager = new EventManager();
+$eventManager = new Events();
 
 $eventManager->listen('event_number_one', function (string $event, string &$payload) {
     $payload .= '-updated!';

composer.json

@@ -16,7 +16,8 @@
     "php": ">=8.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "^8.0"
+    "phpunit/phpunit": "^8.0",
+    "vimeo/psalm": "^4.6"
   },
   "autoload": {
     "psr-4": {

psalm.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="4"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+
+    <issueHandlers>
+        <UnresolvableInclude errorLevel="suppress" />
+    </issueHandlers>
+</psalm>

src/EventManager.php → src/Events.php

@@ -2,13 +2,11 @@
 
 namespace Parable\Event;
 
-class EventManager
+class Events
 {
     protected const GLOBAL_EVENT = '*';
 
-    /**
-     * @var callable[][]
-     */
+    /** @var callable[][] */
     protected array $listeners = [];
 
     public function listen(string $event, callable $listener): void
@@ -33,7 +31,7 @@ public function listenAll(callable $listener): void
     public function trigger(string $event, &$payload = null)
     {
         if ($event === self::GLOBAL_EVENT) {
-            throw new Exception('Cannot specifically trigger global event.');
+            throw new EventsException('Cannot trigger global event, only listen to it.');
         }
 
         foreach ($this->getListeners($event) as $listener) {
@@ -44,7 +42,7 @@ public function trigger(string $event, &$payload = null)
     /**
      * Return the callables associated with the event.
      *
-     * @return callable[][]
+     * @return callable[]
      */
     protected function getListeners(string $event): array
     {

src/Exception.php → src/EventsException.php

@@ -2,6 +2,6 @@
 
 namespace Parable\Event;
 
-class Exception extends \Exception
+class EventsException extends \Exception
 {
 }

tests/EventsTest.php

@@ -0,0 +1,84 @@
+<?php declare(strict_types=1);
+
+namespace Parable\Event\Tests;
+
+use Parable\Event\Events;
+use Parable\Event\EventsException;
+use PHPUnit\Framework\TestCase;
+
+class EventsTest extends TestCase
+{
+    protected Events $events;
+
+    public function setUp(): void
+    {
+        $this->events = new Events();
+    }
+
+    public function testListenToEventAndUpdate(): void
+    {
+        $this->events->listen('test_event', static function ($event, string &$payload) {
+            $payload .= "-suffixed";
+        });
+
+        $payload = 'payload';
+
+        $this->events->trigger('test_event', $payload);
+
+        self::assertSame('payload-suffixed', $payload);
+    }
+
+    public function testMultipleEvents(): void
+    {
+        $this->events->listen('test_event', static function ($event, string &$payload) {
+            $payload .= "-suffixed";
+        });
+        $this->events->listen('test_event', static function ($event, string &$payload) {
+            $payload .= "-twice!";
+        });
+
+        $payload = 'payload';
+
+        $this->events->trigger('test_event', $payload);
+
+        self::assertSame('payload-suffixed-twice!', $payload);
+    }
+
+    public function testSameEventMultipleTimesGetsCalledOnce(): void
+    {
+        $closure = static function ($event, string &$payload) {
+            $payload .= "-suffixed";
+        };
+
+        $this->events->listen('test_event', $closure);
+        $this->events->listen('test_event', $closure);
+
+        $payload = 'payload';
+
+        $this->events->trigger('test_event', $payload);
+
+        self::assertSame('payload-suffixed', $payload);
+    }
+
+    public function testGlobalListeners(): void
+    {
+        $this->events->listenAll(static function ($event, string &$payload) {
+            $payload .= "-suffixed";
+        });
+
+        $payload = 'payload';
+
+        $this->events->trigger('once update', $payload);
+        $this->events->trigger('twice update', $payload);
+
+        self::assertSame('payload-suffixed-suffixed', $payload);
+    }
+
+    public function testCannotTriggerGlobalEvent(): void
+    {
+        $this->expectException(EventsException::class);
+        $this->expectExceptionMessage('Cannot trigger global event, only listen to it.');
+
+        $this->events->trigger('*');
+    }
+}