| Total Complexity | 55 |
| Total Lines | 251 |
| Duplicated Lines | 0 % |
| Changes | 2 | ||
| Bugs | 0 | Features | 1 |
Complex classes like TAssertions often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use TAssertions, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 6 | trait TAssertions { |
||
| 7 | /** |
||
| 8 | * @param string|array $variable |
||
| 9 | */ |
||
| 10 | protected function showStringOrArray($variable): string { |
||
| 12 | } |
||
| 13 | |||
| 14 | protected function isSuccess(bool $success): bool { |
||
| 15 | if(Environment::getShouldFail()) { |
||
| 16 | $success = !$success; |
||
| 17 | } |
||
| 18 | return $success; |
||
| 19 | } |
||
| 20 | |||
| 21 | /** |
||
| 22 | * Tries an assertion |
||
| 23 | * |
||
| 24 | * @param mixed $code Assertion to try |
||
| 25 | */ |
||
| 26 | protected function assert($code, string $failureText = ""): void { |
||
| 27 | $success = $this->isSuccess($code == true); |
||
| 28 | if(!$success) { |
||
| 29 | $message = ($failureText === "") ? "Assertion \"$code\" is not true." : $failureText; |
||
| 30 | } |
||
| 31 | Environment::testResult($message ?? "", $success); |
||
| 32 | } |
||
| 33 | |||
| 34 | /** |
||
| 35 | * Are both values same? |
||
| 36 | * |
||
| 37 | * @param mixed $expected |
||
| 38 | * @param mixed $actual |
||
| 39 | */ |
||
| 40 | protected function assertSame($expected, $actual): void { |
||
| 41 | $success = $this->isSuccess($expected == $actual); |
||
| 42 | if(!$success) { |
||
| 43 | $message = "The value is not $expected but $actual."; |
||
| 44 | } |
||
| 45 | Environment::testResult($message ?? "", $success); |
||
| 46 | } |
||
| 47 | |||
| 48 | /** |
||
| 49 | * Are not both values same? |
||
| 50 | * |
||
| 51 | * @param mixed $expected |
||
| 52 | * @param mixed $actual |
||
| 53 | */ |
||
| 54 | protected function assertNotSame($expected, $actual): void { |
||
| 60 | } |
||
| 61 | |||
| 62 | /** |
||
| 63 | * Is $actual equal to true? |
||
| 64 | */ |
||
| 65 | protected function assertTrue(bool $actual): void { |
||
| 66 | $success = $this->isSuccess($actual); |
||
| 67 | if(!$success) { |
||
| 68 | $message = "The value is not true."; |
||
| 69 | } |
||
| 70 | Environment::testResult($message ?? "", $success); |
||
| 71 | } |
||
| 72 | |||
| 73 | /** |
||
| 74 | * Is the expression true? |
||
| 75 | * |
||
| 76 | * @param mixed $actual |
||
| 77 | */ |
||
| 78 | protected function assertTruthy($actual): void { |
||
| 79 | $success = $this->isSuccess($actual == true); |
||
| 80 | if(!$success) { |
||
| 81 | $message = "The expression is not true."; |
||
| 82 | } |
||
| 83 | Environment::testResult($message ?? "", $success); |
||
| 84 | } |
||
| 85 | |||
| 86 | /** |
||
| 87 | * Is $actual equal to false? |
||
| 88 | */ |
||
| 89 | protected function assertFalse(bool $actual): void { |
||
| 90 | $success = $this->isSuccess(!$actual); |
||
| 91 | if(!$success) { |
||
| 92 | $message = "The value is not false."; |
||
| 93 | } |
||
| 94 | Environment::testResult($message ?? "", $success); |
||
| 95 | } |
||
| 96 | |||
| 97 | /** |
||
| 98 | * Is the expression false? |
||
| 99 | * |
||
| 100 | * @param mixed $actual |
||
| 101 | */ |
||
| 102 | protected function assertFalsey($actual): void { |
||
| 103 | $success = $this->isSuccess($actual == false); |
||
| 104 | if(!$success) { |
||
| 105 | $message = "The expression is not false."; |
||
| 106 | } |
||
| 107 | Environment::testResult($message ?? "", $success); |
||
| 108 | } |
||
| 109 | |||
| 110 | /** |
||
| 111 | * Is the value null? |
||
| 112 | * |
||
| 113 | * @param mixed $actual |
||
| 114 | */ |
||
| 115 | protected function assertNull($actual): void { |
||
| 116 | $success = $this->isSuccess($actual == null); |
||
| 117 | if(!$success) { |
||
| 118 | $message = "The value is not null."; |
||
| 119 | } |
||
| 120 | Environment::testResult($message ?? "", $success); |
||
| 121 | } |
||
| 122 | |||
| 123 | /** |
||
| 124 | * Is not the value null? |
||
| 125 | * |
||
| 126 | * @param mixed $actual |
||
| 127 | */ |
||
| 128 | protected function assertNotNull($actual): void { |
||
| 134 | } |
||
| 135 | |||
| 136 | /** |
||
| 137 | * Does $actual contain $needle? |
||
| 138 | * |
||
| 139 | * @param string|array $needle |
||
| 140 | * @param string|array $actual |
||
| 141 | */ |
||
| 142 | protected function assertContains($needle, $actual): void { |
||
| 161 | } |
||
| 162 | } |
||
| 163 | |||
| 164 | /** |
||
| 165 | * Does $actual not contain $needle? |
||
| 166 | * |
||
| 167 | * @param string|array $needle |
||
| 168 | * @param string|array $actual |
||
| 169 | */ |
||
| 170 | protected function assertNotContains($needle, $actual): void { |
||
| 189 | } |
||
| 190 | } |
||
| 191 | |||
| 192 | /** |
||
| 193 | * Does $value contain $count items? |
||
| 194 | * |
||
| 195 | * @param string|array|\Countable $value |
||
| 196 | */ |
||
| 197 | protected function assertCount(int $count, $value): void { |
||
| 208 | } |
||
| 209 | } |
||
| 210 | |||
| 211 | /** |
||
| 212 | * Does $value not contain $count items? |
||
| 213 | * |
||
| 214 | * @param string|array|\Countable $value |
||
| 215 | */ |
||
| 216 | protected function assertNotCount(int $count, $value): void { |
||
| 217 | if(!is_array($value) && !$value instanceof \Countable) { |
||
| 218 | Environment::testResult("The variable is not array or countable object.", false); |
||
| 219 | return; |
||
| 220 | } |
||
| 221 | $success = $this->isSuccess(count($value) !== $count); |
||
| 222 | if($success) { |
||
| 223 | Environment::testResult(""); |
||
| 224 | } else { |
||
| 225 | $actual = count($value); |
||
| 226 | Environment::testResult("Count of the variable is $actual.", false); |
||
| 227 | } |
||
| 228 | } |
||
| 229 | |||
| 230 | /** |
||
| 231 | * Is $value of type $type? |
||
| 232 | * |
||
| 233 | * @param string|object $type |
||
| 234 | * @param mixed $value |
||
| 235 | */ |
||
| 236 | protected function assertType($type, $value): void { |
||
| 257 | } |
||
| 258 | } |
||
| 259 | } |
||
| 260 | ?> |