14393323144

Committed 10 Apr 2025 04:27PM UTC coverage: 81.196% (-0.2%) from 81.363%

Build # 14393323144

Build Type

push

github

Committed by

web-flow

Commit Message

refactor(core): rename `DoNotDiscover` to `SkipDiscovery` (#1142)

Run Details

7 of 9 new or added lines in 9 files covered. (77.78%)

52 existing lines in 11 files now uncovered.

11529 of 14199 relevant lines covered (81.2%)

106.5 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

92.73

/src/Tempest/Database/src/Commands/MakeMigrationCommand.php

<?php

declare(strict_types=1);

namespace Tempest\Database\Commands;

use InvalidArgumentException;
use Tempest\Console\ConsoleArgument;
use Tempest\Console\ConsoleCommand;
use Tempest\Core\PublishesFiles;
use Tempest\Database\Enums\MigrationType;
use Tempest\Database\Stubs\MigrationStub;
use Tempest\Discovery\SkipDiscovery;
use Tempest\Generation\ClassManipulator;
use Tempest\Generation\DataObjects\StubFile;
use Tempest\Generation\Exceptions\FileGenerationAbortedException;
use Tempest\Generation\Exceptions\FileGenerationFailedException;
use Tempest\Validation\Rules\EndsWith;
use Tempest\Validation\Rules\NotEmpty;

use function Tempest\Support\str;

final class MakeMigrationCommand
{
    use PublishesFiles;

    #[ConsoleCommand(
        name: 'make:migration',
        description: 'Creates a new migration file',
        aliases: ['migration:make', 'migration:create', 'create:migration'],
    )]
    public function __invoke(
        #[ConsoleArgument(
            description: 'The file name of the migration',
        )]
        string $fileName,
        #[ConsoleArgument(
            name: 'type',
            description: 'The type of the migration to create',
        )]
        MigrationType $migrationType = MigrationType::OBJECT,
    ): void {
        try {
            $stubFile = $this->getStubFileFromMigrationType($migrationType);
            $targetPath = match ($migrationType) {
                MigrationType::RAW => $this->generateRawFile($fileName, $stubFile),
                default => $this->generateClassFile($fileName, $stubFile),
            };

            $this->success(sprintf('Migration file successfully created at "%s".', $targetPath));
        } catch (FileGenerationAbortedException|FileGenerationFailedException|InvalidArgumentException $e) {
            $this->error($e->getMessage());
        }
    }

    /**
     * Generates a raw migration file.
     * @param string $fileName The name of the file.
     * @param StubFile $stubFile The stub file to use.
     *
     * @return string The path to the generated file.
     */
    private function generateRawFile(
        string $fileName,
        StubFile $stubFile,
    ): string {
        $now = date('Y-m-d');
        $tableName = str($fileName)->snake()->toString();
        $suggestedPath = str($this->getSuggestedPath('Dummy'))
            ->replace(
                ['Dummy', '.php'],
                [$now . '_' . $tableName, '.sql'],
            )
            ->toString();

        $targetPath = $this->promptTargetPath($suggestedPath, rules: [
            new NotEmpty(),
            new EndsWith('.sql'),
        ]);
        $shouldOverride = $this->askForOverride($targetPath);

        $this->stubFileGenerator->generateRawFile(
            stubFile: $stubFile,
            targetPath: $targetPath,
            shouldOverride: $shouldOverride,
            replacements: [
                'DummyTableName' => $tableName,
            ],
        );

        return $targetPath;
    }

    /**
     * Generates a class migration file.
     *
     * @param string $fileName The name of the file.
     * @param StubFile $stubFile The stub file to use.
     *
     * @return string The path to the generated file.
     */
    private function generateClassFile(
        string $fileName,
        StubFile $stubFile,
    ): string {
        $suggestedPath = $this->getSuggestedPath($fileName);
        $targetPath = $this->promptTargetPath($suggestedPath);
        $shouldOverride = $this->askForOverride($targetPath);

        $this->stubFileGenerator->generateClassFile(
            stubFile: $stubFile,
            targetPath: $targetPath,
            shouldOverride: $shouldOverride,
            replacements: [
                'dummy-date' => date('Y-m-d'),
                'dummy-table-name' => str($fileName)->snake()->toString(),
            ],
            manipulations: [
                fn (ClassManipulator $class) => $class->removeClassAttribute(SkipDiscovery::class),
            ],
        );

        return $targetPath;
    }

    private function getStubFileFromMigrationType(MigrationType $migrationType): StubFile
    {
        try {
            return match ($migrationType) {
                MigrationType::RAW => StubFile::from(dirname(__DIR__) . '/Stubs/migration.stub.sql'),
                MigrationType::OBJECT => StubFile::from(MigrationStub::class), // @phpstan-ignore match.alwaysTrue (Because this is a guardrail for the future implementations)
                default => throw new InvalidArgumentException(sprintf('The "%s" migration type has no supported stub file.', $migrationType->value)),
            };
        } catch (InvalidArgumentException $invalidArgumentException) {
            throw new FileGenerationFailedException(sprintf('Cannot retrieve stub file: %s', $invalidArgumentException->getMessage()));
        }
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	namespace Tempest\Database\Commands;
6
7	use InvalidArgumentException;
8	use Tempest\Console\ConsoleArgument;
9	use Tempest\Console\ConsoleCommand;
10	use Tempest\Core\PublishesFiles;
11	use Tempest\Database\Enums\MigrationType;
12	use Tempest\Database\Stubs\MigrationStub;
13	use Tempest\Discovery\SkipDiscovery;
14	use Tempest\Generation\ClassManipulator;
15	use Tempest\Generation\DataObjects\StubFile;
16	use Tempest\Generation\Exceptions\FileGenerationAbortedException;
17	use Tempest\Generation\Exceptions\FileGenerationFailedException;
18	use Tempest\Validation\Rules\EndsWith;
19	use Tempest\Validation\Rules\NotEmpty;
20
21	use function Tempest\Support\str;
22
23	final class MakeMigrationCommand
24	{
25	use PublishesFiles;
26
27	#[ConsoleCommand(	4✔
28	name: 'make:migration',
29	description: 'Creates a new migration file',
30	aliases: ['migration:make', 'migration:create', 'create:migration'],
31	)]
32	public function __invoke(
33	#[ConsoleArgument(
34	description: 'The file name of the migration',
35	)]
36	string $fileName,
37	#[ConsoleArgument(
38	name: 'type',
39	description: 'The type of the migration to create',
40	)]
41	MigrationType $migrationType = MigrationType::OBJECT,
42	): void {
43	try {
44	$stubFile = $this->getStubFileFromMigrationType($migrationType);	4✔
45	$targetPath = match ($migrationType) {	4✔
46	MigrationType::RAW => $this->generateRawFile($fileName, $stubFile),	4✔
47	default => $this->generateClassFile($fileName, $stubFile),	3✔
48	};	4✔
49
50	$this->success(sprintf('Migration file successfully created at "%s".', $targetPath));	4✔
UNCOV 51	} catch (FileGenerationAbortedException\|FileGenerationFailedException\|InvalidArgumentException $e) {	×
UNCOV 52	$this->error($e->getMessage());	×
53	}
54	}
55
56	/**
57	* Generates a raw migration file.
58	* @param string $fileName The name of the file.
59	* @param StubFile $stubFile The stub file to use.
60	*
61	* @return string The path to the generated file.
62	*/
63	private function generateRawFile(	1✔
64	string $fileName,
65	StubFile $stubFile,
66	): string {
67	$now = date('Y-m-d');	1✔
68	$tableName = str($fileName)->snake()->toString();	1✔
69	$suggestedPath = str($this->getSuggestedPath('Dummy'))	1✔
70	->replace(	1✔
71	['Dummy', '.php'],	1✔
72	[$now . '_' . $tableName, '.sql'],	1✔
73	)	1✔
74	->toString();	1✔
75
76	$targetPath = $this->promptTargetPath($suggestedPath, rules: [	1✔
77	new NotEmpty(),	1✔
78	new EndsWith('.sql'),	1✔
79	]);	1✔
80	$shouldOverride = $this->askForOverride($targetPath);	1✔
81
82	$this->stubFileGenerator->generateRawFile(	1✔
83	stubFile: $stubFile,	1✔
84	targetPath: $targetPath,	1✔
85	shouldOverride: $shouldOverride,	1✔
86	replacements: [	1✔
87	'DummyTableName' => $tableName,	1✔
88	],	1✔
89	);	1✔
90
91	return $targetPath;	1✔
92	}
93
94	/**
95	* Generates a class migration file.
96	*
97	* @param string $fileName The name of the file.
98	* @param StubFile $stubFile The stub file to use.
99	*
100	* @return string The path to the generated file.
101	*/
102	private function generateClassFile(	3✔
103	string $fileName,
104	StubFile $stubFile,
105	): string {
106	$suggestedPath = $this->getSuggestedPath($fileName);	3✔
107	$targetPath = $this->promptTargetPath($suggestedPath);	3✔
108	$shouldOverride = $this->askForOverride($targetPath);	3✔
109
110	$this->stubFileGenerator->generateClassFile(	3✔
111	stubFile: $stubFile,	3✔
112	targetPath: $targetPath,	3✔
113	shouldOverride: $shouldOverride,	3✔
114	replacements: [	3✔
115	'dummy-date' => date('Y-m-d'),	3✔
116	'dummy-table-name' => str($fileName)->snake()->toString(),	3✔
117	],	3✔
118	manipulations: [	3✔
119	fn (ClassManipulator $class) => $class->removeClassAttribute(SkipDiscovery::class),	3✔
120	],	3✔
121	);	3✔
122
123	return $targetPath;	3✔
124	}
125
126	private function getStubFileFromMigrationType(MigrationType $migrationType): StubFile	4✔
127	{
128	try {
129	return match ($migrationType) {
130	MigrationType::RAW => StubFile::from(dirname(__DIR__) . '/Stubs/migration.stub.sql'),	4✔
131	MigrationType::OBJECT => StubFile::from(MigrationStub::class), // @phpstan-ignore match.alwaysTrue (Because this is a guardrail for the future implementations)	3✔
132	default => throw new InvalidArgumentException(sprintf('The "%s" migration type has no supported stub file.', $migrationType->value)),	4✔
133	};
UNCOV 134	} catch (InvalidArgumentException $invalidArgumentException) {	×
UNCOV 135	throw new FileGenerationFailedException(sprintf('Cannot retrieve stub file: %s', $invalidArgumentException->getMessage()));	×
136	}
137	}
138	}

tempestphp / tempest-framework / 14393323144

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous