Merge pull request #26 from jackbayliss/feature/trim-paths

trimFilePaths feature

README.md

@@ -123,6 +123,13 @@ frame is an application frame, or a vendor frame. Here's an example using a Lara
 ```php
 $backtrace = Spatie\Backtrace\Backtrace::create()->applicationPath(base_path());
 ```
+### Removing the application path from the file name
+
+You can use `trimFilePaths` to remove the base path of your app from the file. This will only work if you use it in conjunction the `applicationPath` method re above. Here's an example using a Laravel specific function. This will ensure the Frame has the trimmedFilePath property set.
+
+```php
+$backtrace = Backtrace::create()->applicationPath(base_path())->trimFilePaths());
+```
 
 ### Getting a certain part of a trace
 

src/Backtrace.php

@@ -23,6 +23,9 @@ class Backtrace
     /** @var bool */
     protected $withObject = false;
 
+    /** @var bool */
+    protected $trimFilePaths = false;
+
     /** @var string|null */
     protected $applicationPath;
 
@@ -91,6 +94,13 @@ public function applicationPath(string $applicationPath): self
         return $this;
     }
 
+    public function trimFilePaths(): self
+    {
+        $this->trimFilePaths = true;
+
+        return $this;
+    }
+
     public function offset(int $offset): self
     {
         $this->offset = $offset;
@@ -183,14 +193,18 @@ class_exists(ClosureStream::class)
                 $currentLine -= 1;
             }
 
+            if ($this->trimFilePaths && $this->applicationPath) {
+                $trimmedFilePath = str_replace($this->applicationPath, '', $currentFile);
+            }
             $frame = new Frame(
                 $currentFile,
                 $currentLine,
                 $arguments,
                 $rawFrame['function'] ?? null,
                 $rawFrame['class'] ?? null,
                 $this->isApplicationFrame($currentFile),
-                $textSnippet
+                $textSnippet,
+                $trimmedFilePath ?? null,
             );
 
             $frames[] = $frame;

src/Frame.php

@@ -13,6 +13,9 @@ class Frame
     /** @var string */
     public $file;
 
+    /** @var string|null */
+    public $trimmedFilePath;
+
     /** @var int */
     public $lineNumber;
 
@@ -38,10 +41,13 @@ public function __construct(
         string $method = null,
         string $class = null,
         bool $isApplicationFrame = false,
-        ?string $textSnippet = null
+        ?string $textSnippet = null,
+        ?string $trimmedFilePath = null
     ) {
         $this->file = $file;
 
+        $this->trimmedFilePath = $trimmedFilePath;
+
         $this->lineNumber = $lineNumber;
 
         $this->arguments = $arguments;

tests/BacktraceTest.php

@@ -4,6 +4,7 @@
 
 use DateTime;
 use PHPUnit\Framework\TestSuite;
+use ReflectionClass;
 use Spatie\Backtrace\Arguments\ArgumentReducers;
 use Spatie\Backtrace\Backtrace;
 use Spatie\Backtrace\Frame;
@@ -300,4 +301,19 @@ public function it_can_get_the_index_of_the_first_application_frame()
     {
         $this->assertEquals(0, Backtrace::create()->firstApplicationFrameIndex());
     }
+
+    /** @test */
+    public function it_trims_file_path_if_application_path_set()
+    {
+        $className = (new ReflectionClass(self::class))->getShortName();
+
+        $this->assertEquals(DIRECTORY_SEPARATOR.$className.'.php', Backtrace::create()->applicationPath(__DIR__)->trimFilePaths()->frames()[0]->trimmedFilePath);
+    }
+
+    /** @test */
+    public function it_does_not_trim_file_path_if_no_application_path_set()
+    {
+        $this->assertNull(Backtrace::create()->trimFilePaths()->frames()[0]->trimmedFilePath);
+    }
+
 }