Refactor

Author: sebastianbergmann

src/Event/Value/ThrowableBuilder.php

@@ -37,7 +37,7 @@ public static function from(\Throwable $t): Throwable
             $t::class,
             $t->getMessage(),
             ThrowableToStringMapper::map($t),
-            Filter::getFilteredStacktrace($t, false),
+            Filter::stackTraceFromThrowableAsString($t, false),
             $previous,
         );
     }

src/Framework/Constraint/Exception/Exception.php

@@ -68,7 +68,7 @@ protected function failureDescription(mixed $other): string
 
         if ($other instanceof Throwable) {
             $message = '. Message was: "' . $other->getMessage() . '" at'
-                . "\n" . Filter::getFilteredStacktrace($other);
+                . "\n" . Filter::stackTraceFromThrowableAsString($other);
         }
 
         return sprintf(

src/Framework/TestSuite.php

@@ -589,15 +589,15 @@ private function throwableToString(Throwable $t): string
             return sprintf(
                 "%s\n%s",
                 $message,
-                Filter::getFilteredStacktrace($t),
+                Filter::stackTraceFromThrowableAsString($t),
             );
         }
 
         return sprintf(
             "%s: %s\n%s",
             $t::class,
             $message,
-            Filter::getFilteredStacktrace($t),
+            Filter::stackTraceFromThrowableAsString($t),
         );
     }
 

src/Util/Filter.php

@@ -30,49 +30,56 @@
     /**
      * @throws Exception
      */
-    public static function getFilteredStacktrace(Throwable $t, bool $unwrap = true): string
+    public static function stackTraceFromThrowableAsString(Throwable $t, bool $unwrap = true): string
     {
-        $filteredStacktrace = '';
-
         if ($t instanceof PhptAssertionFailedError) {
-            $eTrace = $t->syntheticTrace();
-            $eFile  = $t->syntheticFile();
-            $eLine  = $t->syntheticLine();
+            $stackTrace = $t->syntheticTrace();
+            $file       = $t->syntheticFile();
+            $line       = $t->syntheticLine();
         } elseif ($t instanceof Exception) {
-            $eTrace = $t->getSerializableTrace();
-            $eFile  = $t->getFile();
-            $eLine  = $t->getLine();
+            $stackTrace = $t->getSerializableTrace();
+            $file       = $t->getFile();
+            $line       = $t->getLine();
         } else {
             if ($unwrap && $t->getPrevious()) {
                 $t = $t->getPrevious();
             }
 
-            $eTrace = $t->getTrace();
-            $eFile  = $t->getFile();
-            $eLine  = $t->getLine();
+            $stackTrace = $t->getTrace();
+            $file       = $t->getFile();
+            $line       = $t->getLine();
         }
 
-        if (!self::frameExists($eTrace, $eFile, $eLine)) {
+        if (!self::frameExists($stackTrace, $file, $line)) {
             array_unshift(
-                $eTrace,
-                ['file' => $eFile, 'line' => $eLine],
+                $stackTrace,
+                ['file' => $file, 'line' => $line],
             );
         }
 
+        return self::stackTraceAsString($stackTrace);
+    }
+
+    /**
+     * @param list<array{file: string, line: ?int, class?: class-string, function?: string, type: string}> $frames
+     */
+    public static function stackTraceAsString(array $frames): string
+    {
+        $buffer      = '';
         $prefix      = defined('__PHPUNIT_PHAR_ROOT__') ? __PHPUNIT_PHAR_ROOT__ : false;
         $excludeList = new ExcludeList;
 
-        foreach ($eTrace as $frame) {
+        foreach ($frames as $frame) {
             if (self::shouldPrintFrame($frame, $prefix, $excludeList)) {
-                $filteredStacktrace .= sprintf(
+                $buffer .= sprintf(
                     "%s:%s\n",
                     $frame['file'],
                     $frame['line'] ?? '?',
                 );
             }
         }
 
-        return $filteredStacktrace;
+        return $buffer;
     }
 
     /**

tests/unit/Event/Value/ThrowableTest.php

@@ -29,7 +29,7 @@ public function testCanBeCreatedForThrowableWithoutPrevious(): void
         $this->assertSame(Exception::class, $t->className());
         $this->assertSame('message', $t->message());
         $this->assertSame("Exception: message\n", $t->description());
-        $this->assertSame(Filter::getFilteredStacktrace($e), $t->stackTrace());
+        $this->assertSame(Filter::stackTraceFromThrowableAsString($e), $t->stackTrace());
         $this->assertFalse($t->hasPrevious());
 
         $this->expectException(NoPreviousThrowableException::class);
@@ -46,15 +46,15 @@ public function testCanBeCreatedForThrowableWithPrevious(): void
         $this->assertSame(Exception::class, $t->className());
         $this->assertSame('second message', $t->message());
         $this->assertSame("Exception: second message\n", $t->description());
-        $this->assertSame(Filter::getFilteredStacktrace($second, false), $t->stackTrace());
+        $this->assertSame(Filter::stackTraceFromThrowableAsString($second, false), $t->stackTrace());
         $this->assertTrue($t->hasPrevious());
 
         $previous = $t->previous();
 
         $this->assertSame(Exception::class, $previous->className());
         $this->assertSame('first message', $previous->message());
         $this->assertSame("Exception: first message\n", $previous->description());
-        $this->assertSame(Filter::getFilteredStacktrace($first), $previous->stackTrace());
+        $this->assertSame(Filter::stackTraceFromThrowableAsString($first), $previous->stackTrace());
 
         $this->assertStringMatchesFormat(
             <<<'EOD'

tests/unit/Util/FilterTest.php

@@ -23,6 +23,6 @@ public function testUnwrapThrowableUsesPreviousValues(): void
         $first  = new Exception('first', 123, null);
         $second = new Exception('second', 345, $first);
 
-        $this->assertSame(Filter::getFilteredStacktrace($second), Filter::getFilteredStacktrace($first));
+        $this->assertSame(Filter::stackTraceFromThrowableAsString($second), Filter::stackTraceFromThrowableAsString($first));
     }
 }