From 97bfbdaf1ebf14761a8aa7c465fd26f2c9ead2c7 Mon Sep 17 00:00:00 2001
From: omair saleh <uldvstar@gmail.com>
Date: Sun, 25 Sep 2022 14:40:42 +0800
Subject: [PATCH] Add common domain and presentation layer

1. domain exception
2. create domain command
---
 src/Common/Domain/AggregateRoot.php           |  7 ++
 src/Common/Domain/CommandInterface.php        | 13 +++
 .../Exceptions/EntityNotFoundException.php    | 11 +++
 .../IncorrectEmailFormatException.php         | 11 +++
 .../Exceptions/MaximumValueException.php      | 11 +++
 .../Domain/Exceptions/RequiredException.php   | 11 +++
 .../Exceptions/UnauthorizedUserException.php  | 11 +++
 src/Common/Domain/QueryInterface.php          | 13 +++
 .../Presentation/CLI/CreateDomainCommand.php  | 85 +++++++++++++++++++
 9 files changed, 173 insertions(+)
 create mode 100644 src/Common/Domain/AggregateRoot.php
 create mode 100644 src/Common/Domain/CommandInterface.php
 create mode 100644 src/Common/Domain/Exceptions/EntityNotFoundException.php
 create mode 100644 src/Common/Domain/Exceptions/IncorrectEmailFormatException.php
 create mode 100644 src/Common/Domain/Exceptions/MaximumValueException.php
 create mode 100644 src/Common/Domain/Exceptions/RequiredException.php
 create mode 100644 src/Common/Domain/Exceptions/UnauthorizedUserException.php
 create mode 100644 src/Common/Domain/QueryInterface.php
 create mode 100644 src/Common/Presentation/CLI/CreateDomainCommand.php

diff --git a/src/Common/Domain/AggregateRoot.php b/src/Common/Domain/AggregateRoot.php
new file mode 100644
index 0000000..898fc2e
--- /dev/null
+++ b/src/Common/Domain/AggregateRoot.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Src\Common\Domain;
+
+class AggregateRoot
+{
+}
\ No newline at end of file
diff --git a/src/Common/Domain/CommandInterface.php b/src/Common/Domain/CommandInterface.php
new file mode 100644
index 0000000..511b2ff
--- /dev/null
+++ b/src/Common/Domain/CommandInterface.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Src\Common\Domain;
+
+use Src\Common\Domain\Exceptions\UnauthorizedUserException;
+
+interface CommandInterface
+{
+    /**
+     * @throws UnauthorizedUserException
+     */
+    public function execute();
+}
\ No newline at end of file
diff --git a/src/Common/Domain/Exceptions/EntityNotFoundException.php b/src/Common/Domain/Exceptions/EntityNotFoundException.php
new file mode 100644
index 0000000..e20e8ea
--- /dev/null
+++ b/src/Common/Domain/Exceptions/EntityNotFoundException.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Src\Common\Domain\Exceptions;
+
+class EntityNotFoundException extends \DomainException
+{
+    public function __construct(string $message = 'Entity not found')
+    {
+        parent::__construct($message);
+    }
+}
\ No newline at end of file
diff --git a/src/Common/Domain/Exceptions/IncorrectEmailFormatException.php b/src/Common/Domain/Exceptions/IncorrectEmailFormatException.php
new file mode 100644
index 0000000..d2e7bf0
--- /dev/null
+++ b/src/Common/Domain/Exceptions/IncorrectEmailFormatException.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Src\Common\Domain\Exceptions;
+
+final class IncorrectEmailFormatException extends \DomainException
+{
+    public function __construct()
+    {
+        parent::__construct('Must be a valid email');
+    }
+}
\ No newline at end of file
diff --git a/src/Common/Domain/Exceptions/MaximumValueException.php b/src/Common/Domain/Exceptions/MaximumValueException.php
new file mode 100644
index 0000000..33bf828
--- /dev/null
+++ b/src/Common/Domain/Exceptions/MaximumValueException.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Src\Common\Domain\Exceptions;
+
+final class MaximumValueException extends \DomainException
+{
+    public function __construct($fieldName, $value)
+    {
+        parent::__construct(__("The maximum value for '$fieldName' is '$value"));
+    }
+}
\ No newline at end of file
diff --git a/src/Common/Domain/Exceptions/RequiredException.php b/src/Common/Domain/Exceptions/RequiredException.php
new file mode 100644
index 0000000..2fe4c3c
--- /dev/null
+++ b/src/Common/Domain/Exceptions/RequiredException.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Src\Common\Domain\Exceptions;
+
+final class RequiredException extends \DomainException
+{
+    public function __construct($fieldName)
+    {
+        parent::__construct(trans('validation.required', ['attribute' => $fieldName]));
+    }
+}
\ No newline at end of file
diff --git a/src/Common/Domain/Exceptions/UnauthorizedUserException.php b/src/Common/Domain/Exceptions/UnauthorizedUserException.php
new file mode 100644
index 0000000..ad9fa08
--- /dev/null
+++ b/src/Common/Domain/Exceptions/UnauthorizedUserException.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Src\Common\Domain\Exceptions;
+
+final class UnauthorizedUserException extends \Exception
+{
+    public function __construct()
+    {
+        parent::__construct('The user is not authorized to access this resource');
+    }
+}
\ No newline at end of file
diff --git a/src/Common/Domain/QueryInterface.php b/src/Common/Domain/QueryInterface.php
new file mode 100644
index 0000000..0c13d44
--- /dev/null
+++ b/src/Common/Domain/QueryInterface.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Src\Common\Domain;
+
+use Src\Common\Domain\Exceptions\UnauthorizedUserException;
+
+interface QueryInterface
+{
+    /**
+     * @throws UnauthorizedUserException
+     */
+    public function handle(): mixed;
+}
\ No newline at end of file
diff --git a/src/Common/Presentation/CLI/CreateDomainCommand.php b/src/Common/Presentation/CLI/CreateDomainCommand.php
new file mode 100644
index 0000000..c13247b
--- /dev/null
+++ b/src/Common/Presentation/CLI/CreateDomainCommand.php
@@ -0,0 +1,85 @@
+<?php
+
+namespace Src\Common\Presentation\CLI;
+
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\File;
+
+class CreateDomainCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'make:domain {boundedContext} {domainName}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Creates a new domain directory structure';
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle()
+    {
+        $basePath = 'src/' . $this->argument('boundedContext') . '/' . $this->argument('domainName');
+
+        // Application
+        $applicationStructure = [
+            'DTO',
+            'Repositories/Eloquent',
+            'Exceptions',
+            'Jobs',
+            'Providers',
+            'Mappers',
+            'UseCases/Commands',
+            'UseCases/Queries',
+        ];
+        foreach ($applicationStructure as $applicationDirectory) {
+            File::makeDirectory($basePath . '/Application/' . $applicationDirectory, 0755, true);
+            touch($basePath . '/Application/' . $applicationDirectory . '/.gitkeep');
+        }
+
+        // Domain
+        $domainStructure = [
+            'Exceptions',
+            'Factories',
+            'Model',
+            'Policies',
+            'Repositories',
+            'Services'
+        ];
+        foreach ($domainStructure as $domainDirectory) {
+            File::makeDirectory($basePath . '/Domain/' . $domainDirectory, 0755, true);
+            touch($basePath . '/Domain/' . $domainDirectory . '/.gitkeep');
+        }
+
+        // Infrastructure
+        $infrastructureStructure = [
+            'EloquentModels'
+        ];
+        foreach ($infrastructureStructure as $infrastructureDirectory) {
+            File::makeDirectory($basePath . '/Infrastructure/' . $infrastructureDirectory, 0755, true);
+            touch($basePath . '/Infrastructure/' . $infrastructureDirectory . '/.gitkeep');
+        }
+
+        // Presentation
+        $presentationStructure = [
+            'API',
+            'CLI',
+            'HTTP'
+        ];
+        foreach ($presentationStructure as $presentationDirectory) {
+            File::makeDirectory($basePath . '/Presentation/' . $presentationDirectory, 0755, true);
+            touch($basePath . '/Presentation/' . $presentationDirectory . '/.gitkeep');
+        }
+
+        return 1;
+    }
+}