DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Location

Complexity

Total Complexity

8

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getLineNumber()	0	3	1
A	getAbsoluteFileName()	0	3	1
A	fromRelativeFileName()	0	8	1
A	fromAbsoluteFileName()	0	8	1
A	getRelativeFileName()	0	3	1
A	compareTo()	0	7	2
A	__construct()	0	5	1

<?php

/**
 * Static Analysis Results Baseliner (sarb).
 *
 * (c) Dave Liddament
 *
 * For the full copyright and licence information please view the LICENSE file distributed with this source code.
 */

declare(strict_types=1);

namespace DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common;

final class Location
{
    /**
     * @throws InvalidPathException
     */
    public static function fromAbsoluteFileName(
        AbsoluteFileName $absoluteFileName,
        ProjectRoot $projectRoot,
        LineNumber $lineNumber,
    ): self {
        $relativeFileName = $projectRoot->getPathRelativeToRootDirectory($absoluteFileName);

        return new self($absoluteFileName, $relativeFileName, $lineNumber);
    }

    /**
     * @throws InvalidPathException
     */
    public static function fromRelativeFileName(
        RelativeFileName $relativeFileName,
        ProjectRoot $projectRoot,
        LineNumber $lineNumber,
    ): self {
        $absoluteFileName = $projectRoot->getAbsoluteFileName($relativeFileName);

        return new self($absoluteFileName, $relativeFileName, $lineNumber);
    }

    private function __construct(
        private AbsoluteFileName $absoluteFileName,
        private RelativeFileName $relativeFileName,
        private LineNumber $lineNumber,
    ) {
    }

    public function getRelativeFileName(): RelativeFileName
    {
        return $this->relativeFileName;
    }

    public function getLineNumber(): LineNumber
    {
        return $this->lineNumber;
    }

    public function getAbsoluteFileName(): AbsoluteFileName
    {
        return $this->absoluteFileName;
    }

    /**
     * Used for ordering Locations, first by FileName then by line number.
     */
    public function compareTo(self $other): int
    {
        if ($this->relativeFileName->getFileName() !== $other->relativeFileName->getFileName()) {
            return $this->relativeFileName->getFileName() <=> $other->relativeFileName->getFileName();
        }

        return $this->lineNumber->getLineNumber() <=> $other->lineNumber->getLineNumber();
    }
}