wol-soft/php-json-schema-model-generator

View on GitHub
src/SchemaProcessor/PostProcessor/AdditionalPropertiesAccessorPostProcessor.php

Summary

Maintainability
B
4 hrs
Test Coverage
A
100%

Function process has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

    public function process(Schema $schema, GeneratorConfiguration $generatorConfiguration): void
    {
        $json = $schema->getJsonSchema()->getJson();

        if ((!$this->addForModelsWithoutAdditionalPropertiesDefinition && !isset($json['additionalProperties']))

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Method process has 28 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function process(Schema $schema, GeneratorConfiguration $generatorConfiguration): void
    {
        $json = $schema->getJsonSchema()->getJson();

        if ((!$this->addForModelsWithoutAdditionalPropertiesDefinition && !isset($json['additionalProperties']))

    Method addSetAdditionalPropertyMethod has 27 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private function addSetAdditionalPropertyMethod(
            Schema $schema,
            GeneratorConfiguration $generatorConfiguration,
            ?PropertyInterface $validationProperty,
        ): void {

      Consider simplifying this complex logical expression.
      Open

              if ((!$this->addForModelsWithoutAdditionalPropertiesDefinition && !isset($json['additionalProperties']))
                  || (isset($json['additionalProperties']) && $json['additionalProperties'] === false)
                  || (!isset($json['additionalProperties']) && $generatorConfiguration->denyAdditionalProperties())
              ) {
                  return;

        The method process() has an NPath complexity of 504. The configured NPath complexity threshold is 200.
        Open

            public function process(Schema $schema, GeneratorConfiguration $generatorConfiguration): void
            {
                $json = $schema->getJsonSchema()->getJson();
        
                if ((!$this->addForModelsWithoutAdditionalPropertiesDefinition && !isset($json['additionalProperties']))

        NPathComplexity

        Since: 0.1

        The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.

        Example

        class Foo {
            function bar() {
                // lots of complicated code
            }
        }

        Source https://phpmd.org/rules/codesize.html#npathcomplexity

        The method process() has a Cyclomatic Complexity of 15. The configured cyclomatic complexity threshold is 10.
        Open

            public function process(Schema $schema, GeneratorConfiguration $generatorConfiguration): void
            {
                $json = $schema->getJsonSchema()->getJson();
        
                if ((!$this->addForModelsWithoutAdditionalPropertiesDefinition && !isset($json['additionalProperties']))

        CyclomaticComplexity

        Since: 0.1

        Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

        Example

        // Cyclomatic Complexity = 11
        class Foo {
        1   public function example() {
        2       if ($a == $b) {
        3           if ($a1 == $b1) {
                        fiddle();
        4           } elseif ($a2 == $b2) {
                        fiddle();
                    } else {
                        fiddle();
                    }
        5       } elseif ($c == $d) {
        6           while ($c == $d) {
                        fiddle();
                    }
        7        } elseif ($e == $f) {
        8           for ($n = 0; $n < $h; $n++) {
                        fiddle();
                    }
                } else {
                    switch ($z) {
        9               case 1:
                            fiddle();
                            break;
        10              case 2:
                            fiddle();
                            break;
        11              case 3:
                            fiddle();
                            break;
                        default:
                            fiddle();
                            break;
                    }
                }
            }
        }

        Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

        The class AdditionalPropertiesAccessorPostProcessor has a coupling between objects value of 17. Consider to reduce the number of dependencies under 13.
        Open

        class AdditionalPropertiesAccessorPostProcessor extends PostProcessor
        {
            /** @var bool */
            private $addForModelsWithoutAdditionalPropertiesDefinition;
        
        

        CouplingBetweenObjects

        Since: 1.1.0

        A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

        Example

        class Foo {
            /**
             * @var \foo\bar\X
             */
            private $x = null;
        
            /**
             * @var \foo\bar\Y
             */
            private $y = null;
        
            /**
             * @var \foo\bar\Z
             */
            private $z = null;
        
            public function setFoo(\Foo $foo) {}
            public function setBar(\Bar $bar) {}
            public function setBaz(\Baz $baz) {}
        
            /**
             * @return \SplObjectStorage
             * @throws \OutOfRangeException
             * @throws \InvalidArgumentException
             * @throws \ErrorException
             */
            public function process(\Iterator $it) {}
        
            // ...
        }

        Source https://phpmd.org/rules/design.html#couplingbetweenobjects

        The method __construct has a boolean flag argument $addForModelsWithoutAdditionalPropertiesDefinition, which is a certain sign of a Single Responsibility Principle violation.
        Open

            public function __construct(bool $addForModelsWithoutAdditionalPropertiesDefinition = false)

        BooleanArgumentFlag

        Since: 1.4.0

        A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

        Example

        class Foo {
            public function bar($flag = true) {
            }
        }

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

        Avoid using static access to class '\PHPModelGenerator\Utils\RenderHelper' in method 'addSetAdditionalPropertyMethod'.
        Open

                $objectProperties = RenderHelper::varExportArray(
                    array_map(
                        static function (PropertyInterface $property): string {
                            return $property->getName();
                        },

        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

        syntax error, unexpected ')', expecting variable (T_VARIABLE)
        Open

            ): void {

        Avoid excessively long class names like AdditionalPropertiesAccessorPostProcessor. Keep class name length under 40.
        Open

        class AdditionalPropertiesAccessorPostProcessor extends PostProcessor
        {
            /** @var bool */
            private $addForModelsWithoutAdditionalPropertiesDefinition;
        
        

        LongClassName

        Since: 2.9

        Detects when classes or interfaces are declared with excessively long names.

        Example

        class ATooLongClassNameThatHintsAtADesignProblem {
        
        }
        
        interface ATooLongInterfaceNameThatHintsAtADesignProblem {
        
        }

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

        Line indented incorrectly; expected 12 spaces, found 20
        Open

                            },

        Line indented incorrectly; expected 8 spaces, found 16
        Open

                        },

        Line indented incorrectly; expected 8 spaces, found 16
        Open

                        static function (PropertyInterface $property): string {

        Line indented incorrectly; expected 12 spaces, found 20
        Open

                            static function (PropertyInterface $property): bool {

        There are no issues that match your filters.

        Category
        Status