Merge pull request #88 from ericsizemore/php-8-support

Increase PHP requirement to 8.1

.gitattributes

@@ -1,7 +1,11 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text eol=lf
+
 /.github export-ignore
 /doc export-ignore
 /examples export-ignore
 /tests export-ignore
+/.gitattributes export-ignore
 /.gitignore export-ignore
 /CHANGELOG.md export-ignore
 /phpunit.xml.dist export-ignore

.github/workflows/ci.yaml

@@ -1,17 +1,20 @@
 name: CI
+
 on:
   push:
   pull_request:
+
 jobs:
   supported-versions-matrix:
     name: Supported Versions Matrix
     runs-on: ubuntu-latest
     outputs:
       version: ${{ steps.supported-versions-matrix.outputs.version }}
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
       - id: supported-versions-matrix
         uses: WyriHaximus/github-action-composer-php-versions-in-range@v1
+
   test:
     name: Run Tests and Code Quality on PHP ${{ matrix.php }}
     runs-on: ubuntu-latest
@@ -23,28 +26,20 @@ jobs:
         php: ${{ fromJson(needs.supported-versions-matrix.outputs.version) }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
-      - name: Setup PHP, extensions and composer with shivammathur/setup-php
+        uses: actions/checkout@v4
+
+      - name: Setup PHP and extensions with shivammathur/setup-php
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
           extensions: mbstring, ctype, iconv, bcmath, filter, json
           coverage: xdebug, pcov
-          tools: composer:v1
-      - name: Get composer cache directory
-        id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-      - name: Get composer action hash
-        id: composer-action-hash
-        run: printf "::set-output name=hash::%s" $(echo -n "${{ matrix.composer }}" | sha512sum)
-      - name: Cache dependencies
-        uses: actions/cache@v2
+
+      - name: Setup Composer, install dependencies
+        uses: ramsey/composer-install@v3
         with:
-          path: ${{ steps.composer-cache.outputs.dir }}
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
-          restore-keys: ${{ runner.os }}-composer-${{ steps.composer-action-hash.outputs.hash }}
-      - name: Install Composer dependencies
-        run: composer install --no-progress --no-interaction --no-suggest --optimize-autoloader --ansi
+           composer-options: "--optimize-autoloader"
+
       - name: Test
         run: |
           ./vendor/bin/phpunit --coverage-text

.gitignore

@@ -1,2 +1,4 @@
 composer.lock
 vendor
+.phpunit.result.cache
+.phpunit.cache

CHANGELOG.md

@@ -1,7 +1,6 @@
 CHANGELOG
 =========
 
-
 * v3.0.1 (2017-07-23)
 
   * Resolved regression introduced in once listeners in v3.0.0 [#49](https://github.com/igorw/evenement/pull/49)

README.md

@@ -18,7 +18,9 @@ It is very strongly inspired by the [EventEmitter](https://nodejs.org/api/events
 
 The recommended way to install Événement is [through composer](http://getcomposer.org). By running the following command:
 
+```bash
     $ composer require evenement/evenement
+```
 
 ## Usage
 
@@ -33,7 +35,7 @@ $emitter = new Evenement\EventEmitter();
 
 ```php
 <?php
-$emitter->on('user.created', function (User $user) use ($logger) {
+$emitter->on('user.created', static function (User $user) use ($logger): void {
     $logger->log(sprintf("User '%s' was created.", $user->getLogin()));
 });
 ```
@@ -42,7 +44,7 @@ $emitter->on('user.created', function (User $user) use ($logger) {
 
 ```php
 <?php
-$emitter->removeListener('user.created', function (User $user) use ($logger) {
+$emitter->removeListener('user.created', static function (User $user) use ($logger): void {
     $logger->log(sprintf("User '%s' was created.", $user->getLogin()));
 });
 ```
@@ -56,8 +58,9 @@ $emitter->emit('user.created', [$user]);
 
 Tests
 -----
-
+```bash
     $ ./vendor/bin/phpunit
+```
 
 License
 -------

composer.json

@@ -1,19 +1,22 @@
 {
     "name": "evenement/evenement",
     "description": "Événement is a very simple event dispatching library for PHP",
-    "keywords": ["event-dispatcher", "event-emitter"],
     "license": "MIT",
+    "keywords": [
+        "event-dispatcher",
+        "event-emitter"
+    ],
     "authors": [
         {
             "name": "Igor Wiedler",
             "email": "[email protected]"
         }
     ],
     "require": {
-        "php": ">=7.0"
+        "php": ">=8.1"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9 || ^6"
+        "phpunit/phpunit": "^10 || ^11"
     },
     "autoload": {
         "psr-4": {
@@ -24,6 +27,8 @@
         "psr-4": {
             "Evenement\\Tests\\": "tests/"
         },
-        "files": ["tests/functions.php"]
+        "files": [
+            "tests/functions.php"
+        ]
     }
 }

doc/01-api.md

@@ -6,14 +6,14 @@ define an interface that extends the emitter and implicitly defines certain
 events to be emitted, or if you want to type hint an `EventEmitter` to be
 passed to a method without coupling to the specific implementation.
 
-## on($event, callable $listener)
+## on(string $event, callable $listener): static;
 
 Allows you to subscribe to an event.
 
 Example:
 
 ```php
-$emitter->on('user.created', function (User $user) use ($logger) {
+$emitter->on('user.created', static function (User $user) use ($logger): void {
     $logger->log(sprintf("User '%s' was created.", $user->getLogin()));
 });
 ```
@@ -23,7 +23,7 @@ instead of the anonymous function:
 
 ```php
 $loggerSubscriber = new LoggerSubscriber($logger);
-$emitter->on('user.created', array($loggerSubscriber, 'onUserCreated'));
+$emitter->on('user.created', [$loggerSubscriber, 'onUserCreated']);
 ```
 
 This has the benefit that listener does not even need to know that the emitter
@@ -32,23 +32,23 @@ exists.
 You can also accept more than one parameter for the listener:
 
 ```php
-$emitter->on('numbers_added', function ($result, $a, $b) {});
+$emitter->on('numbers_added', static function (int $result, int $a, int $b): void {});
 ```
 
-## once($event, callable $listener)
+## once(string $event, callable $listener): static;
 
 Convenience method that adds a listener which is guaranteed to only be called
 once.
 
 Example:
 
 ```php
-$conn->once('connected', function () use ($conn, $data) {
+$conn->once('connected', static function () use ($conn, $data): void {
     $conn->send($data);
 });
 ```
 
-## emit($event, array $arguments = [])
+## emit(string $event, array $arguments = []): void;
 
 Emit an event, which will call all listeners.
 
@@ -66,7 +66,7 @@ $result = $a + $b;
 $emitter->emit('numbers_added', [$result, $a, $b]);
 ```
 
-## listeners($event)
+## listeners(?string $event = null): array;
 
 Allows you to inspect the listeners attached to an event. Particularly useful
 to check if there are any listeners at all.
@@ -75,16 +75,16 @@ Example:
 
 ```php
 $e = new \RuntimeException('Everything is broken!');
-if (0 === count($emitter->listeners('error'))) {
+if (0 === \count($emitter->listeners('error'))) {
     throw $e;
 }
 ```
 
-## removeListener($event, callable $listener)
+## removeListener(string $event, callable $listener): void;
 
 Remove a specific listener for a specific event.
 
-## removeAllListeners($event = null)
+## removeAllListeners(?string $event = null): void;
 
 Remove all listeners for a specific event or all listeners all together. This
 is useful for long-running processes, where you want to remove listeners in

doc/02-plugin-system.md

@@ -29,7 +29,7 @@ A plugin class must implement the `PluginInterface`:
 ```php
 interface PluginInterface
 {
-    function attachEvents(EventEmitterInterface $emitter);
+    public function attachEvents(EventEmitterInterface $emitter): void;
 }
 ```
 
@@ -38,9 +38,9 @@ emitter. For example:
 ```php
 class FooPlugin implements PluginInterface
 {
-    public function attachEvents(EventEmitterInterface $emitter)
+    public function attachEvents(EventEmitterInterface $emitter): void
     {
-        $emitter->on('foo', function () {
+        $emitter->on('foo', static function (): void {
             echo 'bar!';
         });
     }
@@ -76,7 +76,7 @@ In the code that creates the post, I'll insert the `post.create` event:
 ```php
 class PostEvent
 {
-    public $post;
+    public array $post;
 
     public function __construct(array $post)
     {
@@ -98,7 +98,7 @@ allowing listeners to change it.
 
 The same thing for the `post.render` event:
 ```php
-public function renderPostBody(array $post)
+public function renderPostBody(array $post): string
 {
     $emitter = $this->emitter;
 
@@ -127,13 +127,13 @@ The `markdown` function represents a markdown to HTML converter.
 ```php
 class MarkdownPlugin implements PluginInterface
 {
-    public function attachEvents(EventEmitterInterface $emitter)
+    public function attachEvents(EventEmitterInterface $emitter): void
     {
-        $emitter->on('post.create', function (PostEvent $event) {
+        $emitter->on('post.create', static function (PostEvent $event): void {
             $event->post['format'] = 'markdown';
         });
 
-        $emitter->on('post.render', function (PostEvent $event) {
+        $emitter->on('post.render', static function (PostEvent $event): void {
             if (isset($event->post['format']) && 'markdown' === $event->post['format']) {
                 $event->post['body'] = markdown($event->post['body']);
             }

examples/benchmark-emit-no-arguments.php

@@ -17,7 +17,7 @@
 
 $emitter = new EventEmitter();
 
-$emitter->on('event', function () {});
+$emitter->on('event', static function (): void {});
 
 $start = microtime(true);
 for ($i = 0; $i < ITERATIONS; $i++) {

examples/benchmark-emit-once.php

@@ -20,7 +20,7 @@
 $emitter = new EventEmitter();
 
 for ($i = 0; $i < ITERATIONS; $i++) {
-    $emitter->once('event', function ($a, $b, $c) {});
+    $emitter->once('event', static function (int $a, int $b, int $c): void {});
 }
 
 $start = microtime(true);

examples/benchmark-emit-one-argument.php

@@ -17,7 +17,7 @@
 
 $emitter = new EventEmitter();
 
-$emitter->on('event', function ($a) {});
+$emitter->on('event', static function (int $a): void {});
 
 $start = microtime(true);
 for ($i = 0; $i < ITERATIONS; $i++) {

examples/benchmark-emit.php

@@ -17,7 +17,7 @@
 
 $emitter = new EventEmitter();
 
-$emitter->on('event', function ($a, $b, $c) {});
+$emitter->on('event', static function (int $a, int $b, int $c): void {});
 
 $start = microtime(true);
 for ($i = 0; $i < ITERATIONS; $i++) {

examples/benchmark-remove-listener-once.php

@@ -21,7 +21,7 @@
 
 $listeners = [];
 for ($i = 0; $i < ITERATIONS; $i++) {
-    $listeners[] = function ($a, $b, $c) {};
+    $listeners[] = static function (int $a, int $b, int $c): void {};
 }
 
 $start = microtime(true);

phpunit.xml.dist

@@ -1,24 +1,28 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
-<phpunit backupGlobals="false"
-         backupStaticAttributes="false"
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheDirectory=".phpunit.cache"
+         executionOrder="depends,defects"
+         requireCoverageMetadata="true"
+         beStrictAboutCoverageMetadata="true"
+         beStrictAboutOutputDuringTests="true"
+         displayDetailsOnTestsThatTriggerDeprecations="true"
+         displayDetailsOnTestsThatTriggerErrors="true"
+         displayDetailsOnTestsThatTriggerNotices="true"
+         displayDetailsOnTestsThatTriggerWarnings="true"
          colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false"
-         syntaxCheck="false"
->
+         failOnRisky="true"
+         failOnWarning="true">
     <testsuites>
         <testsuite name="Evenement Test Suite">
             <directory>./tests/</directory>
         </testsuite>
     </testsuites>
 
-    <filter>
-        <whitelist>
+    <source restrictNotices="true" restrictWarnings="true">
+        <include>
             <directory>./src/</directory>
-        </whitelist>
-    </filter>
+        </include>
+    </source>
 </phpunit>