jaroslavtyc/drd-plus-tables

View on GitHub
src/Armaments/Weapons/Ranged/Partials/RangedWeaponsTable.php

Summary

Maintainability
A
2 hrs
Test Coverage

Method addCustomRangedWeapon has 11 arguments (exceeds 4 allowed). Consider refactoring.
Open

        RangedWeaponCode $rangedWeaponCode,
        WeaponCategoryCode $rangedWeaponCategoryCode,
        Strength $requiredStrength,
        DistanceBonus $range,
        int $offensiveness,
Severity: Major
Found in src/Armaments/Weapons/Ranged/Partials/RangedWeaponsTable.php - About 1 hr to fix

    The method addCustomRangedWeapon has 11 parameters. Consider reducing the number of parameters to less than 10.
    Open

        public function addCustomRangedWeapon(
            RangedWeaponCode $rangedWeaponCode,
            WeaponCategoryCode $rangedWeaponCategoryCode,
            Strength $requiredStrength,
            DistanceBonus $range,

    Avoid using static access to class '\Granam\Tools\ValueDescriber' in method 'getValueOf'.
    Open

                    'Unknown ranged armament code ' . ValueDescriber::describe($rangedWeaponCode)

    StaticAccess

    Since: 1.4.0

    Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

    Example

    class Foo
    {
        public function bar()
        {
            Bar::baz();
        }
    }

    Source https://phpmd.org/rules/cleancode.html#staticaccess

    Similar blocks of code found in 4 locations. Consider refactoring.
    Open

        protected function getExpectedDataHeaderNamesToTypes(): array
        {
            return [
                self::REQUIRED_STRENGTH => self::INTEGER,
                self::OFFENSIVENESS => self::INTEGER,
    Severity: Major
    Found in src/Armaments/Weapons/Ranged/Partials/RangedWeaponsTable.php and 3 other locations - About 45 mins to fix
    src/Armaments/Weapons/Melee/Partials/MeleeWeaponsTable.php on lines 25..37
    src/Armaments/Weapons/Ranged/RangedWeaponStrengthSanctionsTable.php on lines 35..47
    src/Races/FemaleModifiersTable.php on lines 26..38

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 96.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Avoid excessively long variable names like $rangedWeaponCategoryCode. Keep variable name length under 20.
    Open

            WeaponCategoryCode $rangedWeaponCategoryCode,

    LongVariable

    Since: 0.2

    Detects when a field, formal or local variable is declared with a long name.

    Example

    class Something {
        protected $reallyLongIntName = -3; // VIOLATION - Field
        public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
            $otherReallyLongName = -5; // VIOLATION - Local
            for ($interestingIntIndex = 0; // VIOLATION - For
                 $interestingIntIndex < 10;
                 $interestingIntIndex++ ) {
            }
        }
    }

    Source https://phpmd.org/rules/naming.html#longvariable

    The 'getTwoHandedOnlyOf()' method which returns a boolean should be named 'is...()' or 'has...()'
    Open

        public function getTwoHandedOnlyOf($weaponlikeCode): bool
        {
            return $this->getValueOf($weaponlikeCode, self::TWO_HANDED_ONLY);
        }

    BooleanGetMethodName

    Since: 0.2

    Looks for methods named 'getX()' with 'boolean' as the return type. The convention is to name these methods 'isX()' or 'hasX()'.

    Example

    class Foo {
        /**
         * @return boolean
         */
        public function getFoo() {} // bad
        /**
         * @return bool
         */
        public function isFoo(); // ok
        /**
         * @return boolean
         */
        public function getFoo($bar); // ok, unless checkParameterizedMethods=true
    }

    Source https://phpmd.org/rules/naming.html#booleangetmethodname

    There are no issues that match your filters.

    Category
    Status