BaseTestCaseORM::getMockAnnotatedConfig() - Code Metrics - Inspection of "fix missing locale annotation for Gedmo trait" - sonata-project/SonataTranslationBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.x (#121)

unknown

created 2016-08-15 15:18 UTC

BaseTestCaseORM::getMockAnnotatedConfig() B

↳ Parent: BaseTestCaseORM

Complexity

Conditions	4
Paths	3

Size

Total Lines	82
Code Lines	51

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	82
rs	8.5076
cc	4
eloc	51
nc	3
nop	0

How to fix Long Method

<?php

namespace Sonata\TranslationBundle\Tests\Tool;

use Doctrine\Common\Annotations\AnnotationReader;
use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
use Doctrine\ORM\EntityManager;
use Doctrine\Common\EventManager;
use Doctrine\ORM\Tools\SchemaTool;
use Doctrine\ORM\Configuration;
use Gedmo\Translatable\TranslatableListener;
use Doctrine\ORM\Mapping\DefaultQuoteStrategy;
use Doctrine\ORM\Mapping\DefaultNamingStrategy;
use Doctrine\ORM\Repository\DefaultRepositoryFactory;

/**
 * Base test case contains common mock objects
 * and functionality among all extensions using
 * ORM object manager.
 *
 * @author Gediminas Morkevicius <[email protected]>
 *
 * @link http://www.gediminasm.org
 *
 * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
 */
abstract class BaseTestCaseORM extends \PHPUnit_Framework_TestCase
{
    /**
     * @var EntityManager
     */
    protected $em;

    /**
     * {@inheritdoc}
     */
    protected function setUp()
    {
    }

    /**
     * EntityManager mock object together with
     * annotation mapping driver and pdo_sqlite
     * database in memory.
     *
     * @param EventManager $evm
     *
     * @return EntityManager
     */
    protected function getMockSqliteEntityManager(EventManager $evm = null, Configuration $config = null)
    {
        $conn = array(
            'driver' => 'pdo_sqlite',
            'memory' => true,
        );

        $config = null === $config ? $this->getMockAnnotatedConfig() : $config;
        $em = EntityManager::create($conn, $config, $evm ?: $this->getEventManager());

        $schema = array_map(function ($class) use ($em) {
            return $em->getClassMetadata($class);
        }, (array) $this->getUsedEntityFixtures());

        $schemaTool = new SchemaTool($em);
        $schemaTool->dropSchema(array());
        $schemaTool->createSchema($schema);

        return $this->em = $em;
    }

    /**
     * EntityManager mock object together with
     * annotation mapping driver and custom
     * connection.
     *
     * @param array        $conn
     * @param EventManager $evm
     *
     * @return EntityManager
     */
    protected function getMockCustomEntityManager(array $conn, EventManager $evm = null)
    {
        $config = $this->getMockAnnotatedConfig();
        $em = EntityManager::create($conn, $config, $evm ?: $this->getEventManager());

        $schema = array_map(function ($class) use ($em) {
            return $em->getClassMetadata($class);
        }, (array) $this->getUsedEntityFixtures());

        $schemaTool = new SchemaTool($em);
        $schemaTool->dropSchema(array());
        $schemaTool->createSchema($schema);

        return $this->em = $em;
    }

    /**
     * EntityManager mock object with
     * annotation mapping driver.
     *
     * @param EventManager $evm
     *
     * @return EntityManager
     */
    protected function getMockMappedEntityManager(EventManager $evm = null)
    {
        $driver = $this->getMock('Doctrine\DBAL\Driver');
        $driver->expects($this->once())
            ->method('getDatabasePlatform')
            ->will($this->returnValue($this->getMock('Doctrine\DBAL\Platforms\MySqlPlatform')));

        $conn = $this->getMock('Doctrine\DBAL\Connection', array(), array(array(), $driver));
        $conn->expects($this->once())
            ->method('getEventManager')
            ->will($this->returnValue($evm ?: $this->getEventManager()));

        $config = $this->getMockAnnotatedConfig();
        $this->em = EntityManager::create($conn, $config);

        return $this->em;
    }

    /**
     * Creates default mapping driver.
     *
     * @return \Doctrine\ORM\Mapping\Driver\Driver
     */
    protected function getMetadataDriverImplementation()
    {
        return new AnnotationDriver(new AnnotationReader());
    }

    /**
     * Get a list of used fixture classes.
     *
     * @return array
     */
    abstract protected function getUsedEntityFixtures();

    /**
     * Build event manager.
     *
     * @return EventManager
     */
    private function getEventManager()
    {
        $evm = new EventManager();
        $evm->addEventSubscriber(new TranslatableListener());

        return $evm;
    }

    /**
     * Get annotation mapping configuration.
     *
     * @return \Doctrine\ORM\Configuration
     */
    protected function getMockAnnotatedConfig()
    {
        // We need to mock every method except the ones which
        // handle the filters
        $configurationClass = 'Doctrine\ORM\Configuration';
        $refl = new \ReflectionClass($configurationClass);
        $methods = $refl->getMethods();

        $mockMethods = array();

        foreach ($methods as $method) {
            if ($method->name !== 'addFilter' && $method->name !== 'getFilterClassName') {
                $mockMethods[] = $method->name;
            }
        }

        $config = $this->getMock($configurationClass, $mockMethods);

        $config
            ->expects($this->once())
            ->method('getProxyDir')
            ->will($this->returnValue(__DIR__.'/../temp'))
        ;

        $config
            ->expects($this->once())
            ->method('getProxyNamespace')
            ->will($this->returnValue('Proxy'))
        ;

        $config
            ->expects($this->any())
            ->method('getDefaultQueryHints')
            ->will($this->returnValue(array()))
        ;

        $config
            ->expects($this->once())
            ->method('getAutoGenerateProxyClasses')
            ->will($this->returnValue(true))
        ;

        $config
            ->expects($this->once())
            ->method('getClassMetadataFactoryName')
            ->will($this->returnValue('Doctrine\\ORM\\Mapping\\ClassMetadataFactory'))
        ;

        $mappingDriver = $this->getMetadataDriverImplementation();

        $config
            ->expects($this->any())
            ->method('getMetadataDriverImpl')
            ->will($this->returnValue($mappingDriver))
        ;

        $config
            ->expects($this->any())
            ->method('getDefaultRepositoryClassName')
            ->will($this->returnValue('Doctrine\\ORM\\EntityRepository'))
        ;

        $config
            ->expects($this->any())
            ->method('getQuoteStrategy')
            ->will($this->returnValue(new DefaultQuoteStrategy()))
        ;

        $config
            ->expects($this->any())
            ->method('getNamingStrategy')
            ->will($this->returnValue(new DefaultNamingStrategy()))
        ;

        $config
            ->expects($this->once())
            ->method('getRepositoryFactory')
            ->will($this->returnValue(new DefaultRepositoryFactory()))
        ;

        return $config;
    }
}


1			<?php
2
3			namespace Sonata\TranslationBundle\Tests\Tool;
4
5			use Doctrine\Common\Annotations\AnnotationReader;
6			use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
7			use Doctrine\ORM\EntityManager;
8			use Doctrine\Common\EventManager;
9			use Doctrine\ORM\Tools\SchemaTool;
10			use Doctrine\ORM\Configuration;
11			use Gedmo\Translatable\TranslatableListener;
12			use Doctrine\ORM\Mapping\DefaultQuoteStrategy;
13			use Doctrine\ORM\Mapping\DefaultNamingStrategy;
14			use Doctrine\ORM\Repository\DefaultRepositoryFactory;
15
16			/**
17			* Base test case contains common mock objects
18			* and functionality among all extensions using
19			* ORM object manager.
20			*
21			* @author Gediminas Morkevicius <[email protected]>
22			*
23			* @link http://www.gediminasm.org
24			*
25			* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
26			*/
27			abstract class BaseTestCaseORM extends \PHPUnit_Framework_TestCase
28			{
29			/**
30			* @var EntityManager
31			*/
32			protected $em;
33
34			/**
35			* {@inheritdoc}
36			*/
37			protected function setUp()
38			{
39			}
40
41			/**
42			* EntityManager mock object together with
43			* annotation mapping driver and pdo_sqlite
44			* database in memory.
45			*
46			* @param EventManager $evm
47			*
48			* @return EntityManager
49			*/
50			protected function getMockSqliteEntityManager(EventManager $evm = null, Configuration $config = null)
51			{
52			$conn = array(
53			'driver' => 'pdo_sqlite',
54			'memory' => true,
55			);
56
57			$config = null === $config ? $this->getMockAnnotatedConfig() : $config;
58			$em = EntityManager::create($conn, $config, $evm ?: $this->getEventManager());
59
60			$schema = array_map(function ($class) use ($em) {
61			return $em->getClassMetadata($class);
62			}, (array) $this->getUsedEntityFixtures());
63
64			$schemaTool = new SchemaTool($em);
65			$schemaTool->dropSchema(array());
66			$schemaTool->createSchema($schema);
67
68			return $this->em = $em;
69			}
70
71			/**
72			* EntityManager mock object together with
73			* annotation mapping driver and custom
74			* connection.
75			*
76			* @param array $conn
77			* @param EventManager $evm
78			*
79			* @return EntityManager
80			*/
81			protected function getMockCustomEntityManager(array $conn, EventManager $evm = null)
82			{
83			$config = $this->getMockAnnotatedConfig();
84			$em = EntityManager::create($conn, $config, $evm ?: $this->getEventManager());
85
86			$schema = array_map(function ($class) use ($em) {
87			return $em->getClassMetadata($class);
88			}, (array) $this->getUsedEntityFixtures());
89
90			$schemaTool = new SchemaTool($em);
91			$schemaTool->dropSchema(array());
92			$schemaTool->createSchema($schema);
93
94			return $this->em = $em;
95			}
96
97			/**
98			* EntityManager mock object with
99			* annotation mapping driver.
100			*
101			* @param EventManager $evm
102			*
103			* @return EntityManager
104			*/
105			protected function getMockMappedEntityManager(EventManager $evm = null)
106			{
107			$driver = $this->getMock('Doctrine\DBAL\Driver');
108			$driver->expects($this->once())
109			->method('getDatabasePlatform')
110			->will($this->returnValue($this->getMock('Doctrine\DBAL\Platforms\MySqlPlatform')));
111
112			$conn = $this->getMock('Doctrine\DBAL\Connection', array(), array(array(), $driver));
113			$conn->expects($this->once())
114			->method('getEventManager')
115			->will($this->returnValue($evm ?: $this->getEventManager()));
116
117			$config = $this->getMockAnnotatedConfig();
118			$this->em = EntityManager::create($conn, $config);
119
120			return $this->em;
121			}
122
123			/**
124			* Creates default mapping driver.
125			*
126			* @return \Doctrine\ORM\Mapping\Driver\Driver
127			*/
128			protected function getMetadataDriverImplementation()
129			{
130			return new AnnotationDriver(new AnnotationReader());
131			}
132
133			/**
134			* Get a list of used fixture classes.
135			*
136			* @return array
137			*/
138			abstract protected function getUsedEntityFixtures();
139
140			/**
141			* Build event manager.
142			*
143			* @return EventManager
144			*/
145			private function getEventManager()
146			{
147			$evm = new EventManager();
148			$evm->addEventSubscriber(new TranslatableListener());
149
150			return $evm;
151			}
152
153			/**
154			* Get annotation mapping configuration.
155			*
156			* @return \Doctrine\ORM\Configuration
157			*/
158			protected function getMockAnnotatedConfig()
159			{
160			// We need to mock every method except the ones which
161			// handle the filters
162			$configurationClass = 'Doctrine\ORM\Configuration';
163			$refl = new \ReflectionClass($configurationClass);
164			$methods = $refl->getMethods();
165
166			$mockMethods = array();
167
168			foreach ($methods as $method) {
169			if ($method->name !== 'addFilter' && $method->name !== 'getFilterClassName') {
170			$mockMethods[] = $method->name;
171			}
172			}
173
174			$config = $this->getMock($configurationClass, $mockMethods);
175
176			$config
177			->expects($this->once())
178			->method('getProxyDir')
179			->will($this->returnValue(__DIR__.'/../temp'))
180			;
181
182			$config
183			->expects($this->once())
184			->method('getProxyNamespace')
185			->will($this->returnValue('Proxy'))
186			;
187
188			$config
189			->expects($this->any())
190			->method('getDefaultQueryHints')
191			->will($this->returnValue(array()))
192			;
193
194			$config
195			->expects($this->once())
196			->method('getAutoGenerateProxyClasses')
197			->will($this->returnValue(true))
198			;
199
200			$config
201			->expects($this->once())
202			->method('getClassMetadataFactoryName')
203			->will($this->returnValue('Doctrine\\ORM\\Mapping\\ClassMetadataFactory'))
204			;
205
206			$mappingDriver = $this->getMetadataDriverImplementation();
207
208			$config
209			->expects($this->any())
210			->method('getMetadataDriverImpl')
211			->will($this->returnValue($mappingDriver))
212			;
213
214			$config
215			->expects($this->any())
216			->method('getDefaultRepositoryClassName')
217			->will($this->returnValue('Doctrine\\ORM\\EntityRepository'))
218			;
219
220			$config
221			->expects($this->any())
222			->method('getQuoteStrategy')
223			->will($this->returnValue(new DefaultQuoteStrategy()))
224			;
225
226			$config
227			->expects($this->any())
228			->method('getNamingStrategy')
229			->will($this->returnValue(new DefaultNamingStrategy()))
230			;
231
232			$config
233			->expects($this->once())
234			->method('getRepositoryFactory')
235			->will($this->returnValue(new DefaultRepositoryFactory()))
236			;
237
238			return $config;
239			}
240			}
241

sonata-project / SonataTranslationBundle

Pull Request — 2.x (#121)

BaseTestCaseORM::getMockAnnotatedConfig() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like