Sign upLogin

shadiakiki1986/git-data-repo

View on GitHub
Star
src/GitDataRepo.php

Summary

Maintainability
A
2 hrs
Test Coverage

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

    public static function initGdrPersistentFromAuthJson($repoPath, $authFn, $remoteUrl, $loglevel = \Monolog\Logger::WARNING, $gitconfig = array())
    {
        // copied from accounting-bdlreports-mapeditor/action.php

        // check can put files here
Severity: Minor
Found in src/GitDataRepo.php - About 1 hr to fix

    Function initGdrPersistentFromAuthJson has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

        public static function initGdrPersistentFromAuthJson($repoPath, $authFn, $remoteUrl, $loglevel = \Monolog\Logger::WARNING, $gitconfig = array())
    {
        // copied from accounting-bdlreports-mapeditor/action.php

        // check can put files here
    Severity: Minor
    Found in src/GitDataRepo.php - About 45 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

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

        public static function initGdrPersistentFromAuthJson($repoPath, $authFn, $remoteUrl, $loglevel = \Monolog\Logger::WARNING, $gitconfig = array())
    Severity: Minor
    Found in src/GitDataRepo.php - About 35 mins to fix

      Missing class import via use statement (line '136', column '27').
      Open

                      throw new \Exception("File not found '".$authFn."'");
      Severity: Minor
      Found in src/GitDataRepo.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 '148', column '28').
      Open

                  $gitRepo = new \Coyl\Git\GitRepo($repoPath, false, false);
      Severity: Minor
      Found in src/GitDataRepo.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 '129', column '23').
      Open

                  throw new \Exception("Cache folder '".$repoPath."' is not writable. You may need `[sudo] chown www-data:www-data -R ".$repoPath."`");
      Severity: Minor
      Found in src/GitDataRepo.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 '14', column '26').
      Open

              $this->log = new \Monolog\Logger('GitDataRepo');
      Severity: Minor
      Found in src/GitDataRepo.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 '17', column '17').
      Open

                  new \Monolog\Handler\StreamHandler(
      Severity: Minor
      Found in src/GitDataRepo.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 '149', column '24').
      Open

                  return new \GitDataRepo\GitDataRepo($gitRepo, $remote, $loglevel);
      Severity: Minor
      Found in src/GitDataRepo.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 '167', column '23').
      Open

                  throw new \Exception("Invalid URL format: ".$url);
      Severity: Minor
      Found in src/GitDataRepo.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 '160', column '20').
      Open

              return new \GitDataRepo\GitDataRepo($gitRepo, $remote, $loglevel);
      Severity: Minor
      Found in src/GitDataRepo.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 using static access to class '\DateTime' in method 'date'.
      Open

              return \DateTime::createFromFormat("Y-m-d H:i:s e", $dd);
      Severity: Minor
      Found in src/GitDataRepo.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

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

              } else {
            $remote = $remoteUrl;
        }
      Severity: Minor
      Found in src/GitDataRepo.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 variables with short names like $dd. Configured minimum length is 3.
      Open

              $dd = $this->repo->logFormatted("%ci", "", 1);
      Severity: Minor
      Found in src/GitDataRepo.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

      There are no issues that match your filters.

      Category
      Status