Issue #16: Implemented core and sending email functionality

bin/composer-post-install-script.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+require_once 'vendor/autoload.php';
+
+const ENVIRONMENT_DEVELOPMENT = 'development';
+const ENVIRONMENT_PRODUCTION  = 'production';
+
+// phpcs:disable PSR1.Files.SideEffects.FoundWithSymbols
+
+/**
+ * @param array{source: string, destination: string, environment: array<string>} $file
+ */
+function copyFile(array $file): void
+{
+    if (! in_array(getEnvironment(), $file['environment'])) {
+        echo "Skipping the copy of {$file['source']} due to environment settings." . PHP_EOL;
+        return;
+    }
+
+    if (is_readable($file['destination'])) {
+        echo "File {$file['destination']} already exists. Skipping..." . PHP_EOL;
+        return;
+    }
+
+    if (! copy($file['source'], $file['destination'])) {
+        echo "Cannot copy {$file['source']} file to {$file['destination']}" . PHP_EOL;
+    } else {
+        echo "File {$file['source']} copied successfully to {$file['destination']}." . PHP_EOL;
+    }
+}
+
+function getEnvironment(): string
+{
+    return getenv('COMPOSER_DEV_MODE') === '1' ? ENVIRONMENT_DEVELOPMENT : ENVIRONMENT_PRODUCTION;
+}
+
+/**
+ * When adding files to the below array:
+ * - `source` and `destination` paths must be relative to the project root folder
+ * - `environment` key will indicate on what environments the file will be copied
+ */
+$files = [
+    [
+        'source'      => 'config/autoload/local.php.dist',
+        'destination' => 'config/autoload/local.php',
+        'environment' => [ENVIRONMENT_DEVELOPMENT, ENVIRONMENT_PRODUCTION],
+    ],
+    [
+        'source'      => 'vendor/dotkernel/dot-mail/config/mail.global.php.dist',
+        'destination' => 'config/autoload/mail.global.php',
+        'environment' => [ENVIRONMENT_DEVELOPMENT, ENVIRONMENT_PRODUCTION],
+    ],
+];
+
+echo "Using environment setting: " . getEnvironment() . PHP_EOL;
+
+array_walk($files, 'copyFile');

composer.json

@@ -44,12 +44,23 @@
     },
     "require": {
         "php": "~8.2.0 || ~8.3.0 || ~8.4",
+        "ext-sockets": "*",
+        "clue/socket-raw": "^v1.6.0",
+        "dotkernel/dot-cache": "^4.3",
         "dotkernel/dot-cli": "^3.9",
-        "dotkernel/dot-errorhandler": "^4.2.1",
+        "dotkernel/dot-data-fixtures": "^1.4.0",
+        "dotkernel/dot-dependency-injection": "^1.2",
+        "dotkernel/dot-log": "4.0.4",
+        "dotkernel/dot-mail": "^5.3.0",
+        "dotkernel/dot-twigrenderer": "3.6.0",
         "laminas/laminas-component-installer": "^3.5",
         "laminas/laminas-config-aggregator": "^1.18",
         "mezzio/mezzio": "^3.20",
+        "mezzio/mezzio-authentication-oauth2": "^2.11",
         "netglue/laminas-messenger": "^2.3.0",
+        "ramsey/uuid": "^4.5.0",
+        "ramsey/uuid-doctrine": "^2.1.0",
+        "roave/psr-container-doctrine": "^5.2.2",
         "symfony/redis-messenger": "^v7.2.3"
     },
     "require-dev": {
@@ -63,7 +74,12 @@
     },
     "autoload": {
         "psr-4": {
-            "Queue\\": "src/"
+            "Queue\\": "src/",
+            "Core\\Admin\\": "src/Core/src/Admin/src",
+            "Core\\App\\": "src/Core/src/App/src",
+            "Core\\Security\\": "src/Core/src/Security/src",
+            "Core\\Setting\\": "src/Core/src/Setting/src",
+            "Core\\User\\": "src/Core/src/User/src"
         }
     },
     "autoload-dev": {
@@ -72,6 +88,9 @@
         }
     },
     "scripts": {
+        "post-update-cmd": [
+            "php bin/composer-post-install-script.php"
+        ],
         "check": [
             "@cs-check",
             "@test",

config/autoload/local.php.dist

@@ -9,5 +9,41 @@
 
 declare(strict_types=1);
 
+$baseUrl = 'http://localhost:8080';
+
+$databases = [
+    'default' => [
+        'host'     => 'localhost',
+        'dbname'   => 'dotkernel',
+        'user'     => '',
+        'password' => '',
+        'port'     => 3306,
+        'driver'   => 'pdo_mysql',
+        'charset'  => 'utf8mb4',
+        'collate'  => 'utf8mb4_general_ci',
+    ],
+    // you can add more database connections into this array
+];
+
 return [
+    'application'  => [
+        'name' => $app['name'] ?? '',
+        'url'  => $baseUrl,
+    ],
+    'databases'    => $databases,
+    'doctrine'     => [
+        'connection' => [
+            'orm_default' => [
+                'params' => $databases['default'],
+            ],
+        ],
+    ],
+    'notification' => [
+        'server' => [
+            'protocol' => '',
+            'host'     => '',
+            'port'     => '',
+            'eof'      => "\n",
+        ],
+    ],
 ];

config/autoload/log.local.php.dist

@@ -22,4 +22,4 @@ return [
             ]
         ],
     ],
-];
+];

config/autoload/templates.global.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+use Dot\Twig\Extension\DateExtension;
+use Dot\Twig\Extension\TranslationExtension;
+use Laminas\ServiceManager\Factory\InvokableFactory;
+use Mezzio\Template\TemplateRendererInterface;
+use Mezzio\Twig\TwigEnvironmentFactory;
+use Mezzio\Twig\TwigRendererFactory;
+use Twig\Environment;
+
+return [
+    'dependencies' => [
+        'factories' => [
+            DateExtension::class             => InvokableFactory::class,
+            Environment::class               => TwigEnvironmentFactory::class,
+            TemplateRendererInterface::class => TwigRendererFactory::class,
+            TranslationExtension::class      => InvokableFactory::class,
+        ],
+    ],
+    'debug'        => false,
+    'templates'    => [
+        'extension' => 'html.twig',
+    ],
+    'twig'         => [
+        'assets_url'      => '/',
+        'assets_version'  => null,
+        'auto_reload'     => true,
+        'autoescape'      => 'html',
+        'cache_dir'       => 'data/cache/twig',
+        'extensions'      => [
+            DateExtension::class,
+            TranslationExtension::class,
+        ],
+        'globals'         => [
+            'appName' => $app['name'] ?? '',
+        ],
+        'optimizations'   => -1,
+        'runtime_loaders' => [],
+//        'timezone'        => '',
+    ],
+];

config/config.php

@@ -15,15 +15,29 @@
 $aggregator = new ConfigAggregator([
     // Include cache configuration
     new ArrayProvider($cacheConfig),
-    \Mezzio\ConfigProvider::class,
-    \Dot\ErrorHandler\ConfigProvider::class,
-    \Dot\Log\ConfigProvider::class,
-    \Dot\Cli\ConfigProvider::class,
-    \Netglue\PsrContainer\Messenger\ConfigProvider::class,
+    Mezzio\ConfigProvider::class,
+    Mezzio\Twig\ConfigProvider::class,
+    Netglue\PsrContainer\Messenger\ConfigProvider::class,
 
     // Default App module config
-    \Queue\App\ConfigProvider::class,
-    \Queue\Swoole\ConfigProvider::class,
+    Queue\App\ConfigProvider::class,
+    Queue\Swoole\ConfigProvider::class,
+
+    // Dotkernel packages
+    Dot\Log\ConfigProvider::class,
+    Dot\Cli\ConfigProvider::class,
+    Dot\DataFixtures\ConfigProvider::class,
+    Dot\DependencyInjection\ConfigProvider::class,
+    Dot\Mail\ConfigProvider::class,
+    Dot\Twig\ConfigProvider::class,
+    Dot\Cache\ConfigProvider::class,
+
+    // Core modules
+    Core\Admin\ConfigProvider::class,
+    Core\App\ConfigProvider::class,
+    Core\Security\ConfigProvider::class,
+    Core\Setting\ConfigProvider::class,
+    Core\User\ConfigProvider::class,
 
     // Load application config in a pre-defined order in such a way that local settings
     // overwrite global settings. (Loaded as first to last):

config/pipeline.php

@@ -2,7 +2,6 @@
 
 declare(strict_types=1);
 
-use Dot\ErrorHandler\ErrorHandlerInterface;
 use Mezzio\Application;
 use Mezzio\MiddlewareFactory;
 use Psr\Container\ContainerInterface;
@@ -14,7 +13,6 @@
 return function (Application $app, MiddlewareFactory $factory, ContainerInterface $container): void {
     // The error handler should be the first (most outer) middleware to catch
     // all Exceptions.
-    $app->pipe(ErrorHandlerInterface::class);
 
     // Pipe more middleware here that you want to execute on every request:
     // - bootstrapping

phpcs.xml.dist → phpcs.xml

@@ -19,14 +19,10 @@
     <exclude-pattern>config/routes.php</exclude-pattern>
 
     <!-- Include all rules from the Laminas Coding Standard -->
-    <rule ref="LaminasCodingStandard"/>
-
-    <rule ref="Squiz.Classes.ClassFileName.NoMatch">
-        <exclude-pattern>src/ConfigProvider.*.php</exclude-pattern>
-    </rule>
-
-    <rule ref="PSR12.Files.FileHeader.IncorrectOrder">
+    <rule ref="LaminasCodingStandard">
+        <!-- Exclude rule -->
+        <exclude name="SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly.ReferenceViaFullyQualifiedName" />
+        <exclude-pattern>src/Core/src/App/src/Migration/*</exclude-pattern>
         <exclude-pattern>config/pipeline.php</exclude-pattern>
-        <exclude-pattern>src/MezzioInstaller/Resources/config/routes-*.php</exclude-pattern>
     </rule>
 </ruleset>

phpstan.neon

@@ -7,5 +7,3 @@ parameters:
         - src
         - test
     treatPhpDocTypesAsCertain: false
-    ignoreErrors:
-        - '#Constant Queue\\Swoole\\Command\\StartCommand::PROGRAMMATIC_CONFIG_FILES is unused#'

src/App/ConfigProvider.php

@@ -4,14 +4,14 @@
 
 namespace Queue\App;
 
+use Dot\DependencyInjection\Factory\AttributedServiceFactory;
 use Netglue\PsrContainer\Messenger\Container\MessageBusStaticFactory;
 use Netglue\PsrContainer\Messenger\Container\Middleware\BusNameStampMiddlewareStaticFactory;
 use Netglue\PsrContainer\Messenger\Container\Middleware\MessageHandlerMiddlewareStaticFactory;
 use Netglue\PsrContainer\Messenger\Container\Middleware\MessageSenderMiddlewareStaticFactory;
 use Netglue\PsrContainer\Messenger\HandlerLocator\OneToManyFqcnContainerHandlerLocator;
 use Queue\App\Message\ExampleMessage;
 use Queue\App\Message\ExampleMessageHandler;
-use Queue\App\Message\ExampleMessageHandlerFactory;
 use Symfony\Component\Messenger\MessageBusInterface;
 
 class ConfigProvider
@@ -25,6 +25,7 @@ public function __invoke(): array
                     'buses' => $this->busConfig(),
                 ],
             ],
+            'templates'    => $this->getTemplates(),
         ];
     }
 
@@ -36,14 +37,23 @@ private function getDependencies(): array
                 "message_bus_stamp_middleware"   => [BusNameStampMiddlewareStaticFactory::class, "message_bus"],
                 "message_bus_sender_middleware"  => [MessageSenderMiddlewareStaticFactory::class, "message_bus"],
                 "message_bus_handler_middleware" => [MessageHandlerMiddlewareStaticFactory::class, "message_bus"],
-                ExampleMessageHandler::class     => ExampleMessageHandlerFactory::class,
+                ExampleMessageHandler::class     => AttributedServiceFactory::class,
             ],
             "aliases"   => [
                 MessageBusInterface::class => "message_bus",
             ],
         ];
     }
 
+    public function getTemplates(): array
+    {
+        return [
+            'paths' => [
+                'notification-email' => [__DIR__ . '/templates'],
+            ],
+        ];
+    }
+
     private function busConfig(): array
     {
         return [