forked from sebastianbergmann/phpunit
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathStringContains.php
More file actions
160 lines (134 loc) · 4.3 KB
/
Copy pathStringContains.php
File metadata and controls
160 lines (134 loc) · 4.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<?php declare(strict_types=1);
/*
* This file is part of PHPUnit.
*
* (c) Sebastian Bergmann <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function is_string;
use function mb_detect_encoding;
use function mb_stripos;
use function mb_strtolower;
use function sprintf;
use function str_contains;
use function strlen;
use function strtr;
use SebastianBergmann\Exporter\Exporter;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*/
final class StringContains extends Constraint
{
private readonly string $needle;
private readonly bool $ignoreCase;
private readonly bool $ignoreLineEndings;
public function __construct(string $needle, bool $ignoreCase = false, bool $ignoreLineEndings = false)
{
if ($ignoreLineEndings) {
$needle = $this->normalizeLineEndings($needle);
}
$this->needle = $needle;
$this->ignoreCase = $ignoreCase;
$this->ignoreLineEndings = $ignoreLineEndings;
}
/**
* Returns a string representation of the constraint.
*/
public function toString(): string
{
$needle = $this->needle;
if ($this->ignoreCase) {
$needle = mb_strtolower($this->needle, 'UTF-8');
}
return sprintf(
'contains "%s" [%s](length: %s)',
$needle,
$this->getDetectedEncoding($needle),
strlen($needle),
);
}
public function failureDescription(mixed $other): string
{
$stringifiedHaystack = (new Exporter)->export($other);
$haystackEncoding = $this->getDetectedEncoding($other);
$haystackLength = $this->getHaystackLength($other);
$haystackInformation = sprintf(
'%s [%s](length: %s) ',
$stringifiedHaystack,
$haystackEncoding,
$haystackLength,
);
$needleInformation = $this->toString();
return $haystackInformation . $needleInformation;
}
/**
* Evaluates the constraint for parameter $other. Returns true if the
* constraint is met, false otherwise.
*/
protected function matches(mixed $other): bool
{
$haystack = $other;
if ('' === $this->needle) {
return true;
}
if (!is_string($haystack)) {
return false;
}
if ($this->ignoreLineEndings) {
$haystack = $this->normalizeLineEndings($haystack);
}
if ($this->ignoreCase) {
/*
* We must use the multibyte-safe version, so we can accurately compare non-latin uppercase characters with
* their lowercase equivalents.
*/
return mb_stripos($haystack, $this->needle, 0, 'UTF-8') !== false;
}
/*
* Use the non-multibyte safe functions to see if the string is contained in $other.
*
* This function is very fast, and we don't care about the character position in the string.
*
* Additionally, we want this method to be binary safe, so we can check if some binary data is in other binary
* data.
*/
return str_contains($haystack, $this->needle);
}
private function getDetectedEncoding(mixed $other): string
{
if ($this->ignoreCase) {
return 'Encoding ignored';
}
if (!is_string($other)) {
return 'Encoding detection failed';
}
$detectedEncoding = mb_detect_encoding($other, null, true);
if ($detectedEncoding === false) {
return 'Encoding detection failed';
}
return $detectedEncoding;
}
private function getHaystackLength(mixed $haystack): int
{
if (!is_string($haystack)) {
return 0;
}
if ($this->ignoreLineEndings) {
$haystack = $this->normalizeLineEndings($haystack);
}
return strlen($haystack);
}
private function normalizeLineEndings(string $string): string
{
return strtr(
$string,
[
"\r\n" => "\n",
"\r" => "\n",
],
);
}
}