Sign upLogin

t1gor/Robots.txt-Parser-Class

View on GitHub
Star

Showing 1,364 of 1,364 total issues

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

<?php declare(strict_types=1);

namespace t1gor\RobotsTxtParser\Stream\Filters;

use Psr\Log\LoggerInterface;
Severity: Major
Found in source/Stream/Filters/SkipEndOfCommentedLineFilter.php and 1 other location - About 5 hrs to fix
source/Stream/Filters/SkipCommentedLinesFilter.php on lines 1..31

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

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

<?php declare(strict_types=1);

namespace t1gor\RobotsTxtParser\Stream\Filters;

use Psr\Log\LoggerInterface;
Severity: Major
Found in source/Stream/Filters/SkipCommentedLinesFilter.php and 1 other location - About 5 hrs to fix
source/Stream/Filters/SkipEndOfCommentedLineFilter.php on lines 1..31

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

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

File RobotsTxtParser.php has 353 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php declare(strict_types=1);

namespace t1gor\RobotsTxtParser;

use Psr\Log\LoggerAwareInterface;
Severity: Minor
Found in source/RobotsTxtParser.php - About 4 hrs to fix

    The class RobotsTxtParser has an overall complexity of 103 which is very high. The configured complexity threshold is 50.
    Open

    class RobotsTxtParser implements LoggerAwareInterface {

    use LogsIfAvailableTrait;

    // default encoding
    Severity: Minor
    Found in source/RobotsTxtParser.php by phpmd

    RobotsTxtParser has 27 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class RobotsTxtParser implements LoggerAwareInterface {

    use LogsIfAvailableTrait;

    // default encoding
    Severity: Minor
    Found in source/RobotsTxtParser.php - About 3 hrs to fix

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

          protected function parseURL($url) {
        $parsed = parse_url($url);
        if ($parsed === false) {
            return false;
        } elseif (!isset($parsed['scheme']) || !$this->isValidScheme($parsed['scheme'])) {
      Severity: Minor
      Found in source/RobotsTxtParser.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

      Avoid excessively long variable names like $skippedCrawlDelayValues. Keep variable name length under 20.
      Open

                  $skippedCrawlDelayValues = 0;
      Severity: Minor
      Found in source/Stream/Filters/SkipDirectivesWithInvalidValuesFilter.php by phpmd

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

      Source https://phpmd.org/rules/naming.html#longvariable

      Avoid excessively long variable names like $skippedRequestRateValues. Keep variable name length under 20.
      Open

                  $skippedRequestRateValues = 0;
      Severity: Minor
      Found in source/Stream/Filters/SkipDirectivesWithInvalidValuesFilter.php by phpmd

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

      Source https://phpmd.org/rules/naming.html#longvariable

      Avoid excessively long variable names like $skippedAllowanceValues. Keep variable name length under 20.
      Open

                  $skippedAllowanceValues = 0;
      Severity: Minor
      Found in source/Stream/Filters/SkipDirectivesWithInvalidValuesFilter.php by phpmd

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

      Source https://phpmd.org/rules/naming.html#longvariable

      Function render has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
      Open

          public function render($eol = "\r\n") {
        $input = $this->getRules();
        krsort($input);
        $output = [];
        foreach ($input as $userAgent => $rules) {
      Severity: Minor
      Found in source/RobotsTxtParser.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 filter has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
      Open

          public function filter($in, $out, &$consumed, $closing) {
        while ($bucket = stream_bucket_make_writeable($in)) {
            $skippedRequestRateValues = 0;
            $skippedCrawlDelayValues = 0;
            $skippedAllowanceValues = 0;
      Severity: Minor
      Found in source/Stream/Filters/SkipDirectivesWithInvalidValuesFilter.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 process has 30 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function process(string $line, array &$root, string &$currentUserAgent = '*', string $prevLine = '') {
        $parts     = explode(':', $line);
        $entry     = trim($parts[1]);
        $directive = $this->getDirectiveName();
      Severity: Minor
      Found in source/Parser/DirectiveProcessors/AbstractAllowanceProcessor.php - About 1 hr to fix

        Method render has 30 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function render($eol = "\r\n") {
        $input = $this->getRules();
        krsort($input);
        $output = [];
        foreach ($input as $userAgent => $rules) {
        Severity: Minor
        Found in source/RobotsTxtParser.php - About 1 hr to fix

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

              public function getSitemaps(?string $userAgent = null): array {
        $this->buildTree();
        $maps = [];

        if (!is_null($userAgent)) {
          Severity: Minor
          Found in source/RobotsTxtParser.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 checkRules has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
          Open

              protected function checkRules(string $rule, string $path, string $userAgent = '*'): bool {
        // check for disallowed http status code
        if ($this->checkHttpStatusCodeRule()) {
            return ($rule === Directive::DISALLOW);
        }
          Severity: Minor
          Found in source/RobotsTxtParser.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

          Avoid variables with short names like $in. Configured minimum length is 3.
          Open

              public function __construct(string $in) {
          Severity: Minor
          Found in source/Parser/Url.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

          Avoid variables with short names like $in. Configured minimum length is 3.
          Open

              public function filter($in, $out, &$consumed, $closing) {
          Severity: Minor
          Found in source/Stream/Filters/SkipCommentedLinesFilter.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

          Avoid variables with short names like $in. Configured minimum length is 3.
          Open

              public function filter($in, $out, &$consumed, $closing) {
          Severity: Minor
          Found in source/Stream/Filters/SkipEmptyLinesFilter.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

          Avoid variables with short names like $in. Configured minimum length is 3.
          Open

              public function filter($in, $out, &$consumed, $closing) {
          Severity: Minor
          Found in source/Stream/Filters/SkipDirectivesWithInvalidValuesFilter.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

          Avoid variables with short names like $a. Configured minimum length is 3.
          Open

                              usort($value, function ($a, $b) {
          Severity: Minor
          Found in source/RobotsTxtParser.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

          Severity
          Category
          Status
          Source
          Language