docs: write docs

AkrilliA · May 25, 2024 · bed01fa · bed01fa
1 parent 7d35cec
commit bed01fa
Show file tree

Hide file tree

Showing 12 changed files with 56 additions and 60 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -10,7 +10,6 @@
 - [`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)
@@ -22,3 +21,7 @@
 - `beyond:make:listener`
 - `beyond:make:model`
 - `beyond:make:observer`
+
+### Support
+- [`beyond:make:provider`](commands/make-provider.md)
+- [`beyond:make:rule`](commands/make-rule.md)
diff --git a/docs/commands/make-provider.md b/docs/commands/make-provider.md
@@ -0,0 +1,19 @@
+# `beyond:make:provider`
+Creates a new service provider. 
+
+> [!NOTE]
+> Within the register method, you should **only bind things into the service container**.
+> Because of this, service containers are **not** created under `Application/{App}/Providers` 
+> We want to avoid the feeling of registering things per application. You always register things 
+> for your entire Laravel project.
+
+## Signature
+`beyond:make:provider {name} {--force}`
+
+| Parameters | Description               |
+|------------|---------------------------|
+| name       | The name of your provider |
+
+| Flags    | Description             |
+|----------|-------------------------|
+| --force  | Overwrite existing file |
diff --git a/docs/commands/make-rule.md b/docs/commands/make-rule.md
@@ -2,13 +2,12 @@
 Creates a new rule. 
 
 ## Signature
-`beyond:make:rule {name} {--g|global} {--force}`
+`beyond:make:rule {name} {--force}`
 
 | Parameters | Description           |
 |------------|-----------------------|
 | name       | The name of your rule |
 
-| Flags    | Description                                  |
-|----------|----------------------------------------------|
-| --global | Creates a global rule inside `Support\Rules` |
-| --force  | Overwrite existing file                      |
+| Flags    | Description             |
+|----------|-------------------------|
+| --force  | Overwrite existing file |
diff --git a/src/Commands/Abstracts/ApplicationCommand.php b/src/Commands/Abstracts/ApplicationCommand.php
@@ -8,9 +8,4 @@ public function getNamespaceTemplate(): string
     {
         return 'Application\\%s\\%s';
     }
-
-    public function getBaseCommandName(): string
-    {
-        return 'App';
-    }
 }
diff --git a/src/Commands/Abstracts/BaseCommand.php b/src/Commands/Abstracts/BaseCommand.php
@@ -25,8 +25,6 @@ abstract protected function getStub(): string;
 
     abstract public function getNamespaceTemplate(): string;
 
-    abstract public function getBaseCommandName(): string;
-
     abstract public function getType(): Type;
 
     public function getFileNameTemplate(): string

diff --git a/src/Commands/Abstracts/DomainCommand.php b/src/Commands/Abstracts/DomainCommand.php
@@ -8,9 +8,4 @@ public function getNamespaceTemplate(): string
     {
         return 'Domain\\%s\\%s';
     }
-
-    public function getBaseCommandName(): string
-    {
-        return 'Domain';
-    }
 }
diff --git a/src/Commands/Abstracts/SupportCommand.php b/src/Commands/Abstracts/SupportCommand.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace AkrilliA\LaravelBeyond\Commands\Abstracts;
+
+abstract class SupportCommand extends BaseCommand
+{
+    public function getNamespaceTemplate(): string
+    {
+        return 'Support\\%s';
+    }
+}
diff --git a/src/Commands/MakeRuleCommand.php b/src/Commands/MakeRuleCommand.php
@@ -3,11 +3,12 @@
 namespace AkrilliA\LaravelBeyond\Commands;
 
 use AkrilliA\LaravelBeyond\Commands\Abstracts\ApplicationCommand;
+use AkrilliA\LaravelBeyond\Commands\Abstracts\SupportCommand;
 use AkrilliA\LaravelBeyond\Type;
 
-final class MakeRuleCommand extends ApplicationCommand
+final class MakeRuleCommand extends SupportCommand
 {
-    protected $signature = 'beyond:make:rule {name?} {--g|global} {--force}';
+    protected $signature = 'beyond:make:rule {name?} {--force}';
 
     protected $description = 'Make a new rule';
 

diff --git a/src/Commands/MakeServiceProviderCommand.php b/src/Commands/MakeServiceProviderCommand.php
@@ -3,9 +3,10 @@
 namespace AkrilliA\LaravelBeyond\Commands;
 
 use AkrilliA\LaravelBeyond\Commands\Abstracts\ApplicationCommand;
+use AkrilliA\LaravelBeyond\Commands\Abstracts\SupportCommand;
 use AkrilliA\LaravelBeyond\Type;
 
-final class MakeServiceProviderCommand extends ApplicationCommand
+final class MakeServiceProviderCommand extends SupportCommand
 {
     protected $signature = 'beyond:make:provider {name} {--force}';
 

diff --git a/src/NameResolver.php b/src/NameResolver.php
@@ -5,14 +5,15 @@
 use AkrilliA\LaravelBeyond\Commands\Abstracts\ApplicationCommand;
 use AkrilliA\LaravelBeyond\Commands\Abstracts\BaseCommand;
 use AkrilliA\LaravelBeyond\Commands\Abstracts\DomainCommand;
+use AkrilliA\LaravelBeyond\Commands\Abstracts\SupportCommand;
 use Illuminate\Support\Str;
 use Illuminate\Support\Stringable;
 
 use function Laravel\Prompts\suggest;
 
 final class NameResolver
 {
-    private string $appOrDomain;
+    private ?string $appOrDomain = null;
 
     private string $namespace;
 
@@ -49,7 +50,8 @@ public function getPath(): string
 
     private function isGlobal(): bool
     {
-        return $this->command->hasOption('global') && $this->command->option('global');
+        return $this->command instanceof SupportCommand
+            || ($this->command->hasOption('global') && $this->command->option('global'));
     }
 
     private function setAppOrDomain(Stringable $name): void

diff --git a/tests/Commands/MakeRuleCommandTest.php b/tests/Commands/MakeRuleCommandTest.php
@@ -10,34 +10,6 @@ public function testCanMakeRule(): void
     {
         $this->artisan('beyond:make:rule User.UniqueUser');
 
-        $file = beyond_app_path('User/Rules/UniqueUser.php');
-        $contents = file_get_contents($file);
-
-        $this->assertFileExists($file);
-        $this->assertStringNotContainsString('{{ namespace }}', $contents);
-        $this->assertStringNotContainsString('{{ className }}', $contents);
-    }
-
-    public function testCanMakeRuleUsingForce(): void
-    {
-        $this->artisan('beyond:make:rule User.UniqueUser');
-
-        $file = beyond_app_path('User/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 --force');
-
-        $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);
 
@@ -46,18 +18,18 @@ public function testCanMakeGlobalRule(): void
         $this->assertStringNotContainsString('{{ className }}', $contents);
     }
 
-    public function testCanMakeGlobalRuleUsingForce(): void
+    public function testCanMakeRuleUsingForce(): void
     {
-        $this->artisan('beyond:make:rule User.UniqueUser --global');
+        $this->artisan('beyond:make:rule User.User/UniqueUser');
 
-        $file = beyond_support_path('Rules/UniqueUser.php');
+        $file = beyond_support_path('Rules/User/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 = $this->artisan('beyond:make:rule User/UniqueUser --force');
 
         $code->assertOk();
     }

diff --git a/tests/Commands/MakeServiceProviderCommandTest.php b/tests/Commands/MakeServiceProviderCommandTest.php
@@ -8,9 +8,9 @@ class MakeServiceProviderCommandTest extends TestCase
 {
     public function testCanMakeProvider(): void
     {
-        $this->artisan('beyond:make:provider User.UserServiceProvider');
+        $this->artisan('beyond:make:provider UserServiceProvider');
 
-        $file = beyond_app_path('User/Providers/UserServiceProvider.php');
+        $file = beyond_support_path('Providers/UserServiceProvider.php');
         $contents = file_get_contents($file);
 
         $this->assertFileExists($file);
@@ -19,15 +19,15 @@ public function testCanMakeProvider(): void
 
     public function testCanMakeProviderUsingForce(): void
     {
-        $this->artisan('beyond:make:provider User.UserServiceProvider');
+        $this->artisan('beyond:make:provider UserServiceProvider');
 
-        $file = beyond_app_path('User/Providers/UserServiceProvider.php');
+        $file = beyond_support_path('Providers/UserServiceProvider.php');
         $contents = file_get_contents($file);
 
         $this->assertFileExists($file);
         $this->assertStringNotContainsString('{{ module }}', $contents);
 
-        $code = $this->artisan('beyond:make:provider User.UserServiceProvider --force');
+        $code = $this->artisan('beyond:make:provider UserServiceProvider --force');
 
         $code->assertOk();
     }