[make:test*] use sorted use statements

jrushlow · jrushlow · commit 0b8ed5d1c657 · 2022-04-26T09:08:57.000-04:00
diff --git a/src/Maker/MakeFunctionalTest.php b/src/Maker/MakeFunctionalTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Bundle\MakerBundle\Maker;
 
 use Symfony\Bundle\FrameworkBundle\Test\WebTestAssertionsTrait;
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 use Symfony\Bundle\MakerBundle\ConsoleStyle;
 use Symfony\Bundle\MakerBundle\DependencyBuilder;
 use Symfony\Bundle\MakerBundle\Generator;
@@ -21,6 +22,7 @@
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\CssSelector\CssSelectorConverter;
+use Symfony\Component\Panther\PantherTestCase;
 use Symfony\Component\Panther\PantherTestCaseTrait;
 
 trigger_deprecation('symfony/maker-bundle', '1.29', 'The "%s" class is deprecated, use "%s" instead.', MakeFunctionalTest::class, MakeTest::class);
@@ -43,28 +45,35 @@ public static function getCommandDescription(): string
         return 'Creates a new functional test class';
     }
 
-    public function configureCommand(Command $command, InputConfiguration $inputConf)
+    public function configureCommand(Command $command, InputConfiguration $inputConfig): void
     {
         $command
             ->addArgument('name', InputArgument::OPTIONAL, 'The name of the functional test class (e.g. <fg=yellow>DefaultControllerTest</>)')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeFunctionalTest.txt'))
         ;
     }
 
-    public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator)
+    public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
     {
         $testClassNameDetails = $generator->createClassNameDetails(
             $input->getArgument('name'),
             'Tests\\',
             'Test'
         );
 
+        $pantherAvailable = trait_exists(PantherTestCaseTrait::class);
+
+        $this->useStatements = [
+            ($pantherAvailable ? PantherTestCase::class : WebTestCase::class),
+        ];
+
         $generator->generateClass(
             $testClassNameDetails->getFullName(),
             'test/Functional.tpl.php',
             [
+                'use_statements' => $this->getFormattedUseStatements(),
                 'web_assertions_are_available' => trait_exists(WebTestAssertionsTrait::class),
-                'panther_is_available' => trait_exists(PantherTestCaseTrait::class),
+                'panther_is_available' => $pantherAvailable,
             ]
         );
 
@@ -78,7 +87,7 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
         ]);
     }
 
-    public function configureDependencies(DependencyBuilder $dependencies)
+    public function configureDependencies(DependencyBuilder $dependencies): void
     {
         $dependencies->addClassDependency(
             History::class,
diff --git a/src/Maker/MakeTest.php b/src/Maker/MakeTest.php
@@ -70,7 +70,7 @@ public static function getCommandDescription(): string
         return 'Creates a new test class';
     }
 
-    public function configureCommand(Command $command, InputConfiguration $inputConf)
+    public function configureCommand(Command $command, InputConfiguration $inputConfig): void
     {
         $typesDesc = [];
         $typesHelp = [];
@@ -84,11 +84,11 @@ public function configureCommand(Command $command, InputConfiguration $inputConf
             ->addArgument('name', InputArgument::OPTIONAL, 'The name of the test class (e.g. <fg=yellow>BlogPostTest</>)')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeTest.txt').implode("\n", $typesHelp));
 
-        $inputConf->setArgumentAsNonInteractive('name');
-        $inputConf->setArgumentAsNonInteractive('type');
+        $inputConfig->setArgumentAsNonInteractive('name');
+        $inputConfig->setArgumentAsNonInteractive('type');
     }
 
-    public function interact(InputInterface $input, ConsoleStyle $io, Command $command)
+    public function interact(InputInterface $input, ConsoleStyle $io, Command $command): void
     {
         /* @deprecated remove the following block when removing make:unit-test and make:functional-test */
         $this->handleDeprecatedMakerCommands($input, $io);
@@ -133,7 +133,7 @@ public function interact(InputInterface $input, ConsoleStyle $io, Command $comma
         }
     }
 
-    public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator)
+    public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
     {
         $testClassNameDetails = $generator->createClassNameDetails(
             $input->getArgument('name'),
diff --git a/src/Maker/MakeUnitTest.php b/src/Maker/MakeUnitTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Bundle\MakerBundle\Maker;
 
+use PHPUnit\Framework\TestCase;
 use Symfony\Bundle\MakerBundle\ConsoleStyle;
 use Symfony\Bundle\MakerBundle\DependencyBuilder;
 use Symfony\Bundle\MakerBundle\Generator;
@@ -39,26 +40,28 @@ public static function getCommandDescription(): string
         return 'Creates a new unit test class';
     }
 
-    public function configureCommand(Command $command, InputConfiguration $inputConf)
+    public function configureCommand(Command $command, InputConfiguration $inputConfig): void
     {
         $command
             ->addArgument('name', InputArgument::OPTIONAL, 'The name of the unit test class (e.g. <fg=yellow>UtilTest</>)')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeUnitTest.txt'))
         ;
     }
 
-    public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator)
+    public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
     {
         $testClassNameDetails = $generator->createClassNameDetails(
             $input->getArgument('name'),
             'Tests\\',
             'Test'
         );
 
+        $this->useStatements = [TestCase::class];
+
         $generator->generateClass(
             $testClassNameDetails->getFullName(),
             'test/Unit.tpl.php',
-            []
+            ['use_statements' => $this->getFormattedUseStatements()]
         );
 
         $generator->writeChanges();
@@ -71,7 +74,7 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
         ]);
     }
 
-    public function configureDependencies(DependencyBuilder $dependencies)
+    public function configureDependencies(DependencyBuilder $dependencies): void
     {
     }
 }
diff --git a/src/Resources/skeleton/test/Functional.tpl.php b/src/Resources/skeleton/test/Functional.tpl.php
@@ -3,11 +3,7 @@
 
 namespace <?= $namespace; ?>;
 
-<?php if ($panther_is_available): ?>
-use Symfony\Component\Panther\PantherTestCase;
-<?php else: ?>
-use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
-<?php endif ?>
+<?= $use_statements ?>
 
 class <?= $class_name ?> extends <?= $panther_is_available ? 'PantherTestCase' : 'WebTestCase' ?><?= "\n" ?>
 {
diff --git a/src/Resources/skeleton/test/Unit.tpl.php b/src/Resources/skeleton/test/Unit.tpl.php
@@ -3,7 +3,7 @@
 
 namespace <?= $namespace; ?>;
 
-use PHPUnit\Framework\TestCase;
+<?= $use_statements; ?>
 
 class <?= $class_name ?> extends TestCase
 {

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ public static function getCommandDescription(): string`
`70`	`70`	`return 'Creates a new test class';`
`71`	`71`	`}`
`72`	`72`
`73`		`- public function configureCommand(Command $command, InputConfiguration $inputConf)`
	`73`	`+ public function configureCommand(Command $command, InputConfiguration $inputConfig): void`
`74`	`74`	`{`
`75`	`75`	`$typesDesc = [];`
`76`	`76`	`$typesHelp = [];`
`@@ -84,11 +84,11 @@ public function configureCommand(Command $command, InputConfiguration $inputConf`
`84`	`84`	`->addArgument('name', InputArgument::OPTIONAL, 'The name of the test class (e.g. <fg=yellow>BlogPostTest</>)')`
`85`	`85`	`->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeTest.txt').implode("\n", $typesHelp));`
`86`	`86`
`87`		`- $inputConf->setArgumentAsNonInteractive('name');`
`88`		`- $inputConf->setArgumentAsNonInteractive('type');`
	`87`	`+ $inputConfig->setArgumentAsNonInteractive('name');`
	`88`	`+ $inputConfig->setArgumentAsNonInteractive('type');`
`89`	`89`	`}`
`90`	`90`
`91`		`- public function interact(InputInterface $input, ConsoleStyle $io, Command $command)`
	`91`	`+ public function interact(InputInterface $input, ConsoleStyle $io, Command $command): void`
`92`	`92`	`{`
`93`	`93`	`/* @deprecated remove the following block when removing make:unit-test and make:functional-test */`
`94`	`94`	`$this->handleDeprecatedMakerCommands($input, $io);`
`@@ -133,7 +133,7 @@ public function interact(InputInterface $input, ConsoleStyle $io, Command $comma`
`133`	`133`	`}`
`134`	`134`	`}`
`135`	`135`
`136`		`- public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator)`
	`136`	`+ public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void`
`137`	`137`	`{`
`138`	`138`	`$testClassNameDetails = $generator->createClassNameDetails(`
`139`	`139`	`$input->getArgument('name'),`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Bundle\MakerBundle\Maker;`
`13`	`13`
	`14`	`+use PHPUnit\Framework\TestCase;`
`14`	`15`	`use Symfony\Bundle\MakerBundle\ConsoleStyle;`
`15`	`16`	`use Symfony\Bundle\MakerBundle\DependencyBuilder;`
`16`	`17`	`use Symfony\Bundle\MakerBundle\Generator;`
`@@ -39,26 +40,28 @@ public static function getCommandDescription(): string`
`39`	`40`	`return 'Creates a new unit test class';`
`40`	`41`	`}`
`41`	`42`
`42`		`- public function configureCommand(Command $command, InputConfiguration $inputConf)`
	`43`	`+ public function configureCommand(Command $command, InputConfiguration $inputConfig): void`
`43`	`44`	`{`
`44`	`45`	`$command`
`45`	`46`	`->addArgument('name', InputArgument::OPTIONAL, 'The name of the unit test class (e.g. <fg=yellow>UtilTest</>)')`
`46`	`47`	`->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeUnitTest.txt'))`
`47`	`48`	`;`
`48`	`49`	`}`
`49`	`50`
`50`		`- public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator)`
	`51`	`+ public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void`
`51`	`52`	`{`
`52`	`53`	`$testClassNameDetails = $generator->createClassNameDetails(`
`53`	`54`	`$input->getArgument('name'),`
`54`	`55`	`'Tests\\',`
`55`	`56`	`'Test'`
`56`	`57`	`);`
`57`	`58`
	`59`	`+ $this->useStatements = [TestCase::class];`
	`60`	`+`
`58`	`61`	`$generator->generateClass(`
`59`	`62`	`$testClassNameDetails->getFullName(),`
`60`	`63`	`'test/Unit.tpl.php',`
`61`		`- []`
	`64`	`+ ['use_statements' => $this->getFormattedUseStatements()]`
`62`	`65`	`);`
`63`	`66`
`64`	`67`	`$generator->writeChanges();`
`@@ -71,7 +74,7 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen`
`71`	`74`	`]);`
`72`	`75`	`}`
`73`	`76`
`74`		`- public function configureDependencies(DependencyBuilder $dependencies)`
	`77`	`+ public function configureDependencies(DependencyBuilder $dependencies): void`
`75`	`78`	`{`
`76`	`79`	`}`
`77`	`80`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`namespace <?= $namespace; ?>;`
`5`	`5`
`6`		`-use PHPUnit\Framework\TestCase;`
	`6`	`+<?= $use_statements; ?>`
`7`	`7`
`8`	`8`	`class <?= $class_name ?> extends TestCase`
`9`	`9`	`{`