Sign upLogin

b1tc0re/sitemap

View on GitHub
Star

Showing 7 of 7 total issues

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

    protected function normalizeFilePath($path)
    {
        $parts = explode('/', $path);
        $name = array_pop($parts);
        $partsName = explode('.', $name);
Severity: Major
Found in src/Sitemap.php and 1 other location - About 4 hrs to fix
src/Index.php on lines 150..173

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

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

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

    protected function normalizeFilePath($path)
    {
        $parts = explode('/', $path);
        $name = array_pop($parts);
        $partsName = explode('.', $name);
Severity: Major
Found in src/Index.php and 1 other location - About 4 hrs to fix
src/Sitemap.php on lines 348..371

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

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 fillCollection has a Cognitive Complexity of 26 (exceeds 5 allowed). Consider refactoring.
Open

    protected function fillCollection(string $path)
    {
        $content = file_get_contents($path);

        if (true === $this->useGzipCompress && $gzcontent = gzinflate(substr($content, 10, -8))) {
Severity: Minor
Found in src/Sitemap.php - About 3 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 write has 46 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function write()
    {
        $collections = $this->collection->chunk($this->maxUrls, $chunks);

        $chunks > 1 && $indexMap = new Index($this->getFilePath(), $this->useGzipCompress);
Severity: Minor
Found in src/Sitemap.php - About 1 hr to fix

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

        public function write()
    {
        $collections = $this->collection->chunk($this->maxUrls, $chunks);

        $chunks > 1 && $indexMap = new Index($this->getFilePath(), $this->useGzipCompress);
    Severity: Minor
    Found in src/Sitemap.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 fillCollection has 31 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        protected function fillCollection(string $path)
    {
        $content = file_get_contents($path);

        if (true === $this->useGzipCompress && $gzcontent = gzinflate(substr($content, 10, -8))) {
    Severity: Minor
    Found in src/Sitemap.php - About 1 hr to fix

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

          protected function fillCollection()
    {
        $content = file_get_contents($this->getFilePath());

        if (true === $this->useGzipCompress && $gzcontent = gzinflate(substr($content, 10, -8))) {
      Severity: Minor
      Found in src/Index.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

      Severity
      Category
      Status
      Source
      Language