I18nDataTest.php 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872
  1. <?php
  2. declare(strict_types=1);
  3. require_once dirname(__DIR__, 3) . '/cli/i18n/I18nData.php';
  4. require_once dirname(__DIR__, 3) . '/cli/i18n/I18nValue.php';
  5. final class I18nDataTest extends \PHPUnit\Framework\TestCase {
  6. /** @var array<string,array<string,array<string,I18nValue>>> */
  7. private array $referenceData;
  8. /** @var I18nValue&PHPUnit\Framework\MockObject\MockObject */
  9. private $value;
  10. #[\Override]
  11. public function setUp(): void {
  12. $this->value = $this->getMockBuilder(I18nValue::class)
  13. ->disableOriginalConstructor()
  14. ->getMock();
  15. $this->referenceData = [
  16. 'en' => [
  17. 'file1.php' => [
  18. 'file1.l1.l2.k1' => $this->value,
  19. 'file1.l1.l2.k2' => $this->value,
  20. ],
  21. 'file2.php' => [
  22. 'file2.l1.l2._' => $this->value,
  23. 'file2.l1.l2.k1' => $this->value,
  24. 'file2.l1.l2.k2' => $this->value,
  25. ],
  26. 'file3.php' => [
  27. 'file3.l1.l2._' => $this->value,
  28. 'file3.l1.l2.k1' => $this->value,
  29. ],
  30. ],
  31. ];
  32. }
  33. public function testMoveKey(): void {
  34. $data = new I18nData($this->referenceData);
  35. $value = $data->getData()['en']['file2.php']['file2.l1.l2.k2'];
  36. self::assertTrue($data->isKnown('file2.l1.l2.k2'));
  37. self::assertFalse($data->isKnown('file2.l1.nkl2'));
  38. $data->moveKey('file2.l1.l2.k2', 'file2.l1.nkl2');
  39. self::assertFalse($data->isKnown('file2.l1.l2.k2'));
  40. self::assertTrue($data->isKnown('file2.l1.nkl2'));
  41. }
  42. public function testConstructWhenReferenceOnly(): void {
  43. $data = new I18nData($this->referenceData);
  44. self::assertSame($this->referenceData, $data->getData());
  45. }
  46. public function testConstructorWhenLanguageIsMissingFile(): void {
  47. $rawData = array_merge($this->referenceData, [
  48. 'fr' => [
  49. 'file1.php' => [
  50. 'file1.l1.l2.k1' => $this->value,
  51. ],
  52. ],
  53. ]);
  54. $data = new I18nData($rawData);
  55. self::assertEquals([
  56. 'en' => [
  57. 'file1.php' => [
  58. 'file1.l1.l2.k1' => $this->value,
  59. 'file1.l1.l2.k2' => $this->value,
  60. ],
  61. 'file2.php' => [
  62. 'file2.l1.l2._' => $this->value,
  63. 'file2.l1.l2.k1' => $this->value,
  64. 'file2.l1.l2.k2' => $this->value,
  65. ],
  66. 'file3.php' => [
  67. 'file3.l1.l2._' => $this->value,
  68. 'file3.l1.l2.k1' => $this->value,
  69. ],
  70. ],
  71. 'fr' => [
  72. 'file1.php' => [
  73. 'file1.l1.l2.k1' => $this->value,
  74. 'file1.l1.l2.k2' => $this->value,
  75. ],
  76. 'file2.php' => [
  77. 'file2.l1.l2._' => $this->value,
  78. 'file2.l1.l2.k1' => $this->value,
  79. 'file2.l1.l2.k2' => $this->value,
  80. ],
  81. 'file3.php' => [
  82. 'file3.l1.l2._' => $this->value,
  83. 'file3.l1.l2.k1' => $this->value,
  84. ],
  85. ],
  86. ], $data->getData());
  87. }
  88. public function testConstructorWhenLanguageIsMissingKeys(): void {
  89. $rawData = array_merge($this->referenceData, [
  90. 'fr' => [
  91. 'file1.php' => [
  92. 'file1.l1.l2.k1' => $this->value,
  93. ],
  94. 'file2.php' => [
  95. 'file2.l1.l2.k1' => $this->value,
  96. ],
  97. ],
  98. ]);
  99. $data = new I18nData($rawData);
  100. self::assertEquals([
  101. 'en' => [
  102. 'file1.php' => [
  103. 'file1.l1.l2.k1' => $this->value,
  104. 'file1.l1.l2.k2' => $this->value,
  105. ],
  106. 'file2.php' => [
  107. 'file2.l1.l2._' => $this->value,
  108. 'file2.l1.l2.k1' => $this->value,
  109. 'file2.l1.l2.k2' => $this->value,
  110. ],
  111. 'file3.php' => [
  112. 'file3.l1.l2._' => $this->value,
  113. 'file3.l1.l2.k1' => $this->value,
  114. ],
  115. ],
  116. 'fr' => [
  117. 'file1.php' => [
  118. 'file1.l1.l2.k1' => $this->value,
  119. 'file1.l1.l2.k2' => $this->value,
  120. ],
  121. 'file2.php' => [
  122. 'file2.l1.l2._' => $this->value,
  123. 'file2.l1.l2.k1' => $this->value,
  124. 'file2.l1.l2.k2' => $this->value,
  125. ],
  126. 'file3.php' => [
  127. 'file3.l1.l2._' => $this->value,
  128. 'file3.l1.l2.k1' => $this->value,
  129. ],
  130. ],
  131. ], $data->getData());
  132. }
  133. public function testConstructorWhenLanguageHasExtraKeys(): void {
  134. $rawData = array_merge($this->referenceData, [
  135. 'fr' => [
  136. 'file1.php' => [
  137. 'file1.l1.l2.k1' => $this->value,
  138. 'file1.l1.l2.k2' => $this->value,
  139. 'file1.l1.l2.k3' => $this->value,
  140. ],
  141. 'file2.php' => [
  142. 'file2.l1.l2.k1' => $this->value,
  143. 'file2.l1.l2.k2' => $this->value,
  144. 'file2.l1.l2.k3' => $this->value,
  145. ],
  146. 'file3.php' => [
  147. 'file3.l1.l2._' => $this->value,
  148. 'file3.l1.l2.k1' => $this->value,
  149. ],
  150. ],
  151. ]);
  152. $data = new I18nData($rawData);
  153. self::assertEquals([
  154. 'en' => [
  155. 'file1.php' => [
  156. 'file1.l1.l2.k1' => $this->value,
  157. 'file1.l1.l2.k2' => $this->value,
  158. ],
  159. 'file2.php' => [
  160. 'file2.l1.l2._' => $this->value,
  161. 'file2.l1.l2.k1' => $this->value,
  162. 'file2.l1.l2.k2' => $this->value,
  163. ],
  164. 'file3.php' => [
  165. 'file3.l1.l2._' => $this->value,
  166. 'file3.l1.l2.k1' => $this->value,
  167. ],
  168. ],
  169. 'fr' => [
  170. 'file1.php' => [
  171. 'file1.l1.l2.k1' => $this->value,
  172. 'file1.l1.l2.k2' => $this->value,
  173. ],
  174. 'file2.php' => [
  175. 'file2.l1.l2._' => $this->value,
  176. 'file2.l1.l2.k1' => $this->value,
  177. 'file2.l1.l2.k2' => $this->value,
  178. ],
  179. 'file3.php' => [
  180. 'file3.l1.l2._' => $this->value,
  181. 'file3.l1.l2.k1' => $this->value,
  182. ],
  183. ],
  184. ], $data->getData());
  185. }
  186. public function testConstructorKeepsLocalePluralVariants(): void {
  187. $rawData = [
  188. 'en' => [
  189. 'gen.php' => [
  190. 'gen.interval.day.0' => $this->value,
  191. 'gen.interval.day.1' => $this->value,
  192. ],
  193. ],
  194. 'ru' => [
  195. 'gen.php' => [
  196. 'gen.interval.day.0' => $this->value,
  197. 'gen.interval.day.1' => $this->value,
  198. 'gen.interval.day.2' => $this->value,
  199. ],
  200. ],
  201. ];
  202. $data = new I18nData($rawData);
  203. self::assertArrayHasKey('gen.interval.day.2', $data->getLanguage('ru')['gen.php']);
  204. self::assertArrayNotHasKey('gen.interval.day.2', $data->getReferenceLanguage()['gen.php']);
  205. }
  206. public function testConstructorPrefillsMissingLocalePluralVariantsFromEnglishPlural(): void {
  207. $rawData = [
  208. 'en' => [
  209. 'gen.php' => [
  210. 'gen.interval.day.0' => new I18nValue('%d day ago'),
  211. 'gen.interval.day.1' => new I18nValue('%d days ago'),
  212. 'gen.interval.hour.0' => new I18nValue('%d hour ago'),
  213. 'gen.interval.hour.1' => new I18nValue('%d hours ago'),
  214. ],
  215. ],
  216. 'ru' => [
  217. 'gen.php' => [
  218. 'gen.interval.day.0' => new I18nValue('%d день назад'),
  219. 'gen.interval.day.1' => new I18nValue('%d дня назад'),
  220. 'gen.interval.day.2' => new I18nValue('%d дней назад'),
  221. ],
  222. ],
  223. ];
  224. $data = new I18nData($rawData);
  225. $ruTranslations = $data->getLanguage('ru')['gen.php'];
  226. self::assertSame('%d hour ago', $ruTranslations['gen.interval.hour.0']->getValue());
  227. self::assertSame('%d hours ago', $ruTranslations['gen.interval.hour.1']->getValue());
  228. self::assertSame('%d hours ago', $ruTranslations['gen.interval.hour.2']->getValue());
  229. self::assertTrue($ruTranslations['gen.interval.hour.0']->isTodo());
  230. self::assertTrue($ruTranslations['gen.interval.hour.1']->isTodo());
  231. self::assertTrue($ruTranslations['gen.interval.hour.2']->isTodo());
  232. }
  233. public function testConstructorMarksHigherLocalePluralVariantsAsTodoWhenEqualToEnglishPlural(): void {
  234. $rawData = [
  235. 'en' => [
  236. 'gen.php' => [
  237. 'gen.interval.day.0' => new I18nValue('%d day ago'),
  238. 'gen.interval.day.1' => new I18nValue('%d days ago'),
  239. ],
  240. ],
  241. 'ru' => [
  242. 'gen.php' => [
  243. 'gen.interval.day.0' => new I18nValue('%d день назад'),
  244. 'gen.interval.day.1' => new I18nValue('%d дня назад'),
  245. 'gen.interval.day.2' => new I18nValue('%d days ago'),
  246. ],
  247. ],
  248. ];
  249. $data = new I18nData($rawData);
  250. $ruTranslations = $data->getLanguage('ru')['gen.php'];
  251. self::assertFalse($ruTranslations['gen.interval.day.0']->isTodo());
  252. self::assertFalse($ruTranslations['gen.interval.day.1']->isTodo());
  253. self::assertTrue($ruTranslations['gen.interval.day.2']->isTodo());
  254. }
  255. public function testConstructorSkipsEnglishPluralVariantsNotUsedByOneFormLanguage(): void {
  256. $rawData = [
  257. 'en' => [
  258. 'gen.php' => [
  259. 'gen.interval.day.0' => new I18nValue('%d day ago'),
  260. 'gen.interval.day.1' => new I18nValue('%d days ago'),
  261. ],
  262. ],
  263. 'id' => [
  264. 'gen.php' => [
  265. 'gen.interval.day.0' => new I18nValue('%d hari yang lalu'),
  266. ],
  267. ],
  268. ];
  269. $data = new I18nData($rawData);
  270. $idTranslations = $data->getLanguage('id')['gen.php'];
  271. self::assertArrayHasKey('gen.interval.day.0', $idTranslations);
  272. self::assertArrayNotHasKey('gen.interval.day.1', $idTranslations);
  273. self::assertFalse($idTranslations['gen.interval.day.0']->isTodo());
  274. }
  275. public function testConstructorWhenValueIsIdenticalAndIsMarkedAsIgnore(): void {
  276. $value = $this->getMockBuilder(I18nValue::class)
  277. ->disableOriginalConstructor()
  278. ->getMock();
  279. $value->expects(self::exactly(2))
  280. ->method('isIgnore')
  281. ->willReturn(true);
  282. $value->expects(self::never())
  283. ->method('markAsTodo');
  284. $value->expects(self::exactly(3))
  285. ->method('equal')
  286. ->with($value)
  287. ->willReturn(true);
  288. $rawData = array_merge($this->referenceData, [
  289. 'fr' => [
  290. 'file2.php' => [
  291. 'file2.l1.l2.k1' => $value,
  292. ],
  293. ],
  294. ]);
  295. $rawData['en']['file2.php']['file2.l1.l2.k1'] = $value;
  296. new I18nData($rawData);
  297. }
  298. public function testConstructorWhenValueIsIdenticalAndIsNotMarkedAsIgnore(): void {
  299. $value = $this->getMockBuilder(I18nValue::class)
  300. ->disableOriginalConstructor()
  301. ->getMock();
  302. $value->expects(self::exactly(2))
  303. ->method('isIgnore')
  304. ->willReturn(false);
  305. $value->expects(self::exactly(2))
  306. ->method('markAsTodo');
  307. $value->expects(self::exactly(2))
  308. ->method('equal')
  309. ->with($value)
  310. ->willReturn(true);
  311. $rawData = array_merge($this->referenceData, [
  312. 'fr' => [
  313. 'file2.php' => [
  314. 'file2.l1.l2.k1' => $value,
  315. ],
  316. ],
  317. ]);
  318. $rawData['en']['file2.php']['file2.l1.l2.k1'] = $value;
  319. new I18nData($rawData);
  320. }
  321. public function testConstructorWhenValueIsDifferentAndIsMarkedAsToDo(): void {
  322. $value = $this->getMockBuilder(I18nValue::class)
  323. ->disableOriginalConstructor()
  324. ->getMock();
  325. $value->expects(self::once())
  326. ->method('isTodo')
  327. ->willReturn(true);
  328. $value->expects(self::once())
  329. ->method('markAsDirty');
  330. $rawData = array_merge($this->referenceData, [
  331. 'fr' => [
  332. 'file2.php' => [
  333. 'file2.l1.l2.k1' => $value,
  334. ],
  335. ],
  336. ]);
  337. new I18nData($rawData);
  338. }
  339. public function testConstructorWhenValueIsDifferentAndIsNotMarkedAsTodo(): void {
  340. $value = $this->getMockBuilder(I18nValue::class)
  341. ->disableOriginalConstructor()
  342. ->getMock();
  343. $value->expects(self::once())
  344. ->method('isTodo')
  345. ->willReturn(false);
  346. $value->expects(self::never())
  347. ->method('markAsDirty');
  348. $rawData = array_merge($this->referenceData, [
  349. 'fr' => [
  350. 'file2.php' => [
  351. 'file2.l1.l2.k1' => $value,
  352. ],
  353. ],
  354. ]);
  355. new I18nData($rawData);
  356. }
  357. public function testGetAvailableLanguagesWhenTheyAreSorted(): void {
  358. $rawData = array_merge($this->referenceData, [
  359. 'fr' => [],
  360. 'nl' => [],
  361. ]);
  362. $data = new I18nData($rawData);
  363. self::assertSame([
  364. 'en',
  365. 'fr',
  366. 'nl',
  367. ], $data->getAvailableLanguages());
  368. }
  369. public function testGetAvailableLanguagesWhenTheyAreNotSorted(): void {
  370. $rawData = array_merge($this->referenceData, [
  371. 'nl' => [],
  372. 'fr' => [],
  373. 'de' => [],
  374. ]);
  375. $data = new I18nData($rawData);
  376. self::assertSame([
  377. 'de',
  378. 'en',
  379. 'fr',
  380. 'nl',
  381. ], $data->getAvailableLanguages());
  382. }
  383. public function testAddLanguageWhenLanguageExists(): void {
  384. $this->expectException(\Exception::class);
  385. $this->expectExceptionMessage('The selected language already exists.');
  386. $data = new I18nData($this->referenceData);
  387. $data->addLanguage('en');
  388. }
  389. public function testAddLanguageWhenNoReferenceProvided(): void {
  390. $data = new I18nData($this->referenceData);
  391. $data->addLanguage('fr');
  392. self::assertSame([
  393. 'en' => [
  394. 'file1.php' => [
  395. 'file1.l1.l2.k1' => $this->value,
  396. 'file1.l1.l2.k2' => $this->value,
  397. ],
  398. 'file2.php' => [
  399. 'file2.l1.l2._' => $this->value,
  400. 'file2.l1.l2.k1' => $this->value,
  401. 'file2.l1.l2.k2' => $this->value,
  402. ],
  403. 'file3.php' => [
  404. 'file3.l1.l2._' => $this->value,
  405. 'file3.l1.l2.k1' => $this->value,
  406. ],
  407. ],
  408. 'fr' => [
  409. 'file1.php' => [
  410. 'file1.l1.l2.k1' => $this->value,
  411. 'file1.l1.l2.k2' => $this->value,
  412. ],
  413. 'file2.php' => [
  414. 'file2.l1.l2._' => $this->value,
  415. 'file2.l1.l2.k1' => $this->value,
  416. 'file2.l1.l2.k2' => $this->value,
  417. ],
  418. 'file3.php' => [
  419. 'file3.l1.l2._' => $this->value,
  420. 'file3.l1.l2.k1' => $this->value,
  421. ],
  422. ],
  423. ], $data->getData());
  424. }
  425. public function testAddLanguageWhenUnknownReferenceProvided(): void {
  426. $data = new I18nData($this->referenceData);
  427. $data->addLanguage('fr', 'unknown');
  428. self::assertSame([
  429. 'en' => [
  430. 'file1.php' => [
  431. 'file1.l1.l2.k1' => $this->value,
  432. 'file1.l1.l2.k2' => $this->value,
  433. ],
  434. 'file2.php' => [
  435. 'file2.l1.l2._' => $this->value,
  436. 'file2.l1.l2.k1' => $this->value,
  437. 'file2.l1.l2.k2' => $this->value,
  438. ],
  439. 'file3.php' => [
  440. 'file3.l1.l2._' => $this->value,
  441. 'file3.l1.l2.k1' => $this->value,
  442. ],
  443. ],
  444. 'fr' => [
  445. 'file1.php' => [
  446. 'file1.l1.l2.k1' => $this->value,
  447. 'file1.l1.l2.k2' => $this->value,
  448. ],
  449. 'file2.php' => [
  450. 'file2.l1.l2._' => $this->value,
  451. 'file2.l1.l2.k1' => $this->value,
  452. 'file2.l1.l2.k2' => $this->value,
  453. ],
  454. 'file3.php' => [
  455. 'file3.l1.l2._' => $this->value,
  456. 'file3.l1.l2.k1' => $this->value,
  457. ],
  458. ],
  459. ], $data->getData());
  460. }
  461. public function testAddLanguageWhenKnownReferenceProvided(): void {
  462. $data = new I18nData($this->referenceData);
  463. $data->addLanguage('fr', 'en');
  464. self::assertSame([
  465. 'en' => [
  466. 'file1.php' => [
  467. 'file1.l1.l2.k1' => $this->value,
  468. 'file1.l1.l2.k2' => $this->value,
  469. ],
  470. 'file2.php' => [
  471. 'file2.l1.l2._' => $this->value,
  472. 'file2.l1.l2.k1' => $this->value,
  473. 'file2.l1.l2.k2' => $this->value,
  474. ],
  475. 'file3.php' => [
  476. 'file3.l1.l2._' => $this->value,
  477. 'file3.l1.l2.k1' => $this->value,
  478. ],
  479. ],
  480. 'fr' => [
  481. 'file1.php' => [
  482. 'file1.l1.l2.k1' => $this->value,
  483. 'file1.l1.l2.k2' => $this->value,
  484. ],
  485. 'file2.php' => [
  486. 'file2.l1.l2._' => $this->value,
  487. 'file2.l1.l2.k1' => $this->value,
  488. 'file2.l1.l2.k2' => $this->value,
  489. ],
  490. 'file3.php' => [
  491. 'file3.l1.l2._' => $this->value,
  492. 'file3.l1.l2.k1' => $this->value,
  493. ],
  494. ],
  495. ], $data->getData());
  496. }
  497. public function testIsKnownWhenKeyExists(): void {
  498. $data = new I18nData($this->referenceData);
  499. self::assertTrue($data->isKnown('file2.l1.l2.k2'));
  500. }
  501. public function testIsKnownWhenKeyDoesNotExist(): void {
  502. $data = new I18nData($this->referenceData);
  503. self::assertFalse($data->isKnown('file2.l1.l2.k3'));
  504. }
  505. public function testAddKeyWhenKeyExists(): void {
  506. $this->expectException(\Exception::class);
  507. $this->expectExceptionMessage('The selected key already exists.');
  508. $data = new I18nData($this->referenceData);
  509. $data->addKey('file2.l1.l2.k1', 'value');
  510. }
  511. public function testAddKeyWhenParentKeyExists(): void {
  512. $rawData = array_merge($this->referenceData, [
  513. 'fr' => [],
  514. ]);
  515. $data = new I18nData($rawData);
  516. self::assertTrue($data->isKnown('file2.l1.l2.k1'));
  517. self::assertFalse($data->isKnown('file2.l1.l2.k1._'));
  518. self::assertFalse($data->isKnown('file2.l1.l2.k1.sk1'));
  519. $data->addKey('file2.l1.l2.k1.sk1', 'value');
  520. self::assertFalse($data->isKnown('file2.l1.l2.k1'));
  521. self::assertTrue($data->isKnown('file2.l1.l2.k1._'));
  522. self::assertTrue($data->isKnown('file2.l1.l2.k1.sk1'));
  523. }
  524. public function testAddKeyWhenKeyIsParent(): void {
  525. $rawData = array_merge($this->referenceData, [
  526. 'fr' => [],
  527. ]);
  528. $data = new I18nData($rawData);
  529. self::assertFalse($data->isKnown('file1.l1.l2._'));
  530. self::assertTrue($data->isKnown('file1.l1.l2.k1'));
  531. self::assertTrue($data->isKnown('file1.l1.l2.k2'));
  532. $data->addKey('file1.l1.l2', 'value');
  533. self::assertTrue($data->isKnown('file1.l1.l2._'));
  534. self::assertTrue($data->isKnown('file1.l1.l2.k1'));
  535. self::assertTrue($data->isKnown('file1.l1.l2.k2'));
  536. }
  537. public function testAddKey(): void {
  538. $getTargetedValue = static fn(I18nData $data, string $language) => $data->getData()[$language]['file2.php']['file2.l1.l2.k3'];
  539. $rawData = array_merge($this->referenceData, [
  540. 'fr' => [],
  541. ]);
  542. $data = new I18nData($rawData);
  543. self::assertFalse($data->isKnown('file2.l1.l2.k3'));
  544. $data->addKey('file2.l1.l2.k3', 'value');
  545. self::assertTrue($data->isKnown('file2.l1.l2.k3'));
  546. $enValue = $getTargetedValue($data, 'en');
  547. $frValue = $getTargetedValue($data, 'fr');
  548. self::assertInstanceOf(I18nValue::class, $enValue);
  549. self::assertSame('value', $enValue->getValue());
  550. self::assertTrue($enValue->isTodo());
  551. self::assertSame($frValue, $enValue);
  552. }
  553. public function testAddFileWhenNotPhpFile(): void {
  554. $this->expectException(\Exception::class);
  555. $this->expectExceptionMessage('The selected file name is not supported.');
  556. $data = new I18nData($this->referenceData);
  557. $data->addFile('file2');
  558. }
  559. public function testAddFileWhenAlreadyExists(): void {
  560. $this->expectException(\Exception::class);
  561. $this->expectExceptionMessage('The selected file exists already.');
  562. $data = new I18nData($this->referenceData);
  563. self::assertTrue($data->exists('file2.php'));
  564. $data->addFile('file2.php');
  565. }
  566. public function testAddFileWhenNotExists(): void {
  567. $data = new I18nData($this->referenceData);
  568. self::assertFalse($data->exists('newfile.php'));
  569. $data->addFile('newfile.php');
  570. self::assertTrue($data->exists('newfile.php'));
  571. }
  572. public function testAddValueWhenLanguageDoesNotExist(): void {
  573. $this->expectException(\Exception::class);
  574. $this->expectExceptionMessage('The selected language does not exist.');
  575. $data = new I18nData($this->referenceData);
  576. $data->addValue('file2.l1.l2.k2', 'new value', 'fr');
  577. }
  578. public function testAddValueWhenKeyDoesNotExist(): void {
  579. $this->expectException(\Exception::class);
  580. $this->expectExceptionMessage('The selected key does not exist for the selected language.');
  581. $data = new I18nData($this->referenceData);
  582. $data->addValue('unknown key', 'new value', 'en');
  583. }
  584. public function testAddValueWhenLanguageIsReferenceAndValueInOtherLanguageHasNotChange(): void {
  585. $getTargetedValue = static fn(I18nData $data, string $language) => $data->getData()[$language]['file2.php']['file2.l1.l2.k2'];
  586. $this->value->expects(self::atLeast(2))
  587. ->method('equal')
  588. ->with($this->value)
  589. ->willReturn(true);
  590. $rawData = array_merge($this->referenceData, [
  591. 'fr' => [],
  592. ]);
  593. $data = new I18nData($rawData);
  594. $beforeEnValue = $getTargetedValue($data, 'en');
  595. $beforeFrValue = $getTargetedValue($data, 'fr');
  596. $data->addValue('file2.l1.l2.k2', 'new value', 'en');
  597. $afterEnValue = $getTargetedValue($data, 'en');
  598. $afterFrValue = $getTargetedValue($data, 'fr');
  599. self::assertEquals($this->value, $beforeEnValue);
  600. self::assertEquals($this->value, $beforeFrValue);
  601. self::assertInstanceOf(I18nValue::class, $afterEnValue);
  602. self::assertSame('new value', $afterEnValue->getValue());
  603. self::assertInstanceOf(I18nValue::class, $afterFrValue);
  604. self::assertSame('new value', $afterFrValue->getValue());
  605. }
  606. public function testAddValueWhenLanguageIsReferenceAndValueInOtherLanguageHasChange(): void {
  607. $getTargetedValue = static fn(I18nData $data, string $language) => $data->getData()[$language]['file2.php']['file2.l1.l2.k2'];
  608. $this->value->expects(self::any())
  609. ->method('equal')
  610. ->with($this->value)
  611. ->willReturn(true);
  612. $value = $this->getMockBuilder(I18nValue::class)
  613. ->disableOriginalConstructor()
  614. ->getMock();
  615. $rawData = array_merge($this->referenceData, [
  616. 'fr' => [
  617. 'file2.php' => [
  618. 'file2.l1.l2.k2' => $value,
  619. ]
  620. ],
  621. ]);
  622. $data = new I18nData($rawData);
  623. $beforeEnValue = $getTargetedValue($data, 'en');
  624. $beforeFrValue = $getTargetedValue($data, 'fr');
  625. $data->addValue('file2.l1.l2.k2', 'new value', 'en');
  626. $afterEnValue = $getTargetedValue($data, 'en');
  627. $afterFrValue = $getTargetedValue($data, 'fr');
  628. self::assertEquals($this->value, $beforeEnValue);
  629. self::assertEquals($value, $beforeFrValue);
  630. self::assertInstanceOf(I18nValue::class, $afterEnValue);
  631. self::assertSame('new value', $afterEnValue->getValue());
  632. self::assertEquals($value, $afterFrValue);
  633. }
  634. public function testAddValueWhenLanguageIsNotReference(): void {
  635. $getTargetedValue = static fn(I18nData $data, string $language) => $data->getData()[$language]['file2.php']['file2.l1.l2.k2'];
  636. $rawData = array_merge($this->referenceData, [
  637. 'fr' => [],
  638. ]);
  639. $data = new I18nData($rawData);
  640. $beforeEnValue = $getTargetedValue($data, 'en');
  641. $beforeFrValue = $getTargetedValue($data, 'fr');
  642. $data->addValue('file2.l1.l2.k2', 'new value', 'fr');
  643. $afterEnValue = $getTargetedValue($data, 'en');
  644. $afterFrValue = $getTargetedValue($data, 'fr');
  645. self::assertEquals($this->value, $beforeEnValue);
  646. self::assertEquals($this->value, $beforeFrValue);
  647. self::assertEquals($this->value, $afterEnValue);
  648. self::assertInstanceOf(I18nValue::class, $afterFrValue);
  649. self::assertSame('new value', $afterFrValue->getValue());
  650. }
  651. public function testRemoveKeyWhenKeyDoesNotExist(): void {
  652. $this->expectException(\Exception::class);
  653. $this->expectExceptionMessage('The selected key does not exist.');
  654. $data = new I18nData($this->referenceData);
  655. $data->removeKey('Unknown key');
  656. }
  657. public function testRemoveKeyWhenKeyHasNoEmptySibling(): void {
  658. $this->expectException(\Exception::class);
  659. $this->expectExceptionMessage('The selected key does not exist.');
  660. $data = new I18nData($this->referenceData);
  661. $data->removeKey('file1.l1.l2');
  662. }
  663. public function testRemoveKeyWhenKeyIsEmptySibling(): void {
  664. $rawData = array_merge($this->referenceData, [
  665. 'fr' => [],
  666. ]);
  667. $data = new I18nData($rawData);
  668. $data->removeKey('file2.l1.l2');
  669. self::assertEquals([
  670. 'en' => [
  671. 'file1.php' => [
  672. 'file1.l1.l2.k1' => $this->value,
  673. 'file1.l1.l2.k2' => $this->value,
  674. ],
  675. 'file2.php' => [
  676. 'file2.l1.l2.k1' => $this->value,
  677. 'file2.l1.l2.k2' => $this->value,
  678. ],
  679. 'file3.php' => [
  680. 'file3.l1.l2._' => $this->value,
  681. 'file3.l1.l2.k1' => $this->value,
  682. ],
  683. ],
  684. 'fr' => [
  685. 'file1.php' => [
  686. 'file1.l1.l2.k1' => $this->value,
  687. 'file1.l1.l2.k2' => $this->value,
  688. ],
  689. 'file2.php' => [
  690. 'file2.l1.l2.k1' => $this->value,
  691. 'file2.l1.l2.k2' => $this->value,
  692. ],
  693. 'file3.php' => [
  694. 'file3.l1.l2._' => $this->value,
  695. 'file3.l1.l2.k1' => $this->value,
  696. ],
  697. ],
  698. ], $data->getData());
  699. }
  700. public function testRemoveKeyWhenKeyIsTheOnlyChild(): void {
  701. $rawData = array_merge($this->referenceData, [
  702. 'fr' => [],
  703. ]);
  704. $data = new I18nData($rawData);
  705. $data->removeKey('file3.l1.l2.k1');
  706. self::assertEquals([
  707. 'en' => [
  708. 'file1.php' => [
  709. 'file1.l1.l2.k1' => $this->value,
  710. 'file1.l1.l2.k2' => $this->value,
  711. ],
  712. 'file2.php' => [
  713. 'file2.l1.l2._' => $this->value,
  714. 'file2.l1.l2.k1' => $this->value,
  715. 'file2.l1.l2.k2' => $this->value,
  716. ],
  717. 'file3.php' => [
  718. 'file3.l1.l2' => $this->value,
  719. ],
  720. ],
  721. 'fr' => [
  722. 'file1.php' => [
  723. 'file1.l1.l2.k1' => $this->value,
  724. 'file1.l1.l2.k2' => $this->value,
  725. ],
  726. 'file2.php' => [
  727. 'file2.l1.l2._' => $this->value,
  728. 'file2.l1.l2.k1' => $this->value,
  729. 'file2.l1.l2.k2' => $this->value,
  730. ],
  731. 'file3.php' => [
  732. 'file3.l1.l2' => $this->value,
  733. ],
  734. ],
  735. ], $data->getData());
  736. }
  737. public function testIgnore(): void {
  738. $value = $this->getMockBuilder(I18nValue::class)
  739. ->disableOriginalConstructor()
  740. ->getMock();
  741. $value->expects(self::once())
  742. ->method('unmarkAsIgnore');
  743. $value->expects(self::exactly(2))
  744. ->method('markAsIgnore');
  745. $rawData = array_merge($this->referenceData, [
  746. 'fr' => [
  747. 'file1.php' => [
  748. 'file1.l1.l2.k1' => $value,
  749. ],
  750. ],
  751. ]);
  752. $data = new I18nData($rawData);
  753. $data->ignore('file1.l1.l2.k1', 'fr');
  754. $data->ignore('file1.l1.l2.k1', 'fr', true);
  755. $data->ignore('file1.l1.l2.k1', 'fr', false);
  756. }
  757. public function testIgnoreUnmodified(): void {
  758. $value = $this->getMockBuilder(I18nValue::class)
  759. ->disableOriginalConstructor()
  760. ->getMock();
  761. $value->expects(self::once())
  762. ->method('unmarkAsIgnore');
  763. $value->expects(self::exactly(2))
  764. ->method('markAsIgnore');
  765. $this->value->expects(self::atLeast(2))
  766. ->method('equal')
  767. ->with($value)
  768. ->willReturn(true);
  769. $rawData = array_merge($this->referenceData, [
  770. 'fr' => [
  771. 'file1.php' => [
  772. 'file1.l1.l2.k1' => $value,
  773. ],
  774. ],
  775. ]);
  776. $data = new I18nData($rawData);
  777. $data->ignore_unmodified('fr');
  778. $data->ignore_unmodified('fr', true);
  779. $data->ignore_unmodified('fr', false);
  780. }
  781. public function testGetLanguage(): void {
  782. $rawData = array_merge($this->referenceData, [
  783. 'fr' => [],
  784. 'nl' => [],
  785. ]);
  786. $data = new I18nData($rawData);
  787. self::assertSame($this->referenceData['en'], $data->getLanguage('en'));
  788. }
  789. public function testGetReferenceLanguage(): void {
  790. $rawData = array_merge($this->referenceData, [
  791. 'fr' => [],
  792. 'nl' => [],
  793. ]);
  794. $data = new I18nData($rawData);
  795. self::assertSame($this->referenceData['en'], $data->getReferenceLanguage());
  796. }
  797. }