|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Atrapalo\PHPTools\Tester\Enum; |
|
4
|
|
|
|
|
5
|
|
|
use Atrapalo\PHPTools\Enum\Enum; |
|
6
|
|
|
use Atrapalo\PHPTools\Parser\PHPDocClass; |
|
7
|
|
|
|
|
8
|
|
|
/** |
|
9
|
|
|
* Class EnumPHPDocTester |
|
10
|
|
|
* @package Atrapalo\PHPTools\Enum |
|
11
|
|
|
* |
|
12
|
|
|
* @author Guillermo González <[email protected]> |
|
13
|
|
|
*/ |
|
14
|
|
|
trait EnumTester |
|
15
|
|
|
{ |
|
16
|
|
|
/** |
|
17
|
|
|
* @return string |
|
18
|
|
|
*/ |
|
19
|
|
|
abstract protected function enumClass(): string; |
|
20
|
|
|
|
|
21
|
|
|
/** |
|
22
|
|
|
* @test |
|
23
|
|
|
*/ |
|
24
|
|
|
public function invalidConstructor() |
|
25
|
|
|
{ |
|
26
|
|
|
/** @var Enum $enumClass */ |
|
27
|
|
|
$enumClass = $this->enumClass(); |
|
28
|
|
|
$value = md5(openssl_random_pseudo_bytes(32)); |
|
29
|
|
|
|
|
30
|
|
|
$exception = $enumClass::customInvalidValueException($value); |
|
31
|
|
|
|
|
32
|
|
|
$this->expectException(get_class($exception)); |
|
|
|
|
|
|
33
|
|
|
$this->expectExceptionMessage($exception->getMessage()); |
|
|
|
|
|
|
34
|
|
|
|
|
35
|
|
|
new $enumClass($value); |
|
36
|
|
|
} |
|
37
|
|
|
|
|
38
|
|
|
/** |
|
39
|
|
|
* @test |
|
40
|
|
|
*/ |
|
41
|
|
|
public function callInvalidStaticMethod() |
|
42
|
|
|
{ |
|
43
|
|
|
/** @var Enum $enumClass */ |
|
44
|
|
|
$enumClass = $this->enumClass(); |
|
45
|
|
|
$method = md5(openssl_random_pseudo_bytes(32)); |
|
46
|
|
|
|
|
47
|
|
|
$exception = $enumClass::customUnknownStaticMethodException($method); |
|
48
|
|
|
|
|
49
|
|
|
$this->expectException(get_class($exception)); |
|
|
|
|
|
|
50
|
|
|
$this->expectExceptionMessage($exception->getMessage()); |
|
|
|
|
|
|
51
|
|
|
|
|
52
|
|
|
call_user_func([$enumClass, $method]); |
|
53
|
|
|
} |
|
54
|
|
|
|
|
55
|
|
|
/** |
|
56
|
|
|
* @test |
|
57
|
|
|
*/ |
|
58
|
|
|
public function callInvalidMethod() |
|
59
|
|
|
{ |
|
60
|
|
|
/** @var Enum $enumClass */ |
|
61
|
|
|
$enumClass = $this->enumClass(); |
|
62
|
|
|
|
|
63
|
|
|
$enum = $this->createValidEnum($enumClass); |
|
64
|
|
|
$method = md5(openssl_random_pseudo_bytes(32)); |
|
65
|
|
|
|
|
66
|
|
|
$exception = $enumClass::customUnknownMethodException($method); |
|
67
|
|
|
|
|
68
|
|
|
$this->expectException(get_class($exception)); |
|
|
|
|
|
|
69
|
|
|
$this->expectExceptionMessage($exception->getMessage()); |
|
|
|
|
|
|
70
|
|
|
|
|
71
|
|
|
$enum->$method(); |
|
72
|
|
|
} |
|
73
|
|
|
|
|
74
|
|
|
/** |
|
75
|
|
|
* @test |
|
76
|
|
|
*/ |
|
77
|
|
|
public function staticAccessByPhpDoc() |
|
78
|
|
|
{ |
|
79
|
|
|
$className = $this->enumClass(); |
|
80
|
|
|
|
|
81
|
|
|
$staticMethods = PHPDocClass::staticMethods($className); |
|
82
|
|
|
if (!empty($staticMethods)) { |
|
83
|
|
|
foreach ($staticMethods as $staticMethod) { |
|
84
|
|
|
$data = call_user_func([$className, $staticMethod->name()]); |
|
85
|
|
|
|
|
86
|
|
|
$this->assertInstanceOf($className, $data); |
|
|
|
|
|
|
87
|
|
|
} |
|
88
|
|
|
} else { |
|
89
|
|
|
$this->markTestSkipped('Skipped because no static methods were found for '.get_called_class()); |
|
|
|
|
|
|
90
|
|
|
} |
|
91
|
|
|
} |
|
92
|
|
|
|
|
93
|
|
|
/** |
|
94
|
|
|
* @test |
|
95
|
|
|
*/ |
|
96
|
|
|
public function accessByPhpDoc() |
|
97
|
|
|
{ |
|
98
|
|
|
$className = $this->enumClass(); |
|
99
|
|
|
|
|
100
|
|
|
$methods = PHPDocClass::methods($className); |
|
101
|
|
|
if (!empty($methods)) { |
|
102
|
|
|
|
|
103
|
|
|
$enum = $this->createValidEnum($className); |
|
104
|
|
|
$actualMethod = $this->snakeCaseToCamelCase("IS_".$enum->key()); |
|
105
|
|
|
foreach ($methods as $method) { |
|
106
|
|
|
$methodName = $method->name(); |
|
107
|
|
|
if ($methodName === $actualMethod) { |
|
108
|
|
|
$this->assertTrue($enum->$methodName()); |
|
|
|
|
|
|
109
|
|
|
} else { |
|
110
|
|
|
$this->assertFalse($enum->$methodName()); |
|
|
|
|
|
|
111
|
|
|
} |
|
112
|
|
|
} |
|
113
|
|
|
} else { |
|
114
|
|
|
$this->markTestSkipped('Skipped because no methods were found for '.get_called_class()); |
|
|
|
|
|
|
115
|
|
|
} |
|
116
|
|
|
} |
|
117
|
|
|
|
|
118
|
|
|
/** |
|
119
|
|
|
* @param Enum|string $className |
|
120
|
|
|
* @return Enum |
|
121
|
|
|
*/ |
|
122
|
|
|
private function createValidEnum($className) |
|
123
|
|
|
{ |
|
124
|
|
|
$values = $className::toArray(); |
|
125
|
|
|
|
|
126
|
|
|
return new $className($values[array_rand($values)]); |
|
127
|
|
|
} |
|
128
|
|
|
|
|
129
|
|
|
/** |
|
130
|
|
|
* @param string $string |
|
131
|
|
|
* @return string |
|
132
|
|
|
*/ |
|
133
|
|
|
private function snakeCaseToCamelCase(string $string): string |
|
134
|
|
|
{ |
|
135
|
|
|
return preg_replace_callback('/_(.?)/', function($matches) { |
|
136
|
|
|
return ucfirst($matches[1]); |
|
137
|
|
|
}, strtolower($string)); |
|
138
|
|
|
} |
|
139
|
|
|
} |
This check looks for methods that are used by a trait but not required by it.
To illustrate, let’s look at the following code example
The trait
Idableprovides a methodequalsIdthat in turn relies on the methodgetId(). If this method does not exist on a class mixing in this trait, the method will fail.Adding the
getId()as an abstract method to the trait will make sure it is available.