DragonBe/vies

View on GitHub

Showing 56 of 58 total issues

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

<?php

declare (strict_types=1);

/**
Severity: Major
Found in src/Vies/Validator/ValidatorGB.php and 1 other location - About 1 day to fix
src/Vies/Validator/ValidatorXI.php on lines 1..111

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

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);

/**
Severity: Major
Found in src/Vies/Validator/ValidatorXI.php and 1 other location - About 1 day to fix
src/Vies/Validator/ValidatorGB.php on lines 1..97

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

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

File Vies.php has 276 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

declare (strict_types=1);

/**
Severity: Minor
Found in src/Vies/Vies.php - About 2 hrs to fix

    Vies has 21 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class Vies
    {
        const VIES_PROTO = 'https';
        const VIES_DOMAIN = 'ec.europa.eu';
        const VIES_PORT = 443;
    Severity: Minor
    Found in src/Vies/Vies.php - About 2 hrs to fix

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

          protected $checkCharacterPhysical = [
              1 => 'T',
              2 => 'R',
              3 => 'W',
              4 => 'A',
      Severity: Minor
      Found in src/Vies/Validator/ValidatorES.php by phpmd

      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

      Method populate has 31 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function populate($row): void
          {
              if (is_array($row)) {
                  $row = (object) $row;
              }
      Severity: Minor
      Found in src/Vies/CheckVatResponse.php - About 1 hr to fix

        Method validateVat has 9 arguments (exceeds 4 allowed). Consider refactoring.
        Open

                string $countryCode,
                string $vatNumber,
                string $requesterCountryCode = '',
                string $requesterVatNumber = '',
                string $traderName = '',
        Severity: Major
        Found in src/Vies/Vies.php - About 1 hr to fix

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

              public function validateVat(
                  string $countryCode,
                  string $vatNumber,
                  string $requesterCountryCode = '',
                  string $requesterVatNumber = '',
          Severity: Minor
          Found in src/Vies/Vies.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

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

              private function getSecuredResponse(): array
              {
                  $streamOptions = [
                      'ssl' => [
                          'verify_peer' => true,
          Severity: Minor
          Found in src/Vies/HeartBeat.php - About 1 hr to fix

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

                    $sumBase = array_reduce(str_split($vatNumber), function ($acc, $e) {
            Severity: Minor
            Found in src/Vies/Validator/ValidatorNL.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 checkValue has 5 arguments (exceeds 4 allowed). Consider refactoring.
            Open

                    $vatNumber,
                    $weights,
                    $restModulo = self::DEFAULT_MODULO,
                    $vatNumberPosition = self::DEFAULT_VAT_POSITION,
                    $weightStart = self::DEFAULT_WEIGHT_START
            Severity: Minor
            Found in src/Vies/Validator/ValidatorAbstract.php - About 35 mins to fix

              Function validate has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
              Open

                  public function validate(string $vatNumber): bool
                  {
                      if (strlen($vatNumber) != 11) {
                          return false;
                      }
              Severity: Minor
              Found in src/Vies/Validator/ValidatorIT.php - About 35 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 validate has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
              Open

                  public function validate(string $vatNumber): bool
                  {
                      if (strlen($vatNumber) != 9) {
                          return false;
                      }
              Severity: Minor
              Found in src/Vies/Validator/ValidatorES.php - About 35 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 validateIndividualsLong has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
              Open

                  public function validateIndividualsLong($vatNumber)
                  {
                      $monthBase = array_merge(range(1, 12), range(21, 32), range(51, 62), range(71, 82));
              
                      $yearOfBirth = (int)substr($vatNumber, 0, 2);
              Severity: Minor
              Found in src/Vies/Validator/ValidatorCZ.php - About 35 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 too many return statements within this method.
              Open

                          return ((int) $sumBase % 97) === 1;
              Severity: Major
              Found in src/Vies/Validator/ValidatorNL.php - About 30 mins to fix

                Missing class import via use statement (line '177', column '23').
                Open

                            throw new \InvalidArgumentException('Expecting a resource to be provided');
                Severity: Minor
                Found in src/Vies/HeartBeat.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 '232', column '23').
                Open

                            throw new \RuntimeException('Can not create socket stream: ' . $error);
                Severity: Minor
                Found in src/Vies/HeartBeat.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

                Avoid too many return statements within this method.
                Open

                        return true;
                Severity: Major
                Found in src/Vies/Validator/ValidatorCZ.php - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                              return (int) $checksum === $this->validateNational($vatNumber);
                  Severity: Major
                  Found in src/Vies/Validator/ValidatorES.php - About 30 mins to fix

                    Avoid too many return statements within this method.
                    Open

                            return false;
                    Severity: Major
                    Found in src/Vies/Validator/ValidatorCZ.php - About 30 mins to fix
                      Severity
                      Category
                      Status
                      Source
                      Language