Honeybadger\FileSource

Complexity

Total Complexity

12

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	trimLine()	0	5	1
A	__construct()	0	5	2
A	readFile()	0	3	1
A	startingLineNumber()	0	5	2
A	fileLines()	0	12	2
A	canReadFile()	0	3	2
A	getSource()	0	11	2

<?php

namespace Honeybadger;

use SplFileObject;

class FileSource
{
    /**
     * @var string
     */
    protected $filename;

    /**
     * @var int
     */
    protected $lineNumber;

    /**
     * @var int
     */
    protected $radius;

    /**
     * @param  string  $filename
     * @param  int  $lineNumber
     * @param  int  $radius
     */
    public function __construct(string $filename, int $lineNumber, int $radius = 4)
    {
        $this->filename = $filename;
        $this->lineNumber = $lineNumber < 0 ? 0 : $lineNumber;
        $this->radius = $radius;
    }

    /**
     * @return array
     */
    public function getSource() : array
    {
        if (! $this->canReadFile()) {
            return [];
        }

        return array_slice(
            $this->fileLines($this->readFile()),
            $this->startingLineNumber(),
            ($this->radius * 2) + 1,
            $preserveKeys = true
        );
    }

    /**
     * @param  string  $line
     * @return string
     */
    private function trimLine(string $line) : string
    {
        $trimmed = trim($line, "\n\r\0\x0B");

        return preg_replace(['/\s*$/D', '/\t/'], ['', '    '], $trimmed);
    }

    /**
     * @return bool
     */
    private function canReadFile() : bool
    {
        return is_file($this->filename) && is_readable($this->filename);
    }

    /**
     * @return \SplFileObject
     */
    private function readFile() : SplFileObject
    {
        return new SplFileObject($this->filename, 'r');
    }

    /**
     * @param  \SplFileObject  $file
     * @return array
     */
    private function fileLines(SplFileObject $file) : array
    {
        $lines = [];
        while (! $file->eof()) {
            $lines[] = $this->trimLine($file->fgets());
        }

        // Set the array to base 1 so it actually reflects the line number of code
        array_unshift($lines, null);
        unset($lines[0]);

        return $lines;
    }

    /**
     * @return int
     */
    private function startingLineNumber() : int
    {
        $start = $this->lineNumber - ($this->radius + 1);

        return $start >= 0 ? $start : 0;
    }
}