CommonTrait::removeOlderThan() - Code Metrics - Inspection of "attempt to fix build and fix issue #145" - mmucklo/DtcQueueBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#146)

by Matthew

created 2021-05-18 16:52 UTC

CommonTrait::removeOlderThan() A

↳ Parent: CommonTrait

Complexity

Conditions	3
Paths	3

Size

Total Lines	18
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	3.1406

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	12
c	1
b	0
f	0
nc	3
nop	3
dl	0
loc	18
ccs	9
cts	12
cp	0.75
crap	3.1406
rs	9.8666

<?php

namespace Dtc\QueueBundle\ODM;

use Doctrine\ODM\MongoDB\DocumentManager;
filter:
    dependency_paths: ["lib/*"]
use Dtc\QueueBundle\Document\Job;
use Dtc\QueueBundle\Document\JobTiming;
use Dtc\QueueBundle\Document\Run;
use MongoDB\DeleteResult;
filter:
    dependency_paths: ["lib/*"]

trait CommonTrait
{
    /**
     * @param string $objectName
     * @param string $field
     *
     * @return int
     */
    protected function removeOlderThan($objectName, $field, \DateTime $olderThan)
    {
        /** @var DocumentManager $objectManager */
        $objectManager = $this->getObjectManager();
        $qb = $objectManager->createQueryBuilder($objectName);
        $qb
            ->remove()
            ->field($field)->lt($olderThan);

        $query = $qb->getQuery();
        $result = $query->execute();
        if ($result instanceof DeleteResult) {
            return $result->getDeletedCount();
        } elseif (isset($result['n'])) {
            return $result['n'];
        }

        return 0;
    }

    /**
     * @param Run|Job|JobTiming $object
     * @param string            $action
     */
    protected function persist($object, $action = 'persist')
    {
        $objectManager = $this->getObjectManager();
        $objectManager->$action($object);
        $objectManager->flush();
    }

    /**
     * @return ObjectManager
filter:
    dependency_paths: ["lib/*"]
     */
    abstract public function getObjectManager();

    /**
     * @param string $objectName
     */
    public function stopIdGenerator($objectName)
    {
        // Not needed for ODM
    }

    public function restoreIdGenerator($objectName)
    {
        // Not needed for ODM
    }
}


1		<?php
2
3		namespace Dtc\QueueBundle\ODM;
4
5		use Doctrine\ODM\MongoDB\DocumentManager;
		0 ignored issues – show Bug introduced 2020-08-09 07:45 UTC by Report Bug Copy Issue Report The type `Doctrine\ODM\MongoDB\DocumentManager` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
6		use Dtc\QueueBundle\Document\Job;
7		use Dtc\QueueBundle\Document\JobTiming;
8		use Dtc\QueueBundle\Document\Run;
9		use MongoDB\DeleteResult;
		0 ignored issues – show Bug introduced 2020-08-09 07:45 UTC by Report Bug Copy Issue Report The type `MongoDB\DeleteResult` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
10
11		trait CommonTrait
12		{
13		/**
14		* @param string $objectName
15		* @param string $field
16		*
17		* @return int
18		*/
19	2	protected function removeOlderThan($objectName, $field, \DateTime $olderThan)
20		{
21		/** @var DocumentManager $objectManager */
22	2	$objectManager = $this->getObjectManager();
23	2	$qb = $objectManager->createQueryBuilder($objectName);
24		$qb
25	2	->remove()
26	2	->field($field)->lt($olderThan);
27
28	2	$query = $qb->getQuery();
29	2	$result = $query->execute();
30	2	if ($result instanceof DeleteResult) {
31	2	return $result->getDeletedCount();
32		} elseif (isset($result['n'])) {
33		return $result['n'];
34		}
35
36		return 0;
37		}
38
39		/**
40		* @param Run\|Job\|JobTiming $object
41		* @param string $action
42		*/
43	22	protected function persist($object, $action = 'persist')
44		{
45	22	$objectManager = $this->getObjectManager();
46	22	$objectManager->$action($object);
47	22	$objectManager->flush();
48	22	}
49
50		/**
51		* @return ObjectManager
		0 ignored issues – show Bug introduced 2020-09-01 15:06 UTC by Report Bug Copy Issue Report The type `Dtc\QueueBundle\ODM\ObjectManager` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
52		*/
53		abstract public function getObjectManager();
54
55		/**
56		* @param string $objectName
57		*/
58	1	public function stopIdGenerator($objectName)
59		{
60		// Not needed for ODM
61	1	}
62
63	1	public function restoreIdGenerator($objectName)
64		{
65		// Not needed for ODM
66	1	}
67		}
68

mmucklo / DtcQueueBundle

Pull Request — master (#146)

CommonTrait::removeOlderThan() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like