Improve sorting algorithm (#114)

Improve sorting algorithm (#114)

Author: beeyev

tests/Unit/Updater/ChangelogTracker/ChangelogTrackerTest.php

@@ -19,6 +19,7 @@
  * @uses  \Beeyev\DisposableEmailFilter\Updater\Shared\Whitelist
  * @uses  \Beeyev\DisposableEmailFilter\Updater\SourceBlacklistsLoader\Dto\SourceBlacklistItemDto
  * @uses  \Beeyev\DisposableEmailFilter\Updater\SourceBlacklistsLoader\Dto\SourceBlacklistsDto
+ * @uses  \Beeyev\DisposableEmailFilter\Updater\Support\Utils
  *
  * @internal
  */

tests/Unit/Updater/Support/DomainsExtractorTest.php

@@ -22,8 +22,8 @@ public function testSuccessfullyExtractsDomains(): void
 
         self::assertSame(
             [
-                '1dcv.com',
                 '01dcv.com',
+                '1dcv.com',
                 'abc02.com',
                 'abc03.com',
                 'abc1.com',

tests/Unit/Updater/Support/UtilsTest.php

@@ -70,4 +70,59 @@ public function testHash(): void
         $hash = Utils::hash('lorem ipsum dolor sit amet');
         self::assertSame('201730d4278e576b25515bd90c6072d3', $hash);
     }
+
+    /**
+     * @dataProvider domainProvider
+     */
+    public function testNaturalSortOrdersDomainsCorrectly(array $input, array $expected): void
+    {
+        $result = Utils::naturalSort($input);
+        self::assertSame($expected, $result);
+    }
+
+    public function domainProvider(): array
+    {
+        return [
+            'Numerical sorting with leading zeros' => [
+                ['47gmail.com', '047gmail.com', '47bmt.com'],
+                ['47bmt.com', '047gmail.com', '47gmail.com'],
+            ],
+            'Mixed numerical/alpha segments' => [
+                ['img12.com', 'img2.com', 'img1.com'],
+                ['img1.com', 'img2.com', 'img12.com'],
+            ],
+            'Natural equivalence with string fallback' => [
+                ['apple01.com', 'apple1.com', 'apple001.com'],
+                ['apple001.com', 'apple01.com', 'apple1.com'],
+            ],
+            'Different TLDs with same name' => [
+                ['test.net', 'test.com', 'test.org'],
+                ['test.com', 'test.net', 'test.org'],
+            ],
+            'Complex domain patterns' => [
+                ['1a.example.com', 'a1.example.com', '01a.example.com'],
+                ['01a.example.com', '1a.example.com', 'a1.example.com'],
+            ],
+            'Subdomain sorting' => [
+                ['blog.47gmail.com', '047gmail.com', 'mail.47gmail.com'],
+                ['047gmail.com', 'blog.47gmail.com', 'mail.47gmail.com'],
+            ],
+            'Numerical TLDs (uncommon but valid)' => [
+                ['example.42', 'example.7', 'example.007'],
+                ['example.007', 'example.7', 'example.42'],
+            ],
+            'Empty' => [
+                [],
+                [],
+            ],
+            'Single' => [
+                ['single.com'],
+                ['single.com'],
+            ],
+            'Duplicates' => [
+                ['dup.com', 'dup.com'],
+                ['dup.com', 'dup.com'],
+            ],
+        ];
+    }
 }

updater/ChangelogTracker/ChangelogTracker.php

@@ -12,6 +12,7 @@
 use Beeyev\DisposableEmailFilter\Updater\Shared\Whitelist;
 use Beeyev\DisposableEmailFilter\Updater\SourceBlacklistsLoader\Dto\SourceBlacklistItemDto;
 use Beeyev\DisposableEmailFilter\Updater\SourceBlacklistsLoader\Dto\SourceBlacklistsDto;
+use Beeyev\DisposableEmailFilter\Updater\Support\Utils;
 
 /**
  * @phpstan-type LastSyncedBlacklists array{
@@ -162,9 +163,8 @@ private function getOverallAddedDomains(array $lastSyncedBlacklists): array
         }, $this->sourceBlacklistsDto->items))));
 
         $result = array_diff($bDomains, $lastSyncedBlacklistDomains);
-        natsort($result);
 
-        return array_values($result);
+        return Utils::naturalSort($result);
     }
 
     /**
@@ -183,9 +183,8 @@ private function getOverallRemovedDomains(array $lastSyncedBlacklists): array
         }, $this->sourceBlacklistsDto->items))));
 
         $result = array_diff($lastSyncedBlacklistDomains, $bDomains);
-        natsort($result);
 
-        return array_values($result);
+        return Utils::naturalSort($result);
     }
 
     /**

updater/PrepareBlacklistService.php

@@ -9,6 +9,7 @@
 use Beeyev\DisposableEmailFilter\Updater\DataManipulation\ContentsManipulatorInterface;
 use Beeyev\DisposableEmailFilter\Updater\SourceBlacklistsLoader\Dto\SourceBlacklistsDto;
 use Beeyev\DisposableEmailFilter\Updater\Support\DomainsExtractor;
+use Beeyev\DisposableEmailFilter\Updater\Support\Utils;
 
 /** @internal */
 final class PrepareBlacklistService
@@ -42,9 +43,7 @@ public function getPreparedBlacklist(): array
         $result = array_diff($blacklistData, $whitelistData);
         assert(count($result) > 0);
 
-        natsort($result);
-
-        return array_values($result);
+        return Utils::naturalSort($result);
     }
 
     /**

updater/ReleaseNotesUpdater/ReleaseNotesUpdater.php

@@ -125,6 +125,6 @@ private function getDomainsPreview(array $domains): string
             $result[] = '... See full list in the source file.';
         }
 
-        return implode(PHP_EOL, $result); // @phpstan-ignore return.type
+        return implode(PHP_EOL, $result);
     }
 }

updater/Support/DomainsExtractor.php

@@ -44,9 +44,7 @@ public static function toArray(string $multilineDomainList): array
 
         $result = array_unique($result);
 
-        natsort($result);
-
-        return array_values($result);
+        return Utils::naturalSort($result);
     }
 
     private static function isDomainValid(string $domain): bool

updater/Support/Utils.php

@@ -85,4 +85,24 @@ public static function hash(string $string): string
     {
         return md5($string);
     }
+
+    /**
+     * @param array<string> $inputArray
+     *
+     * @return array<string>
+     */
+    public static function naturalSort(array $inputArray): array
+    {
+        $sut = $inputArray;
+
+        uasort($sut, static function (string $a, string $b): int {
+            if (($cmp = strnatcmp($a, $b)) !== 0) {
+                return $cmp;
+            }
+
+            return strcmp($a, $b);
+        });
+
+        return array_values($sut);
+    }
 }