feat: Add initial additions

Author: b00gizm

.editorconfig

@@ -0,0 +1,21 @@
+# EditorConfig is awesome: https://EditorConfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+max_line_length = 120
+tab_width = 4
+trim_trailing_whitespace = true
+
+[{Dockerfile,Dockerfile.*}]
+indent_size = 2
+
+[.github/**.yaml]
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -1,52 +1,6 @@
-# Cache and logs (Symfony2)
-/app/cache/*
-/app/logs/*
-!app/cache/.gitkeep
-!app/logs/.gitkeep
-
-# Email spool folder
-/app/spool/*
-
-# Cache, session files and logs (Symfony3)
-/var/cache/*
-/var/logs/*
-/var/sessions/*
-!var/cache/.gitkeep
-!var/logs/.gitkeep
-!var/sessions/.gitkeep
-
-# Logs (Symfony4)
-/var/log/*
-!var/log/.gitkeep
-
-# Parameters
-/app/config/parameters.yml
-/app/config/parameters.ini
-
-# Managed by Composer
-/app/bootstrap.php.cache
-/var/bootstrap.php.cache
-/bin/*
-!bin/console
-!bin/symfony_requirements
+/.phpunit.cache
 /vendor/
 
-# Assets and user uploads
-/web/bundles/
-/web/uploads/
-
-# PHPUnit
-/app/phpunit.xml
-/phpunit.xml
-
-# Build data
-/build/
-
-# Composer PHAR
+/.php-cs-fixer.cache
 /composer.phar
-
-# Backup entities generated with doctrine:generate:entities command
-**/Entity/*~
-
-# Embedded web-server pid file
-/.web-server-pid
+/phpunit.xml

.php-cs-fixer.php

@@ -0,0 +1,16 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->exclude(['var', 'vendor', 'migrations', 'fixtures'])
+    ->in(__DIR__)
+;
+
+$config = new PhpCsFixer\Config();
+return $config
+    ->setRules([
+        '@PSR12' => true,
+        'strict_param' => true,
+        'array_syntax' => ['syntax' => 'short'],
+    ])
+    ->setRiskyAllowed(true)
+    ->setFinder($finder);

README.md

@@ -1,2 +1,75 @@
-# ddd-symfony-bundle
-Additions for domain driven development inside Symfony.
+# Symfony Bundle for DDD
+
+Various additions for [domain driven development](https://martinfowler.com/tags/domain%20driven%20design.html) inside Symfony.
+
+## Installation
+
+To use this bundle, require it in Composer
+
+```bash
+composer require geekcell/ddd-bundle
+```
+
+## Aggregate Root
+
+Extend from `AggregateRoot` to record and commit domain events. Domain events must implement the (marker) interface `DomainEvent`. Events will be dispatched via the currently configured Symfony event dispatcher.
+
+### Example Usage
+
+```php
+use GeekCell\DDDBundle\Domain\Event\DomainEvent;
+use GeekCell\DDDBundle\Domain\Model\AggregateRoot;
+
+class OrderPlacedEvent implements DomainEvent
+{
+    ...
+}
+
+class Order extends AggregateRoot
+{
+    public function save(): void
+    {
+        $this->record(new OrderPlacedEvent());
+    }
+
+    ...
+}
+
+$order = new Order();
+$order->save();
+$order->commit(); // <- Events will be dispatched
+```
+
+_Hint: If you want to dispatch an event directly, use `AggregateRoot::dispatch()` instead of `AggregateRoot::record()`._
+
+If you cannot (or don't want to) extend from `AggregateRoot`, you can alternative use `DispatchableTrait` to add dispatching capabilities to any class. The former is however the recommended way.
+
+## Supporting Tools
+
+### Facades
+
+Facades are heavily inspired by [Laravel's Facades](https://laravel.com/docs/facades) and are more or less singletons on steroids. They are basically a shortcut to services inside the DIC.
+
+```php
+use GeekCell\DDDBundle\Support\Facades\EventDispatcher;
+
+EventDispatcher::dispatch($someEvent);
+
+// same as: $container->get('event_dispatcher')->dispatch($someEvent);
+```
+
+You can create your own facades by extending from `Facade` and implementing the `Facade::getFacadeAccessor()` method to return the DIC service alias.
+
+```php
+use GeekCell\DDDBundle\Support\Facades\Facade;
+
+class Logger extends Facade
+{
+    protected static function getFacadeAccessor(): string
+    {
+        return 'logger';
+    }
+}
+```
+
+Although facades are better testable than regular singletons, it is highly recommended to only use them sparringly and always prefer normal dependency injection when possible.

composer.json

@@ -0,0 +1,41 @@
+{
+    "name": "geekcell/ddd-bundle",
+    "type": "symfony-bundle",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Pascal Cremer",
+            "email": "pascal.cremer@geekcell.io"
+        }
+    ],
+    "require": {
+        "symfony/http-kernel": "^6.2",
+        "symfony/event-dispatcher": "^6.2",
+        "symfony/dependency-injection": "^6.2",
+        "symfony/config": "^6.2",
+        "beberlei/assert": "^3.3"
+    },
+    "autoload": {
+        "psr-4": {
+            "GeekCell\\DDDBundle\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "GeekCell\\DDDBundle\\Tests\\": "tests/"
+        }
+    },
+    "require-dev": {
+        "mockery/mockery": "^1.5",
+        "phpunit/phpunit": "^9.5",
+        "phpstan/phpstan": "^1.9",
+        "friendsofphp/php-cs-fixer": "^3.13",
+        "phpstan/phpstan-mockery": "^1.1"
+    },
+    "scripts": {
+        "gc:tests": "phpunit --testdox --colors=always",
+        "gc:cs-lint": "php-cs-fixer fix --config .php-cs-fixer.php --diff -vvv --dry-run",
+        "gc:cs-fix": "php-cs-fixer fix --config .php-cs-fixer.php -vvv || true",
+        "gc:phpstan": "phpstan analyse --memory-limit=2G --no-progress --level=8"
+    }
+}