AbstractCursor - Code Metrics - alcaeus/mongo-php-adapter - Measure and Improve Code Quality continuously with Scrutinizer

AbstractCursor A
last analyzed 2020-09-22 11:40 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	396
Duplicated Lines	2.78 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

85.71%

Importance

Changes

Metric	Value
dl	11
loc	396
ccs	96
cts	112
cp	0.8571
rs	9.52
c	0
b	0
f	0
wmc	36
lcom	1
cbo	7

22 Methods

Rating	Name	Duplication	Size	Complexity
	ensureCursor()	0	1	?
	getCursorInfo()	0	1	?
A	__construct()	0	15	2
A	current()	0	4	1
A	key()	0	4	1
A	next()	11	16	3
A	rewind()	0	9	1
A	valid()	0	4	1
A	batchSize()	0	6	1
A	dead()	0	4	1
A	info()	0	4	1
A	setReadPreference()	0	6	1
A	timeout()	0	5	1
A	getOptions()	0	21	5
A	ensureIterator()	0	9	2
A	wrapTraversable()	0	4	1
A	errorIfOpened()	0	8	2
B	getIterationInfo()	0	38	6
A	notImplemented()	0	4	1
A	reset()	0	8	1
A	__sleep()	0	4	1
A	storeIteratorState()	0	19	3

How to fix Duplicated Code

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

namespace Alcaeus\MongoDbAdapter;

use Alcaeus\MongoDbAdapter\Helper\ReadPreference;
use MongoDB\Collection;
use MongoDB\Driver\Cursor;

/**
 * @internal
 */
abstract class AbstractCursor
{
    use ReadPreference;

    /**
     * @var int|null
     */
    protected $batchSize = null;

    /**
     * @var Collection
     */
    protected $collection;

    /**
     * @var \MongoClient
     */
    protected $connection;

    /**
     * @var Cursor
     */
    protected $cursor;

    /**
     * @var \MongoDB\Database
     */
    protected $db;

    /**
     * @var CursorIterator
     */
    protected $iterator;

    /**
     * @var string
     */
    protected $ns;

    /**
     * @var bool
     */
    protected $startedIterating = false;

    /**
     * @var bool
     */
    protected $cursorNeedsAdvancing = true;

    /**
     * @var mixed
     */
    private $current = null;

    /**
     * @var mixed
     */
    private $key = null;

    /**
     * @var mixed
     */
    private $valid = false;

    /**
     * @var int
     */
    protected $position = 0;

    /**
     * @var array
     */
    protected $optionNames = [
        'batchSize',
        'readPreference',
    ];

    /**
     * @return Cursor
     */
    abstract protected function ensureCursor();

    /**
     * @return array
     */
    abstract protected function getCursorInfo();

    /**
     * Create a new cursor
     * @link http://www.php.net/manual/en/mongocursor.construct.php
     * @param \MongoClient $connection Database connection.
     * @param string $ns Full name of database and collection.
     */
    public function __construct(\MongoClient $connection, $ns)
    {
        $this->connection = $connection;
        $this->ns = $ns;

        $nsParts = explode('.', $ns);
        $dbName = array_shift($nsParts);
        $collectionName = implode('.', $nsParts);

        $this->db = $connection->selectDB($dbName)->getDb();

        if ($collectionName) {
            $this->collection = $connection->selectCollection($dbName, $collectionName)->getCollection();
        }
    }

    /**
     * Returns the current element
     * @link http://www.php.net/manual/en/mongocursor.current.php
     * @return array
     */
    public function current()
    {
        return $this->current;
    }

    /**
     * Returns the current result's _id
     * @link http://www.php.net/manual/en/mongocursor.key.php
     * @return string The current result's _id as a string.
     */
    public function key()
    {
        return $this->key;
    }

    /**
     * Advances the cursor to the next result, and returns that result
     * @link http://www.php.net/manual/en/mongocursor.next.php
     * @throws \MongoConnectionException
     * @throws \MongoCursorTimeoutException
     * @return array Returns the next object
     */
    public function next()
    {
        if (! $this->startedIterating) {

            $this->ensureIterator();
            $this->startedIterating = true;
        } else {
            if ($this->cursorNeedsAdvancing) {
                $this->ensureIterator()->next();
            }

            $this->cursorNeedsAdvancing = true;
            $this->position++;
        }

        return $this->storeIteratorState();
    }

    /**
     * Returns the cursor to the beginning of the result set
     * @throws \MongoConnectionException
     * @throws \MongoCursorTimeoutException
     * @return void
     */
    public function rewind()
    {
        // We can recreate the cursor to allow it to be rewound
        $this->reset();
        $this->startedIterating = true;
        $this->position = 0;
        $this->ensureIterator()->rewind();
        $this->storeIteratorState();
    }

    /**
     * Checks if the cursor is reading a valid result.
     * @link http://www.php.net/manual/en/mongocursor.valid.php
     * @return boolean If the current result is not null.
     */
    public function valid()
    {
        return $this->valid;
    }

    /**
     * Limits the number of elements returned in one batch.
     *
     * @link http://docs.php.net/manual/en/mongocursor.batchsize.php
     * @param int|null $batchSize The number of results to return per batch
     * @return $this Returns this cursor.
     */
    public function batchSize($batchSize)
    {
        $this->batchSize = $batchSize;

        return $this;
    }

    /**
     * Checks if there are documents that have not been sent yet from the database for this cursor
     * @link http://www.php.net/manual/en/mongocursor.dead.php
     * @return boolean Returns if there are more results that have not been sent to the client, yet.
     */
    public function dead()
    {
        return $this->ensureCursor()->isDead();
    }

    /**
     * @return array
     */
    public function info()
    {
        return $this->getCursorInfo() + $this->getIterationInfo();
    }

    /**
     * @link http://www.php.net/manual/en/mongocursor.setreadpreference.php
     * @param string $readPreference
     * @param array $tags
     * @return $this Returns this cursor.
     */
    public function setReadPreference($readPreference, $tags = null)
    {
        $this->setReadPreferenceFromParameters($readPreference, $tags);

        return $this;
    }

    /**
     * Sets a client-side timeout for this query
     * @link http://www.php.net/manual/en/mongocursor.timeout.php
     * @param int $ms The number of milliseconds for the cursor to wait for a response. By default, the cursor will wait forever.
     * @return $this Returns this cursor
     */
    public function timeout($ms)

    {
        trigger_error('The ' . __METHOD__ . ' method is not implemented in mongo-php-adapter', E_USER_WARNING);
        return $this;
    }

    /**
     * Applies all options set on the cursor, overwriting any options that have already been set
     *
     * @param array $optionNames Array of option names to be applied (will be read from properties)
     * @return array
     */
    protected function getOptions($optionNames = null)
    {
        $options = [];

        if ($optionNames === null) {
            $optionNames = $this->optionNames;
        }

        foreach ($optionNames as $option) {
            $converter = 'convert' . ucfirst($option);
            $value = method_exists($this, $converter) ? $this->$converter() : $this->$option;

            if ($value === null) {
                continue;
            }

            $options[$option] = $value;
        }

        return $options;
    }

    /**
     * @return \Iterator
     */
    protected function ensureIterator()
    {
        if ($this->iterator === null) {
            $this->iterator = $this->wrapTraversable($this->ensureCursor());
            $this->iterator->rewind();
        }

        return $this->iterator;
    }

    /**
     * @param \Traversable $traversable
     * @return CursorIterator
     */
    protected function wrapTraversable(\Traversable $traversable)
    {
        return new CursorIterator($traversable);
    }

    /**
     * @throws \MongoCursorException
     */
    protected function errorIfOpened()
    {
        if ($this->cursor === null) {
            return;
        }

        throw new \MongoCursorException('cannot modify cursor after beginning iteration.');
    }

    /**
     * @return array
     */
    protected function getIterationInfo()
    {
        $iterationInfo = [
            'started_iterating' => $this->cursor !== null,
        ];

        if ($this->cursor !== null) {
            switch ($this->cursor->getServer()->getType()) {
                case \MongoDB\Driver\Server::TYPE_RS_ARBITER:
                    $typeString = 'ARBITER';
                    break;
                case \MongoDB\Driver\Server::TYPE_MONGOS:
                    $typeString = 'MONGOS';
                    break;
                case \MongoDB\Driver\Server::TYPE_RS_PRIMARY:
                    $typeString = 'PRIMARY';
                    break;
                case \MongoDB\Driver\Server::TYPE_RS_SECONDARY:
                    $typeString = 'SECONDARY';
                    break;
                default:
                    $typeString = 'STANDALONE';
            }

            $cursorId = (string) $this->cursor->getId();
            $iterationInfo += [
                'id' => (int) $cursorId,
                'at' => $this->position,
                'numReturned' => $this->position, // This can't be obtained from the new cursor
                'server' => sprintf('%s:%d;-;.;%d', $this->cursor->getServer()->getHost(), $this->cursor->getServer()->getPort(), getmypid()),
                'host' => $this->cursor->getServer()->getHost(),
                'port' => $this->cursor->getServer()->getPort(),
                'connection_type_desc' => $typeString,
            ];
        }

        return $iterationInfo;
    }

    /**
     * @throws \Exception
     */
    protected function notImplemented()
    {
        throw new \Exception('Not implemented');
    }

    /**
     * Clears the cursor
     *
     * This is generic but implemented as protected since it's only exposed in MongoCursor
     */
    protected function reset()
    {
        $this->startedIterating = false;
        $this->cursorNeedsAdvancing = true;
        $this->cursor = null;
        $this->iterator = null;
        $this->storeIteratorState();
    }

    /**
     * @return array
     */
    public function __sleep()
    {
        return ['batchSize', 'connection', 'iterator', 'ns', 'optionNames', 'position', 'startedIterating'];
    }

    /**
     * Stores the current cursor element.
     *
     * This is necessary because hasNext() might advance the iterator but we still
     * need to be able to return the current object.
     */
    protected function storeIteratorState()
    {
        if (! $this->startedIterating) {
            $this->current = null;
            $this->key = null;
            $this->valid = false;
            return null;
        }

        $this->current = $this->ensureIterator()->current();
        $this->key = $this->ensureIterator()->key();
        $this->valid = $this->ensureIterator()->valid();

        if ($this->current !== null) {
            $this->current = TypeConverter::toLegacy($this->current);
        }

        return $this->current;
    }
}


1			<?php
2			/*
3			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14			*/
15
16			namespace Alcaeus\MongoDbAdapter;
17
18			use Alcaeus\MongoDbAdapter\Helper\ReadPreference;
19			use MongoDB\Collection;
20			use MongoDB\Driver\Cursor;
21
22			/**
23			* @internal
24			*/
25			abstract class AbstractCursor
26			{
27			use ReadPreference;
28
29			/**
30			* @var int\|null
31			*/
32			protected $batchSize = null;
33
34			/**
35			* @var Collection
36			*/
37			protected $collection;
38
39			/**
40			* @var \MongoClient
41			*/
42			protected $connection;
43
44			/**
45			* @var Cursor
46			*/
47			protected $cursor;
48
49			/**
50			* @var \MongoDB\Database
51			*/
52			protected $db;
53
54			/**
55			* @var CursorIterator
56			*/
57			protected $iterator;
58
59			/**
60			* @var string
61			*/
62			protected $ns;
63
64			/**
65			* @var bool
66			*/
67			protected $startedIterating = false;
68
69			/**
70			* @var bool
71			*/
72			protected $cursorNeedsAdvancing = true;
73
74			/**
75			* @var mixed
76			*/
77			private $current = null;
78
79			/**
80			* @var mixed
81			*/
82			private $key = null;
83
84			/**
85			* @var mixed
86			*/
87			private $valid = false;
88
89			/**
90			* @var int
91			*/
92			protected $position = 0;
93
94			/**
95			* @var array
96			*/
97			protected $optionNames = [
98			'batchSize',
99			'readPreference',
100			];
101
102			/**
103			* @return Cursor
104			*/
105			abstract protected function ensureCursor();
106
107			/**
108			* @return array
109			*/
110			abstract protected function getCursorInfo();
111
112			/**
113			* Create a new cursor
114			* @link http://www.php.net/manual/en/mongocursor.construct.php
115			* @param \MongoClient $connection Database connection.
116			* @param string $ns Full name of database and collection.
117			*/
118	96		public function __construct(\MongoClient $connection, $ns)
119			{
120	96		$this->connection = $connection;
121	96		$this->ns = $ns;
122
123	96		$nsParts = explode('.', $ns);
124	96		$dbName = array_shift($nsParts);
125	96		$collectionName = implode('.', $nsParts);
126
127	96		$this->db = $connection->selectDB($dbName)->getDb();
128
129	96		if ($collectionName) {
130	59		$this->collection = $connection->selectCollection($dbName, $collectionName)->getCollection();
131			}
132	96		}
133
134			/**
135			* Returns the current element
136			* @link http://www.php.net/manual/en/mongocursor.current.php
137			* @return array
138			*/
139	45		public function current()
140			{
141	45		return $this->current;
142			}
143
144			/**
145			* Returns the current result's _id
146			* @link http://www.php.net/manual/en/mongocursor.key.php
147			* @return string The current result's _id as a string.
148			*/
149	29		public function key()
150			{
151	29		return $this->key;
152			}
153
154			/**
155			* Advances the cursor to the next result, and returns that result
156			* @link http://www.php.net/manual/en/mongocursor.next.php
157			* @throws \MongoConnectionException
158			* @throws \MongoCursorTimeoutException
159			* @return array Returns the next object
160			*/
161	47		public function next()
162			{
163	47	View Code Duplication	if (! $this->startedIterating) {
			0 ignored issues – show Duplication introduced 2016-04-08 14:05 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...
164	1		$this->ensureIterator();
165	1		$this->startedIterating = true;
166			} else {
167	47		if ($this->cursorNeedsAdvancing) {
168	46		$this->ensureIterator()->next();
169			}
170
171	47		$this->cursorNeedsAdvancing = true;
172	47		$this->position++;
173			}
174
175	47		return $this->storeIteratorState();
176			}
177
178			/**
179			* Returns the cursor to the beginning of the result set
180			* @throws \MongoConnectionException
181			* @throws \MongoCursorTimeoutException
182			* @return void
183			*/
184	78		public function rewind()
185			{
186			// We can recreate the cursor to allow it to be rewound
187	78		$this->reset();
188	78		$this->startedIterating = true;
189	78		$this->position = 0;
190	78		$this->ensureIterator()->rewind();
191	76		$this->storeIteratorState();
192	76		}
193
194			/**
195			* Checks if the cursor is reading a valid result.
196			* @link http://www.php.net/manual/en/mongocursor.valid.php
197			* @return boolean If the current result is not null.
198			*/
199	76		public function valid()
200			{
201	76		return $this->valid;
202			}
203
204			/**
205			* Limits the number of elements returned in one batch.
206			*
207			* @link http://docs.php.net/manual/en/mongocursor.batchsize.php
208			* @param int\|null $batchSize The number of results to return per batch
209			* @return $this Returns this cursor.
210			*/
211	2		public function batchSize($batchSize)
212			{
213	2		$this->batchSize = $batchSize;
214
215	2		return $this;
216			}
217
218			/**
219			* Checks if there are documents that have not been sent yet from the database for this cursor
220			* @link http://www.php.net/manual/en/mongocursor.dead.php
221			* @return boolean Returns if there are more results that have not been sent to the client, yet.
222			*/
223			public function dead()
224			{
225			return $this->ensureCursor()->isDead();
226			}
227
228			/**
229			* @return array
230			*/
231	5		public function info()
232			{
233	5		return $this->getCursorInfo() + $this->getIterationInfo();
234			}
235
236			/**
237			* @link http://www.php.net/manual/en/mongocursor.setreadpreference.php
238			* @param string $readPreference
239			* @param array $tags
240			* @return $this Returns this cursor.
241			*/
242	96		public function setReadPreference($readPreference, $tags = null)
243			{
244	96		$this->setReadPreferenceFromParameters($readPreference, $tags);
245
246	96		return $this;
247			}
248
249			/**
250			* Sets a client-side timeout for this query
251			* @link http://www.php.net/manual/en/mongocursor.timeout.php
252			* @param int $ms The number of milliseconds for the cursor to wait for a response. By default, the cursor will wait forever.
253			* @return $this Returns this cursor
254			*/
255			public function timeout($ms)
			0 ignored issues – show Unused Code introduced 2016-01-01 11:06 UTC by Report Bug Copy Issue Report The parameter `$ms` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
256			{
257			trigger_error('The ' . __METHOD__ . ' method is not implemented in mongo-php-adapter', E_USER_WARNING);
258			return $this;
259			}
260
261			/**
262			* Applies all options set on the cursor, overwriting any options that have already been set
263			*
264			* @param array $optionNames Array of option names to be applied (will be read from properties)
265			* @return array
266			*/
267	87		protected function getOptions($optionNames = null)
268			{
269	87		$options = [];
270
271	87		if ($optionNames === null) {
272	80		$optionNames = $this->optionNames;
273			}
274
275	87		foreach ($optionNames as $option) {
276	87		$converter = 'convert' . ucfirst($option);
277	87		$value = method_exists($this, $converter) ? $this->$converter() : $this->$option;
278
279	87		if ($value === null) {
280	87		continue;
281			}
282
283	82		$options[$option] = $value;
284			}
285
286	87		return $options;
287			}
288
289			/**
290			* @return \Iterator
291			*/
292	80		protected function ensureIterator()
293			{
294	80		if ($this->iterator === null) {
295	80		$this->iterator = $this->wrapTraversable($this->ensureCursor());
296	78		$this->iterator->rewind();
297			}
298
299	78		return $this->iterator;
300			}
301
302			/**
303			* @param \Traversable $traversable
304			* @return CursorIterator
305			*/
306	37		protected function wrapTraversable(\Traversable $traversable)
307			{
308	37		return new CursorIterator($traversable);
309			}
310
311			/**
312			* @throws \MongoCursorException
313			*/
314	25		protected function errorIfOpened()
315			{
316	25		if ($this->cursor === null) {
317	25		return;
318			}
319
320			throw new \MongoCursorException('cannot modify cursor after beginning iteration.');
321			}
322
323			/**
324			* @return array
325			*/
326	5		protected function getIterationInfo()
327			{
328			$iterationInfo = [
329	5		'started_iterating' => $this->cursor !== null,
330			];
331
332	5		if ($this->cursor !== null) {
333	5		switch ($this->cursor->getServer()->getType()) {
334			case \MongoDB\Driver\Server::TYPE_RS_ARBITER:
335			$typeString = 'ARBITER';
336			break;
337			case \MongoDB\Driver\Server::TYPE_MONGOS:
338			$typeString = 'MONGOS';
339			break;
340			case \MongoDB\Driver\Server::TYPE_RS_PRIMARY:
341			$typeString = 'PRIMARY';
342			break;
343			case \MongoDB\Driver\Server::TYPE_RS_SECONDARY:
344			$typeString = 'SECONDARY';
345			break;
346			default:
347	5		$typeString = 'STANDALONE';
348			}
349
350	5		$cursorId = (string) $this->cursor->getId();
351			$iterationInfo += [
352	5		'id' => (int) $cursorId,
353	5		'at' => $this->position,
354	5		'numReturned' => $this->position, // This can't be obtained from the new cursor
355	5		'server' => sprintf('%s:%d;-;.;%d', $this->cursor->getServer()->getHost(), $this->cursor->getServer()->getPort(), getmypid()),
356	5		'host' => $this->cursor->getServer()->getHost(),
357	5		'port' => $this->cursor->getServer()->getPort(),
358	5		'connection_type_desc' => $typeString,
359			];
360			}
361
362	5		return $iterationInfo;
363			}
364
365			/**
366			* @throws \Exception
367			*/
368			protected function notImplemented()
369			{
370			throw new \Exception('Not implemented');
371			}
372
373			/**
374			* Clears the cursor
375			*
376			* This is generic but implemented as protected since it's only exposed in MongoCursor
377			*/
378	79		protected function reset()
379			{
380	79		$this->startedIterating = false;
381	79		$this->cursorNeedsAdvancing = true;
382	79		$this->cursor = null;
383	79		$this->iterator = null;
384	79		$this->storeIteratorState();
385	79		}
386
387			/**
388			* @return array
389			*/
390	3		public function __sleep()
391			{
392	3		return ['batchSize', 'connection', 'iterator', 'ns', 'optionNames', 'position', 'startedIterating'];
393			}
394
395			/**
396			* Stores the current cursor element.
397			*
398			* This is necessary because hasNext() might advance the iterator but we still
399			* need to be able to return the current object.
400			*/
401	80		protected function storeIteratorState()
402			{
403	80		if (! $this->startedIterating) {
404	79		$this->current = null;
405	79		$this->key = null;
406	79		$this->valid = false;
407	79		return null;
408			}
409
410	78		$this->current = $this->ensureIterator()->current();
411	78		$this->key = $this->ensureIterator()->key();
412	78		$this->valid = $this->ensureIterator()->valid();
413
414	78		if ($this->current !== null) {
415	47		$this->current = TypeConverter::toLegacy($this->current);
416			}
417
418	78		return $this->current;
419			}
420			}
421

alcaeus / mongo-php-adapter

AbstractCursor A last analyzed 2020-09-22 11:40 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

22 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

AbstractCursor A
last analyzed 2020-09-22 11:40 UTC