refactor getSourceAt() in AbstractSourceCodeFormatter to use a linesAround setting instead of a total number of lines.

Author: lupinitylabs

config/query-tracer.php

@@ -234,8 +234,19 @@
         |
         */
 
-        'includeSource'      => true,
-        'includeSourceLines' => 8,
+        'includeSource'     => true,
+
+        /*
+        |--------------------------------------------------------------------------
+        | Number of Source Code Lines Around Target Line
+        |--------------------------------------------------------------------------
+        |
+        | Here you can specify how many lines of source code should be displayed
+        | before and after the target line of the stack frame.
+        |
+        */
+
+        'sourceLinesAround' => 4,
 
         /*
         |--------------------------------------------------------------------------

src/Classes/AbstractSourceCodeFormatter.php

@@ -32,34 +32,37 @@ public function __construct(Config $config)
      * Retrieves the formatted source code from the specified file around the given line.
      *
      * @param string $fileName
-     * @param int $line
+     * @param int    $line
      *
      * @return string|null
      */
     public function getSourceAt(string $fileName, int $line): ?string
     {
-        if ($this->config->shouldIncludeSource()) {
+        if ($this->config->shouldIncludeSource() && $line > 0) {
             if ($cached = $this->sourceCache[$fileName][$line] ?? false) {
                 return $cached;
             }
 
             $sourceCode = file($fileName);
-            $numSourceLines = $this->config->getSourceLineCount();
-            $startingLine = $line - round($numSourceLines / 2);
 
-            while ($startingLine > 1 && trim($sourceCode[$startingLine - 1] ?? '') === '') {
-                $startingLine--;
-                $numSourceLines++;
-            }
+            $sourceLinesAround = $this->config->getSourceLinesAround();
+            $totalLines        = count($sourceCode);
+            $startingLine      = max(1, $line - $sourceLinesAround);
+            $endingLine        = min($totalLines, $line + $sourceLinesAround);
 
-            $lineCounter = $startingLine;
-            $codeSlice   = collect(array_slice($sourceCode, $startingLine, $numSourceLines))->mapWithKeys(
-                function ($line) use (&$lineCounter) {
-                    return [++$lineCounter => $line];
-                }
-            );
+            if ($startingLine <= $endingLine) {
+                $numSourceLines = $endingLine - $startingLine + 1;
+                $lineCounter    = $startingLine;
 
-            return $this->sourceCache[$fileName][$line] = $this->getFormattedCode($codeSlice, $line);
+                $codeSlice = collect(array_slice($sourceCode, $startingLine - 1, $numSourceLines))
+                    ->mapWithKeys(
+                        function ($line) use (&$lineCounter) {
+                            return [$lineCounter++ => $line];
+                        }
+                    );
+
+                return $this->sourceCache[$fileName][$line] = $this->getFormattedCode($codeSlice, $line);
+            }
         }
 
         return null;
@@ -70,7 +73,7 @@ function ($line) use (&$lineCounter) {
      * Formats the source code listing to include in the trace.
      *
      * @param Collection $code
-     * @param int $highlightedLine
+     * @param int        $highlightedLine
      *
      * @return string
      */
@@ -123,8 +126,8 @@ protected function removeExpendableIndentation(Collection $code): Collection
      * Formats the given line according to the maximum line length.
      *
      * @param string $line
-     * @param bool $trim
-     * @param bool $highlightSpaces
+     * @param bool   $trim
+     * @param bool   $highlightSpaces
      *
      * @return string
      */
@@ -145,7 +148,7 @@ protected function formatLine(string $line, bool $trim = true, bool $highlightSp
      * Adds line numbers to the given code lines.
      *
      * @param Collection $code
-     * @param int $highlightedLine
+     * @param int        $highlightedLine
      *
      * @return mixed
      */

src/Classes/Config.php

@@ -16,7 +16,7 @@ public function getLogArrayValues(): array
 
     public function shouldIncludeSource(): bool
     {
-        return config('query-tracer.trace.includeSource') === true && $this->getSourceLineCount() > 0;
+        return config('query-tracer.trace.includeSource') === true;
     }
 
     public function getCommentTag(): string
@@ -34,9 +34,9 @@ public function getLineLength(): int
         return config('query-tracer.trace.sqlComment.lineLength', 80);
     }
 
-    public function getSourceLineCount(): int
+    public function getSourceLinesAround(): int
     {
-        return config('query-tracer.trace.includeSourceLines');
+        return config('query-tracer.trace.sourceLinesAround');
     }
 
     public function getHighlightLineDecoration(): string

tests/Feature/DefaultModeTest.php

@@ -36,16 +36,16 @@
 
 it('includes the source in the query log trace', function () {
     config()->set('query-tracer.trace.includeSource', true);
-    config()->set('query-tracer.trace.includeSourceLines', 8);
+    config()->set('query-tracer.trace.sourceLinesAround', 4);
     config()->set('query-tracer.trace.logArray.values', ['source']);
 
     expectTraceArray()->toHaveKey('source')->containingPerformQuerySourceCode();
 });
 
 
-it('includes the calling line only if includeSourceLines is set to 1', function () {
+it('includes the calling line only if sourceLinesAround is set to 0', function () {
     config()->set('query-tracer.trace.includeSource', true);
-    config()->set('query-tracer.trace.includeSourceLines', 1);
+    config()->set('query-tracer.trace.sourceLinesAround', 0);
     config()->set('query-tracer.trace.logArray.values', ['source']);
 
     expectTraceArray()->toHaveKey('source')->containingPerformQuerySourceCode(true);
@@ -62,14 +62,6 @@
 });
 
 
-it('does not include source if includeSourceLines is set to 0', function () {
-    config()->set('query-tracer.trace.includeSource', true);
-    config()->set('query-tracer.trace.includeSourceLines', 0);
-
-    expectTraceArray()->not->toHaveKey('source');
-});
-
-
 it('only contains the configured log array values', function () {
     $availableValues = getAvailableLogArrayValues();