Sync::handle() - Code Metrics - Inspection of "Changed namespace path to leopard." - triadev/Leopard - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (8cb5b2)

by Christopher

created 2018-12-17 13:11 UTC

Sync::handle() A

↳ Parent: Sync

Complexity

Conditions	4
Paths	3

Size

Total Lines	18
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	4

Importance

Changes

Metric	Value
cc	4
eloc	10
nc	3
nop	0
dl	0
loc	18
ccs	10
cts	10
cp	1
crap	4
rs	9.9332
c	0
b	0
f	0

<?php

Coding Style introduced 2018-12-17 12:25 UTC by

The PHP open tag does not have a corresponding PHP close tag

namespace Triadev\Leopard\Console\Commands\Index;

Coding Style introduced 2018-12-17 12:25 UTC by

Missing file doc comment

use Illuminate\Console\Command;

use Illuminate\Database\Eloquent\Model;

use Illuminate\Support\Collection;

use Triadev\Leopard\Business\Helper\IsModelSearchable;

use Triadev\Leopard\Facade\Leopard;

use Triadev\Leopard\Searchable;

class Sync extends Command

Coding Style Documentation introduced 2018-12-17 12:25 UTC by

Missing class doc comment

Coding Style introduced 2018-12-17 12:25 UTC by

Opening brace should be on the same line as the declaration for class Sync

    use IsModelSearchable;

/**

     * The console command name.

     * @var string

*/

    protected $signature = 'triadev:index:sync {--index=}';

Coding Style introduced 2018-12-17 12:25 UTC by

Protected member variable "signature" must contain a leading underscore

/**

     * The console command description.

     * @var string

*/

    protected $description = 'Sync the elasticsearch index with persist data.';

Coding Style introduced 2018-12-17 12:25 UTC by

Protected member variable "description" must contain a leading underscore

/**

     * Execute the console command.

*/

Coding Style introduced 2018-12-17 12:25 UTC by

Missing @return tag in function comment

    public function handle()

Coding Style introduced 2018-12-17 12:25 UTC by

Expected 2 blank lines before function; 1 found

        $index = $this->option('index') ?: Leopard::getEsDefaultIndex();

Coding Style introduced 2018-12-17 12:25 UTC by

The value of a comparison must not be assigned to a variable

Coding Style introduced 2018-12-17 12:25 UTC by

Inline IF statements are not allowed

        if (!Leopard::getEsClient()->indices()->exists(['index' => $index])) {

Coding Style introduced 2018-12-17 12:25 UTC by

There must be a single space after a NOT operator; 0 found

            $this->error(sprintf("The index does not exist: %s", $index));

Coding Style Comprehensibility introduced 2018-12-17 12:25 UTC by

The string literal The index does not exist: %s does not require double quotes, as per coding-style, please use single quotes.

            return;

        $chunkSize = $this->getChunkSize();

        foreach ($this->getModelsToSync($index) as $modelClass => $model) {

            $this->line(sprintf("Sync index with model: %s", $modelClass));

Coding Style Comprehensibility introduced 2018-12-17 12:25 UTC by

The string literal Sync index with model: %s does not require double quotes, as per coding-style, please use single quotes.

            $model::chunk($chunkSize, function ($models) {

1 ignored issue

– show

                /** @var Collection $models */

Coding Style introduced 2018-12-17 12:25 UTC by

Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead

Coding Style introduced 2018-12-17 12:25 UTC by

Block comments must be started with /*

Coding Style introduced 2018-12-17 12:25 UTC by

The open comment tag must be the only content on the line

Coding Style introduced 2018-12-17 12:25 UTC by

Missing short description in doc comment

Coding Style introduced 2018-12-17 12:25 UTC by

The close comment tag must be the only content on the line

                Leopard::repository()->bulkSave($models);

                $this->line(sprintf("Indexing a chunk of %s documents ...", count($models)));

Coding Style Comprehensibility introduced 2018-12-17 12:25 UTC by

The string literal Indexing a chunk of %s documents ... does not require double quotes, as per coding-style, please use single quotes.

});

Coding Style introduced 2018-12-17 12:25 UTC by

For multi-line function calls, the closing parenthesis should be on a new line.

Coding Style introduced 2018-12-17 12:25 UTC by

Expected 2 blank lines after function; 1 found

Coding Style introduced 2018-12-17 12:25 UTC by

Expected 1 blank line before closing function brace; 0 found

Coding Style introduced 2018-12-17 12:25 UTC by

Expected //end handle()

/**

Coding Style introduced 2018-12-17 12:25 UTC by

Missing short description in doc comment

     * @return int

Coding Style introduced 2018-12-17 12:25 UTC by

Expected "integer" but found "int" for function return type

*/

    private function getChunkSize() : int

Coding Style introduced 2018-12-17 12:41 UTC by

Private method name "Sync::getChunkSize" must be prefixed with an underscore

        return config('leopard.sync.chunkSize');

Coding Style introduced 2018-12-17 12:41 UTC by

Expected 2 blank lines after function; 1 found

Coding Style introduced 2018-12-17 12:41 UTC by

Expected 1 blank line before closing function brace; 0 found

Coding Style introduced 2018-12-17 12:41 UTC by

Expected //end getChunkSize()

/**

Coding Style introduced 2018-12-17 12:41 UTC by

Missing short description in doc comment

     * @param string $index

Coding Style introduced 2018-12-17 12:25 UTC by

Missing parameter comment

     * @return Model|Searchable[]

*/

    private function getModelsToSync(string $index) : array

Coding Style introduced 2018-12-17 12:25 UTC by

Private method name "Sync::getModelsToSync" must be prefixed with an underscore

        $models = [];

        foreach (config(sprintf("leopard.sync.models.%s", $index), []) as $modelClass) {

Coding Style Comprehensibility introduced 2018-12-17 12:41 UTC by

The string literal leopard.sync.models.%s does not require double quotes, as per coding-style, please use single quotes.

            /** @var Model|Searchable $model */

Coding Style introduced 2018-12-17 12:25 UTC by

Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead

Coding Style introduced 2018-12-17 12:25 UTC by

Block comments must be started with /*

Coding Style introduced 2018-12-17 12:25 UTC by

The open comment tag must be the only content on the line

Coding Style introduced 2018-12-17 12:25 UTC by

Missing short description in doc comment

Coding Style introduced 2018-12-17 12:25 UTC by

The close comment tag must be the only content on the line

            $model = new $modelClass();

            $this->isModelSearchable($model);

Bug introduced 2018-12-17 12:41 UTC by

It seems like $model can also be of type Triadev\Leopard\Searchable; however, parameter $model of Triadev\Leopard\Console\...nc::isModelSearchable() does only seem to accept Illuminate\Database\Eloquent\Model, maybe add an additional type check? ( Ignorable by Annotation )

            $models[$modelClass] = $model;

        return $models;

Coding Style introduced 2018-12-17 12:25 UTC by

Expected 2 blank lines after function; 0 found

Coding Style introduced 2018-12-17 12:25 UTC by

Expected 1 blank line before closing function brace; 0 found

Coding Style introduced 2018-12-17 12:25 UTC by

Expected //end getModelsToSync()

Coding Style introduced 2018-12-17 12:25 UTC by

Expected //end class

Coding Style introduced 2018-12-17 12:25 UTC by

As per coding style, files should not end with a newline character.

triadev / Leopard

Branch — master (8cb5b2)

Sync::handle() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like