Merge pull request #172 from TheDragonCode/6.x

Added file name question

Author: andrey-helldar

composer.json

@@ -50,6 +50,7 @@
         "illuminate/container": "^10.0 || ^11.0",
         "illuminate/database": "^10.0 || ^11.0",
         "illuminate/support": "^10.0 || ^11.0",
+        "laravel/prompts": "^0.1.23",
         "symfony/console": "^6.0 || ^7.0"
     },
     "require-dev": {

docs/guide/creating.md

@@ -10,6 +10,25 @@ The new operation's file will be placed in your `operations` directory in the ba
 
 Each operation file name contains a timestamp, which allows Laravel to determine the order of the operations.
 
+## Asks For File Name
+
+> The question will not be asked when calling a console command passing the `--quiet` parameter.
+
+When calling the `operations` console command without passing a name in the `name` parameter,
+you will be asked for a name for the file.
+
+```bash
+$ php artisan make:operation
+  Creating an operation 
+
+ ┌ What should the operation be named? ─────────────────────────┐
+ │ E.g. activate articles                                       │
+ └──────────────────────────────────────────────────────────────┘
+  Press Enter to autodetect
+```
+
+You can enter your own or simply press `Enter` to continue.
+In this case, automatic file name generation will be applied.
 
 ## Automatically Generate A File Name
 
@@ -66,7 +85,8 @@ php artisan make:operation foo/bar/QweRty.php
 
 ## Invokable Method
 
-By default, the new operation class will contain the `__invoke` method, but you can easily replace it with public `up` name.
+By default, the new operation class will contain the `__invoke` method, but you can easily replace it with public `up`
+name.
 
 ```php
 use DragonCode\LaravelDeployOperations\Operation;
@@ -83,7 +103,8 @@ return new class extends Operation
 > Note that the `__invoke` method has been added as a single call.
 > This means that when the operation is running, it will be called, but not when it is rolled back.
 >
-> You should also pay attention to the fact that if there is an `__invoke` method in the class, the `down` method will not be called.
+> You should also pay attention to the fact that if there is an `__invoke` method in the class, the `down` method will
+> not be called.
 
 ```php
 use DragonCode\LaravelDeployOperations\Operation;

src/Processors/Make.php

@@ -10,6 +10,7 @@
 
 use function base_path;
 use function date;
+use function Laravel\Prompts\text;
 use function realpath;
 
 class Make extends Processor
@@ -53,12 +54,37 @@ protected function getFilename(string $branch): string
         $directory = Path::dirname($branch);
         $filename  = Path::filename($branch);
 
-        return Str::of($filename)->prepend($this->getTime())->finish('.php')->prepend($directory . '/')->toString();
+        return Str::of($filename)
+            ->snake()
+            ->prepend($this->getTime())
+            ->finish('.php')
+            ->prepend($directory . '/')
+            ->toString();
     }
 
     protected function getBranchName(): string
     {
-        return $this->options->name ?? $this->git->currentBranch() ?? $this->fallback;
+        if ($name = trim((string) $this->options->name)) {
+            return $name;
+        }
+
+        if ($name = $this->askForName()) {
+            return $name;
+        }
+
+        return $this->git->currentBranch() ?? $this->fallback;
+    }
+
+    protected function askForName(): string
+    {
+        $prompt = $this->promptForName();
+
+        return text($prompt[0], $prompt[1], hint: $prompt[2]);
+    }
+
+    protected function promptForName(): array
+    {
+        return ['What should the operation be named?', 'E.g. activate articles', 'Press Enter to autodetect'];
     }
 
     protected function getTime(): string

tests/Commands/MakeTest.php

@@ -26,13 +26,28 @@ public function testMakingFiles()
         );
     }
 
+    public function testAskedName()
+    {
+        $path = $this->getOperationsPath() . '/' . date('Y_m_d_His') . '_some_name.php';
+
+        $this->assertFileDoesNotExist($path);
+
+        $this->artisan(Names::Make)
+            ->expectsQuestion('What should the operation be named?', 'Some Name')
+            ->assertExitCode(0);
+
+        $this->assertFileExists($path);
+    }
+
     public function testAutoName()
     {
         $path = $this->getOperationsPath() . '/' . date('Y_m_d_His') . '_auto.php';
 
         $this->assertFileDoesNotExist($path);
 
-        $this->artisan(Names::Make)->assertExitCode(0);
+        $this->artisan(Names::Make)
+            ->expectsQuestion('What should the operation be named?', '')
+            ->assertExitCode(0);
 
         $this->assertFileExists($path);
     }