Merge pull request #123 from TheDragonCode/4.x

Added `actions:stub` console command

Author: andrey-helldar

docs/getting-started/installation/index.md

@@ -1,6 +1,6 @@
 # Installation
 
-To get the latest version of Laravel Actions, simply require the project using [Composer](https://getcomposer.org):
+To get the latest version of `Laravel Actions`, simply require the project using [Composer](https://getcomposer.org):
 
 ```bash
 composer require dragon-code/laravel-actions
@@ -11,7 +11,7 @@ Or manually update `require` block of `composer.json` and run `composer update`
 ```json
 {
     "require": {
-        "dragon-code/laravel-actions": "^3.0"
+        "dragon-code/laravel-actions": "^4.0"
     }
 }
 ```

docs/helpers/execution-status.md

@@ -5,7 +5,8 @@ You can also override the `success` and `failed` methods, which are called on su
 ## If Success
 
 ```php
-use DragonCode\LaravelActions\Action;use Illuminate\Support\Facade\Log;
+use DragonCode\LaravelActions\Action;
+use Illuminate\Support\Facade\Log;
 
 return new class () extends Action
 {

docs/how-to-use/customize-stub.md

@@ -0,0 +1,9 @@
+# Customize Stub
+
+In order to use your action template, you first need to publish it using the console command:
+
+```
+php artisan actions:stub
+```
+
+As a result, the file `stubs/action.stub` will be created in the root of the project, which you can change for yourself.

docs/index.md

@@ -15,8 +15,8 @@
 
 * Prologue
     * [Upgrade Guide](prologue/upgrade-guide/index.md)
-      * [To 4.x from 3.x](prologue/upgrade-guide/4.x.md)
-      * [To 3.x from 2.x](prologue/upgrade-guide/3.x.md)
+        * [To 4.x from 3.x](prologue/upgrade-guide/4.x.md)
+        * [To 3.x from 2.x](prologue/upgrade-guide/3.x.md)
 * Getting Started
     * [Installation](getting-started/installation/index.md)
     * How to use

src/Console/StubPublish.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelActions\Console;
+
+use DragonCode\LaravelActions\Constants\Names;
+use DragonCode\LaravelActions\Constants\Options;
+use DragonCode\LaravelActions\Processors\Processor;
+use DragonCode\LaravelActions\Processors\StubPublish as StubProcessor;
+
+class StubPublish extends Command
+{
+    protected $name = Names::STUB_PUBLISH;
+
+    protected $description = 'Publish stub that are available for customization';
+
+    protected Processor|string $processor = StubProcessor::class;
+
+    protected bool $secure = false;
+
+    protected array $options = [
+        Options::FORCE,
+    ];
+}

src/Constants/Names.php

@@ -4,14 +4,14 @@
 
 class Names
 {
+    public const ACTIONS = 'actions';
+
     public const FRESH = 'actions:fresh';
 
     public const INSTALL = 'actions:install';
 
     public const MAKE = 'make:action';
 
-    public const ACTIONS = 'actions';
-
     public const REFRESH = 'actions:refresh';
 
     public const RESET = 'actions:reset';
@@ -20,5 +20,7 @@ class Names
 
     public const STATUS = 'actions:status';
 
+    public const STUB_PUBLISH = 'actions:stub';
+
     public const UPGRADE = 'actions:upgrade';
 }

src/Processors/Make.php

@@ -12,7 +12,7 @@ class Make extends Processor
 {
     protected string $fallback = 'auto';
 
-    protected string $stub = __DIR__ . '/../../resources/stubs/action.stub';
+    protected string $defaultStub = __DIR__ . '/../../resources/stubs/action.stub';
 
     public function handle(): void
     {
@@ -29,7 +29,7 @@ protected function run(): void
 
     protected function create(string $path): void
     {
-        File::copy($this->stub, $path);
+        File::copy($this->stubPath(), $path);
     }
 
     protected function getName(): string
@@ -61,4 +61,13 @@ protected function getTime(): string
     {
         return date('Y_m_d_His_');
     }
+
+    protected function stubPath(): string
+    {
+        if ($path = realpath(base_path('stubs/action.stub'))) {
+            return $path;
+        }
+
+        return $this->defaultStub;
+    }
 }

src/Processors/StubPublish.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelActions\Processors;
+
+use DragonCode\Support\Facades\Filesystem\File;
+
+class StubPublish extends Processor
+{
+    protected string $stub = __DIR__ . '/../../resources/stubs/action.stub';
+
+    public function handle(): void
+    {
+        $this->allow()
+            ? $this->notification->task('Publishing', fn () => $this->publish())
+            : $this->notification->info('Nothing to publish');
+    }
+
+    protected function publish(): void
+    {
+        File::copy($this->stub, $this->path());
+    }
+
+    protected function allow(): bool
+    {
+        return $this->options->force || $this->doesntExist();
+    }
+
+    protected function doesntExist(): bool
+    {
+        return ! File::exists($this->path());
+    }
+
+    protected function path(): string
+    {
+        return base_path('stubs/action.stub');
+    }
+}

src/ServiceProvider.php

@@ -37,14 +37,15 @@ public function register(): void
     protected function registerCommands(): void
     {
         $this->commands([
+            Console\Actions::class,
             Console\Fresh::class,
             Console\Install::class,
             Console\Make::class,
-            Console\Actions::class,
             Console\Refresh::class,
             Console\Reset::class,
             Console\Rollback::class,
             Console\Status::class,
+            Console\StubPublish::class,
             Console\Upgrade::class,
         ]);
     }

tests/Commands/MakeTest.php

@@ -3,6 +3,7 @@
 namespace Tests\Commands;
 
 use DragonCode\LaravelActions\Constants\Names;
+use DragonCode\Support\Facades\Filesystem\File;
 use Tests\TestCase;
 
 class MakeTest extends TestCase
@@ -107,4 +108,34 @@ public function testNestedLeftSlashWithExtension()
             file_get_contents($path)
         );
     }
+
+    public function testFromCustomizedStub()
+    {
+        $name = 'MakeExample';
+
+        $stubPath = base_path('stubs/action.stub');
+
+        $actionPath = $this->getActionsPath() . '/' . date('Y_m_d_His') . '_make_example.php';
+
+        $this->assertFileDoesNotExist($stubPath);
+
+        File::copy(__DIR__ . '/../fixtures/app/stubs/customized.stub', $stubPath);
+
+        $this->assertFileExists($stubPath);
+        $this->assertFileDoesNotExist($actionPath);
+
+        $this->artisan(Names::MAKE, compact('name'))->assertExitCode(0);
+
+        $this->assertFileExists($actionPath);
+
+        $content = file_get_contents($actionPath);
+
+        $this->assertStringContainsString('Foo\\Bar\\Some', $content);
+        $this->assertStringContainsString('extends Some', $content);
+
+        $this->assertStringNotContainsString('DragonCode\\LaravelActions\\Action', $content);
+        $this->assertStringNotContainsString('extends Action', $content);
+        $this->assertStringNotContainsString('Run the actions.', $content);
+        $this->assertStringNotContainsString('@return void', $content);
+    }
 }