themichaelhall/datatypes

View on GitHub
src/System/FilePath.php

Summary

Maintainability
D
1 day
Test Coverage

FilePath has 29 functions (exceeds 20 allowed). Consider refactoring.
Open

class FilePath implements FilePathInterface
{
    /**
     * Returns true if the file path equals other file path, false otherwise.
     *
Severity: Minor
Found in src/System/FilePath.php - About 3 hrs to fix

    File FilePath.php has 254 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php
    
    /**
     * This file is a part of the datatypes package.
     *
    Severity: Minor
    Found in src/System/FilePath.php - About 2 hrs to fix

      Function normalizeDirectoryParts has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
      Open

          private static function normalizeDirectoryParts(bool $isAbsolute, array &$parts, int &$aboveBaseLevel, ?string &$error = null): bool
          {
              $newParts = [];
      
              foreach ($parts as $part) {
      Severity: Minor
      Found in src/System/FilePath.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 parseParts has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
      Open

          private static function parseParts(array $parts, bool $parseAsDirectory, bool &$isAbsolute, array &$directoryParts, ?string &$filename, ?string &$error): bool
          {
              $isAbsolute = count($parts) > 1 && $parts[0] === '';
              if ($isAbsolute) {
                  array_shift($parts);
      Severity: Minor
      Found in src/System/FilePath.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 doParse has 31 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private static function doParse(string $str, bool $parseAsDirectory, ?string &$error = null): ?self
          {
              $drive = null;
      
              // If on Window, try to parse drive.
      Severity: Minor
      Found in src/System/FilePath.php - About 1 hr to fix

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

            private static function doParse(string $str, bool $parseAsDirectory, ?string &$error = null): ?self
            {
                $drive = null;
        
                // If on Window, try to parse drive.
        Severity: Minor
        Found in src/System/FilePath.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 parseParts has 6 arguments (exceeds 4 allowed). Consider refactoring.
        Open

            private static function parseParts(array $parts, bool $parseAsDirectory, bool &$isAbsolute, array &$directoryParts, ?string &$filename, ?string &$error): bool
        Severity: Minor
        Found in src/System/FilePath.php - About 45 mins to fix

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

              private function __construct(bool $isAbsolute, int $aboveBaseLevel, ?string $drive, array $directoryParts, ?string $filename)
          Severity: Minor
          Found in src/System/FilePath.php - About 35 mins to fix

            Avoid too many return statements within this method.
            Open

                    return new self($isAbsolute, $aboveBaseLevel, $drive, $directoryParts, $filename);
            Severity: Major
            Found in src/System/FilePath.php - About 30 mins to fix

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

                  private static function normalizeDirectoryParts(bool $isAbsolute, array &$parts, int &$aboveBaseLevel, ?string &$error = null): bool
                  {
                      $newParts = [];
              
                      foreach ($parts as $part) {
              Severity: Major
              Found in src/System/FilePath.php and 1 other location - About 2 hrs to fix
              src/Net/UrlPath.php on lines 463..496

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

              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

              There are no issues that match your filters.

              Category
              Status