Use RecursiveDirectoryIterator instead of scandir().

Author: donquixote

src/NamespaceDirectory.php

@@ -534,21 +534,23 @@ public function getIterator(): \Iterator {
   public function getElements(): array {
     $classes = [];
     $subdirs = [];
-    foreach ($this->scanThisDir() as $candidate) {
-      if (!preg_match(self::CANDIDATE_REGEX, $candidate, $m)) {
-        continue;
-      }
-      [, $name, $ext] = $m;
-      $path = $this->directory . '/' . $candidate;
-      if ($ext) {
-        if (is_file($path)) {
-          $classes[$path] = $this->terminatedNamespace . $name;
+    foreach (NsDirUtil::getDirContents($this->directory) as $candidate => $is_dir) {
+      if (!$is_dir) {
+        if (!\str_ends_with($candidate, '.php')) {
+          continue;
+        }
+        $path = $this->directory . '/' . $candidate;
+        $name = \substr($candidate, 0, -4);
+        if (!\preg_match(self::CLASS_NAME_REGEX, $name)) {
+          continue;
         }
+        $classes[$path] = $this->terminatedNamespace . $name;
       }
       else {
-        if (is_dir($path)) {
-          $subdirs[$candidate] = $this->subdir($candidate);
+        if (!\preg_match(self::CLASS_NAME_REGEX, $candidate)) {
+          continue;
         }
+        $subdirs[$candidate] = $this->subdir($candidate);
       }
     }
     /** @var array<string, class-string> $classes */
@@ -560,16 +562,11 @@ public function getElements(): array {
    */
   public function getClassFilesHere(): array {
     $classFiles = [];
-    foreach ($this->scanThisDir() as $candidate) {
-      if ('.' === $candidate[0]
-        || !\str_ends_with($candidate, '.php')
-      ) {
+    foreach (NsDirUtil::getDirContents($this->directory) as $candidate => $is_dir) {
+      if ($is_dir || !\str_ends_with($candidate, '.php')) {
         continue;
       }
       $path = $this->directory . '/' . $candidate;
-      if (!\is_file($path)) {
-        continue;
-      }
       $name = \substr($candidate, 0, -4);
       if (!\preg_match(self::CLASS_NAME_REGEX, $name)) {
         continue;
@@ -584,31 +581,12 @@ public function getClassFilesHere(): array {
    * @return \Iterator<string, static>
    */
   public function getSubdirsHere(): \Iterator {
-    foreach ($this->scanThisDir() as $candidate) {
-      if (!preg_match(self::CLASS_NAME_REGEX, $candidate)) {
-        continue;
-      }
-      $path = $this->directory . '/' . $candidate;
-      if (!\is_dir($path)) {
+    foreach (NsDirUtil::getDirContents($this->directory) as $candidate => $is_dir) {
+      if (!$is_dir || !preg_match(self::CLASS_NAME_REGEX, $candidate)) {
         continue;
       }
       yield $candidate => $this->subdir($candidate);
     }
   }
 
-  /**
-   * Runs scandir() on this namespace directory.
-   *
-   * Throws a runtime exception on failure, instead of returning false.
-   * This is considered an unhandled exception, because it is assumed that the
-   * current directory always exists.
-   *
-   * @return list<string>
-   *   Items in the directory in alphabetic order.
-   *   This also includes '.' and '..'.
-   */
-  private function scanThisDir(): array {
-    return NsDirUtil::scanKnownDir($this->directory);
-  }
-
 }

src/NsDirUtil.php

@@ -77,13 +77,10 @@ public static function assertReadableDirectory(string $dir): void {
    *   Format: $[$file] = $class
    */
   private static function doIterateRecursively(string $dir, string $terminatedNamespace): \Iterator {
-    foreach (self::scanKnownDir($dir) as $candidate) {
-      if ('.' === $candidate[0]) {
-        continue;
-      }
+    foreach (self::getDirContents($dir) as $candidate => $is_dir) {
       $path = $dir . '/' . $candidate;
-      if (\str_ends_with($candidate, '.php')) {
-        if (!is_file($path)) {
+      if (!$is_dir) {
+        if (!\str_ends_with($candidate, '.php')) {
           continue;
         }
         $name = substr($candidate, 0, -4);
@@ -94,9 +91,6 @@ private static function doIterateRecursively(string $dir, string $terminatedName
         yield $path => $terminatedNamespace . $name;
       }
       else {
-        if (!is_dir($path)) {
-          continue;  // @codeCoverageIgnore
-        }
         if (!preg_match(self::CLASS_NAME_REGEX, $candidate)) {
           continue;
         }
@@ -109,27 +103,25 @@ private static function doIterateRecursively(string $dir, string $terminatedName
   }
 
   /**
-   * Runs scandir() on a known directory.
-   *
-   * Throws a runtime exception on failure, instead of returning false.
-   * This is considered an unhandled exception, because it is assumed that the
-   * given directory always exists.
+   * Gets names of files and subdirectories in a directory.
    *
    * @param string $dir
-   *   Known directory to scan.
+   *   Parent directory to scan.
+   *
+   * @return array<string, bool>
+   *   Array where the keys are file or directory names, and the values indicate
+   *   whether the entry is a directory.
    *
-   * @return list<string>
-   *   Items in the directory in alphabetic order.
-   *   This also includes '.' and '..'.
-   *   Calling code already does filtering with regex or other means, so it
-   *   would be redundant to do additional filtering here.
+   * @internal
    */
-  public static function scanKnownDir(string $dir): array {
-    $candidates = @\scandir($dir, \SCANDIR_SORT_ASCENDING);
-    if ($candidates === false) {
-      throw new \RuntimeException("Failed to scandir('$dir').");
+  public static function getDirContents(string $dir): array {
+    $iterator = new \RecursiveDirectoryIterator($dir, \FilesystemIterator::SKIP_DOTS|\FilesystemIterator::KEY_AS_FILENAME|\FilesystemIterator::CURRENT_AS_SELF);
+    $contents = [];
+    foreach ($iterator as $name => $iterator_self) {
+      $contents[$name] = $iterator->hasChildren();
     }
-    return $candidates;
+    ksort($contents);
+    return $contents;
   }
 
 }

tests/src/NsDirUtilTest.php

@@ -58,7 +58,7 @@ public function testIterate(): void {
     // Only read permissions, no execute bit.
     // The directory will appear as empty.
     chmod($dir, $perms & 0444);
-    $this->assertNull(NsDirUtil::iterate($dir, '')->key());
+    $this->assertSame($file, NsDirUtil::iterate($dir, '')->key());
     $this->assertFalse(@include $file);
   }
 
@@ -85,9 +85,9 @@ public function testAssertReadableDirectory(): void {
     $f($dir);
   }
 
-  public function testScanKnownDir(): void {
-    $f = NsDirUtil::scanKnownDir(...);
-    $this->callAndAssertException(\RuntimeException::class, fn () => $f(__DIR__ . '/NonExistingDir'));
+  public function testGetDirContents(): void {
+    $f = NsDirUtil::getDirContents(...);
+    $this->callAndAssertException(\UnexpectedValueException::class, fn () => $f(__DIR__ . '/NonExistingDir'));
   }
 
 }