jaroslavtyc/drd-plus-therugist-spells

<?php
declare(strict_types=1);
 
namespace DrdPlus\Theurgist\Spells\SpellParameters;
 
use Granam\Integer\IntegerInterface;
use Granam\Integer\Tools\ToInteger;
use Granam\Number\NumberInterface;
use Granam\Scalar\Tools\ToString;
use Granam\Strict\Object\StrictObject;
use Granam\String\StringInterface;
use Granam\Tools\ValueDescriber;
 
class FormulaDifficultyAddition extends StrictObject implements IntegerInterface
{
    /**
     * @var int
     */
Avoid excessively long variable names like $realmsChangePerAdditionStep. Keep variable name length under 20.
    private $realmsChangePerAdditionStep;
    /**
     * @var int
     */
Avoid excessively long variable names like $difficultyAdditionPerStep. Keep variable name length under 20.
    private $difficultyAdditionPerStep;
    /**
     * @var int
     */
    private $currentAddition;
 
    /**
     * @param string|int|StringInterface|IntegerInterface $difficultyAdditionByRealmsNotation in format 'difficulty per realm' or 'realms=difficulty per realms'
     * @param int|null $currentAddition How much is currently active addition
     * @throws \DrdPlus\Theurgist\Spells\SpellParameters\Exceptions\InvalidFormatOfAdditionByRealmsNotation
     * @throws \DrdPlus\Theurgist\Spells\SpellParameters\Exceptions\InvalidFormatOfRealmsIncrement
     * @throws \DrdPlus\Theurgist\Spells\SpellParameters\Exceptions\InvalidFormatOfAdditionByRealmsValue
     */
Similar blocks of code found in 2 locations. Consider refactoring.
Avoid excessively long variable names like $difficultyAdditionByRealmsNotation. Keep variable name length under 20.
    public function __construct($difficultyAdditionByRealmsNotation, int $currentAddition = null)
    {
Avoid using static access to class '\Granam\Scalar\Tools\ToString' in method '__construct'.
        $parts = $this->parseParts(ToString::toString($difficultyAdditionByRealmsNotation));
        if (\count($parts) === 1 && \array_keys($parts) === [0]) {
            $this->realmsChangePerAdditionStep = 1;
            $this->difficultyAdditionPerStep = $this->sanitizeAddition($parts[0]);
        } elseif (\count($parts) === 2 && \array_keys($parts) === [0, 1]) {
            $this->realmsChangePerAdditionStep = $this->sanitizeRealms($parts[0]);
            $this->difficultyAdditionPerStep = $this->sanitizeAddition($parts[1]);
The method __construct uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
        } else {
            throw new Exceptions\InvalidFormatOfAdditionByRealmsNotation(
                "Expected addition by realms in format 'number' or 'number=number', got "
Avoid using static access to class '\Granam\Tools\ValueDescriber' in method '__construct'.
                . ValueDescriber::describe($difficultyAdditionByRealmsNotation)
            );
        }
        $this->currentAddition = $currentAddition ?? 0;/* no addition, no realm increment */
    }
 
    /**
     * @param string $additionByRealmNotation
     * @return array|string[]
     */
Avoid excessively long variable names like $additionByRealmNotation. Keep variable name length under 20.
    private function parseParts(string $additionByRealmNotation): array
    {
        $parts = \array_map(
            function (string $part) {
                return \trim($part);
            },
            \explode('=', $additionByRealmNotation)
        );
 
        foreach ($parts as $part) {
            if ($part === '') {
                return [];
            }
        }
 
        return $parts;
    }
 
    /**
     * @param $realmIncrement
     * @return int
     * @throws \DrdPlus\Theurgist\Spells\SpellParameters\Exceptions\InvalidFormatOfRealmsIncrement
     */
    private function sanitizeRealms($realmIncrement): int
    {
        try {
Avoid using static access to class '\Granam\Integer\Tools\ToInteger' in method 'sanitizeRealms'.
            return ToInteger::toPositiveInteger($realmIncrement);
        } catch (\Granam\Integer\Tools\Exceptions\Exception $exception) {
            throw new Exceptions\InvalidFormatOfRealmsIncrement(
Avoid using static access to class '\Granam\Tools\ValueDescriber' in method 'sanitizeRealms'.
                'Expected positive integer for realms increment , got ' . ValueDescriber::describe($realmIncrement)
            );
        }
    }
 
    /**
     * @param $addition
     * @return int
     * @throws \DrdPlus\Theurgist\Spells\SpellParameters\Exceptions\InvalidFormatOfAdditionByRealmsValue
     */
    private function sanitizeAddition($addition): int
    {
        try {
Avoid using static access to class '\Granam\Integer\Tools\ToInteger' in method 'sanitizeAddition'.
            return ToInteger::toInteger($addition);
        } catch (\Granam\Integer\Tools\Exceptions\Exception $exception) {
            throw new Exceptions\InvalidFormatOfAdditionByRealmsValue(
Avoid using static access to class '\Granam\Tools\ValueDescriber' in method 'sanitizeAddition'.
                'Expected integer for addition by realm, got ' . ValueDescriber::describe($addition)
            );
        }
    }
 
    /**
     * How is realms increased on addition step, @see getDifficultyAdditionPerStep.
     *
     * @return int
     */
    public function getRealmsChangePerAdditionStep(): int
    {
        return $this->realmsChangePerAdditionStep;
    }
 
    /**
     * Bonus given by increasing realms, @see getRealmsChangePerAdditionStep
     *
     * @return int
     */
    public function getDifficultyAdditionPerStep(): int
    {
        return $this->difficultyAdditionPerStep;
    }
 
    /**
     * Current value of a difficulty "paid" by realms
     *
     * @return int
     */
    public function getCurrentAddition(): int
    {
        return $this->currentAddition;
    }
 
    /**
     * Same as @see getCurrentAddition (representing current value of an Integer object)
     *
     * @return int
     */
    public function getValue(): int
    {
        return $this->getCurrentAddition();
    }
 
    /**
     * @param int|float|NumberInterface $value
     * @return FormulaDifficultyAddition
     * @throws \DrdPlus\Theurgist\Spells\SpellParameters\Exceptions\InvalidFormatOfAdditionByRealmsValue
     */
    public function add($value): FormulaDifficultyAddition
    {
        $value = $this->sanitizeAddition($value);
        if ($value === 0) {
            return $this;
        }
 
        /** @noinspection ExceptionsAnnotatingAndHandlingInspection */
        return new static(
            $this->getNotation(),
Avoid using static access to class '\Granam\Integer\Tools\ToInteger' in method 'add'.
            $this->getValue() + ToInteger::toInteger($value) // current addition is injected as second parameter
        );
    }
 
    /**
     * @param int|float|NumberInterface $value
     * @return FormulaDifficultyAddition
     * @throws \DrdPlus\Theurgist\Spells\SpellParameters\Exceptions\InvalidFormatOfAdditionByRealmsValue
     */
    public function sub($value): FormulaDifficultyAddition
    {
        $value = $this->sanitizeAddition($value);
        if ($value === 0) {
            return $this;
        }
 
        /** @noinspection ExceptionsAnnotatingAndHandlingInspection */
        return new static(
            $this->getNotation(),
Avoid using static access to class '\Granam\Integer\Tools\ToInteger' in method 'sub'.
            $this->getValue() - ToInteger::toInteger($value) // current addition is injected as second parameter
        );
    }
 
    /**
     * @return string
     */
    public function __toString()
    {
        return "{$this->getValue()} {{$this->getRealmsChangePerAdditionStep()}=>{$this->getDifficultyAdditionPerStep()}}";
    }
 
    /**
     * @return string
     */
    public function getNotation(): string
    {
        return "{$this->getRealmsChangePerAdditionStep()}={$this->getDifficultyAdditionPerStep()}";
    }
}