Issue #110: Extract RecordingsPathTrait out of RecordedTestTrait..

Author: donquixote

src/RecordedTestTrait.php

@@ -31,6 +31,7 @@
 trait RecordedTestTrait {
 
   use IsRecordingTrait;
+  use RecordingsPathTrait;
 
   private ?AssertionRecorderInterface $recorder = null;
 
@@ -145,25 +146,8 @@ protected function createRecorder(): AssertionRecorderInterface {
    * Creates a storage for the assertion recorder.
    */
   protected function createAssertionStore(): AssertionValueStoreInterface {
-    $reflection_class = new \ReflectionClass(static::class);
-    $class_file = $reflection_class->getFileName();
-    if ($class_file === false) {
-      throw new \RuntimeException(sprintf("No class file for '%s'.", static::class));
-    }
-    /** @var non-empty-list<string> $parts */
-    $parts = \explode('\\', static::class);
-    $parts_count = count($parts);
-    if ($parts_count < 3) {
-      throw new \RuntimeException(sprintf("Namespace of class '%s' is too shallow.", static::class));
-    }
-    $package_dir = dirname($class_file, $parts_count - 2);
-    $base = implode('/', [
-      $package_dir,
-      'recordings',
-      ...array_slice($parts, 3),
-    ]) . '-';
     return new AssertionValueStore_Yaml(
-      $base,
+      $this->getClassRecordingsPath() . '-',
       $this->buildYamlHeader(...),
     );
   }

src/RecordingsPathTrait.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Ock\Testing;
+
+use Ock\ClassDiscovery\NamespaceDirectory;
+
+trait RecordingsPathTrait {
+
+  /**
+   * Gets a path to use for recordings for this test class.
+   *
+   * If the test class path is 'tests/src/Subdir/MyTest.php', then this method
+   * would return 'tests/recordings/Subdir/MyTest'.
+   *
+   * The calling code can decide whether to use this as a directory, or as a
+   * prefix, where the last fragment might be part of a file name.
+   *
+   * The idea is that anything under 'tests/recordings/' can be deleted and
+   * regenerated, by running the test in recording mode.
+   *
+   * @return string
+   *   Path without ending '/'.
+   */
+  protected function getClassRecordingsPath(): string {
+    $reflection_class = new \ReflectionClass(static::class);
+    $class_dir = NamespaceDirectory::fromReflectionClass($reflection_class);
+    return $class_dir->getPackageDirectory(level: 3)
+      . '/recordings'
+      . $class_dir->getRelativePath('', 3)
+      . '/' . $reflection_class->getShortName();
+  }
+
+}