Sign upLogin

klitsche/dog

View on GitHub
Star

Showing 103 of 103 total issues

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

    public function analyze(ElementInterface $element): iterable
    {
        if (
            $element instanceof DocBlockAwareInterface
            && $element->hasDocBlock() === true
Severity: Major
Found in src/Analyzer/Rules/DocBlockApiNotInternalRule.php and 1 other location - About 3 hrs to fix
src/Analyzer/Rules/DocBlockLinkUrlRule.php on lines 18..46

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

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

Function enrich has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
Open

    public function enrich(ProjectInterface $project): void
    {
        $enrichers = $this->enrichers->getEnrichers();
        $elements = $project->getElements();
Severity: Minor
Found in src/ProjectEnricher.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

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

<?php

declare(strict_types=1);

namespace Klitsche\Dog\Analyzer\Rules;
Severity: Major
Found in src/Analyzer/Rules/DocBlockLicenseMissingRule.php and 2 other locations - About 2 hrs to fix
src/Analyzer/Rules/DocBlockCopyrightMissingRule.php on lines 1..39
src/Analyzer/Rules/DocBlockLinkMissingRule.php on lines 1..39

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

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 3 locations. Consider refactoring.
Open

<?php

declare(strict_types=1);

namespace Klitsche\Dog\Analyzer\Rules;
Severity: Major
Found in src/Analyzer/Rules/DocBlockCopyrightMissingRule.php and 2 other locations - About 2 hrs to fix
src/Analyzer/Rules/DocBlockLicenseMissingRule.php on lines 1..38
src/Analyzer/Rules/DocBlockLinkMissingRule.php on lines 1..39

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

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 3 locations. Consider refactoring.
Open

<?php

declare(strict_types=1);

namespace Klitsche\Dog\Analyzer\Rules;
Severity: Major
Found in src/Analyzer/Rules/DocBlockLinkMissingRule.php and 2 other locations - About 2 hrs to fix
src/Analyzer/Rules/DocBlockCopyrightMissingRule.php on lines 1..39
src/Analyzer/Rules/DocBlockLicenseMissingRule.php on lines 1..38

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

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

Function enrich has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
Open

    public function enrich(DataAwareInterface $dataHolder): void
    {
        if ($dataHolder instanceof Trait_) {
            $usedBy = [];
            $project = $dataHolder->getProject();
Severity: Minor
Found in src/Enrichers/UsedBy/UsedByEnricher.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

Class_ has 22 functions (exceeds 20 allowed). Consider refactoring.
Open

class Class_ implements ElementInterface, FqsenAwareInterface, DocBlockAwareInterface, ProjectAwareInterface, DataAwareInterface
{
    use DocBlockTrait;
    use ProjectTrait;
    use FqsenTrait;
Severity: Minor
Found in src/Elements/Class_.php - About 2 hrs to fix

    Method validateFunction has 50 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private function validateFunction(ElementInterface $element): iterable
    {
        foreach ($element->getArguments() as $i => $argument) {
            if (
                $argument->getType() === null
    Severity: Minor
    Found in src/Analyzer/Rules/TypeMissingRule.php - About 2 hrs to fix

      Method functionLink has 50 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function functionLink(?ElementInterface $element): string
    {
        if ($element === null) {
            return '';
        }
      Severity: Minor
      Found in src/Printer/Markdown/Printer.php - About 2 hrs to fix

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

                int $files,
        int $loc,
        int $ncloc,
        int $classes,
        int $coveredclasses,
        Severity: Major
        Found in src/Enrichers/Clover/ProjectMetrics.php - About 1 hr to fix

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

                  int $loc,
        int $ncloc,
        int $classes,
        int $coveredclasses,
        int $methods,
          Severity: Major
          Found in src/Enrichers/Clover/FileMetrics.php - About 1 hr to fix

            Method enrich has 36 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                public function enrich(DataAwareInterface $dataHolder): void
    {
        switch (true) {
            case $dataHolder instanceof ProjectInterface:
                $elements = $this->clover->xpath('//project');
            Severity: Minor
            Found in src/Enrichers/Clover/CloverEnricher.php - About 1 hr to fix

              Function analyze has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
              Open

                  public function analyze(ElementInterface $element): iterable
    {
        if (
            $element instanceof DocBlockAwareInterface
            && $element->hasDocBlock() === true
              Severity: Minor
              Found in src/Analyzer/Rules/DocBlockParamNameOnlyOnceRule.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 outputError has 35 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  private function outputError(ErrorEvent $event): void
    {
        $exception = $event->getThrowable();
        $this->style->error(
            [
              Severity: Minor
              Found in src/Cli/ErrorReporter.php - About 1 hr to fix

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

                    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $analyzeOption = $input->getOption('analyze');
        $generateOption = $input->getOption('generate');
        if ($analyzeOption === $generateOption) {
                Severity: Minor
                Found in src/Cli/GenerateCommand.php - About 1 hr to fix

                  Method analyze has 35 lines of code (exceeds 25 allowed). Consider refactoring.
                  Open

                      public function analyze(ElementInterface $element): iterable
    {
        if (
            $element instanceof DocBlockAwareInterface
            && $element->hasDocBlock() === true
                  Severity: Minor
                  Found in src/Analyzer/Rules/DocBlockDeprecatedCorrespondingSeeRule.php - About 1 hr to fix

                    Method createFromConfig has 33 lines of code (exceeds 25 allowed). Consider refactoring.
                    Open

                        public static function createFromConfig(ConfigInterface $config)
    {
        $rules = [];
        $rulesConfig = self::mergeWithDefaultRules($config->getRules());
                    Severity: Minor
                    Found in src/Analyzer/Rules.php - About 1 hr to fix

                      Function mergeWithDefaultRules has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
                      Open

                          private static function mergeWithDefaultRules(array $rulesConfig): array
    {
        $mergedRuleConfig = self::DEFAULT;
        foreach ($rulesConfig as $id => $config) {
            if (is_array($config) === false) {
                      Severity: Minor
                      Found in src/Analyzer/Rules.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 addFile has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
                      Open

                          public function addFile(File $file): void
    {
        $this->files[$file->getPath()] = $file;

        foreach ($this->walk([$file]) as $element) {
                      Severity: Minor
                      Found in src/Elements/ElementsIndex.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 enrich has 31 lines of code (exceeds 25 allowed). Consider refactoring.
                      Open

                          public function enrich(ProjectInterface $project): void
    {
        $enrichers = $this->enrichers->getEnrichers();
        $elements = $project->getElements();
                      Severity: Minor
                      Found in src/ProjectEnricher.php - About 1 hr to fix
                        Severity
                        Category
                        Status
                        Source
                        Language