ExplainQueryService - Code Metrics - Inspection of "wip 2" - facile-it/mongodb-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — 1707_add_explain_command (4124c6)

by Alessandro

created 2017-08-29 13:56 UTC

ExplainQueryService A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	146
Duplicated Lines	4.11 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	21
lcom	1
cbo	3
dl	6
loc	146
ccs	0
cts	83
cp	0
rs	10
c	0
b	0
f	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	execute()	0	13	2
D	createCommand()	0	33	10
A	getCountArgs()	3	12	3
A	getFindArgs()	3	13	3
A	getDistinctArgs()	0	7	1
A	getDeleteArgs()	0	9	1

How to fix Duplicated Code

<?php

namespace Facile\MongoDbBundle\Services;

use Facile\MongoDbBundle\Models\Query;
use MongoDB\Driver\Command;
use MongoDB\Driver\Cursor;

class ExplainQueryService
{
    const VERBOSITY_QUERY_PLANNER = 'queryPlanner';
    const VERBOSITY_EXECUTION_STATS = 'executionStats';
    const VERBOSITY_ALL_PLAN_EXECUTION = 'allPlansExecution';

    public static $acceptedMethods= [
        'count',
        'distinct',
        'find',
        'findOne',
        'findOneAndUpdate',
        'findOneAndDelete',
        'deleteOne',
        'deleteMany',
        'aggregate',
    ];

    /** @var ClientRegistry */
    private $clientRegistry;

    /**
     * Constructs a explain command.
     *
     * Supported options:
     * verbosity : queryPlanner | executionStats Mode | allPlansExecution (default)
     * The explain command provides information on the execution of the following commands:
     * count, distinct, group, find, findAndModify, delete, and update.
     *
     * @param ClientRegistry $clientRegistry
     */
    public function __construct(ClientRegistry $clientRegistry)
    {

        $this->clientRegistry = $clientRegistry;
    }

    /**
     * Execute the operation.
     *
     * @param Query  $query
     * @param string $verbosity
     *
     * @return Cursor
     */
    public function execute(Query $query, string $verbosity = self::VERBOSITY_ALL_PLAN_EXECUTION): Cursor
    {
        if (!in_array($query->getMethod(), self::$acceptedMethods)) {
            throw new \InvalidArgumentException(
                'Cannot explain the method \''.$query->getMethod().'\'. Allowed methods: '. implode(', ',self::$acceptedMethods)
            );
        };

        $manager = $this->clientRegistry->getClient($query->getClient())->getManager();

        return $manager
            ->executeCommand($query->getDatabase(), $this->createCommand($query, $verbosity));
    }

    /**
     * Create the explain command.
     *
     * @param Query  $query
     * @param string $verbosity
     *
     * @return Command
     */
    private function createCommand(Query $query, string $verbosity)
    {
        $args = [
            $query->getMethod() => $query->getCollection(),
        ];
        switch($query->getMethod()) {
            case 'count':
                $args +=  $this->getCountArgs($query);break;
switch ($expr) {
     case "A":
         doSomething();
         break; //wrong
     case "B":
         doSomething();
         break; //right
     case "C:":
         doSomething();
         return true; //right
 }
            case 'find':
            case 'findOne':
            case 'findOneAndUpdate':
            case 'findOneAndDelete':
                $args =  $this->getFindArgs($query);break;
switch ($expr) {
     case "A":
         doSomething();
         break; //wrong
     case "B":
         doSomething();
         break; //right
     case "C:":
         doSomething();
         return true; //right
 }
            case 'distinct':
                $args +=  $this->getDistinctArgs($query);break;
switch ($expr) {
     case "A":
         doSomething();
         break; //wrong
     case "B":
         doSomething();
         break; //right
     case "C:":
         doSomething();
         return true; //right
 }
            case 'deleteOne':
            case 'deleteMany':
                $args =  $this->getDeleteArgs($query);break;
switch ($expr) {
     case "A":
         doSomething();
         break; //wrong
     case "B":
         doSomething();
         break; //right
     case "C:":
         doSomething();
         return true; //right
 }
            case 'aggregate':
                return new Command([
                    'aggregate' => $query->getCollection(),
                    'pipeline' => $query->getData(),
                    'explain' => true,
                ]);
        }

        $cmd = [
            'explain' => $args,
            'verbosity' => $verbosity,
        ];

        return new Command($cmd);
    }

    private function getCountArgs(Query $query)
    {
        $args = [
            'query' => $query->getFilters(),
        ];

        foreach (['limit', 'hint', 'skip'] as $supportedOption) {

            $args += (isset($query->getOptions()[$supportedOption]) ? [$supportedOption => $query->getOptions()[$supportedOption]] : []);
        }

        return $args;
    }

    private function getFindArgs(Query $query)
    {
        $args = [
            'find' => $query->getCollection(),
            'filter' => $query->getFilters(),
        ];

        foreach (['sort', 'projection', 'hint', 'skip', 'limit'] as $supportedOption) {

            $args += (isset($query->getOptions()[$supportedOption]) ? [$supportedOption => $query->getOptions()[$supportedOption]] : []);
        }

        return $args;
    }

    private function getDistinctArgs(Query $query)
    {
        return [
            'key' => $query->getData()['fieldName'],
            'query' => $query->getFilters(),
        ];
    }

    private function getDeleteArgs(Query $query)
    {
        return [
            'delete' => $query->getCollection(),
            'deletes' => [
                ['q' => $query->getFilters(), 'limit' => $query->getOptions()['limit'] ?? 0,]
            ]
        ];
    }
}


1		<?php
2
3		namespace Facile\MongoDbBundle\Services;
4
5		use Facile\MongoDbBundle\Models\Query;
6		use MongoDB\Driver\Command;
7		use MongoDB\Driver\Cursor;
8
9		class ExplainQueryService
10		{
11		const VERBOSITY_QUERY_PLANNER = 'queryPlanner';
12		const VERBOSITY_EXECUTION_STATS = 'executionStats';
13		const VERBOSITY_ALL_PLAN_EXECUTION = 'allPlansExecution';
14
15		public static $acceptedMethods= [
16		'count',
17		'distinct',
18		'find',
19		'findOne',
20		'findOneAndUpdate',
21		'findOneAndDelete',
22		'deleteOne',
23		'deleteMany',
24		'aggregate',
25		];
26
27		/** @var ClientRegistry */
28		private $clientRegistry;
29
30		/**
31		* Constructs a explain command.
32		*
33		* Supported options:
34		* verbosity : queryPlanner \| executionStats Mode \| allPlansExecution (default)
35		* The explain command provides information on the execution of the following commands:
36		* count, distinct, group, find, findAndModify, delete, and update.
37		*
38		* @param ClientRegistry $clientRegistry
39		*/
40		public function __construct(ClientRegistry $clientRegistry)
41		{
42
43		$this->clientRegistry = $clientRegistry;
44		}
45
46		/**
47		* Execute the operation.
48		*
49		* @param Query $query
50		* @param string $verbosity
51		*
52		* @return Cursor
53		*/
54		public function execute(Query $query, string $verbosity = self::VERBOSITY_ALL_PLAN_EXECUTION): Cursor
55		{
56		if (!in_array($query->getMethod(), self::$acceptedMethods)) {
57		throw new \InvalidArgumentException(
58		'Cannot explain the method \''.$query->getMethod().'\'. Allowed methods: '. implode(', ',self::$acceptedMethods)
59		);
60		};
61
62		$manager = $this->clientRegistry->getClient($query->getClient())->getManager();
63
64		return $manager
65		->executeCommand($query->getDatabase(), $this->createCommand($query, $verbosity));
66		}
67
68		/**
69		* Create the explain command.
70		*
71		* @param Query $query
72		* @param string $verbosity
73		*
74		* @return Command
75		*/
76		private function createCommand(Query $query, string $verbosity)
77		{
78		$args = [
79		$query->getMethod() => $query->getCollection(),
80		];
81		switch($query->getMethod()) {
82		case 'count':
83		$args += $this->getCountArgs($query);break;
		0 ignored issues – show Coding Style introduced 2017-08-29 13:58 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
84		case 'find':
85		case 'findOne':
86		case 'findOneAndUpdate':
87		case 'findOneAndDelete':
88		$args = $this->getFindArgs($query);break;
		0 ignored issues – show Coding Style introduced 2017-08-29 13:58 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
89		case 'distinct':
90		$args += $this->getDistinctArgs($query);break;
		0 ignored issues – show Coding Style introduced 2017-08-29 13:58 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
91		case 'deleteOne':
92		case 'deleteMany':
93		$args = $this->getDeleteArgs($query);break;
		0 ignored issues – show Coding Style introduced 2017-08-29 13:58 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
94		case 'aggregate':
95		return new Command([
96		'aggregate' => $query->getCollection(),
97		'pipeline' => $query->getData(),
98		'explain' => true,
99		]);
100		}
101
102		$cmd = [
103		'explain' => $args,
104		'verbosity' => $verbosity,
105		];
106
107		return new Command($cmd);
108		}
109
110		private function getCountArgs(Query $query)
111		{
112		$args = [
113		'query' => $query->getFilters(),
114		];
115
116	View Code Duplication	foreach (['limit', 'hint', 'skip'] as $supportedOption) {
		0 ignored issues – show Duplication introduced 2017-08-29 13:58 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
117		$args += (isset($query->getOptions()[$supportedOption]) ? [$supportedOption => $query->getOptions()[$supportedOption]] : []);
118		}
119
120		return $args;
121		}
122
123		private function getFindArgs(Query $query)
124		{
125		$args = [
126		'find' => $query->getCollection(),
127		'filter' => $query->getFilters(),
128		];
129
130	View Code Duplication	foreach (['sort', 'projection', 'hint', 'skip', 'limit'] as $supportedOption) {
		0 ignored issues – show Duplication introduced 2017-08-29 13:58 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
131		$args += (isset($query->getOptions()[$supportedOption]) ? [$supportedOption => $query->getOptions()[$supportedOption]] : []);
132		}
133
134		return $args;
135		}
136
137		private function getDistinctArgs(Query $query)
138		{
139		return [
140		'key' => $query->getData()['fieldName'],
141		'query' => $query->getFilters(),
142		];
143		}
144
145		private function getDeleteArgs(Query $query)
146		{
147		return [
148		'delete' => $query->getCollection(),
149		'deletes' => [
150		['q' => $query->getFilters(), 'limit' => $query->getOptions()['limit'] ?? 0,]
151		]
152		];
153		}
154		}
155

facile-it / mongodb-bundle

Branch — 1707_add_explain_command (4124c6)

ExplainQueryService A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

7 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like