Configuration::getBootstrap() - Code Metrics - Inspection of "Fix some documentation issues found in Scrutinizer" - brianium/paratest - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#203)

unknown

created 2016-05-07 17:45 UTC

Configuration::getBootstrap() A

↳ Parent: Configuration

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2.0625

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	0
loc	8
ccs	3
cts	4
cp	0.75
rs	9.4285
cc	2
eloc	5
nc	2
nop	0
crap	2.0625

<?php
namespace ParaTest\Runners\PHPUnit;

/**
 * Class Configuration
 *
 * Stores information about the phpunit xml
 * configuration being used to run tests
 *
 * @package ParaTest\Runners\PHPUnit
 */
class Configuration
{
    /**
     * Path to the configuration file
     *
     * @var string
     */
    protected $path;

    /**
     * @var \SimpleXMLElement
     */
    protected $xml;

    protected $availableNodes = array('exclude', 'file', 'directory', 'testsuite');

    /**
     * A collection of datastructures
     * build from the <testsuite> nodes inside of a
     * PHPUnit configuration
     *
     * @var array
     */
    protected $suites = array();

    public function __construct($path)
    {
        $this->path = $path;
        if (file_exists($path)) {
            $this->xml = simplexml_load_string(file_get_contents($path));
        }
    }

    /**
     * Get the bootstrap PHPUnit configuration attribute
     *
     * @return string The bootstrap attribute or empty string if not set
     */
    public function getBootstrap()
    {
        if ($this->xml) {
            return (string)$this->xml->attributes()->bootstrap;
        } else {
            return '';
        }
    }

    /**
     * Returns the path to the phpunit configuration
     * file
     *
     * @return string
     */
    public function getPath()
    {
        return $this->path;
    }

    /**
     * Return the contents of the <testsuite> nodes
     * contained in a PHPUnit configuration
     *
     * @return SuitePath[][]|null
     */
    public function getSuites()
    {
        if (!$this->xml) {
            return null;
        }
        $suites = array();
        $nodes  = $this->xml->xpath('//testsuites/testsuite');

        while (list(, $node) = each($nodes)) {
            $suites = array_merge_recursive($suites, $this->getSuiteByName((string)$node['name']));
        }
        return $suites;
    }

    /**
     * Return the contents of the <testsuite> nodes
     * contained in a PHPUnit configuration
     *
     * @param string $suiteName
     *
     * @return SuitePath[]|null
     */
    public function getSuiteByName($suiteName)
    {
        $nodes = $this->xml->xpath(sprintf('//testsuite[@name="%s"]', $suiteName));

        $suites        = array();
        $excludedPaths = array();
        while (list(, $node) = each($nodes)) {
            foreach ($this->availableNodes as $nodeName) {
                foreach ($node->{$nodeName} as $nodeContent) {
                    switch ($nodeName) {
                        case 'exclude':
                            foreach ($this->getSuitePaths((string)$nodeContent) as $excludedPath) {
                                $excludedPaths[$excludedPath] = $excludedPath;
                            }
                            break;
                        case 'testsuite':
                            $suites = array_merge_recursive($suites, $this->getSuiteByName((string)$nodeContent));
                            break;
                        case 'directory':
                            // Replicate behaviour of PHPUnit
                            // if a directory is included and excluded at the same time, then it is considered included
                            foreach ($this->getSuitePaths((string)$nodeContent) as $dir) {
                                if (array_key_exists($dir, $excludedPaths)) {
                                    unset($excludedPaths[$dir]);
                                }
                            }
                            // not breaking on purpose
                        default:
                            foreach ($this->getSuitePaths((string)$nodeContent) as $path) {
                                $suites[(string)$node['name']][] = new SuitePath(
                                    $path,
                                    $excludedPaths,
                                    $nodeContent->attributes()->suffix
                                );
                            }
                            break;
                    }
                }
            }
        }

        return $suites;
    }

    /**
     * Return the path of the directory
     * that contains the phpunit configuration
     *
     * @return string
     */
    public function getConfigDir()
    {
        return dirname($this->path).DIRECTORY_SEPARATOR;
    }

    /**
     * Returns a suite paths relative to the config file
     *
     * @param $path
     * @return array|string[]
     */
    public function getSuitePaths($path)
    {
        $real = realpath($this->getConfigDir().$path);

        if ($real !== false) {
            return array($real);
        }

        if ($this->isGlobRequired($path)) {
            $paths = array();
            foreach (glob($this->getConfigDir().$path, GLOB_ONLYDIR) as $path) {
                if (($path = realpath($path)) !== false) {
                    $paths[] = $path;
                }
            }
            return $paths;
        }

        throw new \RuntimeException("Suite path $path could not be found");
    }

    /**
     * Returns true if path needs globbing (like a /path/*-to/string)
     *
     * @param string $path
     * @return bool
     */
    public function isGlobRequired($path)
    {
        return strpos($path, '*') !== false;
    }

    /**
     * Converting the configuration to a string
     * returns the configuration path
     *
     * @return string
     */
    public function __toString()
    {
        return $this->path;
    }
}


1		<?php
2		namespace ParaTest\Runners\PHPUnit;
3
4		/**
5		* Class Configuration
6		*
7		* Stores information about the phpunit xml
8		* configuration being used to run tests
9		*
10		* @package ParaTest\Runners\PHPUnit
11		*/
12		class Configuration
13		{
14		/**
15		* Path to the configuration file
16		*
17		* @var string
18		*/
19		protected $path;
20
21		/**
22		* @var \SimpleXMLElement
23		*/
24		protected $xml;
25
26		protected $availableNodes = array('exclude', 'file', 'directory', 'testsuite');
27
28		/**
29		* A collection of datastructures
30		* build from the <testsuite> nodes inside of a
31		* PHPUnit configuration
32		*
33		* @var array
34		*/
35		protected $suites = array();
36
37	59	public function __construct($path)
38		{
39	59	$this->path = $path;
40	59	if (file_exists($path)) {
41	52	$this->xml = simplexml_load_string(file_get_contents($path));
42	52	}
43	59	}
44
45		/**
46		* Get the bootstrap PHPUnit configuration attribute
47		*
48		* @return string The bootstrap attribute or empty string if not set
49		*/
50	4	public function getBootstrap()
51		{
52	4	if ($this->xml) {
53	4	return (string)$this->xml->attributes()->bootstrap;
54		} else {
55		return '';
56		}
57		}
58
59		/**
60		* Returns the path to the phpunit configuration
61		* file
62		*
63		* @return string
64		*/
65	15	public function getPath()
66		{
67	15	return $this->path;
68		}
69
70		/**
71		* Return the contents of the <testsuite> nodes
72		* contained in a PHPUnit configuration
73		*
74		* @return SuitePath[][]\|null
75		*/
76	16	public function getSuites()
77		{
78	16	if (!$this->xml) {
79	1	return null;
80		}
81	15	$suites = array();
82	15	$nodes = $this->xml->xpath('//testsuites/testsuite');
83
84	15	while (list(, $node) = each($nodes)) {
85	15	$suites = array_merge_recursive($suites, $this->getSuiteByName((string)$node['name']));
86	14	}
87	14	return $suites;
88		}
89
90		/**
91		* Return the contents of the <testsuite> nodes
92		* contained in a PHPUnit configuration
93		*
94		* @param string $suiteName
95		*
96		* @return SuitePath[]\|null
97		*/
98	15	public function getSuiteByName($suiteName)
99		{
100	15	$nodes = $this->xml->xpath(sprintf('//testsuite[@name="%s"]', $suiteName));
101
102	15	$suites = array();
103	15	$excludedPaths = array();
104	15	while (list(, $node) = each($nodes)) {
105	15	foreach ($this->availableNodes as $nodeName) {
106	15	foreach ($node->{$nodeName} as $nodeContent) {
107		switch ($nodeName) {
108	15	case 'exclude':
109	3	foreach ($this->getSuitePaths((string)$nodeContent) as $excludedPath) {
110	3	$excludedPaths[$excludedPath] = $excludedPath;
111	3	}
112	3	break;
113	15	case 'testsuite':
114	1	$suites = array_merge_recursive($suites, $this->getSuiteByName((string)$nodeContent));
115	1	break;
116	15	case 'directory':
117		// Replicate behaviour of PHPUnit
118		// if a directory is included and excluded at the same time, then it is considered included
119	12	foreach ($this->getSuitePaths((string)$nodeContent) as $dir) {
120	11	if (array_key_exists($dir, $excludedPaths)) {
121	1	unset($excludedPaths[$dir]);
122	1	}
123	11	}
124		// not breaking on purpose
125	14	default:
126	14	foreach ($this->getSuitePaths((string)$nodeContent) as $path) {
127	14	$suites[(string)$node['name']][] = new SuitePath(
128	14	$path,
129	14	$excludedPaths,
130	14	$nodeContent->attributes()->suffix
131	14	);
132	14	}
133	14	break;
134	6	}
135	15	}
136	15	}
137	14	}
138
139	14	return $suites;
140		}
141
142		/**
143		* Return the path of the directory
144		* that contains the phpunit configuration
145		*
146		* @return string
147		*/
148	19	public function getConfigDir()
149		{
150	19	return dirname($this->path).DIRECTORY_SEPARATOR;
151		}
152
153		/**
154		* Returns a suite paths relative to the config file
155		*
156		* @param $path
157		* @return array\|string[]
158		*/
159	15	public function getSuitePaths($path)
160		{
161	15	$real = realpath($this->getConfigDir().$path);
162
163	15	if ($real !== false) {
164	13	return array($real);
165		}
166
167	2	if ($this->isGlobRequired($path)) {
168	1	$paths = array();
169	1	foreach (glob($this->getConfigDir().$path, GLOB_ONLYDIR) as $path) {
170	1	if (($path = realpath($path)) !== false) {
171	1	$paths[] = $path;
172	1	}
173	1	}
174	1	return $paths;
175		}
176
177	1	throw new \RuntimeException("Suite path $path could not be found");
178		}
179
180		/**
181		* Returns true if path needs globbing (like a /path/*-to/string)
182		*
183		* @param string $path
184		* @return bool
185		*/
186	2	public function isGlobRequired($path)
187		{
188	2	return strpos($path, '*') !== false;
189		}
190
191		/**
192		* Converting the configuration to a string
193		* returns the configuration path
194		*
195		* @return string
196		*/
197	3	public function __toString()
198		{
199	3	return $this->path;
200		}
201		}
202

brianium / paratest

Pull Request — master (#203)

Configuration::getBootstrap() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like