|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/* |
|
4
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
|
5
|
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
|
6
|
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
|
7
|
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
|
8
|
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
|
9
|
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
|
10
|
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
|
11
|
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
|
12
|
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
|
13
|
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
|
14
|
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
15
|
|
|
* |
|
16
|
|
|
* The software is based on the Axon Framework project which is |
|
17
|
|
|
* licensed under the Apache 2.0 license. For more information on the Axon Framework |
|
18
|
|
|
* see <http://www.axonframework.org/>. |
|
19
|
|
|
* |
|
20
|
|
|
* This software consists of voluntary contributions made by many individuals |
|
21
|
|
|
* and is licensed under the MIT license. For more information, see |
|
22
|
|
|
* <http://www.governor-framework.org/>. |
|
23
|
|
|
*/ |
|
24
|
|
|
|
|
25
|
|
|
namespace Governor\Framework\Test\Matchers; |
|
26
|
|
|
|
|
27
|
|
|
use Hamcrest\BaseMatcher; |
|
28
|
|
|
use Hamcrest\Description; |
|
29
|
|
|
|
|
30
|
|
|
/** |
|
31
|
|
|
* Description of EmptyCollectionMatcher |
|
32
|
|
|
* |
|
33
|
|
|
* @author "David Kalosi" <[email protected]> |
|
34
|
|
|
* @license <a href="http://www.opensource.org/licenses/mit-license.php">MIT License</a> |
|
35
|
|
|
*/ |
|
36
|
|
|
class EmptyCollectionMatcher extends BaseMatcher |
|
37
|
|
|
{ |
|
38
|
|
|
/** |
|
39
|
|
|
* @var string |
|
40
|
|
|
*/ |
|
41
|
|
|
private $contentDescription; |
|
42
|
|
|
|
|
43
|
|
|
/** |
|
44
|
|
|
* Creates a matcher of a list of empty items. The name of the item type (in plural) is passed in the given |
|
45
|
|
|
* <code>contentDescription</code> and will be part of the description of this matcher. |
|
46
|
|
|
* |
|
47
|
|
|
* @param string $contentDescription The description of the content type of the collection |
|
48
|
|
|
*/ |
|
49
|
3 |
|
public function __construct($contentDescription) |
|
50
|
|
|
{ |
|
51
|
3 |
|
$this->contentDescription = $contentDescription; |
|
52
|
3 |
|
} |
|
53
|
|
|
|
|
54
|
|
|
/** |
|
55
|
|
|
* @param array $item |
|
56
|
|
|
* @return boolean |
|
57
|
|
|
*/ |
|
58
|
3 |
|
public function matches($item) |
|
59
|
|
|
{ |
|
60
|
|
|
//return item instanceof Collection && ((Collection) item).isEmpty(); |
|
|
|
|
|
|
61
|
3 |
|
return is_array($item) && 0 === count($item); |
|
62
|
|
|
} |
|
63
|
|
|
|
|
64
|
|
|
/** |
|
65
|
|
|
* @param \Hamcrest\Description $description |
|
66
|
|
|
*/ |
|
67
|
1 |
|
public function describeTo(Description $description) |
|
68
|
|
|
{ |
|
69
|
1 |
|
$description->appendText("no "); |
|
70
|
1 |
|
$description->appendText($this->contentDescription); |
|
71
|
1 |
|
} |
|
72
|
|
|
|
|
73
|
|
|
} |
|
74
|
|
|
|
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.