Skip to content

Commit 4016853

Browse files
committed
Rename enum and adjust casing
1 parent 7ba6766 commit 4016853

File tree

7 files changed

+60
-60
lines changed

7 files changed

+60
-60
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -179,24 +179,24 @@ By default, the discovered structures will be sorted according to the OS' defaul
179179
You can change the sorting like this:
180180

181181
```php
182-
use Spatie\StructureDiscoverer\Enums\StructureResolverSort;
182+
use Spatie\StructureDiscoverer\Enums\Sort;
183183

184-
Discover::in(__DIR__)->sortBy(StructureResolverSort::NAME)->get();
184+
Discover::in(__DIR__)->sortBy(Sort::Name)->get();
185185
```
186186

187-
Here are all the available sorting options:
187+
Here are all the available sorting options:
188188

189189
```php
190-
use Spatie\StructureDiscoverer\Enums\StructureResolverSort;
190+
use Spatie\StructureDiscoverer\Enums\Sort;
191191

192-
Discover::in(__DIR__)->sortBy(StructureResolverSort::NAME);
193-
Discover::in(__DIR__)->sortBy(StructureResolverSort::SIZE);
194-
Discover::in(__DIR__)->sortBy(StructureResolverSort::TYPE);
195-
Discover::in(__DIR__)->sortBy(StructureResolverSort::EXTENSION);
196-
Discover::in(__DIR__)->sortBy(StructureResolverSort::CHANGED_TIME);
197-
Discover::in(__DIR__)->sortBy(StructureResolverSort::MODIFIED_TIME);
198-
Discover::in(__DIR__)->sortBy(StructureResolverSort::ACCESSED_TIME);
199-
Discover::in(__DIR__)->sortBy(StructureResolverSort::CASE_INSENSITIVE_NAME);
192+
Discover::in(__DIR__)->sortBy(Sort::Name);
193+
Discover::in(__DIR__)->sortBy(Sort::Size);
194+
Discover::in(__DIR__)->sortBy(Sort::Type);
195+
Discover::in(__DIR__)->sortBy(Sort::Extension);
196+
Discover::in(__DIR__)->sortBy(Sort::ChangedTime);
197+
Discover::in(__DIR__)->sortBy(Sort::ModifiedTime);
198+
Discover::in(__DIR__)->sortBy(Sort::AccessedTime);
199+
Discover::in(__DIR__)->sortBy(Sort::CaseInsensitiveName);
200200
```
201201

202202
### Combining conditions

src/Data/DiscoverProfileConfig.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
use Spatie\StructureDiscoverer\Cache\DiscoverCacheDriver;
66
use Spatie\StructureDiscoverer\DiscoverConditions\ExactDiscoverCondition;
77
use Spatie\StructureDiscoverer\DiscoverWorkers\DiscoverWorker;
8-
use Spatie\StructureDiscoverer\Enums\StructureResolverSort;
8+
use Spatie\StructureDiscoverer\Enums\Sort;
99

1010
class DiscoverProfileConfig
1111
{
@@ -18,7 +18,7 @@ public function __construct(
1818
public ?string $cacheId,
1919
public bool $withChains,
2020
public ExactDiscoverCondition $conditions,
21-
public ?StructureResolverSort $sortBy,
21+
public ?Sort $sort,
2222
public bool $reverseSorting
2323
) {
2424
}

src/Discover.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
use Spatie\StructureDiscoverer\DiscoverWorkers\DiscoverWorker;
1010
use Spatie\StructureDiscoverer\DiscoverWorkers\ParallelDiscoverWorker;
1111
use Spatie\StructureDiscoverer\DiscoverWorkers\SynchronousDiscoverWorker;
12-
use Spatie\StructureDiscoverer\Enums\StructureResolverSort;
12+
use Spatie\StructureDiscoverer\Enums\Sort;
1313
use Spatie\StructureDiscoverer\Exceptions\NoCacheConfigured;
1414
use Spatie\StructureDiscoverer\Support\Conditions\HasConditionsTrait;
1515
use Spatie\StructureDiscoverer\Support\LaravelDetector;
@@ -43,7 +43,7 @@ public function __construct(
4343
?DiscoverCacheDriver $cacheDriver = null,
4444
?string $cacheId = null,
4545
bool $withChains = true,
46-
StructureResolverSort $sortBy = null,
46+
Sort $sort = null,
4747
bool $reverseSorting = false,
4848
) {
4949
$this->config = new DiscoverProfileConfig(
@@ -55,7 +55,7 @@ public function __construct(
5555
cacheId: $cacheId,
5656
withChains: $withChains,
5757
conditions: $conditions,
58-
sortBy: $sortBy,
58+
sort: $sort,
5959
reverseSorting: $reverseSorting
6060
);
6161
}
@@ -74,9 +74,9 @@ public function ignoreFiles(string ...$ignoredFiles): self
7474
return $this;
7575
}
7676

77-
public function sortBy(StructureResolverSort $sortBy, bool $reverse = false): self
77+
public function sortBy(Sort $sort, bool $reverse = false): self
7878
{
79-
$this->config->sortBy = $sortBy;
79+
$this->config->sort = $sort;
8080
$this->config->reverseSorting = $reverse;
8181

8282
return $this;

src/Enums/Sort.php

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?php
2+
3+
namespace Spatie\StructureDiscoverer\Enums;
4+
5+
use Symfony\Component\Finder\Finder;
6+
7+
enum Sort
8+
{
9+
case Name;
10+
case Size;
11+
case Type;
12+
case Extension;
13+
case ChangedTime;
14+
case ModifiedTime;
15+
case AccessedTime;
16+
case CaseInsensitiveName;
17+
18+
public function apply(Finder $finder): void
19+
{
20+
match ($this) {
21+
self::Name => $finder->sortByName(),
22+
self::Size => $finder->sortBySize(),
23+
self::Type => $finder->sortByType(),
24+
self::Extension => $finder->sortByExtension(),
25+
self::ChangedTime => $finder->sortByChangedTime(),
26+
self::ModifiedTime => $finder->sortByModifiedTime(),
27+
self::AccessedTime => $finder->sortByAccessedTime(),
28+
self::CaseInsensitiveName => $finder->sortByCaseInsensitiveName(),
29+
};
30+
}
31+
}

src/Enums/StructureResolverSort.php

Lines changed: 0 additions & 31 deletions
This file was deleted.

src/Support/StructuresResolver.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
use Spatie\StructureDiscoverer\Discover;
77
use Spatie\StructureDiscoverer\DiscoverWorkers\DiscoverWorker;
88
use Spatie\StructureDiscoverer\DiscoverWorkers\SynchronousDiscoverWorker;
9-
use Spatie\StructureDiscoverer\Enums\StructureResolverSort;
9+
use Spatie\StructureDiscoverer\Enums\Sort;
1010
use SplFileInfo;
1111
use Symfony\Component\Finder\Finder;
1212

@@ -24,7 +24,7 @@ public function execute(Discover $profile): array
2424
$structures = $this->discover(
2525
$profile->config->directories,
2626
$profile->config->ignoredFiles,
27-
$profile->config->sortBy,
27+
$profile->config->sort,
2828
$profile->config->reverseSorting,
2929
);
3030

@@ -51,7 +51,7 @@ public function execute(Discover $profile): array
5151
public function discover(
5252
array $directories,
5353
array $ignoredFiles,
54-
?StructureResolverSort $sort,
54+
?Sort $sort,
5555
bool $reverseSorting
5656
): array {
5757
if (empty($directories)) {

tests/StructureDiscovererTest.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
use Spatie\StructureDiscoverer\Enums\StructureResolverSort;
3+
use Spatie\StructureDiscoverer\Enums\Sort;
44
use function Pest\Laravel\artisan;
55

66
use Spatie\StructureDiscoverer\Cache\FileDiscoverCacheDriver;
@@ -279,16 +279,16 @@ public function satisfies(DiscoveredStructure $discoveredData): bool
279279
});
280280

281281
it('can sort discovered files', function (
282-
StructureResolverSort $sortBy,
282+
Sort $sort,
283283
array $expected,
284284
) {
285-
$found = Discover::in(__DIR__ . '/Fakes')->classes()->sortBy($sortBy)->get();
285+
$found = Discover::in(__DIR__ . '/Fakes')->classes()->sortBy($sort)->get();
286286

287287
expect($found)->toEqual($expected);
288288
})->with(
289289
[
290290
'name' => [
291-
StructureResolverSort::NAME,
291+
Sort::Name,
292292
[
293293
FakeClassDepender::class,
294294
FakeAttribute::class,
@@ -303,16 +303,16 @@ public function satisfies(DiscoveredStructure $discoveredData): bool
303303
);
304304

305305
it('can sort discovered files in reverse', function (
306-
StructureResolverSort $sortBy,
306+
Sort $sort,
307307
array $expected,
308308
) {
309-
$found = Discover::in(__DIR__ . '/Fakes')->classes()->sortBy($sortBy, true)->get();
309+
$found = Discover::in(__DIR__ . '/Fakes')->classes()->sortBy($sort, true)->get();
310310

311311
expect($found)->toEqual($expected);
312312
})->with(
313313
[
314314
'name' => [
315-
StructureResolverSort::NAME,
315+
Sort::Name,
316316
[
317317
FakeOtherNestedClass::class,
318318
FakeNestedClass::class,

0 commit comments

Comments
 (0)