Artisan, Tinker and Prompts

<?php
// app/Console/Commands/ImportBooks.php
namespace App\Console\Commands;

use App\Models\Author;
use App\Models\Book;
use Illuminate\Console\Command;
use Illuminate\Contracts\Console\Isolatable;
use Illuminate\Contracts\Console\PromptsForMissingInput;

use function Laravel\Prompts\confirm;
use function Laravel\Prompts\table;

class ImportBooks extends Command implements Isolatable, PromptsForMissingInput
{
    protected $signature = 'books:import
        {file : Path to a CSV file with title,author,year rows}
        {--dry-run : Show what would be imported without saving}
        {--limit=0 : Import at most this many rows (0 = all)}';

    protected $description = 'Import books from a CSV file';

    public function handle(): int
    {
        $path = $this->argument('file');
        if (! is_readable($path)) {
            $this->error("Cannot read $path");
            return self::FAILURE;                               // exit code 1
        }

        $rows = array_map('str_getcsv', file($path, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES));
        if ($limit = (int) $this->option('limit')) {
            $rows = array_slice($rows, 0, $limit);
        }

        table(headers: ['Title', 'Author', 'Year'], rows: $rows);

        if ($this->option('dry-run') || ! confirm('Import '.count($rows).' books?', default: true)) {
            $this->info('Nothing imported.');
            return self::SUCCESS;
        }

        $this->withProgressBar($rows, function (array $row) {
            [$title, $author, $year] = $row + [2 => null];
            Book::create([
                'author_id' => Author::firstOrCreate(['name' => $author])->id,
                'title' => $title,
                'isbn' => 'import-'.md5($title.$author),
                'published_year' => $year ?: null,
            ]);
        });
        $this->newLine();
        $this->info('Imported '.count($rows).' books.');

        return self::SUCCESS;
    }

    /** Questions to ask when a required argument is missing (PromptsForMissingInput). */
    protected function promptForMissingArgumentsUsing(): array
    {
        return ['file' => ['Which CSV file should be imported?', 'storage/app/import/books.csv']];
    }
}

$ php artisan books:import --help
Description:
  Import books from a CSV file

Usage:
  books:import [options] [--] <file>

Arguments:
  file                       Path to a CSV file with title,author,year rows

Options:
      --dry-run              Show what would be imported without saving
      --limit[=LIMIT]        Import at most this many rows (0 = all) [default: "0"]
      --isolated[=ISOLATED]  Do not run the command if another instance of the command is already running [default: false]
  ...

$ php artisan books:import storage/app/import/books.csv --dry-run

 ┌─────────────────────┬───────────────────┬──────┐
 │ Title               │ Author            │ Year │
 ├─────────────────────┼───────────────────┼──────┤
 │ Wild Seed           │ Octavia E. Butler │ 1980 │
 │ The Lathe of Heaven │ Ursula K. Le Guin │ 1971 │
 │ The Obelisk Gate    │ N. K. Jemisin     │ 2016 │
 └─────────────────────┴───────────────────┴──────┘

Nothing imported.

$ php artisan books:import storage/app/import/books.csv --limit=2 --no-interaction
 ...
 2/2 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%
Imported 2 books.

$ php artisan books:import nope.csv -n; echo "exit $?"
Cannot read nope.csv
exit 1

<?php
// routes/console.php
use App\Models\Book;
use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\Schedule;

Artisan::command('books:count', function () {
    $this->info(Book::count().' books in the catalogue');
})->purpose('Count the books');

Schedule::command('books:import storage/app/import/books.csv --no-interaction')->dailyAt('03:00');

$ php artisan tinker                       # interactive: type PHP, see the result, exit to quit

$ php artisan tinker --execute='echo App\Models\Book::whereRelation("author", "name", "Octavia E. Butler")->orderBy("published_year")->pluck("title")->toJson();'
["Kindred","Wild Seed","Parable of the Sower"]
$ php artisan books:count                 # the closure command above
25 books in the catalogue
$ php artisan schedule:list
  0 3 * * *  php artisan books:import storage/app/import/books.csv --no-interaction  Next Due: 7 hours from now

<?php
require __DIR__ . '/vendor/autoload.php';

use Laravel\Prompts\Key;
use Laravel\Prompts\Prompt;

use function Laravel\Prompts\form;

// Simulated keystrokes, as in a test: type "Dawn", Enter; arrow down twice, Enter; Enter (accept default)
Prompt::fake(['D', 'a', 'w', 'n', Key::ENTER, Key::DOWN, Key::DOWN, Key::ENTER, Key::ENTER]);

$review = form()
    ->text('Book title', required: true, validate: fn (string $v) => mb_strlen($v) < 2 ? 'Too short.' : null, name: 'title')
    ->select('Rating', options: [5 => '★★★★★', 4 => '★★★★', 3 => '★★★'], name: 'rating')
    ->confirm('Publish now?', default: true, name: 'publish')
    ->submit();

var_dump($review);
// array(3) { ["title"]=> string(4) "Dawn" ["rating"]=> int(3) ["publish"]=> bool(true) }

<?php
// tests/Feature/ImportBooksTest.php
use App\Models\Book;
use Illuminate\Foundation\Testing\RefreshDatabase;

uses(RefreshDatabase::class);

test('it asks for the missing file and confirms before importing', function () {
    $this->artisan('books:import')
        ->expectsQuestion('Which CSV file should be imported?', 'storage/app/import/books.csv')
        ->expectsPromptsTable(headers: ['Title', 'Author', 'Year'], rows: [
            ['Wild Seed', 'Octavia E. Butler', '1980'],
            ['The Lathe of Heaven', 'Ursula K. Le Guin', '1971'],
            ['The Obelisk Gate', 'N. K. Jemisin', '2016'],
        ])
        ->expectsConfirmation('Import 3 books?', 'yes')
        ->expectsOutputToContain('Imported 3 books.')
        ->assertSuccessful();

    expect(Book::count())->toBe(3);
});

test('answering no imports nothing', function () {
    $this->artisan('books:import', ['file' => 'storage/app/import/books.csv'])
        ->expectsConfirmation('Import 3 books?', 'no')
        ->expectsOutput('Nothing imported.')
        ->assertExitCode(0);

    expect(Book::count())->toBe(0);
});

$ php artisan test --filter=ImportBooksTest
   PASS  Tests\Feature\ImportBooksTest
  ✓ it asks for the missing file and confirms before importing           0.22s
  ✓ answering no imports nothing                                         0.01s
  Tests:    2 passed (10 assertions)