docs: write docs

CHANGELOG.md

@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Universal usable `--global` flag by [@regnerisch](https://github.com/regnerisch)
+
 ### Fixed
 - Access before initialization by [@regnerisch](https://github.com/regnerisch) in [#100](https://github.com/akrillia/laravel-beyond/issues/100) reported by [@napruzzese](https://github.com/napruzzese)
 

README.md

@@ -30,7 +30,8 @@ Register the namespaces inside your `composer.json`:
       "Database\\Factories\\": "database/factories/",
       "Database\\Seeders\\": "database/seeders/",
       "Application\\": "src/Application",
-      "Domain\\": "src/Domain"
+      "Domain\\": "src/Domain",
+      "Support\\": "src/Support"
     }
   },
   // ...

docs/README.md

@@ -7,10 +7,10 @@
 - [`beyond:make:job`](commands/make-job.md)
 - [`beyond:make:policy`](commands/make-policy.md)
 - [`beyond:make:process`](commands/make-process.md)
-- `beyond:make:query`
-- `beyond:make:request`
-- `beyond:make:resource`
-- `beyond:make:rule`
+- [`beyond:make:query`](commands/make-query.md)
+- [`beyond:make:request`](commands/make-request.md)
+- [`beyond:make:resource`](commands/make-resource.md)
+- [`beyond:make:rule`](commands/make-rule.md)
 
 ### Domain
 - [`beyond:make:action`](commands/make-action.md)

docs/commands/make-policy.md

@@ -17,7 +17,7 @@ Creates a new policy.
 >     $request = $this->app['request'];
 >
 >     $app = match (true) {
->         $request->is('your-app-prefix/*')  => 'YourApp', // YourApp is the app name inside "src/App"
+>         $request->is('your-app-prefix/*')  => 'YourApp', // YourApp is the app name inside "src/Application"
 >         $request->is('your-app2-prefix/*') => 'YourAppTwo',
 >         default                            => null,
 >     };

docs/commands/make-query.md

@@ -0,0 +1,16 @@
+# `beyond:make:query`
+Creates a new Spatie query builder.
+
+> [!IMPORTANT] 
+> Requires package `spatie/laravel-query-builder`
+
+## Signature
+`beyond:make:query {name} {--force}`
+
+| Parameters | Description                    |
+|------------|--------------------------------|
+| name       | The name of your query builder |
+
+| Flags   | Description             |
+|---------|-------------------------|
+| --force | Overwrite existing file |

docs/commands/make-request.md

@@ -0,0 +1,13 @@
+# `beyond:make:request`
+Creates a new request.
+
+## Signature
+`beyond:make:request {name} {--force}`
+
+| Parameters | Description              |
+|------------|--------------------------|
+| name       | The name of your request |
+
+| Flags   | Description             |
+|---------|-------------------------|
+| --force | Overwrite existing file |

docs/commands/make-resource.md

@@ -0,0 +1,13 @@
+# `beyond:make:resource`
+Creates a new resource.
+
+## Signature
+`beyond:make:resource {name} {--force}`
+
+| Parameters | Description               |
+|------------|---------------------------|
+| name       | The name of your resource |
+
+| Flags   | Description             |
+|---------|-------------------------|
+| --force | Overwrite existing file |

docs/commands/make-rule.md

@@ -0,0 +1,14 @@
+# `beyond:make:rule`
+Creates a new rule. 
+
+## Signature
+`beyond:make:rule {name} {--g|global} {--force}`
+
+| Parameters | Description           |
+|------------|-----------------------|
+| name       | The name of your rule |
+
+| Flags    | Description                                  |
+|----------|----------------------------------------------|
+| --global | Creates a global rule inside `Support\Rules` |
+| --force  | Overwrite existing file                      |

src/Commands/Abstracts/BaseCommand.php

@@ -5,6 +5,7 @@
 use AkrilliA\LaravelBeyond\NameResolver;
 use AkrilliA\LaravelBeyond\Type;
 use Illuminate\Console\Command;
+use Illuminate\Support\Stringable;
 
 use function Laravel\Prompts\error;
 use function Laravel\Prompts\info;
@@ -56,7 +57,7 @@ protected function getNameArgument(): string
 
     public function getNameResolver(?string $name = null): NameResolver
     {
-        return new NameResolver($this, $name ?: $this->getNameArgument());
+        return new NameResolver($this, new Stringable($name ?: $this->getNameArgument()));
     }
 
     protected function configure(): void

src/Commands/MakeModelCommand.php

@@ -3,9 +3,7 @@
 namespace AkrilliA\LaravelBeyond\Commands;
 
 use AkrilliA\LaravelBeyond\Commands\Abstracts\DomainCommand;
-use AkrilliA\LaravelBeyond\NameResolver;
 use AkrilliA\LaravelBeyond\Type;
-use Illuminate\Support\Str;
 
 final class MakeModelCommand extends DomainCommand
 {

src/Commands/MakeRuleCommand.php

@@ -7,7 +7,7 @@
 
 final class MakeRuleCommand extends ApplicationCommand
 {
-    protected $signature = 'beyond:make:rule {name?} {--force}';
+    protected $signature = 'beyond:make:rule {name?} {--g|global} {--force}';
 
     protected $description = 'Make a new rule';
 

src/NameResolver.php

@@ -24,21 +24,19 @@ final class NameResolver
 
     public function __construct(
         private readonly BaseCommand $command,
-        private readonly string $name
+        private readonly Stringable $name
     ) {
-        $this->init();
+        $this->setAppOrDomain($this->name);
+        $this->setDirectoryAndClassName($this->name->after('.'));
+        $this->setNamespace();
+        $this->setPath();
     }
 
     public function getNamespace(): string
     {
         return $this->namespace;
     }
 
-    public function getAppOrDomain(): string
-    {
-        return $this->appOrDomain;
-    }
-
     public function getClassName(): string
     {
         return $this->className;
@@ -49,46 +47,28 @@ public function getPath(): string
         return $this->path;
     }
 
-    public function getCommandNameArgument(): string
+    private function isGlobal(): bool
     {
-        return $this->appOrDomain.'.'.$this->className;
+        return $this->command->hasOption('global') && $this->command->option('global');
     }
 
-    private function init(): void
+    private function setAppOrDomain(Stringable $name): void
     {
-        $name = new Stringable($this->name);
         $this->appOrDomain = $name->contains('.')
             ? $name->before('.')->toString()
             : null;
-        $this->setDirectoryAndClassName($name->after('.'));
 
-        if (! $this->appOrDomain) {
-            $this->appOrDomain = $this->askForAppOrDomainName();
+        if ($this->appOrDomain || $this->isGlobal()) {
+            return;
         }
 
-        $this->namespace = sprintf(
-            $this->command->getNamespaceTemplate().'%s',
-            $this->appOrDomain,
-            $this->command->getType()->getNamespace(),
-            $this->directory ? '\\'.$this->directory : '',
-        );
-
-        $this->path = sprintf(
-            '%s/'.$this->command->getFileNameTemplate(),
-            Str::ucfirst(Str::replace('\\', '/', $this->namespace)),
-            $this->className,
-        );
-    }
-
-    private function askForAppOrDomainName(): string
-    {
         $cases = match (true) {
             $this->command instanceof ApplicationCommand => ['app', beyond_get_choices(base_path('src/Application'))],
             $this->command instanceof DomainCommand      => ['domain', beyond_get_choices(base_path('src/Domain'))],
             default                                      => []
         };
 
-        return suggest(
+        $this->appOrDomain = suggest(
             sprintf('On which %s do you want to add your %s', $cases[0], $this->command->getType()->getName()),
             function (string $value) use ($cases) {
                 return collect($cases[1])->filter(fn ($o) => Str::contains($o, $value, true))->toArray();
@@ -102,4 +82,31 @@ private function setDirectoryAndClassName(Stringable $name): void
             : '';
         $this->className = $name->afterLast('/')->toString();
     }
+
+    private function setNamespace(): void
+    {
+        if ($this->isGlobal()) {
+            $this->namespace = sprintf(
+                'Support\\%s\\%s',
+                $this->command->getType()->getNamespace(),
+                $this->directory ? '\\'.$this->directory : '',
+            );
+        } else {
+            $this->namespace = sprintf(
+                $this->command->getNamespaceTemplate().'%s',
+                $this->appOrDomain,
+                $this->command->getType()->getNamespace(),
+                $this->directory ? '\\'.$this->directory : '',
+            );
+        }
+    }
+
+    private function setPath(): void
+    {
+        $this->path = sprintf(
+            '%s/'.$this->command->getFileNameTemplate(),
+            Str::ucfirst(Str::replace('\\', '/', $this->namespace)),
+            $this->className,
+        );
+    }
 }

src/helper.php

@@ -27,6 +27,13 @@ function beyond_domain_path(string $path = ''): string
     }
 }
 
+if (! function_exists('beyond_support_path')) {
+    function beyond_support_path(string $path = ''): string
+    {
+        return beyond_path('Support/'.ltrim($path, '/'));
+    }
+}
+
 if (! function_exists('beyond_copy_stub')) {
     /**
      * @param  array<string, string>  $refactor

tests/Commands/MakeRuleCommandTest.php

@@ -33,4 +33,32 @@ public function testCanMakeRuleUsingForce(): void
 
         $code->assertOk();
     }
+
+    public function testCanMakeGlobalRule(): void
+    {
+        $this->artisan('beyond:make:rule User.UniqueUser --global');
+
+        $file = beyond_support_path('Rules/UniqueUser.php');
+        $contents = file_get_contents($file);
+
+        $this->assertFileExists($file);
+        $this->assertStringNotContainsString('{{ namespace }}', $contents);
+        $this->assertStringNotContainsString('{{ className }}', $contents);
+    }
+
+    public function testCanMakeGlobalRuleUsingForce(): void
+    {
+        $this->artisan('beyond:make:rule User.UniqueUser --global');
+
+        $file = beyond_support_path('Rules/UniqueUser.php');
+        $contents = file_get_contents($file);
+
+        $this->assertFileExists($file);
+        $this->assertStringNotContainsString('{{ namespace }}', $contents);
+        $this->assertStringNotContainsString('{{ className }}', $contents);
+
+        $code = $this->artisan('beyond:make:rule User.UniqueUser --global --force');
+
+        $code->assertOk();
+    }
 }