Merge pull request #9 from TimoKoerber/essential-flag

Create a cleaner file with --essential flag

Author: TimoKoerber

README.md

@@ -41,7 +41,8 @@ Now you're all set!
 
 ### Create operation files
 ```shell
-php artisan operations:make <operation_name> // create operation file
+php artisan operations:make <operation_name>                // create new operation file
+php artisan operations:make <operation_name> -e|--essential // create file without any attributes
 ```
 
 ### Process operations
@@ -159,7 +160,6 @@ return new class extends OneTimeOperation
 
 Provide your code in the `process()` method, for example: 
 
-
 ```php
 // operations/XXXX_XX_XX_XXXXXX_awesome_operation.php
 
@@ -177,6 +177,15 @@ _(this is only recommended for small operations, since the processing of these o
 
 **Hint:** If you use syncronous processing, the `$queue` attribute will be ignored (duh!). 
 
+### Create a cleaner operation file
+
+If you don't need all the available attributes for your operation, you can create a *cleaner* operation file with the `--essential` or `-e` option: 
+
+```shell
+php artisan operations:make AwesomeOperation --essential
+php artisan operations:make AwesomeOperation -e
+```
+
 ### Processing the operations
 
 ![One-Time Operations for Laravel - Processing the operations](https://user-images.githubusercontent.com/65356688/224434129-43082402-6077-4043-8e97-c44786e60a59.png)

src/Commands/OneTimeOperationsMakeCommand.php

@@ -7,14 +7,16 @@
 
 class OneTimeOperationsMakeCommand extends OneTimeOperationsCommand
 {
-    protected $signature = 'operations:make {name : The name of the one-time operation}';
+    protected $signature = 'operations:make
+                            {name : The name of the one-time operation}
+                            {--e|essential : Create file without any attributes}';
 
     protected $description = 'Create a new one-time operation';
 
     public function handle(): int
     {
         try {
-            $file = OneTimeOperationCreator::createOperationFile($this->argument('name'));
+            $file = OneTimeOperationCreator::createOperationFile($this->argument('name'), $this->option('essential'));
             $this->components->info(sprintf('One-time operation [%s] created successfully.', $file->getOperationName()));
 
             return self::SUCCESS;

src/OneTimeOperationCreator.php

@@ -15,6 +15,8 @@ class OneTimeOperationCreator
 
     protected string $operationName = '';
 
+    protected bool $essential = false;
+
     public function __construct()
     {
         $this->operationsDirectory = OneTimeOperationManager::getDirectoryPath();
@@ -23,10 +25,11 @@ public function __construct()
     /**
      * @throws \Throwable
      */
-    public static function createOperationFile(string $name): OneTimeOperationFile
+    public static function createOperationFile(string $name, bool $essential = false): OneTimeOperationFile
     {
         $instance = new self();
         $instance->setProvidedName($name);
+        $instance->setEssential($essential);
 
         return OneTimeOperationFile::make($instance->createFile());
     }
@@ -54,6 +57,10 @@ protected function getPath(): string
 
     protected function getStubFilepath(): string
     {
+        if ($this->essential) {
+            return File::get(__DIR__.'/../stubs/one-time-operation-essential.stub');
+        }
+
         return File::get(__DIR__.'/../stubs/one-time-operation.stub');
     }
 
@@ -85,4 +92,9 @@ public function setProvidedName(string $providedName): void
     {
         $this->providedName = $providedName;
     }
+
+    public function setEssential(bool $essential): void
+    {
+        $this->essential = $essential;
+    }
 }

stubs/one-time-operation-essential.stub

@@ -0,0 +1,11 @@
+<?php
+
+use TimoKoerber\LaravelOneTimeOperations\OneTimeOperation;
+
+return new class extends OneTimeOperation
+{
+    public function process(): void
+    {
+        //
+    }
+};

tests/Feature/OneTimeOperationCommandTest.php

@@ -18,9 +18,6 @@ public function test_make_command_with_attributes()
         $filepath = $this->filepath('2015_10_21_072800_awesome_operation.php');
         File::delete($filepath);
 
-        // no files, database entries or jobs
-        $this->assertFileDoesNotExist($filepath);
-
         // create operation file
         $this->artisan('operations:make AwesomeOperation')
             ->assertSuccessful()
@@ -37,6 +34,44 @@ public function test_make_command_with_attributes()
         $this->assertStringContainsString('public function process(): void', $fileContent);
     }
 
+    public function test_make_command_without_attributes()
+    {
+        $filepath = $this->filepath('2015_10_21_072800_awesome_operation.php');
+        File::delete($filepath);
+
+        // create operation file with essential flag
+        $this->artisan('operations:make AwesomeOperation --essential')->assertSuccessful();
+
+        $fileContent = File::get($filepath);
+
+        // file should contain method
+        $this->assertStringContainsString('public function process(): void', $fileContent);
+
+        // file should not contain attributes
+        $this->assertStringNotContainsString('protected bool $async = true;', $fileContent);
+        $this->assertStringNotContainsString('protected string $queue = \'default\';', $fileContent);
+        $this->assertStringNotContainsString('protected ?string $tag = null;', $fileContent);
+    }
+
+    public function test_make_command_without_attributes_shortcut()
+    {
+        $filepath = $this->filepath('2015_10_21_072800_awesome_operation.php');
+        File::delete($filepath);
+
+        // create operation file with shortcut for essential flag
+        $this->artisan('operations:make AwesomeOperation -e')->assertSuccessful();
+
+        $fileContent = File::get($filepath);
+
+        // file should contain method
+        $this->assertStringContainsString('public function process(): void', $fileContent);
+
+        // file should not contain attributes
+        $this->assertStringNotContainsString('protected bool $async = true;', $fileContent);
+        $this->assertStringNotContainsString('protected string $queue = \'default\';', $fileContent);
+        $this->assertStringNotContainsString('protected ?string $tag = null;', $fileContent);
+    }
+
     /** @test */
     public function test_the_whole_command_process()
     {