Merge pull request #358 from dotkernel/issue-330

Issue #330: Move common logic to `Core` module

Author: arhimede

README.md

@@ -31,25 +31,35 @@ Documentation is available at: https://docs.dotkernel.org/api-documentation/
 
 Using your terminal, navigate inside the directory you want to download the project files into. Make sure that the directory is empty before proceeding to the download process. Once there, run the following command:
 
-    git clone https://github.com/dotkernel/api.git .
+```shell
+git clone https://github.com/dotkernel/api.git .
+```
 
 ## Step 2: Install project's dependencies
 
-    composer install
+```shell
+composer install
+```
 
 ## Step 3: Development mode
 
 If you're installing the project for development, make sure you have development mode enabled, by running:
 
-    composer development-enable
+```shell
+composer development-enable
+```
 
 You can disable development mode by running:
 
-    composer development-disable
+```shell
+composer development-disable
+```
 
 You can check if you have development mode enabled by running:
 
-    composer development-status
+```shell
+composer development-status
+```
 
 ## Step 4: Prepare config files
 
@@ -66,11 +76,13 @@ You can check if you have development mode enabled by running:
 * fill out the database connection params in `config/autoload/local.php` under `$databases['default']`
 * run the database migrations by using the following command:
 
-    php vendor/bin/doctrine-migrations migrate
+```shell
+php vendor/bin/doctrine-migrations migrate
+```
 
 This command will prompt you to confirm that you want to run it:
 
-    WARNING! You are about to execute a migration in database "..." that could result in schema changes and data loss. Are you sure you wish to continue? (yes/no) [yes]:
+> WARNING! You are about to execute a migration in database "..." that could result in schema changes and data loss. Are you sure you wish to continue? (yes/no) [yes]:
 
 Hit `Enter` to confirm the operation.
 
@@ -80,29 +92,39 @@ Hit `Enter` to confirm the operation.
 
 To list all the fixtures, run:
 
-    php bin/doctrine fixtures:list
+```shell
+php bin/doctrine fixtures:list
+```
 
 This will output all the fixtures in the order of execution.
 
 To execute all fixtures, run:
 
-    php bin/doctrine fixtures:execute
+```shell
+php bin/doctrine fixtures:execute
+```
 
 To execute a specific fixture, run:
 
-    php bin/doctrine fixtures:execute --class=FixtureClassName
+```shell
+php bin/doctrine fixtures:execute --class=FixtureClassName
+```
 
 More details on how fixtures work can be found here: https://github.com/dotkernel/dot-data-fixtures#creating-fixtures
 
 ## Step 6: Test the installation
 
-    php -S 0.0.0.0:8080 -t public
+```shell
+php -S 0.0.0.0:8080 -t public
+```
 
 Sending a GET request to the [home page](http://0.0.0.0:8080/) should output the following message:
 
-    {
+```text
+{
     "message": "DotKernel API version 5"
-    }
+}
+```
 
 ## Documentation
 

composer.json

@@ -93,7 +93,9 @@
             "Api\\Admin\\": "src/Admin/src/",
             "Api\\App\\": "src/App/src/",
             "Api\\User\\": "src/User/src/",
-            "Api\\Fixtures\\": "data/doctrine/fixtures/"
+            "Core\\Admin\\": "src/Core/src/Admin/src/",
+            "Core\\App\\": "src/Core/src/App/src/",
+            "Core\\User\\": "src/Core/src/User/src/"
         }
     },
     "autoload-dev": {
@@ -109,7 +111,6 @@
         "development-disable": "laminas-development-mode disable",
         "development-enable": "laminas-development-mode enable",
         "development-status": "laminas-development-mode status",
-        "mezzio": "mezzio --ansi",
         "check": [
             "@cs-check",
             "@test",
@@ -120,7 +121,6 @@
         "cs-fix": "phpcbf",
         "serve": "php -S 0.0.0.0:8080 -t public/",
         "static-analysis": "phpstan analyse --memory-limit 1G",
-        "test": "phpunit --colors=always",
-        "test-coverage": "phpunit --colors=always --coverage-clover clover.xml"
+        "test": "phpunit --colors=always"
     }
 }

config/autoload/authorization.global.php

@@ -2,8 +2,8 @@
 
 declare(strict_types=1);
 
-use Api\Admin\Entity\AdminRole;
-use Api\User\Entity\UserRole;
+use Core\Admin\Entity\AdminRole;
+use Core\User\Entity\UserRole;
 
 return [
     /**

config/autoload/dependencies.global.php

@@ -10,13 +10,13 @@
 use Api\App\Factory\OAuthScopeRepositoryFactory;
 use Api\App\Factory\UserIdentityFactory;
 use Api\App\Factory\UserRepositoryFactory;
-use Api\App\Repository\OAuthAccessTokenRepository;
-use Api\App\Repository\OAuthAuthCodeRepository;
-use Api\App\Repository\OAuthClientRepository;
-use Api\App\Repository\OAuthRefreshTokenRepository;
-use Api\App\Repository\OAuthScopeRepository;
-use Api\App\UserIdentity;
-use Api\User\Repository\UserRepository;
+use Core\App\Repository\OAuthAccessTokenRepository;
+use Core\App\Repository\OAuthAuthCodeRepository;
+use Core\App\Repository\OAuthClientRepository;
+use Core\App\Repository\OAuthRefreshTokenRepository;
+use Core\App\Repository\OAuthScopeRepository;
+use Core\User\Repository\UserRepository;
+use Core\User\UserIdentity;
 use Doctrine\Migrations\Tools\Console\Command\ExecuteCommand;
 use Dot\ErrorHandler\ErrorHandlerInterface;
 use Dot\ErrorHandler\LogErrorHandler;
@@ -41,8 +41,8 @@
             ClientRepositoryInterface::class                   => OAuthClientRepository::class,
             RefreshTokenRepositoryInterface::class             => OAuthRefreshTokenRepository::class,
             ScopeRepositoryInterface::class                    => OAuthScopeRepository::class,
-            ErrorHandlerInterface::class                       => LogErrorHandler::class,
             Mezzio\Authentication\UserInterface::class         => UserIdentity::class,
+            ErrorHandlerInterface::class                       => LogErrorHandler::class,
             Mezzio\Authorization\AuthorizationInterface::class => Mezzio\Authorization\Rbac\LaminasRbac::class,
             UserRepositoryInterface::class                     => UserRepository::class,
         ],

config/autoload/doctrine.global.php

@@ -3,14 +3,14 @@
 declare(strict_types=1);
 
 use Doctrine\Migrations\Configuration\EntityManager\ExistingEntityManager;
-use Doctrine\Migrations\Configuration\Migration\PhpFile;
+use Doctrine\Migrations\Configuration\Migration\ConfigurationArray;
 use Doctrine\Migrations\DependencyFactory;
 use Doctrine\ORM\EntityManager;
 
 $container = require 'config/container.php';
 
 return DependencyFactory::fromEntityManager(
-    new PhpFile('config/migrations.php'),
+    new ConfigurationArray($container->get('config')['doctrine']['migrations']),
     new ExistingEntityManager(
         $container->get(EntityManager::class)
     )

config/cli-config.php

@@ -48,9 +48,13 @@ class_exists(Mezzio\Tooling\ConfigProvider::class)
     Dot\Cache\ConfigProvider::class,
 
     // Default App module config
+    Core\Admin\ConfigProvider::class,
+    Core\App\ConfigProvider::class,
+    Core\User\ConfigProvider::class,
     Api\Admin\ConfigProvider::class,
     Api\App\ConfigProvider::class,
     Api\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):
     //   - `global.php`

config/config.php

@@ -18,6 +18,8 @@
     <file>src</file>
     <file>test</file>
 
+    <exclude-pattern>src/Core/src/App/src/Migration/*</exclude-pattern>
+
     <!-- Include all rules from the Laminas Coding Standard -->
     <rule ref="LaminasCodingStandard">
         <!-- Exclude rule -->

config/migrations.php

@@ -4,14 +4,14 @@
 
 namespace Api\Admin\Command;
 
-use Api\Admin\Entity\AdminRole;
 use Api\Admin\InputFilter\CreateAdminInputFilter;
 use Api\Admin\Service\AdminRoleService;
 use Api\Admin\Service\AdminService;
 use Api\App\Exception\BadRequestException;
 use Api\App\Exception\ConflictException;
 use Api\App\Exception\NotFoundException;
-use Api\App\Message;
+use Core\Admin\Entity\AdminRole;
+use Core\App\Message;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
@@ -34,7 +34,7 @@ class AdminCreateCommand extends Command
 
     public function __construct(
         protected AdminService $adminService,
-        protected AdminRoleService $adminRoleService
+        protected AdminRoleService $adminRoleService,
     ) {
         parent::__construct(self::$defaultName);
     }