Merge pull request #6 from stevebauman/main

Add ability to sort discovered files

Author: freekmurze

README.md

@@ -172,6 +172,33 @@ Discover::in(__DIR__)
     ->get()
 ```
 
+### Sorting
+
+By default, the discovered structures will be sorted according to the OS' default.
+
+You can change the sorting like this:
+
+```php
+use Spatie\StructureDiscoverer\Enums\Sort;
+
+Discover::in(__DIR__)->sortBy(Sort::Name)->get();
+```
+
+Here are all the available sorting options:
+
+```php
+use Spatie\StructureDiscoverer\Enums\Sort;
+
+Discover::in(__DIR__)->sortBy(Sort::Name);
+Discover::in(__DIR__)->sortBy(Sort::Size);
+Discover::in(__DIR__)->sortBy(Sort::Type);
+Discover::in(__DIR__)->sortBy(Sort::Extension);
+Discover::in(__DIR__)->sortBy(Sort::ChangedTime);
+Discover::in(__DIR__)->sortBy(Sort::ModifiedTime);
+Discover::in(__DIR__)->sortBy(Sort::AccessedTime);
+Discover::in(__DIR__)->sortBy(Sort::CaseInsensitiveName);
+```
+
 ### Combining conditions
 
 By default, all conditions will work like an AND operation, so in this case:

src/Data/DiscoverProfileConfig.php

@@ -5,6 +5,7 @@
 use Spatie\StructureDiscoverer\Cache\DiscoverCacheDriver;
 use Spatie\StructureDiscoverer\DiscoverConditions\ExactDiscoverCondition;
 use Spatie\StructureDiscoverer\DiscoverWorkers\DiscoverWorker;
+use Spatie\StructureDiscoverer\Enums\Sort;
 
 class DiscoverProfileConfig
 {
@@ -17,6 +18,8 @@ public function __construct(
         public ?string $cacheId,
         public bool $withChains,
         public ExactDiscoverCondition $conditions,
+        public ?Sort $sort,
+        public bool $reverseSorting
     ) {
     }
 

src/Discover.php

@@ -9,6 +9,7 @@
 use Spatie\StructureDiscoverer\DiscoverWorkers\DiscoverWorker;
 use Spatie\StructureDiscoverer\DiscoverWorkers\ParallelDiscoverWorker;
 use Spatie\StructureDiscoverer\DiscoverWorkers\SynchronousDiscoverWorker;
+use Spatie\StructureDiscoverer\Enums\Sort;
 use Spatie\StructureDiscoverer\Exceptions\NoCacheConfigured;
 use Spatie\StructureDiscoverer\Support\Conditions\HasConditionsTrait;
 use Spatie\StructureDiscoverer\Support\LaravelDetector;
@@ -42,6 +43,8 @@ public function __construct(
         ?DiscoverCacheDriver $cacheDriver = null,
         ?string $cacheId = null,
         bool $withChains = true,
+        Sort $sort = null,
+        bool $reverseSorting = false,
     ) {
         $this->config = new DiscoverProfileConfig(
             directories: $directories,
@@ -52,6 +55,8 @@ public function __construct(
             cacheId: $cacheId,
             withChains: $withChains,
             conditions: $conditions,
+            sort: $sort,
+            reverseSorting: $reverseSorting
         );
     }
 
@@ -69,6 +74,14 @@ public function ignoreFiles(string ...$ignoredFiles): self
         return $this;
     }
 
+    public function sortBy(Sort $sort, bool $reverse = false): self
+    {
+        $this->config->sort = $sort;
+        $this->config->reverseSorting = $reverse;
+
+        return $this;
+    }
+
     public function full(): self
     {
         $this->config->full = true;

src/Enums/Sort.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Spatie\StructureDiscoverer\Enums;
+
+use Symfony\Component\Finder\Finder;
+
+enum Sort
+{
+    case Name;
+    case Size;
+    case Type;
+    case Extension;
+    case ChangedTime;
+    case ModifiedTime;
+    case AccessedTime;
+    case CaseInsensitiveName;
+
+    public function apply(Finder $finder): void
+    {
+        match ($this) {
+            self::Name => $finder->sortByName(),
+            self::Size => $finder->sortBySize(),
+            self::Type => $finder->sortByType(),
+            self::Extension => $finder->sortByExtension(),
+            self::ChangedTime => $finder->sortByChangedTime(),
+            self::ModifiedTime => $finder->sortByModifiedTime(),
+            self::AccessedTime => $finder->sortByAccessedTime(),
+            self::CaseInsensitiveName => $finder->sortByCaseInsensitiveName(),
+        };
+    }
+}

src/Support/StructuresResolver.php

@@ -6,6 +6,7 @@
 use Spatie\StructureDiscoverer\Discover;
 use Spatie\StructureDiscoverer\DiscoverWorkers\DiscoverWorker;
 use Spatie\StructureDiscoverer\DiscoverWorkers\SynchronousDiscoverWorker;
+use Spatie\StructureDiscoverer\Enums\Sort;
 use SplFileInfo;
 use Symfony\Component\Finder\Finder;
 
@@ -22,7 +23,9 @@ public function execute(Discover $profile): array
     {
         $structures = $this->discover(
             $profile->config->directories,
-            $profile->config->ignoredFiles
+            $profile->config->ignoredFiles,
+            $profile->config->sort,
+            $profile->config->reverseSorting,
         );
 
         if ($profile->config->withChains) {
@@ -47,13 +50,25 @@ public function execute(Discover $profile): array
     /** @return array<DiscoveredStructure> */
     public function discover(
         array $directories,
-        array $ignoredFiles = [],
+        array $ignoredFiles,
+        ?Sort $sort,
+        bool $reverseSorting
     ): array {
         if (empty($directories)) {
             return [];
         }
 
-        $files = (new Finder())->files()->in($directories);
+        $finder = (new Finder())->files();
+
+        if ($sort) {
+            $sort->apply($finder);
+        }
+
+        if ($reverseSorting) {
+            $finder->reverseSorting();
+        }
+
+        $files = $finder->in($directories);
 
         $filenames = collect($files)
             ->reject(fn (SplFileInfo $file) => in_array($file->getPathname(), $ignoredFiles) || $file->getExtension() !== 'php')

tests/StructureDiscovererTest.php

@@ -1,5 +1,6 @@
 <?php
 
+use Spatie\StructureDiscoverer\Enums\Sort;
 use function Pest\Laravel\artisan;
 
 use Spatie\StructureDiscoverer\Cache\FileDiscoverCacheDriver;
@@ -277,6 +278,54 @@ public function satisfies(DiscoveredStructure $discoveredData): bool
     ]);
 });
 
+it('can sort discovered files', function (
+    Sort $sort,
+    array $expected,
+) {
+    $found = Discover::in(__DIR__ . '/Fakes')->classes()->sortBy($sort)->get();
+
+    expect($found)->toEqual($expected);
+})->with(
+    [
+        'name' => [
+            Sort::Name,
+            [
+                FakeClassDepender::class,
+                FakeAttribute::class,
+                FakeChildClass::class,
+                FakeRootClass::class,
+                FakeSubChildClass::class,
+                FakeNestedClass::class,
+                FakeOtherNestedClass::class,
+            ]
+        ],
+    ],
+);
+
+it('can sort discovered files in reverse', function (
+    Sort $sort,
+    array $expected,
+) {
+    $found = Discover::in(__DIR__ . '/Fakes')->classes()->sortBy($sort, true)->get();
+
+    expect($found)->toEqual($expected);
+})->with(
+    [
+        'name' => [
+            Sort::Name,
+            [
+                FakeOtherNestedClass::class,
+                FakeNestedClass::class,
+                FakeSubChildClass::class,
+                FakeRootClass::class,
+                FakeChildClass::class,
+                FakeAttribute::class,
+                FakeClassDepender::class,
+            ]
+        ],
+    ],
+);
+
 it('can ignore files when discovering', function () {
     $found = Discover::in(__DIR__ . '/Fakes/Nested')
         ->ignoreFiles(__DIR__ . '/Fakes/Nested/FakeNestedInterface.php')