WorkerCompilerPass::addMethodCalls() - Code Metrics - Inspection of "Issue #68 attempt to fix dependency on doctrine wh..." - mmucklo/DtcQueueBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#69)

by Matthew

created 2018-06-07 03:46 UTC

WorkerCompilerPass::addMethodCalls() A

↳ Parent: WorkerCompilerPass

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	6
nc	2
nop	2
dl	0
loc	7
ccs	7
cts	7
cp	1
crap	2
rs	9.4285
c	0
b	0
f	0

<?php

namespace Dtc\QueueBundle\DependencyInjection\Compiler;

use Dtc\GridBundle\DependencyInjection\Compiler\GridSourceCompilerPass;
use Dtc\QueueBundle\Model\Job;
use Dtc\QueueBundle\Model\JobTiming;
use Dtc\QueueBundle\Model\Run;
use Dtc\QueueBundle\Exception\ClassNotFoundException;
use Dtc\QueueBundle\Exception\ClassNotSubclassException;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\DependencyInjection\Alias;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Reference;

class WorkerCompilerPass implements CompilerPassInterface
{
    public function process(ContainerBuilder $container)
    {
        if (false === $container->hasDefinition('dtc_queue.manager.worker')) {
            return;
        }

        $this->setupAliases($container);

        $definition = $container->getDefinition('dtc_queue.manager.worker');

        $jobClass = $this->getJobClass($container);
        $jobArchiveClass = $this->getJobClassArchive($container);
        $container->setParameter('dtc_queue.class.job', $jobClass);
        $container->setParameter('dtc_queue.class.job_archive', $jobArchiveClass);

        $managerType = $this->getRunManagerType($container);
        $jobTimingManagerType = $this->getJobTimingManagerType($container);
        $container->setParameter('dtc_queue.class.job_timing', $this->getClass(
            $container,
            $jobTimingManagerType,
            'job_timing',
            'JobTiming',
            JobTiming::class
        ));
        $container->setParameter('dtc_queue.class.run', $this->getClass($container, $managerType, 'run', 'Run', Run::class));
        $container->setParameter('dtc_queue.class.run_archive', $this->getClass($container, $managerType, 'run_archive', 'RunArchive', Run::class));

        $this->setupTaggedServices($container, $definition);
        $eventDispatcher = $container->getDefinition('dtc_queue.event_dispatcher');
        foreach ($container->findTaggedServiceIds('dtc_queue.event_subscriber') as $id => $attributes) {
            $eventSubscriber = $container->getDefinition($id);
            $eventDispatcher->addMethodCall('addSubscriber', [$eventSubscriber]);
        }
        $this->setupDoctrineManagers($container);
        $this->addLiveJobs($container);
    }

    /**
     * Add any extra method calls needed
     * @param ContainerBuilder $container
     * @param string $defaultManagerType
     */
    protected function addMethodCalls(ContainerBuilder $container, $defaultManagerType) {
        if ($defaultManagerType === 'orm') {
            $doctrine = $container->getDefinition('doctrine');
            $container->getDefinition('dtc_queue.doctrine_listener')->addMethodCall('setRegistry', [$doctrine]);
            $container->getDefinition('dtc_queue.manager.job.orm')->addMethodCall('setRegistry', [$doctrine]);
            $container->getDefinition('dtc_queue.manager.run.orm')->addMethodCall('setRegistry', [$doctrine]);
            $container->getDefinition('dtc_queue.manager.job_timing.orm')->addMethodCall('setRegistry', [$doctrine]);
        }
    }

    /**
     * @param string $type
     */
    protected function setupAlias(ContainerBuilder $container, $defaultManagerType, $type)
    {
        $definitionName = 'dtc_queue.'.$type.'.'.$defaultManagerType;
        if (!$container->hasDefinition($definitionName) && !$container->hasAlias($definitionName)) {
            throw new InvalidConfigurationException("No $type manager found for dtc_queue.$type.$defaultManagerType");
        }
        if ($container->hasDefinition($definitionName)) {
            $alias = new Alias('dtc_queue.'.$type.'.'.$defaultManagerType);
            $alias->setPublic(true);
            $container->setAlias('dtc_queue.'.$type, $alias);

            return;
        }

        $container->getAlias($definitionName)->setPublic(true);
        $container->setAlias('dtc_queue.'.$type, $container->getAlias($definitionName));
    }

    protected function setupAliases(ContainerBuilder $container)
    {
        $defaultManagerType = $container->getParameter('dtc_queue.manager.job');
        $this->addMethodCalls($container, $defaultManagerType);
        $this->setupAlias($container, $defaultManagerType, 'manager.job');
        $runManagerType = $container->getParameter($this->getRunManagerType($container));
        $this->addMethodCalls($container, $runManagerType);
        $this->setupAlias($container, $runManagerType, 'manager.run');
        $jobTimingManagerType = $container->getParameter($this->getJobTimingManagerType($container));
        $this->addMethodCalls($container, $jobTimingManagerType);
        $this->setupAlias($container, $jobTimingManagerType, 'manager.job_timing');
    }

    /**
     * @param ContainerBuilder $container
     * @param Definition       $definition
     */
    protected function setupTaggedServices(ContainerBuilder $container, Definition $definition)
    {
        $jobManagerRef = array(new Reference('dtc_queue.manager.job'));
        // Add each worker to workerManager, make sure each worker has instance to work
        foreach ($container->findTaggedServiceIds('dtc_queue.worker') as $id => $attributes) {
            $worker = $container->getDefinition($id);
            $class = $container->getDefinition($id)->getClass();

            $refClass = new \ReflectionClass($class);
            $workerClass = 'Dtc\QueueBundle\Model\Worker';
            if (!$refClass->isSubclassOf($workerClass)) {
                throw new \InvalidArgumentException(sprintf('Service "%s" must extend class "%s".', $id, $workerClass));
            }

            // Give each worker access to job manager
            $worker->addMethodCall('setJobManager', $jobManagerRef);
            $definition->addMethodCall('addWorker', array(new Reference($id)));
        }
    }

    /**
     * @param ContainerBuilder $container
     */
    protected function setupDoctrineManagers(ContainerBuilder $container)
    {
        $documentManager = $container->getParameter('dtc_queue.odm.document_manager');

        $odmManager = "doctrine_mongodb.odm.{$documentManager}_document_manager";
        if ($container->has($odmManager)) {
            $container->setAlias('dtc_queue.document_manager', $odmManager);
        }

        $entityManager = $container->getParameter('dtc_queue.orm.entity_manager');

        $ormManager = "doctrine.orm.{$entityManager}_entity_manager";
        if ($container->has($ormManager)) {
            $container->setAlias('dtc_queue.entity_manager', $ormManager);
        }
    }

    /**
     * @param ContainerBuilder $container
     */
    protected function addLiveJobs(ContainerBuilder $container)
    {
        $jobReflection = new \ReflectionClass($container->getParameter('dtc_queue.class.job'));
        if ($jobReflection->isInstance(new \Dtc\QueueBundle\Document\Job())) {
            GridSourceCompilerPass::addGridSource($container, 'dtc_queue.grid_source.jobs_waiting.odm');
            GridSourceCompilerPass::addGridSource($container, 'dtc_queue.grid_source.jobs_running.odm');
        }
        if ($jobReflection->isInstance(new \Dtc\QueueBundle\Entity\Job())) {
            GridSourceCompilerPass::addGridSource($container, 'dtc_queue.grid_source.jobs_waiting.orm');
            GridSourceCompilerPass::addGridSource($container, 'dtc_queue.grid_source.jobs_running.orm');
        }
    }

    /**
     * @param $managerType
     *
     * @return null|string
     */
    protected function getDirectory($managerType)
    {
        switch ($managerType) {
            case 'odm':
                return 'Document';
            case 'beanstalkd':
                return 'Beanstalkd';
            case 'rabbit_mq':
                return 'RabbitMQ';
            case 'orm':
                return 'Entity';
            case 'redis':
                return 'Redis';
        }

        return null;
    }

    /**
     * Determines the job class based on the queue manager type.
     *
     * @param ContainerBuilder $container
     *
     * @return mixed|string
     *
     * @throws InvalidConfigurationException
     */
    protected function getJobClass(ContainerBuilder $container)
    {
        $jobClass = $container->getParameter('dtc_queue.class.job');
        if (!$jobClass) {
            if ($directory = $this->getDirectory($managerType = $container->getParameter('dtc_queue.manager.job'))) {
                $jobClass = 'Dtc\QueueBundle\\'.$directory.'\Job';
            } else {
                throw new InvalidConfigurationException('Unknown manager.job type '.$managerType.' - please specify a Job class in the \'class\' configuration parameter');
            }
        }

        $this->testClass($jobClass, Job::class);

        return $jobClass;
    }

    protected function getRunManagerType(ContainerBuilder $container)
    {
        $managerType = 'dtc_queue.manager.job';
        if ($container->hasParameter('dtc_queue.manager.run')) {
            $managerType = 'dtc_queue.manager.run';
        }

        return $managerType;
    }

    protected function getJobTimingManagerType(ContainerBuilder $container)
    {
        $managerType = $this->getRunManagerType($container);
        if ($container->hasParameter('dtc_queue.manager.job_timing')) {
            $managerType = 'dtc_queue.manager.job_timing';
        }

        return $managerType;
    }

    /**
     * @param string $managerType
     * @param string $type
     * @param string $className
     */
    protected function getClass(ContainerBuilder $container, $managerType, $type, $className, $baseClass)
    {
        $runClass = $container->hasParameter('dtc_queue.class.'.$type) ? $container->getParameter('dtc_queue.class.'.$type) : null;
        if (!$runClass) {
            switch ($container->getParameter($managerType)) {
                case 'odm':
                    $runClass = 'Dtc\\QueueBundle\\Document\\'.$className;
                    break;
                case 'orm':
                    $runClass = 'Dtc\\QueueBundle\\Entity\\'.$className;
                    break;
                default:
                    $runClass = $baseClass;
            }
        }

        $this->testClass($runClass, $baseClass);

        return $runClass;
    }

    /**
     * @throws ClassNotFoundException
     * @throws ClassNotSubclassException
     */
    protected function testClass($className, $parent)
    {
        if (!class_exists($className)) {
            throw new ClassNotFoundException("Can't find class $className");
        }

        $test = new $className();
        if (!$test instanceof $className) {
            throw new ClassNotSubclassException("$className must be instance of (or derived from) $parent");
        }
    }

    /**
     * Determines the job class based on the queue manager type.
     *
     * @param ContainerBuilder $container
     *
     * @return mixed|string
     *
     * @throws ClassNotFoundException
     * @throws ClassNotSubclassException
     */
    protected function getJobClassArchive(ContainerBuilder $container)
    {
        $jobArchiveClass = $container->getParameter('dtc_queue.class.job_archive');
        if (!$jobArchiveClass) {
            switch ($container->getParameter('dtc_queue.manager.job')) {
                case 'odm':
                    $jobArchiveClass = 'Dtc\\QueueBundle\\Document\\JobArchive';
                    break;
                case 'orm':
                    $jobArchiveClass = 'Dtc\\QueueBundle\\Entity\\JobArchive';
                    break;
            }
        }
        if (null !== $jobArchiveClass) {
            $this->testClass($jobArchiveClass, Job::class);
        }

        return $jobArchiveClass;
    }
}


1		<?php
2
3		namespace Dtc\QueueBundle\DependencyInjection\Compiler;
4
5		use Dtc\GridBundle\DependencyInjection\Compiler\GridSourceCompilerPass;
6		use Dtc\QueueBundle\Model\Job;
7		use Dtc\QueueBundle\Model\JobTiming;
8		use Dtc\QueueBundle\Model\Run;
9		use Dtc\QueueBundle\Exception\ClassNotFoundException;
10		use Dtc\QueueBundle\Exception\ClassNotSubclassException;
11		use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
12		use Symfony\Component\DependencyInjection\Alias;
13		use Symfony\Component\DependencyInjection\ContainerBuilder;
14		use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
15		use Symfony\Component\DependencyInjection\Definition;
16		use Symfony\Component\DependencyInjection\Reference;
17
18		class WorkerCompilerPass implements CompilerPassInterface
19		{
20	4	public function process(ContainerBuilder $container)
21		{
22	4	if (false === $container->hasDefinition('dtc_queue.manager.worker')) {
23	4	return;
24		}
25
26	4	$this->setupAliases($container);
27
28	4	$definition = $container->getDefinition('dtc_queue.manager.worker');
29
30	4	$jobClass = $this->getJobClass($container);
31	3	$jobArchiveClass = $this->getJobClassArchive($container);
32	3	$container->setParameter('dtc_queue.class.job', $jobClass);
33	3	$container->setParameter('dtc_queue.class.job_archive', $jobArchiveClass);
34
35	3	$managerType = $this->getRunManagerType($container);
36	3	$jobTimingManagerType = $this->getJobTimingManagerType($container);
37	3	$container->setParameter('dtc_queue.class.job_timing', $this->getClass(
38	3	$container,
39	3	$jobTimingManagerType,
40	3	'job_timing',
41	3	'JobTiming',
42	3	JobTiming::class
43		));
44	3	$container->setParameter('dtc_queue.class.run', $this->getClass($container, $managerType, 'run', 'Run', Run::class));
45	3	$container->setParameter('dtc_queue.class.run_archive', $this->getClass($container, $managerType, 'run_archive', 'RunArchive', Run::class));
46
47	3	$this->setupTaggedServices($container, $definition);
48	2	$eventDispatcher = $container->getDefinition('dtc_queue.event_dispatcher');
49	2	foreach ($container->findTaggedServiceIds('dtc_queue.event_subscriber') as $id => $attributes) {
50		$eventSubscriber = $container->getDefinition($id);
51		$eventDispatcher->addMethodCall('addSubscriber', [$eventSubscriber]);
52		}
53	2	$this->setupDoctrineManagers($container);
54	2	$this->addLiveJobs($container);
55	2	}
56
57		/**
58		* Add any extra method calls needed
59		* @param ContainerBuilder $container
60		* @param string $defaultManagerType
61		*/
62	4	protected function addMethodCalls(ContainerBuilder $container, $defaultManagerType) {
63	4	if ($defaultManagerType === 'orm') {
64	1	$doctrine = $container->getDefinition('doctrine');
65	1	$container->getDefinition('dtc_queue.doctrine_listener')->addMethodCall('setRegistry', [$doctrine]);
66	1	$container->getDefinition('dtc_queue.manager.job.orm')->addMethodCall('setRegistry', [$doctrine]);
67	1	$container->getDefinition('dtc_queue.manager.run.orm')->addMethodCall('setRegistry', [$doctrine]);
68	1	$container->getDefinition('dtc_queue.manager.job_timing.orm')->addMethodCall('setRegistry', [$doctrine]);
69		}
70	4	}
71
72		/**
73		* @param string $type
74		*/
75	4	protected function setupAlias(ContainerBuilder $container, $defaultManagerType, $type)
76		{
77	4	$definitionName = 'dtc_queue.'.$type.'.'.$defaultManagerType;
78	4	if (!$container->hasDefinition($definitionName) && !$container->hasAlias($definitionName)) {
79		throw new InvalidConfigurationException("No $type manager found for dtc_queue.$type.$defaultManagerType");
80		}
81	4	if ($container->hasDefinition($definitionName)) {
82	4	$alias = new Alias('dtc_queue.'.$type.'.'.$defaultManagerType);
83	4	$alias->setPublic(true);
84	4	$container->setAlias('dtc_queue.'.$type, $alias);
85
86	4	return;
87		}
88
89		$container->getAlias($definitionName)->setPublic(true);
90		$container->setAlias('dtc_queue.'.$type, $container->getAlias($definitionName));
91		}
92
93	4	protected function setupAliases(ContainerBuilder $container)
94		{
95	4	$defaultManagerType = $container->getParameter('dtc_queue.manager.job');
96	4	$this->addMethodCalls($container, $defaultManagerType);
97	4	$this->setupAlias($container, $defaultManagerType, 'manager.job');
98	4	$runManagerType = $container->getParameter($this->getRunManagerType($container));
99	4	$this->addMethodCalls($container, $runManagerType);
100	4	$this->setupAlias($container, $runManagerType, 'manager.run');
101	4	$jobTimingManagerType = $container->getParameter($this->getJobTimingManagerType($container));
102	4	$this->addMethodCalls($container, $jobTimingManagerType);
103	4	$this->setupAlias($container, $jobTimingManagerType, 'manager.job_timing');
104	4	}
105
106		/**
107		* @param ContainerBuilder $container
108		* @param Definition $definition
109		*/
110	3	protected function setupTaggedServices(ContainerBuilder $container, Definition $definition)
111		{
112	3	$jobManagerRef = array(new Reference('dtc_queue.manager.job'));
113		// Add each worker to workerManager, make sure each worker has instance to work
114	3	foreach ($container->findTaggedServiceIds('dtc_queue.worker') as $id => $attributes) {
115	2	$worker = $container->getDefinition($id);
116	2	$class = $container->getDefinition($id)->getClass();
117
118	2	$refClass = new \ReflectionClass($class);
119	2	$workerClass = 'Dtc\QueueBundle\Model\Worker';
120	2	if (!$refClass->isSubclassOf($workerClass)) {
121	1	throw new \InvalidArgumentException(sprintf('Service "%s" must extend class "%s".', $id, $workerClass));
122		}
123
124		// Give each worker access to job manager
125	1	$worker->addMethodCall('setJobManager', $jobManagerRef);
126	1	$definition->addMethodCall('addWorker', array(new Reference($id)));
127		}
128	2	}
129
130		/**
131		* @param ContainerBuilder $container
132		*/
133	2	protected function setupDoctrineManagers(ContainerBuilder $container)
134		{
135	2	$documentManager = $container->getParameter('dtc_queue.odm.document_manager');
136
137	2	$odmManager = "doctrine_mongodb.odm.{$documentManager}_document_manager";
138	2	if ($container->has($odmManager)) {
139		$container->setAlias('dtc_queue.document_manager', $odmManager);
140		}
141
142	2	$entityManager = $container->getParameter('dtc_queue.orm.entity_manager');
143
144	2	$ormManager = "doctrine.orm.{$entityManager}_entity_manager";
145	2	if ($container->has($ormManager)) {
146		$container->setAlias('dtc_queue.entity_manager', $ormManager);
147		}
148	2	}
149
150		/**
151		* @param ContainerBuilder $container
152		*/
153	2	protected function addLiveJobs(ContainerBuilder $container)
154		{
155	2	$jobReflection = new \ReflectionClass($container->getParameter('dtc_queue.class.job'));
156	2	if ($jobReflection->isInstance(new \Dtc\QueueBundle\Document\Job())) {
157	2	GridSourceCompilerPass::addGridSource($container, 'dtc_queue.grid_source.jobs_waiting.odm');
158	2	GridSourceCompilerPass::addGridSource($container, 'dtc_queue.grid_source.jobs_running.odm');
159		}
160	2	if ($jobReflection->isInstance(new \Dtc\QueueBundle\Entity\Job())) {
161	1	GridSourceCompilerPass::addGridSource($container, 'dtc_queue.grid_source.jobs_waiting.orm');
162	1	GridSourceCompilerPass::addGridSource($container, 'dtc_queue.grid_source.jobs_running.orm');
163		}
164	2	}
165
166		/**
167		* @param $managerType
168		*
169		* @return null\|string
170		*/
171	4	protected function getDirectory($managerType)
172		{
173		switch ($managerType) {
174	4	case 'odm':
175	3	return 'Document';
176	2	case 'beanstalkd':
177	1	return 'Beanstalkd';
178	2	case 'rabbit_mq':
179	1	return 'RabbitMQ';
180	2	case 'orm':
181	1	return 'Entity';
182	2	case 'redis':
183	1	return 'Redis';
184		}
185
186	1	return null;
187		}
188
189		/**
190		* Determines the job class based on the queue manager type.
191		*
192		* @param ContainerBuilder $container
193		*
194		* @return mixed\|string
195		*
196		* @throws InvalidConfigurationException
197		*/
198	4	protected function getJobClass(ContainerBuilder $container)
199		{
200	4	$jobClass = $container->getParameter('dtc_queue.class.job');
201	4	if (!$jobClass) {
202	4	if ($directory = $this->getDirectory($managerType = $container->getParameter('dtc_queue.manager.job'))) {
203	3	$jobClass = 'Dtc\QueueBundle\\'.$directory.'\Job';
204		} else {
205	1	throw new InvalidConfigurationException('Unknown manager.job type '.$managerType.' - please specify a Job class in the \'class\' configuration parameter');
206		}
207		}
208
209	3	$this->testClass($jobClass, Job::class);
210
211	3	return $jobClass;
212		}
213
214	4	protected function getRunManagerType(ContainerBuilder $container)
215		{
216	4	$managerType = 'dtc_queue.manager.job';
217	4	if ($container->hasParameter('dtc_queue.manager.run')) {
218	4	$managerType = 'dtc_queue.manager.run';
219		}
220
221	4	return $managerType;
222		}
223
224	4	protected function getJobTimingManagerType(ContainerBuilder $container)
225		{
226	4	$managerType = $this->getRunManagerType($container);
227	4	if ($container->hasParameter('dtc_queue.manager.job_timing')) {
228	4	$managerType = 'dtc_queue.manager.job_timing';
229		}
230
231	4	return $managerType;
232		}
233
234		/**
235		* @param string $managerType
236		* @param string $type
237		* @param string $className
238		*/
239	3	protected function getClass(ContainerBuilder $container, $managerType, $type, $className, $baseClass)
240		{
241	3	$runClass = $container->hasParameter('dtc_queue.class.'.$type) ? $container->getParameter('dtc_queue.class.'.$type) : null;
242	3	if (!$runClass) {
243	3	switch ($container->getParameter($managerType)) {
244	3	case 'odm':
245	3	$runClass = 'Dtc\\QueueBundle\\Document\\'.$className;
246	3	break;
247	1	case 'orm':
248	1	$runClass = 'Dtc\\QueueBundle\\Entity\\'.$className;
249	1	break;
250		default:
251		$runClass = $baseClass;
252		}
253		}
254
255	3	$this->testClass($runClass, $baseClass);
256
257	3	return $runClass;
258		}
259
260		/**
261		* @throws ClassNotFoundException
262		* @throws ClassNotSubclassException
263		*/
264	3	protected function testClass($className, $parent)
265		{
266	3	if (!class_exists($className)) {
267		throw new ClassNotFoundException("Can't find class $className");
268		}
269
270	3	$test = new $className();
271	3	if (!$test instanceof $className) {
272		throw new ClassNotSubclassException("$className must be instance of (or derived from) $parent");
273		}
274	3	}
275
276		/**
277		* Determines the job class based on the queue manager type.
278		*
279		* @param ContainerBuilder $container
280		*
281		* @return mixed\|string
282		*
283		* @throws ClassNotFoundException
284		* @throws ClassNotSubclassException
285		*/
286	3	protected function getJobClassArchive(ContainerBuilder $container)
287		{
288	3	$jobArchiveClass = $container->getParameter('dtc_queue.class.job_archive');
289	3	if (!$jobArchiveClass) {
290	3	switch ($container->getParameter('dtc_queue.manager.job')) {
291	3	case 'odm':
292	3	$jobArchiveClass = 'Dtc\\QueueBundle\\Document\\JobArchive';
293	3	break;
294	1	case 'orm':
295	1	$jobArchiveClass = 'Dtc\\QueueBundle\\Entity\\JobArchive';
296	1	break;
297		}
298		}
299	3	if (null !== $jobArchiveClass) {
300	3	$this->testClass($jobArchiveClass, Job::class);
301		}
302
303	3	return $jobArchiveClass;
304		}
305		}
306

mmucklo / DtcQueueBundle

Pull Request — master (#69)

WorkerCompilerPass::addMethodCalls() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like