Skip to content

Added the ability to exclude paths from processing #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 28, 2022
Merged

Added the ability to exclude paths from processing #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions config/actions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,25 @@
*/

'path' => base_path('actions'),

/*
|--------------------------------------------------------------------------
| Path Exclusion
|--------------------------------------------------------------------------
|
| This option determines which directory and/or file paths should be
| excluded when processing files.
|
| Valid values: array, string or null
|
| Specify `null` to disable.
|
| For example,
| ['foo', 'bar']
| 'foo'
| null
|
*/

'exclude' => null,
];
9 changes: 9 additions & 0 deletions src/Helpers/Config.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace DragonCode\LaravelActions\Helpers;

use DragonCode\Support\Facades\Helpers\Arr;
use Illuminate\Config\Repository;

class Config
Expand All @@ -28,6 +29,14 @@ public function table(): string
return $this->config->get('actions.table');
}

public function exclude(): array
{
return Arr::of((array) $this->config->get('actions.exclude'))
->map(fn (string $path) => str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $path))
->filter()
->toArray();
}

public function path(?string $path = null): string
{
$directory = $this->config->get('actions.path', base_path('actions'));
Expand Down
2 changes: 2 additions & 0 deletions src/Processors/Processor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ protected function getFiles(string $path, ?Closure $filter = null): array

$files = $this->isFile($file) ? [$file] : $this->file->names($path, $filter, true);

$files = Arr::filter($files, fn (string $path) => ! Str::contains($path, $this->config->exclude()));

return Arr::of($this->sorter->byValues($files))
->map(fn (string $value) => Str::before($value, '.php'))
->toArray();
Expand Down
150 changes: 121 additions & 29 deletions tests/Commands/MigrateTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,22 +61,22 @@ public function testOnce()
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 1);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationDoesntLike($this->table, $table);
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 2);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationDoesntLike($this->table, $table);
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 3);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationDoesntLike($this->table, $table);
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 4);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationDoesntLike($this->table, $table);
}

Expand Down Expand Up @@ -141,7 +141,7 @@ public function testSingleEnvironment()
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 5);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationHas($this->table, 'run_on_all');
$this->assertDatabaseMigrationDoesntLike($this->table, 'run_on_production');
$this->assertDatabaseMigrationHas($this->table, 'run_on_testing');
Expand All @@ -150,7 +150,7 @@ public function testSingleEnvironment()
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 5);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationHas($this->table, 'run_on_all');
$this->assertDatabaseMigrationDoesntLike($this->table, 'run_on_production');
$this->assertDatabaseMigrationHas($this->table, 'run_on_testing');
Expand Down Expand Up @@ -178,7 +178,7 @@ public function testManyEnvironments()
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 5);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationHas($this->table, 'run_on_all');
$this->assertDatabaseMigrationDoesntLike($this->table, 'run_on_production');
$this->assertDatabaseMigrationHas($this->table, 'run_on_testing');
Expand All @@ -189,7 +189,7 @@ public function testManyEnvironments()
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 5);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationHas($this->table, 'run_on_all');
$this->assertDatabaseMigrationDoesntLike($this->table, 'run_on_production');
$this->assertDatabaseMigrationHas($this->table, 'run_on_testing');
Expand All @@ -214,13 +214,13 @@ public function testAllow()
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 5);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationHas($this->table, 'run_allow');
$this->assertDatabaseMigrationDoesntLike($this->table, 'run_disallow');
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 5);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationHas($this->table, 'run_allow');
$this->assertDatabaseMigrationDoesntLike($this->table, 'run_disallow');
}
Expand All @@ -239,7 +239,7 @@ public function testUpSuccess()
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 2);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationHas($this->table, 'run_success');
}

Expand All @@ -257,7 +257,7 @@ public function testUpSuccessOnFailed()
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 2);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationDoesntLike($this->table, 'run_success_on_failed');

try {
Expand All @@ -274,7 +274,7 @@ public function testUpSuccessOnFailed()
}

$this->assertDatabaseCount($table, 2);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationDoesntLike($this->table, 'run_success_on_failed');
}

Expand All @@ -292,7 +292,7 @@ public function testUpFailed()
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 0);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationHas($this->table, 'run_failed');
}

Expand All @@ -310,12 +310,9 @@ public function testUpFailedOnException()
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 0);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationDoesntLike($this->table, 'run_failed_failure');

$this->assertDatabaseCount($table, 0);
$this->assertDatabaseCount($this->table, 11);

try {
$this->copyFailedMethod();

Expand All @@ -330,7 +327,7 @@ public function testUpFailedOnException()
}

$this->assertDatabaseCount($table, 0);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationDoesntLike($this->table, 'run_failed_failure');
}

Expand Down Expand Up @@ -393,8 +390,8 @@ public function testPathAsDirectory()
$this->assertDatabaseMigrationDoesntLike($this->table, 'baz');
$this->artisan(Names::MIGRATE, ['--path' => $path])->assertExitCode(0);

$this->assertDatabaseCount($table, 1);
$this->assertDatabaseCount($this->table, 1);
$this->assertDatabaseCount($table, 2);
$this->assertDatabaseCount($this->table, 2);
$this->assertDatabaseMigrationHas($this->table, 'baz');

$this->assertSame('sub_path/2021_12_15_205804_baz', $this->table()->first()->action);
Expand Down Expand Up @@ -426,13 +423,13 @@ public function testDisabledBefore()
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 2);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationHas($this->table, 'test_before_enabled');
$this->assertDatabaseMigrationHas($this->table, 'test_before_disabled');
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 2);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationHas($this->table, 'test_before_enabled');
$this->assertDatabaseMigrationHas($this->table, 'test_before_disabled');
}
Expand All @@ -452,13 +449,13 @@ public function testEnabledBefore()
$this->artisan(Names::MIGRATE, ['--before' => true])->assertExitCode(0);

$this->assertDatabaseCount($table, 1);
$this->assertDatabaseCount($this->table, 10);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseMigrationHas($this->table, 'test_before_enabled');
$this->assertDatabaseMigrationDoesntLike($this->table, 'test_before_disabled');
$this->artisan(Names::MIGRATE, ['--before' => true])->assertExitCode(0);

$this->assertDatabaseCount($table, 1);
$this->assertDatabaseCount($this->table, 10);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseMigrationHas($this->table, 'test_before_enabled');
$this->assertDatabaseMigrationDoesntLike($this->table, 'test_before_disabled');
}
Expand All @@ -478,25 +475,25 @@ public function testMixedBefore()
$this->artisan(Names::MIGRATE, ['--before' => true])->assertExitCode(0);

$this->assertDatabaseCount($table, 1);
$this->assertDatabaseCount($this->table, 10);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseMigrationHas($this->table, 'test_before_enabled');
$this->assertDatabaseMigrationDoesntLike($this->table, 'test_before_disabled');
$this->artisan(Names::MIGRATE, ['--before' => true])->assertExitCode(0);

$this->assertDatabaseCount($table, 1);
$this->assertDatabaseCount($this->table, 10);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseMigrationHas($this->table, 'test_before_enabled');
$this->assertDatabaseMigrationDoesntLike($this->table, 'test_before_disabled');
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 2);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationHas($this->table, 'test_before_enabled');
$this->assertDatabaseMigrationHas($this->table, 'test_before_disabled');
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 2);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseCount($this->table, 12);
$this->assertDatabaseMigrationHas($this->table, 'test_before_enabled');
$this->assertDatabaseMigrationHas($this->table, 'test_before_disabled');
}
Expand Down Expand Up @@ -560,4 +557,99 @@ public function testSorting(): void

$this->assertSame($files, $records);
}

public function testDirectoryExclusion()
{
$this->copyFiles();

$this->app['config']->set('actions.exclude', 'sub_path');

$table = 'every_time';

$this->artisan(Names::INSTALL)->assertExitCode(0);

$this->assertDatabaseCount($table, 0);
$this->assertDatabaseCount($this->table, 0);
$this->assertDatabaseMigrationDoesntLike($this->table, $table);
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path');
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path/2021_12_15_205804_baz');
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path/2022_10_27_230732_foo');
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 1);
$this->assertDatabaseCount($this->table, 10);
$this->assertDatabaseMigrationDoesntLike($this->table, $table);
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path');
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path/2021_12_15_205804_baz');
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path/2022_10_27_230732_foo');
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 2);
$this->assertDatabaseCount($this->table, 10);
$this->assertDatabaseMigrationDoesntLike($this->table, $table);
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path');
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path/2021_12_15_205804_baz');
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path/2022_10_27_230732_foo');
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 3);
$this->assertDatabaseCount($this->table, 10);
$this->assertDatabaseMigrationDoesntLike($this->table, $table);
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path');
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path/2021_12_15_205804_baz');
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path/2022_10_27_230732_foo');
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 4);
$this->assertDatabaseCount($this->table, 10);
$this->assertDatabaseMigrationDoesntLike($this->table, $table);
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path');
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path/2021_12_15_205804_baz');
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path/2022_10_27_230732_foo');
}

public function testFileExclusion()
{
$this->copyFiles();

$this->app['config']->set('actions.exclude', 'sub_path/2021_12_15_205804_baz');

$table = 'every_time';

$this->artisan(Names::INSTALL)->assertExitCode(0);

$this->assertDatabaseCount($table, 0);
$this->assertDatabaseCount($this->table, 0);
$this->assertDatabaseMigrationDoesntLike($this->table, $table);
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path/2021_12_15_205804_baz');
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path/2022_10_27_230732_foo');
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 1);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseMigrationDoesntLike($this->table, $table);
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path/2021_12_15_205804_baz');
$this->assertDatabaseMigrationHas($this->table, 'sub_path/2022_10_27_230732_foo');
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 2);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseMigrationDoesntLike($this->table, $table);
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path/2021_12_15_205804_baz');
$this->assertDatabaseMigrationHas($this->table, 'sub_path/2022_10_27_230732_foo');
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 3);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseMigrationDoesntLike($this->table, $table);
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path/2021_12_15_205804_baz');
$this->assertDatabaseMigrationHas($this->table, 'sub_path/2022_10_27_230732_foo');
$this->artisan(Names::MIGRATE)->assertExitCode(0);

$this->assertDatabaseCount($table, 4);
$this->assertDatabaseCount($this->table, 11);
$this->assertDatabaseMigrationDoesntLike($this->table, $table);
$this->assertDatabaseMigrationDoesntLike($this->table, 'sub_path/2021_12_15_205804_baz');
$this->assertDatabaseMigrationHas($this->table, 'sub_path/2022_10_27_230732_foo');
}
}
Loading