Sign upLogin

BookStackApp/BookStack

View on GitHub
Star
app/Search/SearchRunner.php

Summary

Maintainability
D
2 days
Test Coverage

File SearchRunner.php has 328 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace BookStack\Search;

use BookStack\Entities\EntityProvider;
Severity: Minor
Found in app/Search/SearchRunner.php - About 3 hrs to fix

    SearchRunner has 28 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class SearchRunner
{
    /**
     * Retain a cache of score adjusted terms for specific search options.
     */
    Severity: Minor
    Found in app/Search/SearchRunner.php - About 3 hrs to fix

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

          public function searchEntities(SearchOptions $searchOpts, string $entityType = 'all', int $page = 1, int $count = 20): array
    {
        $entityTypes = array_keys($this->entityProvider->all());
        $entityTypesToSearch = $entityTypes;
      Severity: Minor
      Found in app/Search/SearchRunner.php - About 1 hr to fix

        Function applyTagSearch has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

            protected function applyTagSearch(EloquentBuilder $query, TagSearchOption $option): void
    {
        $filter = function (EloquentBuilder $query) use ($option): void {
            $tagParts = $option->getParts();
            if (empty($tagParts['operator']) || empty($tagParts['value'])) {
        Severity: Minor
        Found in app/Search/SearchRunner.php - About 55 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

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

            public function searchEntities(SearchOptions $searchOpts, string $entityType = 'all', int $page = 1, int $count = 20): array
    {
        $entityTypes = array_keys($this->entityProvider->all());
        $entityTypesToSearch = $entityTypes;
        Severity: Minor
        Found in app/Search/SearchRunner.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

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

            protected function applyNegatableWhere(EloquentBuilder $query, bool $negated, string $column, string $operator, mixed $value): void
        Severity: Minor
        Found in app/Search/SearchRunner.php - About 35 mins to fix

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

              protected function filterUpdatedBy(EloquentBuilder $query, Entity $model, string $input, bool $negated)
    {
        $userSlug = $input === 'me' ? user()->slug : trim($input);
        $user = User::query()->where('slug', '=', $userSlug)->first(['id']);
        if ($user) {
          Severity: Major
          Found in app/Search/SearchRunner.php and 2 other locations - About 1 hr to fix
          app/Search/SearchRunner.php on lines 377..384
          app/Search/SearchRunner.php on lines 395..402

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

          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

              protected function filterCreatedBy(EloquentBuilder $query, Entity $model, string $input, bool $negated)
    {
        $userSlug = $input === 'me' ? user()->slug : trim($input);
        $user = User::query()->where('slug', '=', $userSlug)->first(['id']);
        if ($user) {
          Severity: Major
          Found in app/Search/SearchRunner.php and 2 other locations - About 1 hr to fix
          app/Search/SearchRunner.php on lines 386..393
          app/Search/SearchRunner.php on lines 395..402

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

          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

              protected function filterOwnedBy(EloquentBuilder $query, Entity $model, string $input, bool $negated)
    {
        $userSlug = $input === 'me' ? user()->slug : trim($input);
        $user = User::query()->where('slug', '=', $userSlug)->first(['id']);
        if ($user) {
          Severity: Major
          Found in app/Search/SearchRunner.php and 2 other locations - About 1 hr to fix
          app/Search/SearchRunner.php on lines 377..384
          app/Search/SearchRunner.php on lines 386..393

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

          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