Queue - Code Metrics - Inspection of "[WIP] Version 3" - traderinteractive/mongo-queue-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#60)

by Chad

created 2018-03-04 22:23 UTC

Queue C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	466
Duplicated Lines	3 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
wmc	65
lcom	1
cbo	3
dl	14
loc	466
rs	5.7894
c	0
b	0
f	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	3

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Queue often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Queue, and based on these observations, apply Extract Interface, too.

<?php
/**
 * Defines the TraderInteractive\Mongo\Queue class.
 */

namespace TraderInteractive\Mongo;

use MongoDB\BSON\UTCDateTime;
use MongoDB\Client;

/**
 * Abstraction of mongo db collection as priority queue.
 *
 * Tied priorities are ordered by time. So you may use a single priority for normal queuing (default args exist for
 * this purpose).  Using a random priority achieves random get()
 */
final class Queue extends AbstractQueue implements QueueInterface
{
    /**
     * Construct queue.
     *
     * @param \MongoDB\Collection|string $collectionOrUrl A MongoCollection instance or the mongo connection url.
     * @param string $db the mongo db name
     * @param string $collection the collection name to use for the queue
     *
     * @throws \InvalidArgumentException $collectionOrUrl, $db or $collection was not a string
     */
    public function __construct($collectionOrUrl, string $db = null, string $collection = null)
    {
        if ($collectionOrUrl instanceof \MongoDB\Collection) {
            $this->collection = $collectionOrUrl;
            return;
        }

        if (!is_string($collectionOrUrl)) {
            throw new \InvalidArgumentException('$collectionOrUrl was not a string');
        }

        $this->collection = (new Client($collectionOrUrl))->selectDatabase($db)->selectCollection($collection);
    }
}


1			<?php
2			/**
3			* Defines the TraderInteractive\Mongo\Queue class.
4			*/
5
6			namespace TraderInteractive\Mongo;
7
8			use MongoDB\BSON\UTCDateTime;
9			use MongoDB\Client;
10
11			/**
12			* Abstraction of mongo db collection as priority queue.
13			*
14			* Tied priorities are ordered by time. So you may use a single priority for normal queuing (default args exist for
15			* this purpose). Using a random priority achieves random get()
16			*/
17			final class Queue extends AbstractQueue implements QueueInterface
18			{
19			/**
20			* Construct queue.
21			*
22			* @param \MongoDB\Collection\|string $collectionOrUrl A MongoCollection instance or the mongo connection url.
23			* @param string $db the mongo db name
24			* @param string $collection the collection name to use for the queue
25			*
26			* @throws \InvalidArgumentException $collectionOrUrl, $db or $collection was not a string
27			*/
28			public function __construct($collectionOrUrl, string $db = null, string $collection = null)
29			{
30			if ($collectionOrUrl instanceof \MongoDB\Collection) {
31			$this->collection = $collectionOrUrl;
32			return;
33			}
34
35			if (!is_string($collectionOrUrl)) {
36			throw new \InvalidArgumentException('$collectionOrUrl was not a string');
37			}
38
39			$this->collection = (new Client($collectionOrUrl))->selectDatabase($db)->selectCollection($collection);
40			}
41			}
42

traderinteractive / mongo-queue-php