Drop ->withRealpathRoot().

Author: donquixote

README.md

@@ -42,24 +42,38 @@ $basic_namespace_dir = NamespaceDirectory::create($basedir . '/src', 'Acme\\Foo'
 // The directory is determined automatically with ReflectionClass::getFileName().
 $namespace_dir = NamespaceDirectory::fromKnownClass(VenusFlyTrap::class);
 
-// Iterate class files.
-function foo(ClassFilesIAInterface $classFilesIA): void {
-  foreach ($classFilesIA as $file => $class) {
-    $rc = new \ReflectionClass($class);
-    // Call realpath() to be sure.
-    assert($rc->getFileName() === realpath($file));
-  }
-  // Or do this to skip the realpath() call:
-  foreach ($classFilesIA->withRealpathRoot() as $file => $class) {
-    $rc = new \ReflectionClass($class);
-    assert($rc->getFileName() === $file);
+// Iterate class names by integer key.
+function foo(ClassNamesIAInterface $classNamesIA): void {
+  foreach ($classNamesIA as $class) {
+    assert(class_exists($class));
   }
 }
 
-// Iterate class names.
-function foo(ClassNamesIAInterface $classNamesIA): void {
-  foreach ($classNamesIA as $class) {
+// Iterate class names with file path as key.
+function foo(ClassFilesIAInterface $classNamesIA): void {
+  foreach ($classNamesIA as $file => $class) {
+    assert(file_exists($file));
     assert(class_exists($class));
   }
 }
+
+// Get reflection classes.
+function foo(ClassFilesIAInterface $classFilesIA): void {
+  foreach ($classFilesIA as $file => $class) {
+    try {
+      $rc = new \ReflectionClass($class);
+    }
+    catch (\ReflectionException|\Error) {
+      // Skip non-existing classes / interfaces / traits.
+      // Skip if a base class or interface is missing.
+      // Unfortunately, missing traits still cause fatal error.
+      continue;
+    }
+    // Ignore if the class is defined elsewhere.
+    if ($rc->getFileName() !== $file && realpath($rc->getFileName()) !== realpath($file)) {
+      continue;
+    }
+    do_something($rc);
+  }
+}
 ```

src/ClassFilesIA/ClassFilesIAInterface.php

@@ -17,17 +17,4 @@ interface ClassFilesIAInterface extends ClassNamesIAInterface {
    */
   public function getIterator(): \Iterator;
 
-  /**
-   * Gets a version where all base paths are sent through ->realpath().
-   *
-   * This is useful when comparing the path to \ReflectionClass::getFileName().
-   *
-   * Implementations might use an optimization where they only send the base
-   * path through realpath(), assuming that the subdirectories do not contain
-   * symlinks.
-   *
-   * @return static
-   */
-  public function withRealpathRoot(): static;
-
 }

src/ClassFilesIA/ClassFilesIA_Concat.php

@@ -20,14 +20,4 @@ public function getIterator(): \Iterator {
     }
   }
 
-  /**
-   * {@inheritdoc}
-   */
-  public function withRealpathRoot(): static {
-    $clone = clone $this;
-    foreach ($clone->classFilesIAs as $i => $classFilesIA) {
-      $clone->classFilesIAs[$i] = $classFilesIA->withRealpathRoot();
-    }
-    return $clone;
-  }
 }

src/ClassFilesIA/ClassFilesIA_Empty.php

@@ -4,8 +4,6 @@
 
 class ClassFilesIA_Empty implements ClassFilesIAInterface {
 
-  use RealpathRootThisTrait;
-
   /**
    * {@inheritdoc}
    */

src/ClassFilesIA/ClassFilesIA_NamespaceDirectoryPsr4.php

@@ -57,18 +57,6 @@ public function __construct(
     private readonly string $terminatedNamespace,
   ) {}
 
-  /**
-   * {@inheritdoc}
-   */
-  public function withRealpathRoot(): static {
-    $clone = clone $this;
-    $realpath = realpath($this->directory);
-    // @todo Properly handle this case.
-    assert($realpath !== false, "Cannot get realpath for '$this->directory'. Perhaps the directory does not exist.");
-    $clone->directory = $realpath;
-    return $clone;
-  }
-
   /**
    * {@inheritdoc}
    */

src/ClassFilesIA/RealpathRootThisTrait.php

@@ -97,21 +97,6 @@ private function __construct(
     private readonly string $terminatedNamespace,
   ) {}
 
-  /**
-   * Gets a version where all base paths are sent through ->realpath().
-   *
-   * @return static
-   */
-  public function withRealpathRoot(): static {
-    $clone = clone $this;
-    $realpath = realpath($this->directory);
-    if ($realpath === false) {
-      throw new \RuntimeException("Failed to realpath('$this->directory')");
-    }
-    $clone->directory = $realpath;
-    return $clone;
-  }
-
   /**
    * @param string $namespace
    *

src/NamespaceDirectory.php

@@ -78,24 +78,6 @@ public function testCreateFromNsdirObject(): void {
     $this->assertEquals(new ClassFilesIA_Empty(), $f(__DIR__ . '/non/existing/subdir'));
   }
 
-  public function testWithRealpathRoot(): void {
-    $c = fn (string $dir) => new ClassFilesIA_NamespaceDirectoryPsr4($dir, 'Acme\Zoo\\');
-    $realpath = realpath(__DIR__) ?: $this->fail();
-    $crooked_path = __DIR__ . '/../src';
-    $this->assertFalse(str_ends_with($realpath, '/../src'));
-    $obj_with_realpath = $c($realpath);
-    $this->assertEquals($obj_with_realpath, $c($crooked_path)->withRealpathRoot());
-
-    // A new clone is returned even though values are the same.
-    // Perhaps this will change in the future.
-    $this->assertEquals($obj_with_realpath, $obj_with_realpath->withRealpathRoot());
-    $this->assertNotSame($obj_with_realpath, $obj_with_realpath->withRealpathRoot());
-
-    // Test effect on the iterator.
-    $this->assertSame($realpath, dirname($obj_with_realpath->getIterator()->key()));
-    $this->assertSame($crooked_path, dirname($c($crooked_path)->getIterator()->key()));
-  }
-
   /**
    * @throws \ReflectionException
    */
@@ -117,7 +99,6 @@ public function testGetIterator(): void {
   public function testEmpty(): void {
     $classFilesIA = new ClassFilesIA_Empty();
     $this->assertFalse($classFilesIA->getIterator()->valid());
-    $this->assertSame($classFilesIA, $classFilesIA->withRealpathRoot());
   }
 
   /**
@@ -140,17 +121,6 @@ public function testConcat(): void {
       [__DIR__ . '/Fixtures/Acme/Animal/RedSquirrel.php', RedSquirrel::class],
       [__DIR__ . '/Fixtures/Acme/Plant/Tree/Fig.php', Fig::class],
     ], $actual);
-
-    $this->assertEquals(
-      new ClassFilesIA_Concat([
-        ClassFilesIA::psr4(realpath(__DIR__) ?: '?', 'Acme\Zoo'),
-        ClassFilesIA::psr4(realpath(__DIR__ . '/Fixtures') ?: '?', 'Acme\Zoo'),
-      ]),
-      (new ClassFilesIA_Concat([
-        ClassFilesIA::psr4(__DIR__ . '/../src', 'Acme\Zoo'),
-        ClassFilesIA::psr4(__DIR__ . '/../src/Fixtures', 'Acme\Zoo'),
-      ]))->withRealpathRoot(),
-    );
   }
 
   public function testFactoryPsr4(): void {

tests/src/ClassFilesIATest.php

@@ -85,31 +85,6 @@ public function testFromReflectionClass(): void {
     );
   }
 
-  public function testWithRealpathRoot(): void {
-    $c = fn (string $dir) => NamespaceDirectory::create($dir, 'Acme\Zoo');
-    $realpath = realpath(__DIR__) ?: $this->fail();
-    $crooked_path = __DIR__ . '/../src';
-    $this->assertFalse(str_ends_with($realpath, '/../src'));
-    $obj_with_realpath = $c($realpath);
-    $this->assertEquals($obj_with_realpath, $c($crooked_path)->withRealpathRoot());
-
-    // A new clone is returned even though values are the same.
-    // Perhaps this will change in the future.
-    $this->assertEquals($obj_with_realpath, $obj_with_realpath->withRealpathRoot());
-    $this->assertNotSame($obj_with_realpath, $obj_with_realpath->withRealpathRoot());
-
-    // Test effect on the iterator.
-    $this->assertSame($realpath, dirname($obj_with_realpath->getIterator()->key()));
-    $this->assertSame($crooked_path, dirname($c($crooked_path)->getIterator()->key()));
-
-    $this->callAndAssertException(
-      \RuntimeException::class,
-      $this
-        ->nsdir(__DIR__ . '/non/existing/path', 'Acme\Zoo')
-        ->withRealpathRoot(...),
-    );
-  }
-
   public function testFindNamespace(): void {
     $nsdir = $this->nsdir('path/to/package/src/Animal/Mammal', 'Acme\Zoo\Animal\Mammal');
     $this->assertSame($nsdir, $nsdir->findNamespace('Acme\Zoo\Animal\Mammal'));