Merge pull request #1 from bwaidelich/feature/initial-version

feat: Initial version

Author: bwaidelich

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: [bwaidelich]
+custom: ['https://www.paypal.me/bwaidelich']

.github/workflows/php.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    strategy:
+      matrix:
+        php-versions: [ '8.3', '8.4' ]
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ matrix.php-versions }}
+
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+#    - name: Validate composer.json and composer.lock
+#      run: composer validate --strict
+
+    - name: Cache Composer packages
+      id: composer-cache
+      uses: actions/cache@v3
+      with:
+        path: vendor
+        key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-php-
+
+    - name: Install dependencies
+      run: composer install --prefer-dist --no-progress
+
+    - name: Run tests
+      run: composer run-script test

.gitignore

@@ -0,0 +1,2 @@
+composer.lock
+vendor

composer.json

@@ -0,0 +1,51 @@
+{
+    "name": "wwwision/subscription-engine",
+    "description": "Subscription engine for event-sourced systems",
+    "type": "package",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Bastian Waidelich",
+            "email": "b.waidelich@wwwision.de"
+        }
+    ],
+    "funding": [
+        {
+            "type": "github",
+            "url": "https://github.com/sponsors/bwaidelich"
+        },
+        {
+            "type": "paypal",
+            "url": "https://www.paypal.me/bwaidelich"
+        }
+    ],
+    "require": {
+        "php": ">=8.3",
+        "psr/log": "^1 || ^2 || ^3"
+    },
+    "require-dev": {
+        "roave/security-advisories": "dev-latest",
+        "phpstan/phpstan": "^2",
+        "squizlabs/php_codesniffer": "^4.0.x-dev",
+        "phpunit/phpunit": "^11"
+    },
+    "autoload": {
+        "psr-4": {
+            "Wwwision\\SubscriptionEngine\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Wwwision\\SubscriptionEngine\\Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+        "test:phpstan": "phpstan",
+        "test:cs": "phpcs --colors src",
+        "test:cs:fix": "phpcbf --colors src",
+        "test": [
+            "@test:phpstan",
+            "@test:cs"
+        ]
+    }
+}

phpcs.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" ?>
+<ruleset name="PSR2">
+    <description>The PSR2 coding standard – without line length limitation</description>
+    <rule ref="PSR2">
+        <exclude name="Generic.Files.LineLength.TooLong" />
+    </rule>
+</ruleset>

phpstan.neon

@@ -0,0 +1,5 @@
+includes:
+  - phpstan.neon.dist
+parameters:
+  editorUrlTitle: 'file://%%file%%:%%line%%'
+  editorUrl: 'file://%%file%%:%%line%%'

phpstan.neon.dist

@@ -0,0 +1,5 @@
+parameters:
+  level: 9
+  treatPhpDocTypesAsCertain: false
+  paths:
+    - src

phpunit.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.1/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheDirectory=".phpunit.cache"
+         executionOrder="depends,defects"
+         requireCoverageMetadata="true"
+         beStrictAboutCoverageMetadata="true"
+         beStrictAboutOutputDuringTests="true"
+         failOnRisky="true"
+         failOnWarning="true">
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests/unit</directory>
+        </testsuite>
+    </testsuites>
+
+    <coverage includeUncoveredFiles="false" />
+
+    <source restrictDeprecations="true" restrictNotices="true" restrictWarnings="true">
+        <include>
+            <directory>src</directory>
+        </include>
+    </source>
+</phpunit>

src/Engine/Error.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Wwwision\SubscriptionEngine\Engine;
+
+use Throwable;
+use Wwwision\SubscriptionEngine\Subscription\Position;
+use Wwwision\SubscriptionEngine\Subscription\SubscriptionId;
+
+final readonly class Error
+{
+    private function __construct(
+        public SubscriptionId $subscriptionId,
+        public string $message,
+        public Throwable|null $throwable,
+        public Position|null $position,
+    ) {
+    }
+
+    public static function create(
+        SubscriptionId $subscriptionId,
+        string $message,
+        Throwable|null $throwable,
+        Position|null $position,
+    ): self {
+        return new self(
+            $subscriptionId,
+            $message,
+            $throwable,
+            $position
+        );
+    }
+}

src/Engine/Errors.php

@@ -0,0 +1,65 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Wwwision\SubscriptionEngine\Engine;
+
+use InvalidArgumentException;
+
+/**
+ * @implements \IteratorAggregate<Error>
+ */
+final readonly class Errors implements \IteratorAggregate, \Countable
+{
+    private const int CLAMP_ERRORS = 5;
+
+    /**
+     * @var non-empty-array<Error>
+     */
+    private array $errors;
+
+    private function __construct(Error ...$errors)
+    {
+        if ($errors === []) {
+            throw new InvalidArgumentException('Errors must not be empty.', 1736159619);
+        }
+        $this->errors = array_values($errors);
+    }
+
+    /**
+     * @param array<Error> $errors
+     */
+    public static function fromArray(array $errors): self
+    {
+        return new self(...$errors);
+    }
+
+    public function getIterator(): \Traversable
+    {
+        yield from $this->errors;
+    }
+
+    public function count(): int
+    {
+        return count($this->errors);
+    }
+
+    public function first(): Error
+    {
+        return $this->errors[array_key_first($this->errors)];
+    }
+
+    public function getClampedMessage(): string
+    {
+        $additionalMessage = '';
+        $lines = [];
+        foreach ($this->errors as $error) {
+            $lines[] = sprintf('%s"%s": %s', $error->position ? 'Event ' . $error->position->value . ' in ' : '', $error->subscriptionId->value, $error->message);
+            if (count($lines) >= self::CLAMP_ERRORS) {
+                $additionalMessage = sprintf('%sAnd %d other exceptions, see log.', ";\n", count($this->errors) - self::CLAMP_ERRORS);
+                break;
+            }
+        }
+        return implode(";\n", $lines) . $additionalMessage;
+    }
+}