AbstractCursor::getIterationInfo() - Code Metrics - Inspection of "Merge pull request #53 from alcaeus/fix-map-reduce..." - alcaeus/mongo-php-adapter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 662a8c...489af3 )

by Andreas

created 2016-02-10 19:30 UTC

AbstractCursor::getIterationInfo() B

↳ Parent: AbstractCursor

Complexity

Conditions	6
Paths	6

Size

Total Lines	38
Code Lines	29

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	22
CRAP Score	6.8807

Importance

Changes	4
Bugs	0	Features	2

Metric	Value
c	4
b	0
f	2
dl	0
loc	38
ccs	22
cts	31
cp	0.7097
rs	8.439
cc	6
eloc	29
nc	6
nop	0
crap	6.8807

<?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
     */
    protected $batchSize = 0;

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

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

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

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

    /**
     * @var \Iterator
     */
    protected $iterator;

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

    /**
     * @var bool
     */
    protected $startedIterating = 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()
    {
        if (! $this->startedIterating) {
            return null;
        }

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

        return $document;
    }

    /**
     * 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()
    {
        if (! $this->startedIterating) {
            return null;
        }

        return $this->ensureIterator()->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 {
            $this->ensureIterator()->next();
            $this->position++;
        }

        return $this->current();
    }

    /**
     * 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();
    }

    /**
     * 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()
    {
        if (! $this->startedIterating) {
            return false;
        }

        return $this->ensureIterator()->valid();
    }

    /**
     * Limits the number of elements returned in one batch.
     *
     * @link http://docs.php.net/manual/en/mongocursor.batchsize.php
     * @param int $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)

    {
        $this->notImplemented();
    }

    /**
     * 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) {
            // MongoDB\Driver\Cursor needs to be wrapped into a \Generator so that a valid \Iterator with working implementations of
            // next, current, valid, key and rewind is returned. These methods don't work if we wrap the Cursor inside an \IteratorIterator
            $this->iterator = $this->wrapTraversable($this->ensureCursor());
        }

        return $this->iterator;
    }

    /**
     * @param \Traversable $traversable
     * @return \Generator
     */
    protected function wrapTraversable(\Traversable $traversable)
    {
        foreach ($traversable as $key => $value) {
            yield $key => $value;
        }
    }

    /**
     * @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->cursor = null;
        $this->iterator = null;
    }
}


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
31		*/
32		protected $batchSize = 0;
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 \Iterator
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 int
71		*/
72		protected $position = 0;
73
74		/**
75		* @var array
76		*/
77		protected $optionNames = [
78		'batchSize',
79		'readPreference',
80		];
81
82		/**
83		* @return Cursor
84		*/
85		abstract protected function ensureCursor();
86
87		/**
88		* @return array
89		*/
90		abstract protected function getCursorInfo();
91
92		/**
93		* Create a new cursor
94		* @link http://www.php.net/manual/en/mongocursor.construct.php
95		* @param \MongoClient $connection Database connection.
96		* @param string $ns Full name of database and collection.
97		*/
98	43	public function __construct(\MongoClient $connection, $ns)
99		{
100	43	$this->connection = $connection;
101	43	$this->ns = $ns;
102
103	43	$nsParts = explode('.', $ns);
104	43	$dbName = array_shift($nsParts);
105	43	$collectionName = implode('.', $nsParts);
106
107	43	$this->db = $connection->selectDB($dbName)->getDb();
108
109	43	if ($collectionName) {
110	34	$this->collection = $connection->selectCollection($dbName, $collectionName)->getCollection();
111	34	}
112	43	}
113
114		/**
115		* Returns the current element
116		* @link http://www.php.net/manual/en/mongocursor.current.php
117		* @return array
118		*/
119	20	public function current()
120		{
121	20	if (! $this->startedIterating) {
122	2	return null;
123		}
124
125	20	$document = $this->ensureIterator()->current();
126	20	if ($document !== null) {
127	20	$document = TypeConverter::toLegacy($document);
128	20	}
129
130	20	return $document;
131		}
132
133		/**
134		* Returns the current result's _id
135		* @link http://www.php.net/manual/en/mongocursor.key.php
136		* @return string The current result's _id as a string.
137		*/
138	12	public function key()
139		{
140	12	if (! $this->startedIterating) {
141	2	return null;
142		}
143
144	11	return $this->ensureIterator()->key();
145		}
146
147		/**
148		* Advances the cursor to the next result, and returns that result
149		* @link http://www.php.net/manual/en/mongocursor.next.php
150		* @throws \MongoConnectionException
151		* @throws \MongoCursorTimeoutException
152		* @return array Returns the next object
153		*/
154	20	public function next()
155		{
156	20	if (! $this->startedIterating) {
157	2	$this->ensureIterator();
158	2	$this->startedIterating = true;
159	2	} else {
160	20	$this->ensureIterator()->next();
161	20	$this->position++;
162		}
163
164	20	return $this->current();
165		}
166
167		/**
168		* Returns the cursor to the beginning of the result set
169		* @throws \MongoConnectionException
170		* @throws \MongoCursorTimeoutException
171		* @return void
172		*/
173	37	public function rewind()
174		{
175		// We can recreate the cursor to allow it to be rewound
176	37	$this->reset();
177	37	$this->startedIterating = true;
178	37	$this->position = 0;
179	37	$this->ensureIterator()->rewind();
180	35	}
181
182		/**
183		* Checks if the cursor is reading a valid result.
184		* @link http://www.php.net/manual/en/mongocursor.valid.php
185		* @return boolean If the current result is not null.
186		*/
187	35	public function valid()
188		{
189	35	if (! $this->startedIterating) {
190	1	return false;
191		}
192
193	35	return $this->ensureIterator()->valid();
194		}
195
196		/**
197		* Limits the number of elements returned in one batch.
198		*
199		* @link http://docs.php.net/manual/en/mongocursor.batchsize.php
200		* @param int $batchSize The number of results to return per batch
201		* @return $this Returns this cursor.
202		*/
203	1	public function batchSize($batchSize)
204		{
205	1	$this->batchSize = $batchSize;
206
207	1	return $this;
208		}
209
210		/**
211		* Checks if there are documents that have not been sent yet from the database for this cursor
212		* @link http://www.php.net/manual/en/mongocursor.dead.php
213		* @return boolean Returns if there are more results that have not been sent to the client, yet.
214		*/
215		public function dead()
216		{
217		return $this->ensureCursor()->isDead();
218		}
219
220		/**
221		* @return array
222		*/
223	3	public function info()
224		{
225	3	return $this->getCursorInfo() + $this->getIterationInfo();
226		}
227
228		/**
229		* @link http://www.php.net/manual/en/mongocursor.setreadpreference.php
230		* @param string $readPreference
231		* @param array $tags
232		* @return $this Returns this cursor.
233		*/
234	43	public function setReadPreference($readPreference, $tags = null)
235		{
236	43	$this->setReadPreferenceFromParameters($readPreference, $tags);
237
238	43	return $this;
239		}
240
241		/**
242		* Sets a client-side timeout for this query
243		* @link http://www.php.net/manual/en/mongocursor.timeout.php
244		* @param int $ms The number of milliseconds for the cursor to wait for a response. By default, the cursor will wait forever.
245		* @return $this Returns this cursor
246		*/
247		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...
248		{
249		$this->notImplemented();
250		}
251
252		/**
253		* Applies all options set on the cursor, overwriting any options that have already been set
254		*
255		* @param array $optionNames Array of option names to be applied (will be read from properties)
256		* @return array
257		*/
258	40	protected function getOptions($optionNames = null)
259		{
260	40	$options = [];
261
262	40	if ($optionNames === null) {
263	38	$optionNames = $this->optionNames;
264	38	}
265
266	40	foreach ($optionNames as $option) {
267	40	$converter = 'convert' . ucfirst($option);
268	40	$value = method_exists($this, $converter) ? $this->$converter() : $this->$option;
269
270	40	if ($value === null) {
271	29	continue;
272		}
273
274	39	$options[$option] = $value;
275	40	}
276
277	40	return $options;
278		}
279
280		/**
281		* @return \Iterator
282		*/
283	38	protected function ensureIterator()
284		{
285	38	if ($this->iterator === null) {
286		// MongoDB\Driver\Cursor needs to be wrapped into a \Generator so that a valid \Iterator with working implementations of
287		// next, current, valid, key and rewind is returned. These methods don't work if we wrap the Cursor inside an \IteratorIterator
288	38	$this->iterator = $this->wrapTraversable($this->ensureCursor());
289	36	}
290
291	36	return $this->iterator;
292		}
293
294		/**
295		* @param \Traversable $traversable
296		* @return \Generator
297		*/
298	9	protected function wrapTraversable(\Traversable $traversable)
299		{
300	9	foreach ($traversable as $key => $value) {
301	9	yield $key => $value;
302	9	}
303	9	}
304
305		/**
306		* @throws \MongoCursorException
307		*/
308	18	protected function errorIfOpened()
309		{
310	18	if ($this->cursor === null) {
311	18	return;
312		}
313
314		throw new \MongoCursorException('cannot modify cursor after beginning iteration.');
315		}
316
317		/**
318		* @return array
319		*/
320	3	protected function getIterationInfo()
321		{
322		$iterationInfo = [
323	3	'started_iterating' => $this->cursor !== null,
324	3	];
325
326	3	if ($this->cursor !== null) {
327	3	switch ($this->cursor->getServer()->getType()) {
328	3	case \MongoDB\Driver\Server::TYPE_RS_ARBITER:
329		$typeString = 'ARBITER';
330		break;
331	3	case \MongoDB\Driver\Server::TYPE_MONGOS:
332		$typeString = 'MONGOS';
333		break;
334	3	case \MongoDB\Driver\Server::TYPE_RS_PRIMARY:
335		$typeString = 'PRIMARY';
336		break;
337	3	case \MongoDB\Driver\Server::TYPE_RS_SECONDARY:
338		$typeString = 'SECONDARY';
339		break;
340	3	default:
341	3	$typeString = 'STANDALONE';
342	3	}
343
344	3	$cursorId = (string) $this->cursor->getId();
345		$iterationInfo += [
346	3	'id' => (int) $cursorId,
347	3	'at' => $this->position,
348	3	'numReturned' => $this->position, // This can't be obtained from the new cursor
349	3	'server' => sprintf('%s:%d;-;.;%d', $this->cursor->getServer()->getHost(), $this->cursor->getServer()->getPort(), getmypid()),
350	3	'host' => $this->cursor->getServer()->getHost(),
351	3	'port' => $this->cursor->getServer()->getPort(),
352	3	'connection_type_desc' => $typeString,
353		];
354	3	}
355
356	3	return $iterationInfo;
357		}
358
359		/**
360		* @throws \Exception
361		*/
362		protected function notImplemented()
363		{
364		throw new \Exception('Not implemented');
365		}
366
367		/**
368		* Clears the cursor
369		*
370		* This is generic but implemented as protected since it's only exposed in MongoCursor
371		*/
372	38	protected function reset()
373		{
374	38	$this->startedIterating = false;
375	38	$this->cursor = null;
376	38	$this->iterator = null;
377	38	}
378		}
379

alcaeus / mongo-php-adapter

Push — master ( 662a8c...489af3 )

AbstractCursor::getIterationInfo() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like