bnomei/kirby3-boost

View on GitHub

Showing 30 of 30 total issues

Function findByID has a Cognitive Complexity of 73 (exceeds 5 allowed). Consider refactoring.
Open

    public function findByID(string $id, bool $cache = true, bool $extend = true): ?Page
    {

        $page = $this->lookup($id, $cache);
        if ($page) {
Severity: Minor
Found in classes/Bolt.php - About 1 day 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 boost has a Cognitive Complexity of 29 (exceeds 5 allowed). Consider refactoring.
Open

    function boost($id)
    {
        if (! $id || ! option('bnomei.boost.helper')) {
            return null;
        }
Severity: Minor
Found in index.php - About 4 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

File index.php has 326 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

use Bnomei\Bolt;
use Bnomei\BoostCache;
use Bnomei\BoostDirInventory;
Severity: Minor
Found in index.php - About 3 hrs to fix

    Method findByID has 95 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function findByID(string $id, bool $cache = true, bool $extend = true): ?Page
        {
    
            $page = $this->lookup($id, $cache);
            if ($page) {
    Severity: Major
    Found in classes/Bolt.php - About 3 hrs to fix

      Function find has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
      Open

          public function find(string $uuid, bool $throwException = true): ?Page
          {
              $uuid = str_replace('page://', '', trim($uuid));
              $diruri = $this->diruri($uuid);
      
      
      Severity: Minor
      Found in classes/BoostIndex.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

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

          public function index(bool $force = false, ?Page $target = null): int
          {
      
              $count = $this->index ? count($this->index) : 0;
              if ($count > 0 && ! $force) {
      Severity: Minor
      Found in classes/BoostIndex.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 modified has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
      Open

          public static function modified($model): ?int
          {
              if ($model instanceof \Kirby\Cms\Page ||
                  $model instanceof \Kirby\Cms\File ||
                  $model instanceof \Kirby\Cms\User) {
      Severity: Minor
      Found in classes/BoostCache.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 run has 36 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public static function run(array $caches = [], int $seconds = 1, $count = 1000, $contentLength = 128, $writeRatio = 0.1): array
          {
              $caches = $caches ?? [BoostCache::file()];
      
              $benchmarks = [];
      Severity: Minor
      Found in classes/CacheBenchmark.php - About 1 hr to fix

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

            function boost($id)
            {
                if (! $id || ! option('bnomei.boost.helper')) {
                    return null;
                }
        Severity: Minor
        Found in index.php - About 1 hr to fix

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

              private static function benchmark($cache, int $seconds = 1, $count = 1000, $contentLength = 128, $writeRatio = 0.1): array
              {
                  if (is_callable([$cache, 'beginTransaction'])) {
                      $cache->beginTransaction();
                  }
          Severity: Minor
          Found in classes/CacheBenchmark.php - About 1 hr to fix

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

                private static function benchmark($cache, int $seconds = 1, $count = 1000, $contentLength = 128, $writeRatio = 0.1): array
                {
                    if (is_callable([$cache, 'beginTransaction'])) {
                        $cache->beginTransaction();
                    }
            Severity: Minor
            Found in classes/CacheBenchmark.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 patchDirClass has 31 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                public static function patchDirClass(): void
                {
                    $reflection = new ReflectionClass(Dir::class);
                    $file = $reflection->getFileName();
            
            
            Severity: Minor
            Found in classes/BoostDirInventory.php - About 1 hr to fix

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

                  public function lookup(string $id, bool $cache = true): ?Page
                  {
                      $lookup = A::get(self::$idToPage, $id);
              
                      // in case the page was deleted/moved
              Severity: Minor
              Found in classes/Bolt.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 modified has 27 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  public static function modified($model): ?int
                  {
                      if ($model instanceof \Kirby\Cms\Page ||
                          $model instanceof \Kirby\Cms\File ||
                          $model instanceof \Kirby\Cms\User) {
              Severity: Minor
              Found in classes/BoostCache.php - About 1 hr to fix

                Method load has 27 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                    public static function load(): ?Kirby\Cms\Pages
                    {
                        // if cached then return that
                        if (static::$cache) {
                            return static::$cache;
                Severity: Minor
                Found in collections/example_static_cached_collection.php - About 1 hr to fix

                  Method find has 26 lines of code (exceeds 25 allowed). Consider refactoring.
                  Open

                      public function find(string $uuid, bool $throwException = true): ?Page
                      {
                          $uuid = str_replace('page://', '', trim($uuid));
                          $diruri = $this->diruri($uuid);
                  
                  
                  Severity: Minor
                  Found in classes/BoostIndex.php - About 1 hr to fix

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

                            'boost' => function () {
                                $time = -microtime(true);
                                $count = 0;
                                BoostCache::beginTransaction();
                                foreach ($this as $page) {
                    Severity: Minor
                    Found in index.php and 1 other location - About 55 mins to fix
                    index.php on lines 207..217

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

                    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

                            'unboost' => function () {
                                $time = -microtime(true);
                                $count = 0;
                                BoostCache::beginTransaction();
                                foreach ($this as $page) {
                    Severity: Minor
                    Found in index.php and 1 other location - About 55 mins to fix
                    index.php on lines 196..206

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

                    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

                    Method benchmark has 5 arguments (exceeds 4 allowed). Consider refactoring.
                    Open

                        private static function benchmark($cache, int $seconds = 1, $count = 1000, $contentLength = 128, $writeRatio = 0.1): array
                    Severity: Minor
                    Found in classes/CacheBenchmark.php - About 35 mins to fix

                      Method run has 5 arguments (exceeds 4 allowed). Consider refactoring.
                      Open

                          public static function run(array $caches = [], int $seconds = 1, $count = 1000, $contentLength = 128, $writeRatio = 0.1): array
                      Severity: Minor
                      Found in classes/CacheBenchmark.php - About 35 mins to fix
                        Severity
                        Category
                        Status
                        Source
                        Language