TAssertions::assertNull() - Code Metrics - Inspection of "removed data and testSuit annotations" - konecnyjakub/mytester - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b25a31...347863 )

by Jakub

created 2020-10-04 14:53 UTC

TAssertions::assertNull() A

↳ Parent: TAssertions

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes	3
Bugs	0	Features	1

Metric	Value
cc	2
eloc	3
c	3
b	0
f	1
nc	2
nop	1
dl	0
loc	4
ccs	4
cts	4
cp	1
crap	2
rs	10

<?php
declare(strict_types=1);

namespace MyTester;

trait TAssertions {
  /** @internal */
  protected int $taskCount = 0;
  /** @internal */
  protected bool $shouldFail = false;

  /**
   * Prints result of a test
   *
   * @internal
   */
  protected function testResult(string $text, bool $success = true): void {
    $this->incCounter();
    if($success) {
      return;
    }
    echo "Test $this->taskCount failed. $text\n";
  }

  /**
   * Increases task counter
   *
   * @internal
   */
  protected function incCounter(): void {
    $this->taskCount++;
  }

  /**
   * Resets task counter
   *
   * @internal
   */
  protected function resetCounter(): void {
    $this->taskCount = 0;
  }

  /**
   * @internal
   */
  protected function getCounter(): int {
    return $this->taskCount;
  }

  /**
   * @param string|array $variable
   */
  protected function showStringOrArray($variable): string {
    return (is_string($variable) ? $variable : "(array)");
  }

  protected function isSuccess(bool $success): bool {
    if($this->shouldFail) {
      $success = !$success;
    }
    return $success;
  }
  
  /**
   * Tries an assertion
   *
   * @param mixed $code Assertion to try
   */
  protected function assert($code, string $failureText = ""): void {
    $success = $this->isSuccess($code == true);
    if(!$success) {
      $message = ($failureText === "") ? "Assertion \"$code\" is not true." : $failureText;
    }
    $this->testResult($message ?? "", $success);
  }

  /**
   * Are both values same?
   *
   * @param mixed $expected
   * @param mixed $actual
   */
  protected function assertSame($expected, $actual): void {
    $success = $this->isSuccess($expected == $actual);
    $message = ($success) ? "" : "The value is not $expected but $actual.";
    $this->testResult($message, $success);
  }

  /**
   * Are not both values same?
   *
   * @param mixed $expected
   * @param mixed $actual
   */
  protected function assertNotSame($expected, $actual): void {
    $success = $this->isSuccess($expected !== $actual);
    $message = ($success) ? "" : "The value is $expected.";
    $this->testResult($message, $success);
  }

  /**
   * Is $actual equal to true?
   */
  protected function assertTrue(bool $actual): void {
    $success = $this->isSuccess($actual);
    $message = ($success) ? "" : "The value is not true.";
    $this->testResult($message, $success);
  }

  /**
   * Is the expression true?
   *
   * @param mixed $actual
   */
  protected function assertTruthy($actual): void {
    $success = $this->isSuccess($actual == true);
    $message = ($success) ? "" : "The expression is not true.";
    $this->testResult($message, $success);
  }

  /**
   * Is $actual equal to false?
   */
  protected function assertFalse(bool $actual): void {
    $success = $this->isSuccess(!$actual);
    $message = ($success) ? "" : "The value is not false.";
    $this->testResult($message, $success);
  }

  /**
   * Is the expression false?
   *
   * @param mixed $actual
   */
  protected function assertFalsey($actual): void {
    $success = $this->isSuccess($actual == false);
    $message = ($success) ? "" : "The expression is not false.";
    $this->testResult($message, $success);
  }

  /**
   * Is the value null?
   *
   * @param mixed $actual
   */
  protected function assertNull($actual): void {
    $success = $this->isSuccess($actual == null);
    $message = ($success) ? "" : "The value is not null.";
    $this->testResult($message ?? "", $success);
  }

  /**
   * Is not the value null?
   *
   * @param mixed $actual
   */
  protected function assertNotNull($actual): void {
    $success = $this->isSuccess($actual !== null);
    $message = ($success) ? "" : "The value is null.";
    $this->testResult($message, $success);
  }

  /**
   * Does $actual contain $needle?
   *
   * @param string|array $needle
   * @param string|array $actual
   */
  protected function assertContains($needle, $actual): void {
    if(!is_string($needle) && !is_array($needle)) {

      $this->testResult("The variable is not string or array.", false);
    } elseif(is_string($actual) && is_string($needle)) {
      $success = $this->isSuccess($needle !== "" && strpos($actual, $needle) !== false);
      if($success) {
        $this->testResult("");
      } else {
        $this->testResult("$needle is not in the variable.", false);
      }
    } elseif(is_array($actual)) {
      $success = $this->isSuccess(in_array($needle, $actual));
      $message = ($success) ? "" : $this->showStringOrArray($needle) . " is not in the variable.";
      $this->testResult($message, $success);
    } else {
      $this->testResult($this->showStringOrArray($needle) . " is not in the variable.", false);
    }
  }

  /**
   * Does $actual not contain $needle?
   *
   * @param string|array $needle
   * @param string|array $actual
   */
  protected function assertNotContains($needle, $actual): void {
    if(!is_string($needle) && !is_array($needle)) {

      $this->testResult("The variable is not string or array.", false);
    } elseif(is_string($actual) && is_string($needle)) {
      $success = $this->isSuccess($needle === "" || strpos($actual, $needle) === false);
      $message = ($success) ? "" : "$needle is in the variable.";
      $this->testResult($message, $success);
    } elseif(is_array($actual)) {
      $success = $this->isSuccess(!in_array($needle, $actual));
      if($success) {
        $this->testResult("");
      } else {
        $this->testResult($this->showStringOrArray($needle) . " is in the variable.", false);
      }
    } else {
      $this->testResult($this->showStringOrArray($needle) . " is not in the variable.", false);
    }
  }

  /**
   * Does $value contain $count items?
   *
   * @param string|array|\Countable $value
   */
  protected function assertCount(int $count, $value): void {
    if(!is_array($value) && !$value instanceof \Countable) {
      $this->testResult("The variable is not array or countable object.", false);
      return;
    }
    $actual = count($value);
    $success = $this->isSuccess($actual === $count);
    $message = ($success) ? "" : "Count of the variable is $actual.";
    $this->testResult($message, $success);
  }

  /**
   * Does $value not contain $count items?
   *
   * @param string|array|\Countable $value
   */
  protected function assertNotCount(int $count, $value): void {
    if(!is_array($value) && !$value instanceof \Countable) {
      $this->testResult("The variable is not array or countable object.", false);
      return;
    }
    $actual = count($value);
    $success = $this->isSuccess($actual !== $count);
    $message = ($success) ? "" : "Count of the variable is $actual.";
    $this->testResult($message, $success);
  }

  /**
   * Is $value of type $type?
   *
   * @param string|object $type
   * @param mixed $value
   */
  protected function assertType($type, $value): void {
    if(!is_object($type) && !is_string($type)) {

      $this->testResult("Type must be string or object.", false);
      return;
    }
    if(in_array($type, ["array", "bool", "float", "int", "string", "null", "object", "resource",
      "scalar", "iterable", "callable", ], true)) {
      $success = $this->isSuccess(call_user_func("is_$type", $value));
      $actual = gettype($value);
      $message = ($success) ? "" : "The variable is $actual.";
      $this->testResult($message, $success);
      return;
    }
    $success = $this->isSuccess($value instanceof $type);
    $actual = get_debug_type($value);
    $message = ($success) ? "" : "The variable is instance of $actual.";
    $this->testResult($message, $success);
  }
}
?>

1		<?php
2		declare(strict_types=1);
3
4		namespace MyTester;
5
6		trait TAssertions {
7		/** @internal */
8		protected int $taskCount = 0;
9		/** @internal */
10		protected bool $shouldFail = false;
11
12		/**
13		* Prints result of a test
14		*
15		* @internal
16		*/
17	1	protected function testResult(string $text, bool $success = true): void {
18	1	$this->incCounter();
19	1	if($success) {
20	1	return;
21		}
22	1	echo "Test $this->taskCount failed. $text\n";
23	1	}
24
25		/**
26		* Increases task counter
27		*
28		* @internal
29		*/
30	1	protected function incCounter(): void {
31	1	$this->taskCount++;
32	1	}
33
34		/**
35		* Resets task counter
36		*
37		* @internal
38		*/
39	1	protected function resetCounter(): void {
40	1	$this->taskCount = 0;
41	1	}
42
43		/**
44		* @internal
45		*/
46	1	protected function getCounter(): int {
47	1	return $this->taskCount;
48		}
49
50		/**
51		* @param string\|array $variable
52		*/
53		protected function showStringOrArray($variable): string {
54		return (is_string($variable) ? $variable : "(array)");
55		}
56
57	1	protected function isSuccess(bool $success): bool {
58	1	if($this->shouldFail) {
59	1	$success = !$success;
60		}
61	1	return $success;
62		}
63
64		/**
65		* Tries an assertion
66		*
67		* @param mixed $code Assertion to try
68		*/
69	1	protected function assert($code, string $failureText = ""): void {
70	1	$success = $this->isSuccess($code == true);
71	1	if(!$success) {
72		$message = ($failureText === "") ? "Assertion \"$code\" is not true." : $failureText;
73		}
74	1	$this->testResult($message ?? "", $success);
75	1	}
76
77		/**
78		* Are both values same?
79		*
80		* @param mixed $expected
81		* @param mixed $actual
82		*/
83	1	protected function assertSame($expected, $actual): void {
84	1	$success = $this->isSuccess($expected == $actual);
85	1	$message = ($success) ? "" : "The value is not $expected but $actual.";
86	1	$this->testResult($message, $success);
87	1	}
88
89		/**
90		* Are not both values same?
91		*
92		* @param mixed $expected
93		* @param mixed $actual
94		*/
95	1	protected function assertNotSame($expected, $actual): void {
96	1	$success = $this->isSuccess($expected !== $actual);
97	1	$message = ($success) ? "" : "The value is $expected.";
98	1	$this->testResult($message, $success);
99	1	}
100
101		/**
102		* Is $actual equal to true?
103		*/
104	1	protected function assertTrue(bool $actual): void {
105	1	$success = $this->isSuccess($actual);
106	1	$message = ($success) ? "" : "The value is not true.";
107	1	$this->testResult($message, $success);
108	1	}
109
110		/**
111		* Is the expression true?
112		*
113		* @param mixed $actual
114		*/
115	1	protected function assertTruthy($actual): void {
116	1	$success = $this->isSuccess($actual == true);
117	1	$message = ($success) ? "" : "The expression is not true.";
118	1	$this->testResult($message, $success);
119	1	}
120
121		/**
122		* Is $actual equal to false?
123		*/
124	1	protected function assertFalse(bool $actual): void {
125	1	$success = $this->isSuccess(!$actual);
126	1	$message = ($success) ? "" : "The value is not false.";
127	1	$this->testResult($message, $success);
128	1	}
129
130		/**
131		* Is the expression false?
132		*
133		* @param mixed $actual
134		*/
135	1	protected function assertFalsey($actual): void {
136	1	$success = $this->isSuccess($actual == false);
137	1	$message = ($success) ? "" : "The expression is not false.";
138	1	$this->testResult($message, $success);
139	1	}
140
141		/**
142		* Is the value null?
143		*
144		* @param mixed $actual
145		*/
146	1	protected function assertNull($actual): void {
147	1	$success = $this->isSuccess($actual == null);
148	1	$message = ($success) ? "" : "The value is not null.";
149	1	$this->testResult($message ?? "", $success);
150	1	}
151
152		/**
153		* Is not the value null?
154		*
155		* @param mixed $actual
156		*/
157	1	protected function assertNotNull($actual): void {
158	1	$success = $this->isSuccess($actual !== null);
159	1	$message = ($success) ? "" : "The value is null.";
160	1	$this->testResult($message, $success);
161	1	}
162
163		/**
164		* Does $actual contain $needle?
165		*
166		* @param string\|array $needle
167		* @param string\|array $actual
168		*/
169	1	protected function assertContains($needle, $actual): void {
170	1	if(!is_string($needle) && !is_array($needle)) {
		1 ignored issue – show introduced 2020-09-06 17:20 UTC by Report Bug Copy Issue Report The condition `is_array($needle)` is always `true`. Loading history...
171		$this->testResult("The variable is not string or array.", false);
172	1	} elseif(is_string($actual) && is_string($needle)) {
173	1	$success = $this->isSuccess($needle !== "" && strpos($actual, $needle) !== false);
174	1	if($success) {
175	1	$this->testResult("");
176		} else {
177	1	$this->testResult("$needle is not in the variable.", false);
178		}
179	1	} elseif(is_array($actual)) {
180	1	$success = $this->isSuccess(in_array($needle, $actual));
181	1	$message = ($success) ? "" : $this->showStringOrArray($needle) . " is not in the variable.";
182	1	$this->testResult($message, $success);
183		} else {
184		$this->testResult($this->showStringOrArray($needle) . " is not in the variable.", false);
185		}
186	1	}
187
188		/**
189		* Does $actual not contain $needle?
190		*
191		* @param string\|array $needle
192		* @param string\|array $actual
193		*/
194	1	protected function assertNotContains($needle, $actual): void {
195	1	if(!is_string($needle) && !is_array($needle)) {
		1 ignored issue – show introduced 2020-09-06 17:20 UTC by Report Bug Copy Issue Report The condition `is_array($needle)` is always `true`. Loading history...
196		$this->testResult("The variable is not string or array.", false);
197	1	} elseif(is_string($actual) && is_string($needle)) {
198	1	$success = $this->isSuccess($needle === "" \|\| strpos($actual, $needle) === false);
199	1	$message = ($success) ? "" : "$needle is in the variable.";
200	1	$this->testResult($message, $success);
201	1	} elseif(is_array($actual)) {
202	1	$success = $this->isSuccess(!in_array($needle, $actual));
203	1	if($success) {
204	1	$this->testResult("");
205		} else {
206	1	$this->testResult($this->showStringOrArray($needle) . " is in the variable.", false);
207		}
208		} else {
209		$this->testResult($this->showStringOrArray($needle) . " is not in the variable.", false);
210		}
211	1	}
212
213		/**
214		* Does $value contain $count items?
215		*
216		* @param string\|array\|\Countable $value
217		*/
218	1	protected function assertCount(int $count, $value): void {
219	1	if(!is_array($value) && !$value instanceof \Countable) {
220	1	$this->testResult("The variable is not array or countable object.", false);
221	1	return;
222		}
223	1	$actual = count($value);
224	1	$success = $this->isSuccess($actual === $count);
225	1	$message = ($success) ? "" : "Count of the variable is $actual.";
226	1	$this->testResult($message, $success);
227	1	}
228
229		/**
230		* Does $value not contain $count items?
231		*
232		* @param string\|array\|\Countable $value
233		*/
234	1	protected function assertNotCount(int $count, $value): void {
235	1	if(!is_array($value) && !$value instanceof \Countable) {
236	1	$this->testResult("The variable is not array or countable object.", false);
237	1	return;
238		}
239	1	$actual = count($value);
240	1	$success = $this->isSuccess($actual !== $count);
241	1	$message = ($success) ? "" : "Count of the variable is $actual.";
242	1	$this->testResult($message, $success);
243	1	}
244
245		/**
246		* Is $value of type $type?
247		*
248		* @param string\|object $type
249		* @param mixed $value
250		*/
251	1	protected function assertType($type, $value): void {
252	1	if(!is_object($type) && !is_string($type)) {
		1 ignored issue – show introduced 2020-09-06 17:20 UTC by Report Bug Copy Issue Report The condition `is_string($type)` is always `true`. Loading history...
253		$this->testResult("Type must be string or object.", false);
254		return;
255		}
256	1	if(in_array($type, ["array", "bool", "float", "int", "string", "null", "object", "resource",
257	1	"scalar", "iterable", "callable", ], true)) {
258	1	$success = $this->isSuccess(call_user_func("is_$type", $value));
259	1	$actual = gettype($value);
260	1	$message = ($success) ? "" : "The variable is $actual.";
261	1	$this->testResult($message, $success);
262	1	return;
263		}
264	1	$success = $this->isSuccess($value instanceof $type);
265	1	$actual = get_debug_type($value);
266	1	$message = ($success) ? "" : "The variable is instance of $actual.";
267	1	$this->testResult($message, $success);
268	1	}
269		}
270		?>

konecnyjakub / mytester

Push — master ( b25a31...347863 )

TAssertions::assertNull() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like