bmitch/churn-php

<?php

declare(strict_types=1);

namespace Churn\Result;

use SplFixedArray;

/**
 * @internal
 */
final class HighestScores
{
    /**
     * @var SplFixedArray<ResultInterface|null>
     */
    private $scores;

    /**
     * @param integer $maxSize Max number of results to keep.
     */
    public function __construct(int $maxSize)
    {
        // PHPDoc mandatory for now, see: https://github.com/vimeo/psalm/issues/7160
        /** @psalm-suppress MixedPropertyTypeCoercion */
        $this->scores = new SplFixedArray($maxSize);
    }

    /**
     * Returns the results as a normal PHP array.
     *
     * @return array<ResultInterface>
     */
    public function toArray(): array
    {
        return \array_filter($this->scores->toArray());
    }

    /**
     * Add the result if its priority is high enough.
     *
     * @param ResultInterface $result The result for a file.
     */
    public function add(ResultInterface $result): void
    {
        $worstScore = $this->scores[$this->scores->getSize() - 1];
        if (null !== $worstScore && $result->getPriority() <= $worstScore->getPriority()) {
            return;
        }

        $this->insertAt($result, $this->findPosition($result));
    }

    /**
     * Returns the position where the result must be inserted.
     *
     * @param ResultInterface $result The result for a file.
     */
    private function findPosition(ResultInterface $result): int
    {
        $pos = 0;

        foreach ($this->scores as $score) {
            if (null === $score || $result->getPriority() > $score->getPriority()) {
                break;
            }

            $pos++;
        }

        return $pos;
    }

    /**
     * Inserts the result at a given position and shifts the lower elements.
     *
     * @param ResultInterface $result The result for a file.
     * @param integer $position The position where the result must be inserted.
     */
    private function insertAt(ResultInterface $result, int $position): void
    {
        for ($i = $this->scores->getSize() - 1; $i > $position; $i--) {
            $this->scores[$i] = $this->scores[$i - 1];
        }

        $this->scores[$position] = $result;
    }
}