TikiWiki/tiki-manager

View on GitHub
src/Command/CheckoutCommand.php

Summary

Maintainability
C
1 day
Test Coverage

Function execute has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
Open

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $instanceId = $input->getOption('instance');
        $instance = Instance::getInstance($instanceId);

Severity: Minor
Found in src/Command/CheckoutCommand.php - About 2 hrs 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 interact has 69 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function interact(InputInterface $input, OutputInterface $output)
    {
        $instances = CommandHelper::getInstances('tiki');
        $instances = array_filter($instances, function ($instance) {
            return $instance->vcs_type == 'git';
Severity: Major
Found in src/Command/CheckoutCommand.php - About 2 hrs to fix

    Method execute has 67 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        protected function execute(InputInterface $input, OutputInterface $output)
        {
            $instanceId = $input->getOption('instance');
            $instance = Instance::getInstance($instanceId);
    
    
    Severity: Major
    Found in src/Command/CheckoutCommand.php - About 2 hrs to fix

      Function interact has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
      Open

          protected function interact(InputInterface $input, OutputInterface $output)
          {
              $instances = CommandHelper::getInstances('tiki');
              $instances = array_filter($instances, function ($instance) {
                  return $instance->vcs_type == 'git';
      Severity: Minor
      Found in src/Command/CheckoutCommand.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 configure has 34 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          protected function configure()
          {
              $this
                  ->setName('instance:checkout')
                  ->setDescription('Checkout a different branch or revision on an underlying Git controlled source.')
      Severity: Minor
      Found in src/Command/CheckoutCommand.php - About 1 hr to fix

        Avoid too many return statements within this method.
        Open

                        return $answer;
        Severity: Major
        Found in src/Command/CheckoutCommand.php - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                          return $answer;
          Severity: Major
          Found in src/Command/CheckoutCommand.php - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                                return $answer;
            Severity: Major
            Found in src/Command/CheckoutCommand.php - About 30 mins to fix

              The method interact() has an NPath complexity of 540. The configured NPath complexity threshold is 200.
              Open

                  protected function interact(InputInterface $input, OutputInterface $output)
                  {
                      $instances = CommandHelper::getInstances('tiki');
                      $instances = array_filter($instances, function ($instance) {
                          return $instance->vcs_type == 'git';
              Severity: Minor
              Found in src/Command/CheckoutCommand.php by phpmd

              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 execute() has an NPath complexity of 1152. The configured NPath complexity threshold is 200.
              Open

                  protected function execute(InputInterface $input, OutputInterface $output)
                  {
                      $instanceId = $input->getOption('instance');
                      $instance = Instance::getInstance($instanceId);
              
              
              Severity: Minor
              Found in src/Command/CheckoutCommand.php by phpmd

              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 execute() has a Cyclomatic Complexity of 15. The configured cyclomatic complexity threshold is 10.
              Open

                  protected function execute(InputInterface $input, OutputInterface $output)
                  {
                      $instanceId = $input->getOption('instance');
                      $instance = Instance::getInstance($instanceId);
              
              
              Severity: Minor
              Found in src/Command/CheckoutCommand.php by phpmd

              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 method interact() has a Cyclomatic Complexity of 13. The configured cyclomatic complexity threshold is 10.
              Open

                  protected function interact(InputInterface $input, OutputInterface $output)
                  {
                      $instances = CommandHelper::getInstances('tiki');
                      $instances = array_filter($instances, function ($instance) {
                          return $instance->vcs_type == 'git';
              Severity: Minor
              Found in src/Command/CheckoutCommand.php by phpmd

              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

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

                              throw new \RuntimeException('No instance available.');
              Severity: Minor
              Found in src/Command/CheckoutCommand.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 '91', column '23').
              Open

                          throw new \RuntimeException('Unable to initialize Tiki application. Please check if selected instance is a Tiki instance.');
              Severity: Minor
              Found in src/Command/CheckoutCommand.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 '144', column '23').
              Open

                          throw new \RuntimeException(sprintf('Instance %s not found.', $instanceId));
              Severity: Minor
              Found in src/Command/CheckoutCommand.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 '88', column '27').
              Open

                              throw new \RuntimeException('Selected Tiki instance is not a Git checkout.');
              Severity: Minor
              Found in src/Command/CheckoutCommand.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 '111', column '35').
              Open

                                      throw new \RuntimeException('Git URL cannot be empty');
              Severity: Minor
              Found in src/Command/CheckoutCommand.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 '165', column '23').
              Open

                          throw new \RuntimeException('Branch name cannot be empty.');
              Severity: Minor
              Found in src/Command/CheckoutCommand.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 '152', column '23').
              Open

                          throw new \RuntimeException('Unable to initialize Tiki application. Please check if selected instance is a Tiki instance.');
              Severity: Minor
              Found in src/Command/CheckoutCommand.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 '102', column '35').
              Open

                                      throw new \RuntimeException('Folder cannot be empty');
              Severity: Minor
              Found in src/Command/CheckoutCommand.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 '161', column '23').
              Open

                          throw new \RuntimeException('Folder name cannot be empty.');
              Severity: Minor
              Found in src/Command/CheckoutCommand.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 '123', column '31').
              Open

                                  throw new \RuntimeException('Branch name cannot be empty');
              Severity: Minor
              Found in src/Command/CheckoutCommand.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 '27').
              Open

                              throw new \RuntimeException('Selected Tiki instance is not a Git checkout.');
              Severity: Minor
              Found in src/Command/CheckoutCommand.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 '\TikiManager\Command\Helper\CommandHelper' in method 'interact'.
              Open

                          CommandHelper::renderInstancesTable($output, $instancesInfo);
              Severity: Minor
              Found in src/Command/CheckoutCommand.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

              Avoid using static access to class '\TikiManager\Application\Instance' in method 'interact'.
              Open

                      $instance = Instance::getInstance($instanceId);
              Severity: Minor
              Found in src/Command/CheckoutCommand.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 execute uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
              Open

                      } else {
                          $this->io->writeln(sprintf('Checking out %s into %s...', $branch, $folder));
                      }
              Severity: Minor
              Found in src/Command/CheckoutCommand.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 using static access to class '\TikiManager\Command\Helper\CommandHelper' in method 'interact'.
              Open

                      $instances = CommandHelper::getInstances('tiki');
              Severity: Minor
              Found in src/Command/CheckoutCommand.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

              Avoid using static access to class '\TikiManager\Command\Helper\CommandHelper' in method 'interact'.
              Open

                              $selectedInstances = CommandHelper::validateInstanceSelection($answer, $instances);
              Severity: Minor
              Found in src/Command/CheckoutCommand.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

              Avoid using static access to class '\TikiManager\Application\Instance' in method 'execute'.
              Open

                      $instance = Instance::getInstance($instanceId);
              Severity: Minor
              Found in src/Command/CheckoutCommand.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 execute uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
              Open

                      } else {
                          throw new \RuntimeException('Unable to initialize Tiki application. Please check if selected instance is a Tiki instance.');
                      }
              Severity: Minor
              Found in src/Command/CheckoutCommand.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 assigning values to variables in if clauses and the like (line '86', column '13').
              Open

                  protected function interact(InputInterface $input, OutputInterface $output)
                  {
                      $instances = CommandHelper::getInstances('tiki');
                      $instances = array_filter($instances, function ($instance) {
                          return $instance->vcs_type == 'git';
              Severity: Minor
              Found in src/Command/CheckoutCommand.php by phpmd

              IfStatementAssignment

              Since: 2.7.0

              Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

              Example

              class Foo
              {
                  public function bar($flag)
                  {
                      if ($foo = 'bar') { // possible typo
                          // ...
                      }
                      if ($baz = 0) { // always false
                          // ...
                      }
                  }
              }

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

              Avoid using static access to class '\TikiManager\Command\Helper\CommandHelper' in method 'interact'.
              Open

                      $instancesInfo = CommandHelper::getInstancesInfo($instances);
              Severity: Minor
              Found in src/Command/CheckoutCommand.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 interact uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
              Open

                      } else {
                          throw new \RuntimeException('Unable to initialize Tiki application. Please check if selected instance is a Tiki instance.');
                      }
              Severity: Minor
              Found in src/Command/CheckoutCommand.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

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

                          } else {
                              $this->io->writeln(sprintf('Folder doesn\'t exist, cloning %s...', $url));
                              $vcs->setRepositoryUrl($url);
                              $this->io->writeln($vcs->clone($branch, $folder));
                              if ($revision) {
              Severity: Minor
              Found in src/Command/CheckoutCommand.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 assigning values to variables in if clauses and the like (line '147', column '13').
              Open

                  protected function execute(InputInterface $input, OutputInterface $output)
                  {
                      $instanceId = $input->getOption('instance');
                      $instance = Instance::getInstance($instanceId);
              
              
              Severity: Minor
              Found in src/Command/CheckoutCommand.php by phpmd

              IfStatementAssignment

              Since: 2.7.0

              Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

              Example

              class Foo
              {
                  public function bar($flag)
                  {
                      if ($foo = 'bar') { // possible typo
                          // ...
                      }
                      if ($baz = 0) { // always false
                          // ...
                      }
                  }
              }

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

              There are no issues that match your filters.

              Category
              Status