From 4e4f4355e052539c5315a417560819a5ffd44d79 Mon Sep 17 00:00:00 2001 From: alexkrivonos Date: Tue, 8 Sep 2026 12:53:35 +0200 Subject: [PATCH 1/2] docs: update package description and heading emojis in readme --- README.md | 13 ++++++------- composer.json | 2 +- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 87af70d..3258dfa 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Das Paket kommt mit **Zero-Dependencies** auf externe Framework-Fassaden (kein L ## ⚡️ Quickstart -### Installation +### 📦 Installation Das Paket kann direkt über Composer in Deine (Host-)Applikation installiert werden: @@ -21,7 +21,7 @@ Das Paket kann direkt über Composer in Deine (Host-)Applikation installiert wer composer require allgorithm/business-core ``` -### Die Operation Pipeline in Action +### 🚀 Die Operation Pipeline in Action Die Kernkomponente ist die `OperationPipeline`. Sie sorgt dafür, dass jede Operation zwingend autorisiert wird, Guards passiert, Fehler sicher fängt und lückenlos auditiert: @@ -59,7 +59,7 @@ if ($result->isSuccess()) { --- -## 🛡️ Public Contracts & Statuswerte +## 🏛️ Public Contracts & Statuswerte Der Core orchestriert Logik ausschließlich über saubere Interfaces (Contracts). Die wesentlichen Bestandteile: @@ -68,7 +68,7 @@ Der Core orchestriert Logik ausschließlich über saubere Interfaces (Contracts) * **`OperationGuardContract`**: Abgekoppelte Vorbedingungen, die strukturiert als `CheckResult` zurückmelden, ob eine Aktion erlaubt ist. * **`AuditWriterContract`**: Strikt Append-Only Revisionsprotokoll für alle Ausgänge (`AuditEntry`). -### Abbruchregeln (Pipeline Flow) +### 🚦 Abbruchregeln (Pipeline Flow) Die Ausführung einer Operation über die `OperationPipeline` folgt deterministischen Regeln: @@ -78,7 +78,7 @@ Die Ausführung einer Operation über die `OperationPipeline` folgt deterministi 4. **Exceptions**: Jegliche `\Throwable` in der `handle()`-Logik wird gefangen und strukturiert in ein `FAILED`-Resultat umgewandelt. Niemals crasht der Request unkontrolliert! 5. **Audit First**: Egal welcher Ausgang (Erfolg, Blockiert, Fehler), die `AuditStage` schreibt immer lückenlos einen revisionssicheren `AuditEntry`. -### OperationStatus +### 📊 OperationStatus Jedes Ergebnis wird einheitlich als `OperationResult` zurückgegeben, welches den definitiven Status trägt: @@ -94,8 +94,7 @@ enum OperationStatus: string --- - - ## 📄 Lizenz & Contributing Dieses Projekt ist unter der **MIT Lizenz** veröffentlicht. Pull Requests und Feedback sind herzlich willkommen! + diff --git a/composer.json b/composer.json index 237efce..9af3fe2 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "allgorithm/business-core", - "description": "Domain-neutral foundation for business operations, guards, events and append-only audit.", + "description": "A high-performance, zero-dependency PHP foundation for orchestrating Domain-Driven Design use cases, strict guards, and append-only auditing.", "type": "library", "license": "MIT", "authors": [ From f956e611f0a7b0501ec4c0220b92826f68dcdb04 Mon Sep 17 00:00:00 2001 From: alexkrivonos Date: Tue, 8 Sep 2026 12:59:31 +0200 Subject: [PATCH 2/2] docs: add CHANGELOG for release v1.0.0 --- CHANGELOG.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..3ecff0d --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,25 @@ +# Changelog + +All notable changes to `allgorithm/business-core` will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [v1.0.0] - 2026-09-08 + +### Added +- **Core Architecture**: Zero-dependency, pure PHP 8.4+ foundation for Domain-Driven Design (DDD). +- **Operation Pipeline**: Deterministic multi-stage pipeline orchestration: + - Context Validation & Actor resolution (`ActorContext`, `OperationContext`). + - Strict Authorization Gate (`AuthorizationStage`, `AuthorizationContract`). + - Pre-condition Guards Evaluation (`GuardStage`, `OperationGuardContract`, `CheckResult`). + - Safe Handler Execution with `\Throwable` safety netting into `OperationStatus::FAILED`. + - Event Dispatching (`EventDispatcherContract`, `DomainEvent`). + - Manipulationssicherer Append-Only Audit Trail (`AuditStage`, `AuditWriterContract`, `AuditEntry`) with built-in PII/sensitive data redaction. +- **Contracts & Value Objects**: + - `CommandContract`, `QueryContract`, `OperationContract`. + - Immutable DTOs (`OperationDescriptor`, `CheckResult`, `CheckResolution`, `AuditEntry`, `OperationResult`). +- **DevOps & Quality Gates**: + - PHPStan Level 8 static analysis integration. + - Pest PHP Architecture Tests (`GatekeeperArchTest`, `CoreArchTest`). + - GitHub Actions CI matrix with automated `composer audit`, PHPStan, and Pest validation.