Skip to content

Commit 969cff0

Browse files
sebastianbergmannsebastianbergmann
committed
Refactor exception hierarchy
1 parent b100e6f commit 969cff0

File tree

14 files changed

+109
-97
lines changed

14 files changed

+109
-97
lines changed

‎src/CodeCoverage.php‎

Lines changed: 55 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,9 @@ class PHP_CodeCoverage
8989
/**
9090
* Constructor.
9191
*
92-
* @param PHP_CodeCoverage_Driver $driver
93-
* @param PHP_CodeCoverage_Filter $filter
94-
* @throws PHP_CodeCoverage_Exception
92+
* @param PHP_CodeCoverage_Driver $driver
93+
* @param PHP_CodeCoverage_Filter $filter
94+
* @throws PHP_CodeCoverage_RuntimeException
9595
*/
9696
public function __construct(PHP_CodeCoverage_Driver $driver = null, PHP_CodeCoverage_Filter $filter = null)
9797
{
@@ -200,14 +200,14 @@ public function setTests(array $tests)
200200
/**
201201
* Start collection of code coverage information.
202202
*
203-
* @param mixed $id
204-
* @param bool $clear
205-
* @throws PHP_CodeCoverage_Exception
203+
* @param mixed $id
204+
* @param bool $clear
205+
* @throws PHP_CodeCoverage_InvalidArgumentException
206206
*/
207207
public function start($id, $clear = false)
208208
{
209209
if (!is_bool($clear)) {
210-
throw PHP_CodeCoverage_Util_InvalidArgumentHelper::factory(
210+
throw PHP_CodeCoverage_InvalidArgumentException::create(
211211
1,
212212
'boolean'
213213
);
@@ -225,23 +225,23 @@ public function start($id, $clear = false)
225225
/**
226226
* Stop collection of code coverage information.
227227
*
228-
* @param bool $append
229-
* @param mixed $linesToBeCovered
230-
* @param array $linesToBeUsed
228+
* @param bool $append
229+
* @param mixed $linesToBeCovered
230+
* @param array $linesToBeUsed
231231
* @return array
232-
* @throws PHP_CodeCoverage_Exception
232+
* @throws PHP_CodeCoverage_InvalidArgumentException
233233
*/
234234
public function stop($append = true, $linesToBeCovered = [], array $linesToBeUsed = [])
235235
{
236236
if (!is_bool($append)) {
237-
throw PHP_CodeCoverage_Util_InvalidArgumentHelper::factory(
237+
throw PHP_CodeCoverage_InvalidArgumentException::create(
238238
1,
239239
'boolean'
240240
);
241241
}
242242

243243
if (!is_array($linesToBeCovered) && $linesToBeCovered !== false) {
244-
throw PHP_CodeCoverage_Util_InvalidArgumentHelper::factory(
244+
throw PHP_CodeCoverage_InvalidArgumentException::create(
245245
2,
246246
'array or false'
247247
);
@@ -258,12 +258,12 @@ public function stop($append = true, $linesToBeCovered = [], array $linesToBeUse
258258
/**
259259
* Appends code coverage data.
260260
*
261-
* @param array $data
262-
* @param mixed $id
263-
* @param bool $append
264-
* @param mixed $linesToBeCovered
265-
* @param array $linesToBeUsed
266-
* @throws PHP_CodeCoverage_Exception
261+
* @param array $data
262+
* @param mixed $id
263+
* @param bool $append
264+
* @param mixed $linesToBeCovered
265+
* @param array $linesToBeUsed
266+
* @throws PHP_CodeCoverage_RuntimeException
267267
*/
268268
public function append(array $data, $id = null, $append = true, $linesToBeCovered = [], array $linesToBeUsed = [])
269269
{
@@ -272,7 +272,7 @@ public function append(array $data, $id = null, $append = true, $linesToBeCovere
272272
}
273273

274274
if ($id === null) {
275-
throw new PHP_CodeCoverage_Exception;
275+
throw new PHP_CodeCoverage_RuntimeException;
276276
}
277277

278278
$this->applyListsFilter($data);
@@ -375,14 +375,14 @@ public function merge(PHP_CodeCoverage $that)
375375
}
376376

377377
/**
378-
* @param bool $flag
379-
* @throws PHP_CodeCoverage_Exception
378+
* @param bool $flag
379+
* @throws PHP_CodeCoverage_InvalidArgumentException
380380
* @since Method available since Release 1.1.0
381381
*/
382382
public function setCacheTokens($flag)
383383
{
384384
if (!is_bool($flag)) {
385-
throw PHP_CodeCoverage_Util_InvalidArgumentHelper::factory(
385+
throw PHP_CodeCoverage_InvalidArgumentException::create(
386386
1,
387387
'boolean'
388388
);
@@ -400,14 +400,14 @@ public function getCacheTokens()
400400
}
401401

402402
/**
403-
* @param bool $flag
404-
* @throws PHP_CodeCoverage_Exception
403+
* @param bool $flag
404+
* @throws PHP_CodeCoverage_InvalidArgumentException
405405
* @since Method available since Release 2.0.0
406406
*/
407407
public function setCheckForUnintentionallyCoveredCode($flag)
408408
{
409409
if (!is_bool($flag)) {
410-
throw PHP_CodeCoverage_Util_InvalidArgumentHelper::factory(
410+
throw PHP_CodeCoverage_InvalidArgumentException::create(
411411
1,
412412
'boolean'
413413
);
@@ -417,13 +417,13 @@ public function setCheckForUnintentionallyCoveredCode($flag)
417417
}
418418

419419
/**
420-
* @param bool $flag
421-
* @throws PHP_CodeCoverage_Exception
420+
* @param bool $flag
421+
* @throws PHP_CodeCoverage_InvalidArgumentException
422422
*/
423423
public function setForceCoversAnnotation($flag)
424424
{
425425
if (!is_bool($flag)) {
426-
throw PHP_CodeCoverage_Util_InvalidArgumentHelper::factory(
426+
throw PHP_CodeCoverage_InvalidArgumentException::create(
427427
1,
428428
'boolean'
429429
);
@@ -433,13 +433,13 @@ public function setForceCoversAnnotation($flag)
433433
}
434434

435435
/**
436-
* @param bool $flag
437-
* @throws PHP_CodeCoverage_Exception
436+
* @param bool $flag
437+
* @throws PHP_CodeCoverage_InvalidArgumentException
438438
*/
439439
public function setMapTestClassNameToCoveredClassName($flag)
440440
{
441441
if (!is_bool($flag)) {
442-
throw PHP_CodeCoverage_Util_InvalidArgumentHelper::factory(
442+
throw PHP_CodeCoverage_InvalidArgumentException::create(
443443
1,
444444
'boolean'
445445
);
@@ -449,13 +449,13 @@ public function setMapTestClassNameToCoveredClassName($flag)
449449
}
450450

451451
/**
452-
* @param bool $flag
453-
* @throws PHP_CodeCoverage_Exception
452+
* @param bool $flag
453+
* @throws PHP_CodeCoverage_InvalidArgumentException
454454
*/
455455
public function setAddUncoveredFilesFromWhitelist($flag)
456456
{
457457
if (!is_bool($flag)) {
458-
throw PHP_CodeCoverage_Util_InvalidArgumentHelper::factory(
458+
throw PHP_CodeCoverage_InvalidArgumentException::create(
459459
1,
460460
'boolean'
461461
);
@@ -465,13 +465,13 @@ public function setAddUncoveredFilesFromWhitelist($flag)
465465
}
466466

467467
/**
468-
* @param bool $flag
469-
* @throws PHP_CodeCoverage_Exception
468+
* @param bool $flag
469+
* @throws PHP_CodeCoverage_InvalidArgumentException
470470
*/
471471
public function setProcessUncoveredFilesFromWhitelist($flag)
472472
{
473473
if (!is_bool($flag)) {
474-
throw PHP_CodeCoverage_Util_InvalidArgumentHelper::factory(
474+
throw PHP_CodeCoverage_InvalidArgumentException::create(
475475
1,
476476
'boolean'
477477
);
@@ -481,13 +481,13 @@ public function setProcessUncoveredFilesFromWhitelist($flag)
481481
}
482482

483483
/**
484-
* @param bool $flag
485-
* @throws PHP_CodeCoverage_Exception
484+
* @param bool $flag
485+
* @throws PHP_CodeCoverage_InvalidArgumentException
486486
*/
487487
public function setDisableIgnoredLines($flag)
488488
{
489489
if (!is_bool($flag)) {
490-
throw PHP_CodeCoverage_Util_InvalidArgumentHelper::factory(
490+
throw PHP_CodeCoverage_InvalidArgumentException::create(
491491
1,
492492
'boolean'
493493
);
@@ -499,10 +499,10 @@ public function setDisableIgnoredLines($flag)
499499
/**
500500
* Applies the @covers annotation filtering.
501501
*
502-
* @param array $data
503-
* @param mixed $linesToBeCovered
504-
* @param array $linesToBeUsed
505-
* @throws PHP_CodeCoverage_Exception_UnintentionallyCoveredCode
502+
* @param array $data
503+
* @param mixed $linesToBeCovered
504+
* @param array $linesToBeUsed
505+
* @throws PHP_CodeCoverage_UnintentionallyCoveredCodeException
506506
*/
507507
private function applyCoversAnnotationFilter(array &$data, $linesToBeCovered, array $linesToBeUsed)
508508
{
@@ -650,15 +650,15 @@ private function processUncoveredFileFromWhitelist($uncoveredFile, array &$data,
650650
/**
651651
* Returns the lines of a source file that should be ignored.
652652
*
653-
* @param string $filename
653+
* @param string $filename
654654
* @return array
655-
* @throws PHP_CodeCoverage_Exception
655+
* @throws PHP_CodeCoverage_InvalidArgumentException
656656
* @since Method available since Release 2.0.0
657657
*/
658658
private function getLinesToBeIgnored($filename)
659659
{
660660
if (!is_string($filename)) {
661-
throw PHP_CodeCoverage_Util_InvalidArgumentHelper::factory(
661+
throw PHP_CodeCoverage_InvalidArgumentException::create(
662662
1,
663663
'string'
664664
);
@@ -822,10 +822,10 @@ private function getLinesToBeIgnored($filename)
822822
}
823823

824824
/**
825-
* @param array $data
826-
* @param array $linesToBeCovered
827-
* @param array $linesToBeUsed
828-
* @throws PHP_CodeCoverage_Exception_UnintentionallyCoveredCode
825+
* @param array $data
826+
* @param array $linesToBeCovered
827+
* @param array $linesToBeUsed
828+
* @throws PHP_CodeCoverage_UnintentionallyCoveredCodeException
829829
* @since Method available since Release 2.0.0
830830
*/
831831
private function performUnintentionallyCoveredCodeCheck(array &$data, array $linesToBeCovered, array $linesToBeUsed)
@@ -852,7 +852,7 @@ private function performUnintentionallyCoveredCodeCheck(array &$data, array $lin
852852
}
853853

854854
if (!empty($message)) {
855-
throw new PHP_CodeCoverage_Exception_UnintentionallyCoveredCode(
855+
throw new PHP_CodeCoverage_UnintentionallyCoveredCodeException(
856856
$message
857857
);
858858
}
@@ -901,14 +901,14 @@ private function getAllowedLines(array $linesToBeCovered, array $linesToBeUsed)
901901

902902
/**
903903
* @return PHP_CodeCoverage_Driver
904-
* @throws PHP_CodeCoverage_Exception
904+
* @throws PHP_CodeCoverage_RuntimeException
905905
*/
906906
private function selectDriver()
907907
{
908908
$runtime = new Runtime;
909909

910910
if (!$runtime->canCollectCodeCoverage()) {
911-
throw new PHP_CodeCoverage_Exception('No code coverage driver available');
911+
throw new PHP_CodeCoverage_RuntimeException('No code coverage driver available');
912912
}
913913

914914
if ($runtime->isHHVM()) {

‎src/CodeCoverage/Driver/PHPDBG.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ class PHP_CodeCoverage_Driver_PHPDBG implements PHP_CodeCoverage_Driver
2222
public function __construct()
2323
{
2424
if (PHP_SAPI !== 'phpdbg') {
25-
throw new PHP_CodeCoverage_Exception(
25+
throw new PHP_CodeCoverage_RuntimeException(
2626
'This driver requires the PHPDBG SAPI'
2727
);
2828
}
2929

3030
if (!function_exists('phpdbg_start_oplog')) {
31-
throw new PHP_CodeCoverage_Exception(
31+
throw new PHP_CodeCoverage_RuntimeException(
3232
'This build of PHPDBG does not support code coverage'
3333
);
3434
}

‎src/CodeCoverage/Driver/Xdebug.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ class PHP_CodeCoverage_Driver_Xdebug implements PHP_CodeCoverage_Driver
2222
public function __construct()
2323
{
2424
if (!extension_loaded('xdebug')) {
25-
throw new PHP_CodeCoverage_Exception('This driver requires Xdebug');
25+
throw new PHP_CodeCoverage_RuntimeException('This driver requires Xdebug');
2626
}
2727

2828
if (version_compare(phpversion('xdebug'), '2.2.0-dev', '>=') &&
2929
!ini_get('xdebug.coverage_enable')) {
30-
throw new PHP_CodeCoverage_Exception(
30+
throw new PHP_CodeCoverage_RuntimeException(
3131
'xdebug.coverage_enable=On has to be set in php.ini'
3232
);
3333
}

‎src/CodeCoverage/Exception.php‎ renamed to ‎src/CodeCoverage/Exception/Exception.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99
*/
1010

1111
/**
12-
* Exception class for PHP_CodeCoverage component.
12+
* Exception interface for PHP_CodeCoverage component.
1313
*
14-
* @since Class available since Release 1.1.0
14+
* @since Interface available since Release 3.0.0
1515
*/
16-
class PHP_CodeCoverage_Exception extends RuntimeException
16+
interface PHP_CodeCoverage_Exception
1717
{
1818
}

‎src/CodeCoverage/Util/InvalidArgumentHelper.php‎ renamed to ‎src/CodeCoverage/Exception/InvalidArgumentException.php‎

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,21 @@
99
*/
1010

1111
/**
12-
* Factory for PHP_CodeCoverage_Exception objects that are used to describe
13-
* invalid arguments passed to a function or method.
14-
*
15-
* @since Class available since Release 1.2.0
12+
* @since Class available since Release 3.0.0
1613
*/
17-
class PHP_CodeCoverage_Util_InvalidArgumentHelper
14+
class PHP_CodeCoverage_InvalidArgumentException extends InvalidArgumentException implements PHP_CodeCoverage_Exception
1815
{
1916
/**
20-
* @param int $argument
21-
* @param string $type
22-
* @param mixed $value
23-
* @return PHP_CodeCoverage_Exception
17+
* @param int $argument
18+
* @param string $type
19+
* @param mixed $value
20+
* @return PHP_CodeCoverage_InvalidArgumentException
2421
*/
25-
public static function factory($argument, $type, $value = null)
22+
public static function create($argument, $type, $value = null)
2623
{
2724
$stack = debug_backtrace(false);
2825

29-
return new PHP_CodeCoverage_Exception(
26+
return new self(
3027
sprintf(
3128
'Argument #%d%sof %s::%s() must be a %s',
3229
$argument,

‎src/CodeCoverage/Exception/RuntimeException.php‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?php
2+
/*
3+
* This file is part of the PHP_CodeCoverage package.
4+
*
5+
* (c) Sebastian Bergmann <[email protected]>
6+
*
7+
* For the full copyright and license information, please view the LICENSE
8+
* file that was distributed with this source code.
9+
*/
10+
11+
/**
12+
* @since Class available since Release 3.0.0
13+
*/
14+
class PHP_CodeCoverage_RuntimeException extends RuntimeException implements PHP_CodeCoverage_Exception
15+
{
16+
}

‎src/CodeCoverage/Exception/UnintentionallyCoveredCode.php‎ renamed to ‎src/CodeCoverage/Exception/UnintentionallyCoveredCodeException.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@
1313
*
1414
* @since Class available since Release 2.0.0
1515
*/
16-
class PHP_CodeCoverage_Exception_UnintentionallyCoveredCode extends PHP_CodeCoverage_Exception
16+
class PHP_CodeCoverage_UnintentionallyCoveredCodeException extends PHP_CodeCoverage_RuntimeException
1717
{
1818
}

‎src/CodeCoverage/Filter.php‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,9 +197,8 @@ public function isFile($filename)
197197
* When the whitelist is empty (default), blacklisting is used.
198198
* When the whitelist is not empty, whitelisting is used.
199199
*
200-
* @param string $filename
200+
* @param string $filename
201201
* @return bool
202-
* @throws PHP_CodeCoverage_Exception
203202
*/
204203
public function isFiltered($filename)
205204
{

0 commit comments

Comments
 (0)