Rename sourceDir to rootDir

Author: scheb

README.md

@@ -71,12 +71,12 @@ register_shutdown_function(function () use ($bufferedGraveyard) {
 ### Relative Path Logs
 
 By default the absolute file path is used in the logs. This can be in problem in some environments (e.g. when your 
-deployment process creates a new directory for every release). If you tell the source root to the graveyard, it will log
+deployment process creates a new directory for every release). If you tell the root path to the graveyard, it will log
 the relative file path instead. This makes log files exchangeable between different servers/environments/installation
 paths.
 
 ```php
-GraveyardProvider::getGraveyard()->setSourceDir('/path/to/src');
+GraveyardProvider::getGraveyard()->setRootDir('/path/to/src');
 ```
 
 It is especially useful, if you want to collect logs files from multiple production servers to run an overall analysis

src/Graveyard.php

@@ -21,24 +21,24 @@ class Graveyard implements GraveyardInterface
     /**
      * @var string
      */
-    private $sourceDir;
+    private $rootDir;
 
     /**
      * @var int|null
      */
     private $stackTraceDepth;
 
-    public function __construct(array $handlers = [], ?string $sourceDir = null, ?int $stackTraceDepth = null)
+    public function __construct(array $handlers = [], ?string $rootDir = null, ?int $stackTraceDepth = null)
     {
         $this->handlers = $handlers;
         $this->traceProvider = new TraceProvider();
         $this->stackTraceDepth = $stackTraceDepth;
-        $this->setSourceDir($sourceDir);
+        $this->setRootDir($rootDir);
     }
 
-    public function setSourceDir($sourceDir): void
+    public function setRootDir($rootDir): void
     {
-        $this->sourceDir = $sourceDir;
+        $this->rootDir = $rootDir;
     }
 
     public function addHandler(HandlerInterface $handler): void
@@ -58,13 +58,13 @@ public function tombstone(array $arguments, array $trace, array $metadata): void
 
     private function traceRelativePath(array $trace): array
     {
-        if (!$this->sourceDir) {
+        if (!$this->rootDir) {
             return $trace;
         }
 
         foreach ($trace as $key => &$frame) {
             if (isset($frame['file'])) {
-                $frame['file'] = PathNormalizer::makeRelativeTo($frame['file'], $this->sourceDir);
+                $frame['file'] = PathNormalizer::makeRelativeTo($frame['file'], $this->rootDir);
             }
         }
 

tests/GraveyardTest.php

@@ -67,7 +67,7 @@ public function tombstone_handlersRegistered_callAllHandlers(): void
     /**
      * @test
      */
-    public function tombstone_sourceDirSet_logRelativePath(): void
+    public function tombstone_rootDirSet_logRelativePath(): void
     {
         $this->handler
             ->expects($this->once())
@@ -77,14 +77,14 @@ public function tombstone_sourceDirSet_logRelativePath(): void
             }));
 
         $trace = TraceFixture::getTraceFixture();
-        $this->graveyard->setSourceDir('/path/to');
+        $this->graveyard->setRootDir('/path/to');
         $this->graveyard->tombstone(['label'], $trace, ['metaField' => 'metaValue']);
     }
 
     /**
      * @test
      */
-    public function tombstone_sourceDirNotMatchedFilePath_logAbsolutePath(): void
+    public function tombstone_rootDirNotMatchedFilePath_logAbsolutePath(): void
     {
         $this->handler
             ->expects($this->once())
@@ -94,7 +94,7 @@ public function tombstone_sourceDirNotMatchedFilePath_logAbsolutePath(): void
             }));
 
         $trace = TraceFixture::getTraceFixture();
-        $this->graveyard->setSourceDir('/other/path');
+        $this->graveyard->setRootDir('/other/path');
         $this->graveyard->tombstone(['label'], $trace, ['metaField' => 'metaValue']);
     }