Sign upLogin

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

View on GitHub
Star

Showing 44 of 44 total issues

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

<?php

declare(strict_types = 1);

namespace PHPModelGenerator\Exception\Arrays;
Severity: Major
Found in src/Exception/Arrays/InvalidItemException.php and 1 other location - About 4 hrs to fix
src/Exception/Arrays/InvalidTupleException.php on lines 1..60

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 175.

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

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

<?php

declare(strict_types = 1);

namespace PHPModelGenerator\Exception\Arrays;
Severity: Major
Found in src/Exception/Arrays/InvalidTupleException.php and 1 other location - About 4 hrs to fix
src/Exception/Arrays/InvalidItemException.php on lines 1..60

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 175.

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

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

<?php

declare(strict_types = 1);

namespace PHPModelGenerator\Exception\Object;
Severity: Major
Found in src/Exception/Object/NestedObjectException.php and 1 other location - About 1 hr to fix
src/Exception/Dependency/InvalidSchemaDependencyException.php on lines 1..50

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 115.

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

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

<?php

declare(strict_types = 1);

namespace PHPModelGenerator\Exception\Dependency;
Severity: Major
Found in src/Exception/Dependency/InvalidSchemaDependencyException.php and 1 other location - About 1 hr to fix
src/Exception/Object/NestedObjectException.php on lines 1..50

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 115.

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 class names like RegularPropertyAsAdditionalPropertyException. Keep class name length under 40.
Open

class RegularPropertyAsAdditionalPropertyException extends ValidationException
{
    /**
     * @var string
     */
Severity: Minor
Found in src/Exception/Object/RegularPropertyAsAdditionalPropertyException.php by phpmd

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

Function toArray has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

    public function toArray(array $except = [], int $depth = 512)
    {
        if ($depth < 1) {
            return false;
        }
Severity: Minor
Found in src/Traits/SerializableTrait.php - About 1 hr to fix

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

Function convertConstants has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

    protected static function convertConstants(array &$options): void
    {
        static $constants = [];

        foreach (['createFromFormat', 'outputFormat'] as $format) {
Severity: Minor
Found in src/Filter/DateTime.php - About 55 mins to fix

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

Function filter has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

    public static function filter(?string $value, array $options = []): ?\DateTime
    {
        static::convertConstants($options);

        try {
Severity: Minor
Found in src/Filter/DateTime.php - About 55 mins to fix

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

Avoid variables with short names like $e. Configured minimum length is 3.
Open

                function (ValidationException $e): string {
Severity: Minor
Found in src/Exception/ErrorRegistryException.php by phpmd

ShortVariable

Since: 0.2

Detects when a field, local, or parameter has a very short name.

Example

class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

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

Method __construct has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

        string $message,
        string $propertyName,
        $providedValue,
        $code = 0,
        Throwable $previous = null
Severity: Minor
Found in src/Exception/ValidationException.php - About 35 mins to fix

    Method __construct has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

            $providedValue,
        string $propertyName,
        ?Exception $ifException,
        ?Exception $thenException,
        ?Exception $elseException
    Severity: Minor
    Found in src/Exception/ComposedValue/ConditionalException.php - About 35 mins to fix

      Property name "$_customSerializer" should not be prefixed with an underscore to indicate visibility
      Open

          private static $_customSerializer = [];
      Severity: Minor
      Found in src/Traits/SerializableTrait.php by phpcodesniffer

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

          public function toJSON(array $except = [], int $options = 0, int $depth = 512, bool $stripSensitiveData = true)
      Severity: Minor
      Found in src/Exception/JSONModelValidationException.php by phpmd

      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

      Missing class import via use statement (line '51', column '42').
      Open

                  return $value !== null ? new \DateTime($value) : null;
      Severity: Minor
      Found in src/Filter/DateTime.php by phpmd

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
    return new \stdClass();
}

      Source http://phpmd.org/rules/cleancode.html#MissingImport

      Missing class import via use statement (line '30', column '28').
      Open

                      return new \DateTime();
      Severity: Minor
      Found in src/Filter/DateTime.php by phpmd

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
    return new \stdClass();
}

      Source http://phpmd.org/rules/cleancode.html#MissingImport

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

          public function toArray(array $except = [], int $depth = 512, bool $stripSensitiveData = true)
      Severity: Minor
      Found in src/Exception/JSONModelValidationException.php by phpmd

      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 unused parameters such as '$depth'.
      Open

          protected function resolveSerializationHook(array $data, int $depth, array $except): array
      Severity: Minor
      Found in src/Traits/SerializableTrait.php by phpmd

      UnusedFormalParameter

      Since: 0.2

      Avoid passing parameters to methods or constructors and then not using those parameters.

      Example

      class Foo
{
    private function bar($howdy)
    {
        // $howdy is not used
    }
}

      Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

      The method toArray uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
      Open

              } else {
            array_push($except, '__KEEP_SENSITIVE_DATA__');
        }
      Severity: Minor
      Found in src/Exception/JSONModelValidationException.php by phpmd

      ElseExpression

      Since: 1.4.0

      An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

      Example

      class Foo
{
    public function bar($flag)
    {
        if ($flag) {
            // one branch
        } else {
            // another branch
        }
    }
}

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

      Avoid unused parameters such as '$except'.
      Open

          protected function resolveSerializationHook(array $data, int $depth, array $except): array
      Severity: Minor
      Found in src/Traits/SerializableTrait.php by phpmd

      UnusedFormalParameter

      Since: 0.2

      Avoid passing parameters to methods or constructors and then not using those parameters.

      Example

      class Foo
{
    private function bar($howdy)
    {
        // $howdy is not used
    }
}

      Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

      Avoid using static access to class '\DateTime' in method 'filter'.
      Open

                      $result = \DateTime::createFromFormat($options['createFromFormat'], $value);
      Severity: Minor
      Found in src/Filter/DateTime.php by phpmd

      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

      Severity
      Category
      Status
      Source
      Language