SingleLineAfterImportsFixerTest.php 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529
  1. <?php
  2. declare(strict_types=1);
  3. /*
  4. * This file is part of PHP CS Fixer.
  5. *
  6. * (c) Fabien Potencier <fabien@symfony.com>
  7. * Dariusz Rumiński <dariusz.ruminski@gmail.com>
  8. *
  9. * This source file is subject to the MIT license that is bundled
  10. * with this source code in the file LICENSE.
  11. */
  12. namespace PhpCsFixer\Tests\Fixer\Import;
  13. use PhpCsFixer\Tests\Test\AbstractFixerTestCase;
  14. use PhpCsFixer\WhitespacesFixerConfig;
  15. /**
  16. * @author Ceeram <ceeram@cakephp.org>
  17. *
  18. * @internal
  19. *
  20. * @covers \PhpCsFixer\Fixer\Import\SingleLineAfterImportsFixer
  21. */
  22. final class SingleLineAfterImportsFixerTest extends AbstractFixerTestCase
  23. {
  24. /**
  25. * @dataProvider provideFixCases
  26. */
  27. public function testFix(string $expected, ?string $input = null): void
  28. {
  29. $this->doTest($expected, $input);
  30. }
  31. public static function provideFixCases(): iterable
  32. {
  33. yield [
  34. '<?php
  35. use D;
  36. use E;
  37. use DP; /**/
  38. use EZ; //
  39. use DAZ;
  40. use EGGGG; /**/
  41. use A\B;
  42. use C\DE;
  43. use E\F;
  44. use G\H;
  45. ',
  46. '<?php
  47. use D; use E;
  48. use DP; /**/ use EZ; //
  49. use DAZ; use EGGGG; /**/
  50. use A\B;
  51. use C\DE;
  52. use E\F;
  53. use G\H;
  54. ',
  55. ];
  56. yield [
  57. '<?php use \Exception;
  58. ?>
  59. <?php
  60. $a = new Exception();
  61. ',
  62. '<?php use \Exception?>
  63. <?php
  64. $a = new Exception();
  65. ',
  66. ];
  67. yield [
  68. '<?php use \stdClass;
  69. use \DateTime;
  70. ?>
  71. <?php
  72. $a = new DateTime();
  73. ',
  74. '<?php use \stdClass; use \DateTime?>
  75. <?php
  76. $a = new DateTime();
  77. ',
  78. ];
  79. yield [
  80. '<?php namespace Foo;
  81. '.'
  82. use Bar\Baz;
  83. /**
  84. * Foo.
  85. */',
  86. '<?php namespace Foo;
  87. '.'
  88. use Bar\Baz;
  89. /**
  90. * Foo.
  91. */',
  92. ];
  93. yield [
  94. '<?php
  95. namespace A\B;
  96. use D;
  97. class C {}
  98. ',
  99. '<?php
  100. namespace A\B;
  101. use D;
  102. class C {}
  103. ',
  104. ];
  105. yield [
  106. '<?php
  107. namespace A\B;
  108. use D;
  109. class C {}
  110. ',
  111. '<?php
  112. namespace A\B;
  113. use D;
  114. class C {}
  115. ',
  116. ];
  117. yield [
  118. '<?php
  119. namespace A\B;
  120. use D;
  121. use E;
  122. class C {}
  123. ',
  124. '<?php
  125. namespace A\B;
  126. use D;
  127. use E;
  128. class C {}
  129. ',
  130. ];
  131. yield [
  132. '<?php
  133. namespace A\B;
  134. use D;
  135. class C {}
  136. ',
  137. '<?php
  138. namespace A\B;
  139. use D; class C {}
  140. ',
  141. ];
  142. yield [
  143. '<?php
  144. namespace A\B;
  145. use D;
  146. use E;
  147. {
  148. class C {}
  149. }',
  150. '<?php
  151. namespace A\B;
  152. use D; use E; {
  153. class C {}
  154. }',
  155. ];
  156. yield [
  157. '<?php
  158. namespace A\B;
  159. use D;
  160. use E;
  161. {
  162. class C {}
  163. }',
  164. '<?php
  165. namespace A\B;
  166. use D;
  167. use E; {
  168. class C {}
  169. }',
  170. ];
  171. yield [
  172. '<?php
  173. namespace A\B {
  174. use D;
  175. use E;
  176. class C {}
  177. }',
  178. '<?php
  179. namespace A\B {
  180. use D; use E; class C {}
  181. }',
  182. ];
  183. yield [
  184. '<?php
  185. namespace A\B;
  186. class C {
  187. use SomeTrait;
  188. }',
  189. ];
  190. yield [
  191. '<?php
  192. $lambda = function () use (
  193. $arg
  194. ){
  195. return true;
  196. };',
  197. ];
  198. yield [
  199. '<?php
  200. namespace A\B;
  201. use D, E;
  202. class C {
  203. }',
  204. '<?php
  205. namespace A\B;
  206. use D, E;
  207. class C {
  208. }',
  209. ];
  210. yield [
  211. '<?php
  212. namespace A1;
  213. use B1; // need to import this !
  214. use B2;
  215. class C1 {}
  216. ',
  217. ];
  218. yield [
  219. '<?php
  220. namespace A2;
  221. use B2;// need to import this !
  222. use B3;
  223. class C4 {}
  224. ',
  225. ];
  226. yield [
  227. '<?php
  228. namespace A1;
  229. use B1; // need to import this !
  230. use B2;
  231. class C1 {}
  232. ',
  233. ];
  234. yield [
  235. '<?php
  236. namespace A1;
  237. use B1;// need to import this !
  238. use B2;
  239. class C1 {}
  240. ',
  241. ];
  242. yield [
  243. '<?php
  244. namespace A1;
  245. use B1; /** need to import this !*/
  246. use B2;
  247. class C1 {}
  248. ',
  249. ];
  250. yield [
  251. '<?php
  252. namespace A1;
  253. use B1;# need to import this !
  254. use B2;
  255. class C1 {}
  256. ',
  257. ];
  258. yield [
  259. '<?php
  260. namespace Foo;
  261. use Bar;
  262. use Baz;
  263. class Hello {}
  264. ',
  265. '<?php
  266. namespace Foo;
  267. use Bar;
  268. use Baz;
  269. class Hello {}
  270. ',
  271. ];
  272. yield [
  273. '<?php
  274. class HelloTrait {
  275. use SomeTrait;
  276. use Another;// ensure use statements for traits are not touched
  277. }
  278. ',
  279. ];
  280. yield [
  281. '<?php
  282. namespace Foo {}
  283. namespace Bar {
  284. class Baz
  285. {
  286. use Aaa;
  287. }
  288. }
  289. ',
  290. ];
  291. yield [
  292. '<?php use A\B;
  293. ?>',
  294. '<?php use A\B?>',
  295. ];
  296. yield [
  297. '<?php use A\B;
  298. ',
  299. '<?php use A\B;',
  300. ];
  301. yield [
  302. str_replace("\n", "\r\n", '<?php
  303. use Foo;
  304. use Bar;
  305. class Baz {}
  306. '),
  307. ];
  308. yield [
  309. '<?php
  310. use some\test\{ClassA, ClassB, ClassC as C};
  311. ?>
  312. test 123
  313. ',
  314. '<?php
  315. use some\test\{ClassA, ClassB, ClassC as C} ?>
  316. test 123
  317. ',
  318. ];
  319. yield [
  320. '<?php
  321. use some\test\{CA, Cl, ClassC as C};
  322. class Test {}
  323. ',
  324. '<?php
  325. use some\test\{CA, Cl, ClassC as C};
  326. class Test {}
  327. ',
  328. ];
  329. yield [
  330. '<?php
  331. use function some\test\{fn_g, fn_f, fn_e};
  332. fn_a();',
  333. '<?php
  334. use function some\test\{fn_g, fn_f, fn_e};
  335. fn_a();',
  336. ];
  337. yield [
  338. '<?php
  339. use const some\test\{ConstA, ConstB, ConstD};
  340. ',
  341. '<?php
  342. use const some\test\{ConstA, ConstB, ConstD};
  343. ',
  344. ];
  345. yield [
  346. '<?php
  347. namespace Z\B;
  348. use const some\test\{ConstA, ConstB, ConstC};
  349. use A\B\C;
  350. ',
  351. '<?php
  352. namespace Z\B;
  353. use const some\test\{ConstA, ConstB, ConstC};
  354. use A\B\C;
  355. ',
  356. ];
  357. yield [
  358. ' <?php
  359. use some\a\ClassA;
  360. use function some\a\fn_a;
  361. use const some\c;
  362. ',
  363. ' <?php
  364. use some\a\ClassA; use function some\a\fn_a; use const some\c;
  365. ',
  366. ];
  367. yield [
  368. "<?php use some\\a\\{ClassA,};\n\n",
  369. '<?php use some\a\{ClassA,};',
  370. ];
  371. yield [
  372. "<?php use some\\a\\{ClassA};\nuse some\\b\\{ClassB};\n\n",
  373. '<?php use some\a\{ClassA};use some\b\{ClassB};',
  374. ];
  375. yield [
  376. "<?php use some\\a\\{ClassA};\nuse const some\\b\\{ClassB};\n\n",
  377. '<?php use some\a\{ClassA};use const some\b\{ClassB};',
  378. ];
  379. yield [
  380. "<?php use some\\a\\{ClassA, ClassZ};\nuse const some\\b\\{ClassB, ClassX};\nuse function some\\d;\n\n",
  381. '<?php use some\a\{ClassA, ClassZ};use const some\b\{ClassB, ClassX};use function some\\d;',
  382. ];
  383. $imports = [
  384. 'some\a\{ClassA, ClassB, ClassC as C,};',
  385. 'function some\a\{fn_a, fn_b, fn_c,};',
  386. 'const some\a\{ConstA,ConstB,ConstC,};',
  387. 'const some\Z\{ConstX,ConstY,ConstZ,};',
  388. ];
  389. yield 'group types with trailing comma' => [
  390. "<?php\nuse ".implode("\nuse ", $imports)."\n\necho 1;",
  391. "<?php\nuse ".implode('use ', $imports).' echo 1;',
  392. ];
  393. foreach ($imports as $import) {
  394. $case = [
  395. "<?php\nuse ".$import."\n\necho 1;",
  396. "<?php\nuse ".$import.' echo 1;',
  397. ];
  398. yield [
  399. str_replace('some', '\\some', $case[0]),
  400. str_replace('some', '\\some', $case[1]),
  401. ];
  402. yield $case;
  403. }
  404. }
  405. /**
  406. * @dataProvider provideMessyWhitespacesCases
  407. */
  408. public function testMessyWhitespaces(string $expected, ?string $input = null): void
  409. {
  410. $this->fixer->setWhitespacesConfig(new WhitespacesFixerConfig("\t", "\r\n"));
  411. $this->doTest($expected, $input);
  412. }
  413. public static function provideMessyWhitespacesCases(): iterable
  414. {
  415. yield [
  416. "<?php namespace A\\B;\r\n use D;\r\n\r\n class C {}",
  417. "<?php namespace A\\B;\r\n use D;\r\n\r\n\r\n class C {}",
  418. ];
  419. yield [
  420. "<?php namespace A\\B;\r\n use D;\r\n\r\n class C {}",
  421. "<?php namespace A\\B;\r\n use D;\r\n class C {}",
  422. ];
  423. }
  424. }