FixturesLoader::locateResources() - Code Metrics - Inspection of "Webtestcase: Extract some fixtures methods" - liip/LiipFunctionalTestBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#271)

by Alexis

created 2016-06-12 15:26 UTC

FixturesLoader::locateResources() A

↳ Parent: FixturesLoader

Complexity

Conditions	4
Paths	3

Size

Total Lines	17
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	4

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	17
ccs	10
cts	10
cp	1
rs	9.2
cc	4
eloc	9
nc	3
nop	2
crap	4

<?php

/*
 * This file is part of the Liip/FunctionalTestBundle
 *
 * (c) Lukas Kahwe Smith <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Liip\FunctionalTestBundle\Utils;

use Symfony\Component\DependencyInjection\ContainerInterface;
use Doctrine\Common\DataFixtures\DependentFixtureInterface;
use Doctrine\DBAL\Connection;
use Nelmio\Alice\Fixtures;
use Symfony\Bundle\DoctrineFixturesBundle\Common\DataFixtures\Loader;
use Doctrine\Common\Persistence\ObjectManager;
use Doctrine\Common\DataFixtures\ProxyReferenceRepository;

class FixturesLoader
{
    /**
     * @param string $type
     *
     * @return string
     */
    public static function getExecutorClass($type)
    {
        return 'PHPCR' === $type && class_exists('Doctrine\Bundle\PHPCRBundle\DataFixtures\PHPCRExecutor')
            ? 'Doctrine\Bundle\PHPCRBundle\DataFixtures\PHPCRExecutor'
            : 'Doctrine\\Common\\DataFixtures\\Executor\\'.$type.'Executor';
    }

    /**
     * Get file path of the SQLite database.
     *
     * @param Connection $connection
     *
     * @return string $name
     */
    public static function getNameParameter(Connection $connection)
    {
        $params = $connection->getParams();

        if (isset($params['master'])) {
            $params = $params['master'];
        }

        $name = isset($params['path']) ? $params['path'] : (isset($params['dbname']) ? $params['dbname'] : false);

        if (!$name) {
            throw new \InvalidArgumentException("Connection does not contain a 'path' or 'dbname' parameter and cannot be dropped.");
        }

        return $name;
    }

    /**
     * This function finds the time when the data blocks of a class definition
     * file were being written to, that is, the time when the content of the
     * file was changed.
     *
     * @param string $class The fully qualified class name of the fixture class to
     *                      check modification date on.
     *
     * @return \DateTime|null
     */
    protected static function getFixtureLastModified($class)
    {
        $lastModifiedDateTime = null;

        $reflClass = new \ReflectionClass($class);
        $classFileName = $reflClass->getFileName();

        if (file_exists($classFileName)) {
            $lastModifiedDateTime = new \DateTime();
            $lastModifiedDateTime->setTimestamp(filemtime($classFileName));
        }

        return $lastModifiedDateTime;
    }

    /**
     * Determine if the Fixtures that define a database backup have been
     * modified since the backup was made.
     *
     * @param array  $classNames The fixture classnames to check
     * @param string $backup     The fixture backup SQLite database file path
     *
     * @return bool TRUE if the backup was made since the modifications to the
     *              fixtures; FALSE otherwise
     */
    public static function isBackupUpToDate(array $classNames, $backup, $container)
    {
        $backupLastModifiedDateTime = new \DateTime();
        $backupLastModifiedDateTime->setTimestamp(filemtime($backup));

        /** @var \Symfony\Bridge\Doctrine\DataFixtures\ContainerAwareLoader $loader */
        $loader = self::getFixtureLoader($container, $classNames);

        // Use loader in order to fetch all the dependencies fixtures.
        foreach ($loader->getFixtures() as $className) {
            $fixtureLastModifiedDateTime = self::getFixtureLastModified($className);
            if ($backupLastModifiedDateTime < $fixtureLastModifiedDateTime) {
                return false;
            }
        }

        return true;
    }

    /**
     * Locate fixture files.
     *
     * @param array $paths
     *
     * @return array $files
     */
    public static function locateResources($paths, $container)
    {
        $files = array();

        $kernel = $container->get('kernel');

        foreach ($paths as $path) {
            if ($path[0] !== '@' && file_exists($path) === true) {
                $files[] = $path;
                continue;
            }

            $files[] = $kernel->locateResource($path);
        }

        return $files;
    }

    /**
     * Retrieve Doctrine DataFixtures loader.
     *
     * @param ContainerInterface $container
     * @param array              $classNames
     *
     * @return Loader
     */
    public static function getFixtureLoader(ContainerInterface $container, array $classNames)
    {
        $loaderClass = class_exists('Symfony\Bridge\Doctrine\DataFixtures\ContainerAwareLoader')
            ? 'Symfony\Bridge\Doctrine\DataFixtures\ContainerAwareLoader'
            : (class_exists('Doctrine\Bundle\FixturesBundle\Common\DataFixtures\Loader')
                // This class is not available during tests.
                // @codeCoverageIgnoreStart
                ? 'Doctrine\Bundle\FixturesBundle\Common\DataFixtures\Loader'
                // @codeCoverageIgnoreEnd
                : 'Symfony\Bundle\DoctrineFixturesBundle\Common\DataFixtures\Loader');

        $loader = new $loaderClass($container);

        foreach ($classNames as $className) {
            self::loadFixtureClass($loader, $className);
        }

        return $loader;
    }

    /**
     * Purge database.
     *
     * @param ObjectManager            $om
     * @param string                   $type
     * @param int                      $purgeMode
     * @param string                   $executorClass
     * @param ProxyReferenceRepository $referenceRepository
     */
    public static function purgeDatabase(ObjectManager $om, $type, $purgeMode,
         $executorClass,
         ProxyReferenceRepository $referenceRepository,
         $container)
    {
        $purgerClass = 'Doctrine\\Common\\DataFixtures\\Purger\\'.$type.'Purger';
        if ('PHPCR' === $type) {
            $purger = new $purgerClass($om);
            $initManager = $container->has('doctrine_phpcr.initializer_manager')
                ? $container->get('doctrine_phpcr.initializer_manager')
                : null;

            $executor = new $executorClass($om, $purger, $initManager);
        } else {
            $purger = new $purgerClass();
            if (null !== $purgeMode) {
                $purger->setPurgeMode($purgeMode);
            }

            $executor = new $executorClass($om, $purger);
        }

        $executor->setReferenceRepository($referenceRepository);
        $executor->purge();

        return $executor;
    }

    /**
     * Load a data fixture class.
     *
     * @param Loader $loader
     * @param string $className
     */
    protected static function loadFixtureClass($loader, $className)
    {
        $fixture = new $className();

        if ($loader->hasFixture($fixture)) {
            unset($fixture);

            return;
        }

        $loader->addFixture($fixture);

        if ($fixture instanceof DependentFixtureInterface) {
            foreach ($fixture->getDependencies() as $dependency) {
                self::loadFixtureClass($loader, $dependency);
            }
        }
    }
}


1		<?php
2
3		/*
4		* This file is part of the Liip/FunctionalTestBundle
5		*
6		* (c) Lukas Kahwe Smith <[email protected]>
7		*
8		* This source file is subject to the MIT license that is bundled
9		* with this source code in the file LICENSE.
10		*/
11
12		namespace Liip\FunctionalTestBundle\Utils;
13
14		use Symfony\Component\DependencyInjection\ContainerInterface;
15		use Doctrine\Common\DataFixtures\DependentFixtureInterface;
16		use Doctrine\DBAL\Connection;
17		use Nelmio\Alice\Fixtures;
18		use Symfony\Bundle\DoctrineFixturesBundle\Common\DataFixtures\Loader;
19		use Doctrine\Common\Persistence\ObjectManager;
20		use Doctrine\Common\DataFixtures\ProxyReferenceRepository;
21
22		class FixturesLoader
23		{
24		/**
25		* @param string $type
26		*
27		* @return string
28		*/
29	32	public static function getExecutorClass($type)
30		{
31	32	return 'PHPCR' === $type && class_exists('Doctrine\Bundle\PHPCRBundle\DataFixtures\PHPCRExecutor')
32	32	? 'Doctrine\Bundle\PHPCRBundle\DataFixtures\PHPCRExecutor'
33	32	: 'Doctrine\\Common\\DataFixtures\\Executor\\'.$type.'Executor';
34		}
35
36		/**
37		* Get file path of the SQLite database.
38		*
39		* @param Connection $connection
40		*
41		* @return string $name
42		*/
43	31	public static function getNameParameter(Connection $connection)
44		{
45	27	$params = $connection->getParams();
46
47	31	if (isset($params['master'])) {
48		$params = $params['master'];
49		}
50
51	27	$name = isset($params['path']) ? $params['path'] : (isset($params['dbname']) ? $params['dbname'] : false);
52
53	27	if (!$name) {
54		throw new \InvalidArgumentException("Connection does not contain a 'path' or 'dbname' parameter and cannot be dropped.");
55		}
56
57	27	return $name;
58		}
59
60		/**
61		* This function finds the time when the data blocks of a class definition
62		* file were being written to, that is, the time when the content of the
63		* file was changed.
64		*
65		* @param string $class The fully qualified class name of the fixture class to
66		* check modification date on.
67		*
68		* @return \DateTime\|null
69		*/
70	3	protected static function getFixtureLastModified($class)
71		{
72	3	$lastModifiedDateTime = null;
73
74	3	$reflClass = new \ReflectionClass($class);
75	3	$classFileName = $reflClass->getFileName();
76
77	3	if (file_exists($classFileName)) {
78	3	$lastModifiedDateTime = new \DateTime();
79	3	$lastModifiedDateTime->setTimestamp(filemtime($classFileName));
80	3	}
81
82	3	return $lastModifiedDateTime;
83		}
84
85		/**
86		* Determine if the Fixtures that define a database backup have been
87		* modified since the backup was made.
88		*
89		* @param array $classNames The fixture classnames to check
90		* @param string $backup The fixture backup SQLite database file path
91		*
92		* @return bool TRUE if the backup was made since the modifications to the
93		* fixtures; FALSE otherwise
94		*/
95	7	public static function isBackupUpToDate(array $classNames, $backup, $container)
96		{
97	7	$backupLastModifiedDateTime = new \DateTime();
98	7	$backupLastModifiedDateTime->setTimestamp(filemtime($backup));
99
100		/** @var \Symfony\Bridge\Doctrine\DataFixtures\ContainerAwareLoader $loader */
101	7	$loader = self::getFixtureLoader($container, $classNames);
102
103		// Use loader in order to fetch all the dependencies fixtures.
104	7	foreach ($loader->getFixtures() as $className) {
105	3	$fixtureLastModifiedDateTime = self::getFixtureLastModified($className);
106	3	if ($backupLastModifiedDateTime < $fixtureLastModifiedDateTime) {
107	1	return false;
108		}
109	7	}
110
111	7	return true;
112		}
113
114		/**
115		* Locate fixture files.
116		*
117		* @param array $paths
118		*
119		* @return array $files
120		*/
121	6	public static function locateResources($paths, $container)
122		{
123	6	$files = array();
124
125	6	$kernel = $container->get('kernel');
126
127	6	foreach ($paths as $path) {
128	6	if ($path[0] !== '@' && file_exists($path) === true) {
129	1	$files[] = $path;
130	1	continue;
131		}
132
133	5	$files[] = $kernel->locateResource($path);
134	6	}
135
136	6	return $files;
137		}
138
139		/**
140		* Retrieve Doctrine DataFixtures loader.
141		*
142		* @param ContainerInterface $container
143		* @param array $classNames
144		*
145		* @return Loader
146		*/
147	32	public static function getFixtureLoader(ContainerInterface $container, array $classNames)
148		{
149	32	$loaderClass = class_exists('Symfony\Bridge\Doctrine\DataFixtures\ContainerAwareLoader')
150	32	? 'Symfony\Bridge\Doctrine\DataFixtures\ContainerAwareLoader'
151	32	: (class_exists('Doctrine\Bundle\FixturesBundle\Common\DataFixtures\Loader')
152		// This class is not available during tests.
153		// @codeCoverageIgnoreStart
154		? 'Doctrine\Bundle\FixturesBundle\Common\DataFixtures\Loader'
155		// @codeCoverageIgnoreEnd
156	32	: 'Symfony\Bundle\DoctrineFixturesBundle\Common\DataFixtures\Loader');
157
158	32	$loader = new $loaderClass($container);
159
160	32	foreach ($classNames as $className) {
161	10	self::loadFixtureClass($loader, $className);
162	32	}
163
164	32	return $loader;
165		}
166
167		/**
168		* Purge database.
169		*
170		* @param ObjectManager $om
171		* @param string $type
172		* @param int $purgeMode
173		* @param string $executorClass
174		* @param ProxyReferenceRepository $referenceRepository
175		*/
176	26	public static function purgeDatabase(ObjectManager $om, $type, $purgeMode,
177		$executorClass,
178		ProxyReferenceRepository $referenceRepository,
179		$container)
180		{
181	26	$purgerClass = 'Doctrine\\Common\\DataFixtures\\Purger\\'.$type.'Purger';
182	26	if ('PHPCR' === $type) {
183	1	$purger = new $purgerClass($om);
184	1	$initManager = $container->has('doctrine_phpcr.initializer_manager')
185	1	? $container->get('doctrine_phpcr.initializer_manager')
186	1	: null;
187
188	1	$executor = new $executorClass($om, $purger, $initManager);
189	1	} else {
190	25	$purger = new $purgerClass();
191	25	if (null !== $purgeMode) {
192	1	$purger->setPurgeMode($purgeMode);
193	1	}
194
195	25	$executor = new $executorClass($om, $purger);
196		}
197
198	26	$executor->setReferenceRepository($referenceRepository);
199	26	$executor->purge();
200
201	26	return $executor;
202		}
203
204		/**
205		* Load a data fixture class.
206		*
207		* @param Loader $loader
208		* @param string $className
209		*/
210	10	protected static function loadFixtureClass($loader, $className)
211		{
212	10	$fixture = new $className();
213
214	10	if ($loader->hasFixture($fixture)) {
215	2	unset($fixture);
216
217	2	return;
218		}
219
220	10	$loader->addFixture($fixture);
221
222	10	if ($fixture instanceof DependentFixtureInterface) {
223	2	foreach ($fixture->getDependencies() as $dependency) {
224	2	self::loadFixtureClass($loader, $dependency);
225	2	}
226	2	}
227	10	}
228		}
229

liip / LiipFunctionalTestBundle

Pull Request — master (#271)

FixturesLoader::locateResources() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like