Sign upLogin

deployphp/deployer

View on GitHub
Star
src/Documentation/DocGen.php

Summary

Maintainability
F
5 days
Test Coverage

Function gen has a Cognitive Complexity of 130 (exceeds 5 allowed). Consider refactoring.
Open

    public function gen(string $destination): ?string
    {
        foreach ($this->recipes as $recipe) {
            // $find will try to return DocConfig for a given config $name.
            $findConfig = function (string $name) use ($recipe): ?DocConfig {
Severity: Minor
Found in src/Documentation/DocGen.php - About 2 days 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 gen has 240 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function gen(string $destination): ?string
    {
        foreach ($this->recipes as $recipe) {
            // $find will try to return DocConfig for a given config $name.
            $findConfig = function (string $name) use ($recipe): ?DocConfig {
Severity: Major
Found in src/Documentation/DocGen.php - About 1 day to fix

    File DocGen.php has 351 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php declare(strict_types=1);

/* (c) Anton Medvedev <anton@medv.io>
 *
 * For the full copyright and license information, please view the LICENSE
    Severity: Minor
    Found in src/Documentation/DocGen.php - About 4 hrs to fix

      Avoid too many return statements within this method.
      Open

                                  return $this->recipes[$r]->config[$name];
      Severity: Major
      Found in src/Documentation/DocGen.php - About 30 mins to fix

        Avoid too many return statements within this method.
        Open

                            return $recipe->tasks[$name];
        Severity: Major
        Found in src/Documentation/DocGen.php - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                          return null;
          Severity: Major
          Found in src/Documentation/DocGen.php - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                                        return $r->tasks[$name];
            Severity: Major
            Found in src/Documentation/DocGen.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                              return null;
              Severity: Major
              Found in src/Documentation/DocGen.php - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                        return null;
                Severity: Major
                Found in src/Documentation/DocGen.php - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                                          return "{{" . $name . "}}";
                  Severity: Major
                  Found in src/Documentation/DocGen.php - About 30 mins to fix

                    Avoid too many return statements within this method.
                    Open

                                                return "[$name](/docs/$md#$anchor)";
                    Severity: Major
                    Found in src/Documentation/DocGen.php - About 30 mins to fix

                      Avoid too many return statements within this method.
                      Open

                                      return $output;
                      Severity: Major
                      Found in src/Documentation/DocGen.php - About 30 mins to fix

                        Avoid too many return statements within this method.
                        Open

                                                    return $this->recipes[$r]->tasks[$name];
                        Severity: Major
                        Found in src/Documentation/DocGen.php - About 30 mins to fix

                          Avoid too many return statements within this method.
                          Open

                                                  return $findConfigOverride($this->recipes[$r], $name);
                          Severity: Major
                          Found in src/Documentation/DocGen.php - About 30 mins to fix

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

                                public function generateContribIndex(string $destination) {
        $index = "# All Contrib Recipes\n\n";
        $list = [];
        foreach ($this->recipes as $recipe) {
            if (preg_match('/^contrib\/[^\/]+\.php$/', $recipe->recipePath)) {
                            Severity: Major
                            Found in src/Documentation/DocGen.php and 1 other location - About 2 hrs to fix
                            src/Documentation/DocGen.php on lines 318..330

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

                            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

                                public function generateRecipesIndex(string $destination) {
        $index = "# All Recipes\n\n";
        $list = [];
        foreach ($this->recipes as $recipe) {
            if (preg_match('/^recipe\/[^\/]+\.php$/', $recipe->recipePath)) {
                            Severity: Major
                            Found in src/Documentation/DocGen.php and 1 other location - About 2 hrs to fix
                            src/Documentation/DocGen.php on lines 332..344

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

                            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