forked from joomla-framework/string
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathInflectorTest.php
More file actions
405 lines (347 loc) · 11.2 KB
/
Copy pathInflectorTest.php
File metadata and controls
405 lines (347 loc) · 11.2 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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
<?php
/**
* @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
namespace Joomla\String\Tests;
use Doctrine\Common\Inflector\Inflector as DoctrineInflector;
use Joomla\String\Inflector;
use Joomla\Test\TestHelper;
use PHPUnit\Framework\TestCase;
/**
* Test for the Inflector class.
*
* @link http://en.wikipedia.org/wiki/English_plural
* @since 1.0
*/
class InflectorTest extends TestCase
{
/**
* @var Inflector
*/
protected $inflector;
/**
* Method to seed data to testIsCountable.
*
* @return \Generator
*/
public function seedIsCountable(): \Generator
{
yield ['id', true];
yield ['title', false];
}
/**
* Method to seed data to testToPlural.
*
* @return \Generator
*
* @since 1.0
*/
public function seedSinglePlural(): \Generator
{
// Regular plurals
yield ['bus', 'buses'];
yield ['notify', 'notifies'];
yield ['click', 'clicks'];
// Almost regular plurals.
yield ['photo', 'photos'];
yield ['zero', 'zeros'];
// Irregular identicals
yield ['salmon', 'salmon'];
// Irregular plurals
yield ['ox', 'oxen'];
yield ['quiz', 'quizzes'];
yield ['status', 'statuses'];
yield ['matrix', 'matrices'];
yield ['index', 'indices'];
yield ['vertex', 'vertices'];
yield ['hive', 'hives'];
// Ablaut plurals
yield ['foot', 'feet'];
yield ['louse', 'lice'];
yield ['man', 'men'];
yield ['mouse', 'mice'];
yield ['tooth', 'teeth'];
yield ['woman', 'women'];
}
/**
* Sets up the fixture.
*
* This method is called before a test is executed.
*
* @return void
*/
protected function setUp(): void
{
parent::setUp();
$this->inflector = Inflector::getInstance(true);
DoctrineInflector::reset();
}
/**
* Tears down the fixture, for example, close a network connection.
* This method is called after a test is executed.
*
* @return void
*/
protected function tearDown(): void
{
DoctrineInflector::reset();
parent::tearDown();
}
/**
* @testdox A rule cannot be added to the inflector if it is of an unsupported type
*/
public function testAddRuleException()
{
$this->expectException(\InvalidArgumentException::class);
/** @noinspection PhpParamsInspection */
TestHelper::invoke($this->inflector, 'addRule', new \stdClass(), 'singular');
}
/**
* @testdox A countable rule can be added to the inflector
*/
public function testAddCountableRule()
{
// Add string.
$this->inflector->addCountableRule('foo');
$countable = TestHelper::getValue($this->inflector, 'countable');
$this->assertContains(
'foo',
$countable['rules'],
'Checks a countable rule was added.'
);
// Add array.
$this->inflector->addCountableRule(['goo', 'car']);
$countable = TestHelper::getValue($this->inflector, 'countable');
$this->assertContains(
'car',
$countable['rules'],
'Checks a countable rule was added by array.'
);
}
/**
* @testdox A word can be added to the inflector without a plural form
*/
public function testAddWordWithoutPlural()
{
if (!$this->checkInflectorImplementation($this->inflector)) {
$this->markTestSkipped('This test depends on the library\'s implementation');
}
$this->assertSame(
$this->inflector,
$this->inflector->addWord('foo')
);
$plural = TestHelper::getValue(DoctrineInflector::class, 'plural');
$this->assertTrue(
in_array('foo', $plural['uninflected'])
);
$singular = TestHelper::getValue(DoctrineInflector::class, 'singular');
$this->assertTrue(
in_array('foo', $singular['uninflected'])
);
}
/**
* @testdox A word can be added to the inflector with a plural form
*/
public function testAddWordWithPlural()
{
if (!$this->checkInflectorImplementation($this->inflector)) {
$this->markTestSkipped('This test depends on the library\'s implementation');
}
$this->assertEquals(
$this->inflector,
$this->inflector->addWord('bar', 'foo')
);
$plural = TestHelper::getValue(DoctrineInflector::class, 'plural');
$this->assertArrayHasKey(
'foo',
$plural['irregular']
);
$singular = TestHelper::getValue(DoctrineInflector::class, 'singular');
$this->assertArrayHasKey(
'bar',
$singular['irregular']
);
}
/**
* @testdox A pluralisation rule can be added to the inflector
*/
public function testAddPluraliseRule()
{
if (!$this->checkInflectorImplementation($this->inflector)) {
$this->markTestSkipped('This test depends on the library\'s implementation');
}
$this->assertSame(
$this->inflector->addPluraliseRule(['/^(custom)$/i' => '\1izables']),
$this->inflector,
'Checks chaining.'
);
$plural = TestHelper::getValue(DoctrineInflector::class, 'plural');
$this->assertArrayHasKey(
'/^(custom)$/i',
$plural['rules'],
'Checks a pluralisation rule was added.'
);
}
/**
* @testdox A singularisation rule can be added to the inflector
*/
public function testAddSingulariseRule()
{
if (!$this->checkInflectorImplementation($this->inflector)) {
$this->markTestSkipped('This test depends on the library\'s implementation');
}
$this->assertSame(
$this->inflector->addSingulariseRule(['/^(inflec|contribu)tors$/i' => '\1ta']),
$this->inflector,
'Checks chaining.'
);
$singular = TestHelper::getValue(DoctrineInflector::class, 'singular');
$this->assertArrayHasKey(
'/^(inflec|contribu)tors$/i',
$singular['rules'],
'Checks a singularisation rule was added.'
);
}
/**
* @testdox The singleton instance of the inflector can be retrieved
*/
public function testGetInstance()
{
$this->assertInstanceOf(
Inflector::class,
Inflector::getInstance(),
'Check getInstance returns the right class.'
);
$this->assertNotSame(
Inflector::getInstance(),
Inflector::getInstance(true),
'getInstance with the new flag should not return the singleton instance'
);
}
/**
* @testdox A string is checked to determine if it a countable word
*
* @param string $input A string.
* @param boolean $expected The expected result of the function call.
*
* @dataProvider seedIsCountable
*/
public function testIsCountable(string $input, bool $expected)
{
$this->assertEquals(
$expected,
$this->inflector->isCountable($input)
);
}
/**
* @testdox A string is checked to determine if it is in plural form
*
* @param string $singular The singular form of a word.
* @param string $plural The plural form of a word.
*
* @dataProvider seedSinglePlural
*/
public function testIsPlural(string $singular, string $plural)
{
if ($singular === 'bus' && !$this->checkInflectorImplementation($this->inflector)) {
$this->markTestSkipped('"bus/buses" is not known to the new implementation');
}
$this->assertTrue(
$this->inflector->isPlural($plural),
"'$plural' should be reported as plural"
);
if ($singular !== $plural) {
$this->assertFalse(
$this->inflector->isPlural($singular),
"'$singular' should not be reported as a plural form in comparison to '$plural'"
);
}
}
/**
* @testdox A string is checked to determine if it is in singular form
*
* @param string $singular The singular form of a word.
* @param string $plural The plural form of a word.
*
* @dataProvider seedSinglePlural
*/
public function testIsSingular(string $singular, string $plural)
{
if ($singular === 'bus' && !$this->checkInflectorImplementation($this->inflector)) {
$this->markTestSkipped('"bus/buses" is not known to the new implementation');
}
$this->assertTrue(
$this->inflector->isSingular($singular),
"'$singular' should be reported as singular"
);
if ($singular !== $plural) {
$this->assertFalse(
$this->inflector->isSingular($plural),
"'$plural' should not be reported as a singular form in comparison to '$singular'"
);
}
}
/**
* @testdox A string is converted to its plural form
*
* @param string $singular The singular form of a word.
* @param string $plural The plural form of a word.
*
* @dataProvider seedSinglePlural
*/
public function testToPlural(string $singular, string $plural)
{
$this->assertSame(
$plural,
$this->inflector->toPlural($singular),
"'$plural' should be the plural form of '$singular'"
);
}
/**
* @testdox A string that is already plural is returned in the same form
*/
public function testToPluralAlreadyPlural()
{
$this->assertSame(
'buses',
$this->inflector->toPlural('buses'),
"'buses' should not be pluralised'"
);
}
/**
* @testdox A string is converted to its singular form
*
* @param string $singular The singular form of a word.
* @param string $plural The plural form of a word.
*
* @dataProvider seedSinglePlural
*/
public function testToSingular(string $singular, string $plural)
{
$this->assertSame(
$singular,
$this->inflector->toSingular($plural),
"'$singular' should be the singular form of '$plural'"
);
}
/**
* @testdox A string that is already singular is returned in the same form
*/
public function testToSingularAlreadySingular()
{
if (!$this->checkInflectorImplementation($this->inflector)) {
$this->markTestSkipped('"bus/buses" is not known to the new implementation');
}
$this->assertSame(
'bus',
$this->inflector->toSingular('bus'),
"'bus' should not be singularised'"
);
}
private function checkInflectorImplementation(DoctrineInflector $inflector): bool
{
$reflectionClass = new \ReflectionClass($inflector);
return $reflectionClass->hasProperty('plural');
}
}