Merge pull request #94 from holiq/3x

refactor(command): installation structure directory
KoalaFacade · Oct 10, 2023 · ca581b2 · ca581b2
2 parents 83761b4 + 6f09896
commit ca581b2
Show file tree

Hide file tree

Showing 21 changed files with 141 additions and 137 deletions.
diff --git a/composer.json b/composer.json
@@ -51,10 +51,10 @@
     },
     "require-dev": {
         "laravel/pint": "^1.2",
-        "pestphp/pest": "^1.22",
-        "pestphp/pest-plugin-laravel": "^1.3",
+        "pestphp/pest": "^2.21",
+        "pestphp/pest-plugin-laravel": "^2.2",
         "orchestra/testbench": "^7.14|^8.0",
-        "phpstan/phpstan": "^1.9"
+        "phpstan/phpstan": "^1.10"
     },
     "config": {
         "allow-plugins": {

diff --git a/config/diamond.php b/config/diamond.php
@@ -27,6 +27,6 @@
     'structures' => [
         Layer::infrastructure->name => 'Infrastructure',
         Layer::domain->name => 'Domain',
-        Layer::application->name => 'app',
+        Layer::application->name => 'Application',
     ],
 ];
diff --git a/src/Actions/Command/ResolveCommandAction.php b/src/Actions/Command/ResolveCommandAction.php
@@ -16,7 +16,7 @@
 {
     public function __construct(
         protected Console $console,
-        protected Closure | null $copyStubData = null,
+        protected ?Closure $copyStubData = null,
     ) {
     }
 

diff --git a/src/Actions/Composer/ResolveComposerAutoLoaderAction.php b/src/Actions/Composer/ResolveComposerAutoLoaderAction.php
@@ -25,28 +25,22 @@ public function __construct(protected Filesystem $fileSystem)
      * @throws UnableToWriteFile
      * @throws Throwable
      */
-    public function execute(): bool
+    public function execute(string $domain): bool
     {
         /** @var string $baseDirectory */
         $baseDirectory = config(key: 'diamond.base_directory');
         $composer = $this->fetchComposerContents();
 
-        foreach ($this->resolveBaseStructures() as $structure) {
-            $namespace = Str::of(string: $structure)->finish(cap: '\\');
-            $directory = $namespace->replace(search: '\\', replace: '/');
+        $namespace = Str::of(string: $domain)->finish(cap: '\\');
+        $directory = $namespace->replace(search: '\\', replace: '/');
 
-            if (Arr::exists(array: $composer->autoload['psr-4'], key: $namespace->toString())) {
-                continue;
-            }
-
-            Arr::set(
-                array: $composer->autoload['psr-4'],
-                key: $namespace->toString(),
-                value: $directory
-                    ->start(prefix: $baseDirectory)
-                    ->toString()
-            );
-        }
+        Arr::set(
+            array: $composer->autoload['psr-4'],
+            key: $namespace->toString(),
+            value: $directory
+                ->start(prefix: $baseDirectory)
+                ->toString()
+        );
 
         return $this->updateComposerContents(contents: $composer);
     }
@@ -97,15 +91,4 @@ protected function resolveBasePathForComposer(): string
     {
         return base_path(path: 'composer.json');
     }
-
-    /**
-     * @return array<string>
-     */
-    protected function resolveBaseStructures(): array
-    {
-        /** @var array<string> $structures */
-        $structures = config(key: 'diamond.structures');
-
-        return $structures;
-    }
 }
diff --git a/src/Actions/Stub/ReplacePlaceholderAction.php b/src/Actions/Stub/ReplacePlaceholderAction.php
@@ -47,6 +47,7 @@ function ($value, $key) use (&$stub) {
                 }
             );
 
+        /** @var string $contents */
         $contents = $stub;
 
         $filesystem->ensureDirectoryExists(path: Str::of($filePath)->beforeLast(search: '/'));

diff --git a/src/Commands/Application/ResourceMakeCommand.php b/src/Commands/Application/ResourceMakeCommand.php
@@ -62,7 +62,7 @@ class: $this->getClassName(),
         );
     }
 
-    public function resolveModelNamespace(): string | null
+    public function resolveModelNamespace(): ?string
     {
         if ($this->resolveModelOption()) {
             $namespace = Source::resolveNamespace(

diff --git a/src/Commands/Concerns/HasOptions.php b/src/Commands/Concerns/HasOptions.php
@@ -19,31 +19,31 @@ protected function resolveFactoryOption(): bool
         return (bool) $this->option(key: 'factory');
     }
 
-    protected function resolveTableName(): string | null
+    protected function resolveTableName(): ?string
     {
         /** @var string|null $name */
         $name = $this->option(key: 'create') ?: $this->option(key: 'table');
 
         return $name;
     }
 
-    public function resolveEventOption(): string | null
+    public function resolveEventOption(): ?string
     {
         /** @var string|null $name */
         $name = $this->option(key: 'event');
 
         return $name;
     }
 
-    public function resolveModelOption(): string | null
+    public function resolveModelOption(): ?string
     {
         /** @var string|null $name */
         $name = $this->option(key: 'model');
 
         return $name;
     }
 
-    public function resolveRenderOption(): string | null
+    public function resolveRenderOption(): ?string
     {
         /** @var string|null $name */
         $name = $this->option(key: 'render');

diff --git a/src/Commands/Domain/BuilderMakeCommand.php b/src/Commands/Domain/BuilderMakeCommand.php
@@ -62,7 +62,7 @@ class: $this->getClassName(),
         );
     }
 
-    public function resolveModelNamespace(): string | null
+    public function resolveModelNamespace(): ?string
     {
         if ($this->resolveModelOption()) {
             $namespace = Source::resolveNamespace(

diff --git a/src/Commands/Infrastructure/FactoryMakeCommand.php b/src/Commands/Infrastructure/FactoryMakeCommand.php
@@ -17,7 +17,7 @@
 
 class FactoryMakeCommand extends Command implements Console
 {
-    use InteractsWithConsole, HasOptions, HasArguments;
+    use HasArguments, HasOptions, InteractsWithConsole;
 
     protected $signature = 'infrastructure:make:factory {name} {domain} {--model=} {--force}';
 
@@ -60,7 +60,7 @@ class: $this->resolveNameArgument(),
         );
     }
 
-    protected function getModelNamespace(): string | null
+    protected function getModelNamespace(): ?string
     {
         return Source::resolveNamespace(
             data: new NamespaceData(

diff --git a/src/Commands/InstallCommand.php b/src/Commands/InstallCommand.php
@@ -5,16 +5,18 @@
 use Illuminate\Console\Command;
 use Illuminate\Contracts\Filesystem\FileNotFoundException;
 use Illuminate\Filesystem\Filesystem;
-use Illuminate\Support\Arr;
-use Illuminate\Support\Str;
+// use Illuminate\Support\Str;
 use KoalaFacade\DiamondConsole\Actions\Composer\ResolveComposerAutoLoaderAction;
+use KoalaFacade\DiamondConsole\Commands\Concerns\HasArguments;
 use KoalaFacade\DiamondConsole\Enums\Layer;
 use KoalaFacade\DiamondConsole\Support\Source;
 use Throwable;
 
 class InstallCommand extends Command
 {
-    protected $signature = 'diamond:install {--skip-refactor}';
+    use HasArguments;
+
+    protected $signature = 'domain:install {domain}';
 
     protected $description = 'Install the Domain Driven Structure in your project';
 
@@ -30,21 +32,23 @@ public function handle(): void
 
         $fileSystem->ensureDirectoryExists(path: $this->resolveBaseDirectoryPath());
 
+        $domainName = $this->resolveDomainArgument();
+
         foreach ($this->resolveBaseStructures() as $structure) {
-            $path = $this->resolveBaseDirectoryPath() . $structure;
+            $path = $this->resolveBaseDirectoryPath() . $domainName . '/' . $structure;
 
             if ($fileSystem->exists(path: $path)) {
                 $this->line(string: 'Skipping generate ' . $structure . ' , the base directory is exists');
 
                 continue;
             }
 
-            $fileSystem->makeDirectory(path: $path);
+            $fileSystem->ensureDirectoryExists(path: $path);
         }
 
-        ResolveComposerAutoLoaderAction::resolve()->execute();
+        ResolveComposerAutoLoaderAction::resolve()->execute($domainName);
 
-        $this->resolveRefactor();
+        // $this->resolveRefactor();
 
         $this->info(string: 'Successfully generate base file');
     }
@@ -62,43 +66,47 @@ protected function resolveBaseStructures(): array
         /** @var array<string> $structures */
         $structures = config(key: 'diamond.structures');
 
-        return Arr::except(array: $structures, keys: Layer::application->name);
+        return $structures;
     }
 
     protected function resolveInfrastructurePath(): string
     {
-        return Layer::infrastructure->resolvePath(suffix: '/Laravel/Providers');
+        return Layer::infrastructure->resolvePath(prefix: $this->resolveDomainArgument(), suffix: '/Laravel/Providers');
     }
 
     protected function resolveNamespace(): string
     {
-        return Layer::infrastructure->resolveNamespace(suffix: '\\Laravel\\Providers');
+        return Layer::infrastructure->resolveNamespace(prefix: $this->resolveDomainArgument() . '\\', suffix: '\\Laravel\\Providers');
     }
 
-    protected function resolveRefactor(): void
-    {
-        if (! $this->option('skip-refactor')) {
-            $filesystem = new Filesystem;
-            $filesystem->ensureDirectoryExists($this->resolveInfrastructurePath());
-            $filesystem->moveDirectory(from: app_path(path: 'Providers'), to: $this->resolveInfrastructurePath());
-            $configPath = base_path(path: '/config/app.php');
-            $contents = Str::replace(
-                search: 'App\\Providers',
-                replace: $this->resolveNamespace(),
-                subject: $filesystem->get($configPath)
-            );
-
-            $filesystem->put(path: $configPath, contents: $contents);
-
-            foreach ($filesystem->files($this->resolveInfrastructurePath()) as $file) {
-                $contents = Str::replace(
-                    search: 'App\\Providers',
-                    replace: $this->resolveNamespace(),
-                    subject: $filesystem->get($file)
-                );
-
-                $filesystem->put(path: $file, contents: $contents);
-            }
-        }
-    }
+    // disable auto refactor app path for now, because we need further planning
+    //
+    // protected function resolveRefactor(): void
+    // {
+    //     if (! $this->option('skip-refactor')) {
+    //         $filesystem = new Filesystem;
+    //         $filesystem->ensureDirectoryExists($this->resolveInfrastructurePath());
+    //         $filesystem->moveDirectory(from: app_path(path: 'Providers'), to: $this->resolveInfrastructurePath());
+    //         $configPath = base_path(path: '/config/app.php');
+    //         /** @var string $contents */
+    //         $contents = Str::replace(
+    //             search: 'App\\Providers',
+    //             replace: $this->resolveNamespace(),
+    //             subject: $filesystem->get($configPath)
+    //         );
+    //
+    //         $filesystem->put(path: $configPath, contents: $contents);
+    //
+    //         foreach ($filesystem->files($this->resolveInfrastructurePath()) as $file) {
+    //             /** @var string $contents */
+    //             $contents = Str::replace(
+    //                 search: 'App\\Providers',
+    //                 replace: $this->resolveNamespace(),
+    //                 subject: $filesystem->get($file)
+    //             );
+    //
+    //             $filesystem->put(path: $file, contents: $contents);
+    //         }
+    //     }
+    // }
 }
diff --git a/src/Contracts/Console.php b/src/Contracts/Console.php
@@ -2,7 +2,7 @@
 
 namespace KoalaFacade\DiamondConsole\Contracts;
 
-interface Console extends Options, Placeholders, Arguments, LifeCycle
+interface Console extends Arguments, LifeCycle, Options, Placeholders
 {
     public function getFullPath(): string;
 

diff --git a/src/DataTransferObjects/NamespaceData.php b/src/DataTransferObjects/NamespaceData.php
@@ -10,7 +10,7 @@ public function __construct(
         public string $structures,
         public string $domainArgument,
         public string $nameArgument,
-        public string | null $endsWith = null
+        public ?string $endsWith = null
     ) {
     }
 }
diff --git a/src/DataTransferObjects/PlaceholderData.php b/src/DataTransferObjects/PlaceholderData.php
@@ -8,17 +8,17 @@
 readonly class PlaceholderData extends DataTransferObject
 {
     final public function __construct(
-        public null | string $namespace = null,
-        public null | string $class = null,
-        public null | string $subject = null,
-        public null | string $tableName = null,
-        public null | string $factoryContract = null,
-        public null | string $factoryContractNamespace = null,
-        public null | string $factoryContractAlias = null,
-        public null | string $event = null,
-        public null | string $eventNamespace = null,
-        public null | string $model = null,
-        public null | string $modelNamespace = null,
+        public ?string $namespace = null,
+        public ?string $class = null,
+        public ?string $subject = null,
+        public ?string $tableName = null,
+        public ?string $factoryContract = null,
+        public ?string $factoryContractNamespace = null,
+        public ?string $factoryContractAlias = null,
+        public ?string $event = null,
+        public ?string $eventNamespace = null,
+        public ?string $model = null,
+        public ?string $modelNamespace = null,
     ) {
     }
 

diff --git a/src/DiamondConsoleServiceProvider.php b/src/DiamondConsoleServiceProvider.php
@@ -57,7 +57,7 @@ public function diamondCommands(): array
         return Arr::flatten(array: array_merge($generalCommands, $domainDrivenCommands));
     }
 
-    protected function resolveCommandNamespace(SplFileInfo $file, string | null $directory = null): string
+    protected function resolveCommandNamespace(SplFileInfo $file, string $directory = null): string
     {
         return Str::of(string: $file->getFilenameWithoutExtension())
             ->prepend(values: $directory ? "$directory\\" : '')

diff --git a/src/Enums/Layer.php b/src/Enums/Layer.php
@@ -10,15 +10,15 @@ enum Layer
 
     case infrastructure;
 
-    public function resolveNamespace(string $suffix = ''): string
+    public function resolveNamespace(string $prefix = '', string $suffix = ''): string
     {
         $key = $this->name;
 
-        return config(key: 'diamond.structures.' . $key) . $suffix;
+        return $prefix . config(key: 'diamond.structures.' . $key) . $suffix;
     }
 
-    public function resolvePath(string $suffix): string
+    public function resolvePath(string $prefix, string $suffix): string
     {
-        return base_path() . '/' . config(key: 'diamond.base_directory') . $this->resolveNamespace(suffix: $suffix);
+        return base_path() . '/' . config(key: 'diamond.base_directory') . $prefix . '/' . $this->resolveNamespace(suffix: $suffix);
     }
 }
diff --git a/src/Foundation/DataTransferObject.php b/src/Foundation/DataTransferObject.php
@@ -10,9 +10,9 @@
 
 abstract readonly class DataTransferObject
 {
+    use Cloneable;
     use HasResolvable;
     use Tappable;
-    use Cloneable;
 
     /**
      * Prevent properties to included on create
-Original file line number
+Diff line change
@@ Expand Up / @@ -47,6 +47,7 @@ function ($value, $key) use (&$stub) { @@
                     }
                 );
+            /** @var string $contents */
             $contents = $stub;
             $filesystem->ensureDirectoryExists(path: Str::of($filePath)->beforeLast(search: '/'));
@@ Expand Down @@