🎨 [BC break] make methods static

Author: garak

UPGRADE.md

@@ -1,6 +1,14 @@
 UPGRADE
 =======
 
+From 4.0 to 5.0
+---------------
+
+A bunch of methods are now static. This is affecting you only if you're overriding such methods, since you
+need to declare as static your methods too. Calling such method can be left untouched (e.g. you can still call
+methods using `$this->` instead of `self::`).
+Also, `$em` proteced property is now static. If you were using `$this->em`, you need to use `self::$em` instead.
+
 From 3.0 to 4.0
 ---------------
 

composer.json

@@ -24,11 +24,11 @@
         "symfony/dom-crawler": "^4.4 || ^5.0"
     },
     "require-dev": {
-        "doctrine/lexer": "^1.0.1",
+        "doctrine/lexer": "^1.2",
         "doctrine/orm": "^2.7",
         "friendsofphp/php-cs-fixer": "^2.16",
         "mikey179/vfsstream": "^1.6",
-        "phpunit/phpunit": "^8.5 || ^9.1",
+        "phpunit/phpunit": "^8.5 || ^9.2",
         "symfony/doctrine-bridge": "^4.4 || ^5.0",
         "symfony/framework-bundle": "^4.4 || ^5.0",
         "symfony/mime": "^4.4 || ^5.0",
@@ -41,7 +41,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "4.5.x-dev"
+            "dev-master": "5.1.x-dev"
         }
     },
     "autoload": {

docs/index.md

@@ -58,7 +58,7 @@ final class MyTest extends WebTestCase
 
 * Browser output debug
 
-  You can output the content of response in your browser, just calling `$this->saveOutput()`.
+  You can output the content of response in your browser, just calling `self::saveOutput()`.
   You can define a parameter named `domain`, otherwise standard localhost will be used. 
   The output will be save under document root and displayed with browser (by default, `/usr/bin/firefox`),
   then the page will be deleted.
@@ -92,7 +92,7 @@ final class MyTest extends WebTestCase
   This is integrated by default with [BeelabUserBundle](https://github.com/Bee-Lab/BeelabUserBundle).
   Anyway, you can use any user provider, passing the name of service as third argument or configuring.
   For example, if you want to login users provided by FOSUserBundle in your tests, you can do something like
-  `$this->login('myuser', 'main', 'fos_user.user_provider.username');`.
+  `self::login('myuser', 'main', 'fos_user.user_provider.username');`.
   Another notable service you can use is Symfony's built-in `security.user.provider.concrete.in_memory`.
   For basic usage, just pass the username as first argument.
 
@@ -118,25 +118,25 @@ final class MyTest extends WebTestCase
 
 * Files for forms
 
-  Use `$this->getImageFile()`, `$this->getPdfFile()`, `$this->getZipFile()`, and `$this->getTxtFile()` to get
+  Use `self::getImageFile()`, `self::getPdfFile()`, `self::getZipFile()`, and `self::getTxtFile()` to get
   files of various types for your uploadable fields.
-  In forms with more than a field of the same type, use `$this->getImageFile(1)`, `$this->getImageFile(2)`, etc.
-  You can also use `$this->getFile(0, $data, 'png', 'image/png')` and pass directly your file data.
+  In forms with more than a field of the same type, use `self::getImageFile(1)`, `self::getImageFile(2)`, etc.
+  You can also use `self::getFile(0, $data, 'png', 'image/png')` and pass directly your file data.
 
 * Form values shortcut
 
-  If you need to retrieve the value of a form field, you can use `$this->getFormValue('form_field')`.
+  If you need to retrieve the value of a form field, you can use `self::getFormValue('form_field')`.
   This is useful for retrieving CSRF token values or select values.
   In case of a select, note that you need to add `option` after your field's id, and you can pass a third 
   optional parameter with the position.
   If, for example, you want to retrieve the value of your second option in a `bar` field of a `foo` form
-  (maybe beacuse the first one is empty), you can do `$this->getFormValue('foo_bar option', 1)`
+  (maybe beacuse the first one is empty), you can do `self::getFormValue('foo_bar option', 1)`
 
 * Forms with collections
 
   Tipically, a form with a collection is a problem during tests, because the values of collections are not displayed
   in the HTML (but, instead, added via JavaScript).
-  You can solve such problema by visiting form URL and then using `$this->postForm('your_form_name', $values)`
+  You can solve such problema by visiting form URL and then using `self::postForm('your_form_name', $values)`
   (where`$values` can include collection values).
 
 ### Fixtures-related
@@ -150,7 +150,7 @@ final class MyTest extends WebTestCase
 * AbstractContainerAwareFixture
 
   When you need the service container in your fixtures, instead of implementing
-  `Symfony\Component\DependencyInjection\ContainerAwareInterface`, you can extends
+  `Symfony\Component\DependencyInjection\ContainerAwareInterface`, you can extend
   `Beelab\TestBundle\DataFixtures\AbstractContainerAwareFixture`.
 
 * Get entity by reference
@@ -178,13 +178,13 @@ final class MyTest extends WebTestCase
 
 * Mail sent assertion
 
-  Check how many mails has been sent with `$this->assertMailSent(1)` (or 2, 3, etc.).
+  Check how many mails has been sent with `self::assertMailSent(1)` (or 2, 3, etc.).
   You need to call `$self::client->enableProfiler()` before.
   Currently, this is working only with SwiftMailer.
 
 ### Command related
 
 * Test commands
 
-  You can test a command by executing something like `$output = $this->commandTest('app:alert', new AlertCommand());`
+  You can test a command by executing something like `$output = self::commandTest('app:alert', new AlertCommand());`
   and then doing assertions on `$output`.

src/Test/WebTestCase.php

@@ -22,7 +22,7 @@ abstract class WebTestCase extends SymfonyWebTestCase
     /**
      * @var EntityManagerInterface|null
      */
-    protected $em;
+    protected static $em;
 
     /**
      * @var \Symfony\Component\BrowserKit\AbstractBrowser
@@ -34,6 +34,10 @@ abstract class WebTestCase extends SymfonyWebTestCase
      */
     private $fixture;
 
+    protected static $authUser;
+
+    protected static $authPw;
+
     protected function setUp(): void
     {
         $environment = $_SERVER['APP_ENV'] ?? 'test';
@@ -45,7 +49,7 @@ protected function setUp(): void
             $kernel->boot();
             static::$container = $kernel->getContainer();
             if (static::$container->has('doctrine.orm.entity_manager')) {
-                $this->em = static::$container->get('doctrine.orm.entity_manager');
+                self::$em = static::$container->get('doctrine.orm.entity_manager');
             }
         }
         if (!empty(static::$authUser) && !empty(static::$authPw)) {
@@ -60,8 +64,8 @@ protected function setUp(): void
 
     protected function tearDown(): void
     {
-        if (null !== $this->em) {
-            $this->em->getConnection()->close();
+        if (null !== self::$em) {
+            self::$em->getConnection()->close();
         }
         parent::tearDown();
     }
@@ -71,7 +75,7 @@ protected function tearDown(): void
      * See http://giorgiocefaro.com/blog/test-symfony-and-automatically-open-the-browser-with-the-response-content
      * You can define a "domain" parameter with the current domain of your app.
      */
-    protected function saveOutput(bool $delete = true): void
+    protected static function saveOutput(bool $delete = true): void
     {
         $browser = static::$container->getParameter('beelab_test.browser');
         $rootDir = static::$container->getParameter('kernel.project_dir').'/';
@@ -100,7 +104,7 @@ protected function saveOutput(bool $delete = true): void
      *
      * @throws \InvalidArgumentException
      */
-    protected function login(string $username = '[email protected]', ?string $firewall = null, ?string $service = null): void
+    protected static function login(string $username = '[email protected]', ?string $firewall = null, ?string $service = null): void
     {
         $service = $service ?? static::$container->getParameter('beelab_test.user_service');
         if (null === $user = static::$container->get($service)->loadUserByUsername($username)) {
@@ -118,17 +122,17 @@ protected function login(string $username = '[email protected]', ?string $firew
     /**
      * Get an image file to be used in a form.
      */
-    protected function getImageFile(int $file = 0): UploadedFile
+    protected static function getImageFile(int $file = 0): UploadedFile
     {
         $data = 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAADElEQVQI12P4//8/AAX+Av7czFnnAAAAAElFTkSuQmCC';
 
-        return $this->getFile($file, $data, 'png', 'image/png');
+        return self::getFile($file, $data, 'png', 'image/png');
     }
 
     /**
      * Get a pdf file to be used in a form.
      */
-    protected function getPdfFile(int $file = 0): UploadedFile
+    protected static function getPdfFile(int $file = 0): UploadedFile
     {
         $data = <<<'EOF'
 JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgP
@@ -142,30 +146,30 @@ protected function getPdfFile(int $file = 0): UploadedFile
 ICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==
 EOF;
 
-        return $this->getFile($file, $data, 'pdf', 'application/pdf');
+        return self::getFile($file, $data, 'pdf', 'application/pdf');
     }
 
     /**
      * Get a pdf file to be used in a form.
      */
-    protected function getZipFile(int $file = 0): UploadedFile
+    protected static function getZipFile(int $file = 0): UploadedFile
     {
         $data = <<<'EOF'
 UEsDBAoAAgAAAM5RjEVOGigMAgAAAAIAAAAFABwAaC50eHRVVAkAA/OxilTzsYpUdXgLAAEE6AMAAARkAAAAaApQSwECHgMKAAIAAADOUYxF
 ThooDAIAAAACAAAABQAYAAAAAAABAAAApIEAAAAAaC50eHRVVAUAA/OxilR1eAsAAQToAwAABGQAAABQSwUGAAAAAAEAAQBLAAAAQQAAAAAA
 EOF;
 
-        return $this->getFile($file, $data, 'zip', 'application/zip');
+        return self::getFile($file, $data, 'zip', 'application/zip');
     }
 
     /**
      * Get a txt file to be used in a form.
      */
-    protected function getTxtFile(int $file = 0): UploadedFile
+    protected static function getTxtFile(int $file = 0): UploadedFile
     {
         $data = 'Lorem ipsum dolor sit amet';
 
-        return $this->getFile($file, $data, 'txt', 'text/plain');
+        return self::getFile($file, $data, 'txt', 'text/plain');
     }
 
     /**
@@ -189,7 +193,7 @@ protected function loadFixtures(
                 throw new \InvalidArgumentException(\sprintf('The service "%s" is not an EntityManager', $manager));
             }
         } else {
-            $manager = $this->em;
+            $manager = self::$em;
         }
         $manager->getConnection()->exec('SET foreign_key_checks = 0');
         $loader = new Loader(static::$container);
@@ -205,21 +209,21 @@ protected function loadFixtures(
      * Assert that $num mail has been sent
      * Need self::$client->enableProfiler() before calling.
      */
-    protected function assertMailSent(int $num, string $message = ''): void
+    protected static function assertMailSent(int $num, string $message = ''): void
     {
         if (false !== $profile = self::$client->getProfile()) {
             $collector = $profile->getCollector('swiftmailer');
-            $this->assertEquals($num, $collector->getMessageCount(), $message);
+            self::assertEquals($num, $collector->getMessageCount(), $message);
         } else {
-            $this->markTestSkipped('Profiler not enabled.');
+            self::markTestSkipped('Profiler not enabled.');
         }
     }
 
     /**
      * Get a form field value, from its id
      * Useful for POSTs.
      */
-    protected function getFormValue(string $fieldId, int $position = 0): string
+    protected static function getFormValue(string $fieldId, int $position = 0): string
     {
         return self::$client->getCrawler()->filter('#'.$fieldId)->eq($position)->attr('value');
     }
@@ -241,7 +245,7 @@ protected static function ajax(string $method, string $uri, array $params = [],
      * @param array   $otherCommands Possible other commands to define
      * @param array   $inputs        Possible inputs to set inside command
      */
-    protected function commandTest(
+    protected static function commandTest(
         string $name,
         Command $command,
         array $arguments = [],
@@ -283,7 +287,7 @@ protected function getReference(string $name)
     /**
      * Get a file to be used in a form.
      */
-    protected function getFile(string $file, string $data, string $ext, string $mime): UploadedFile
+    protected static function getFile(string $file, string $data, string $ext, string $mime): UploadedFile
     {
         $name = 'file_'.$file.'.'.$ext;
         $path = \tempnam(\sys_get_temp_dir(), 'sf_test_').$name;
@@ -297,13 +301,13 @@ protected function getFile(string $file, string $data, string $ext, string $mime
      *
      * @param string $name   The name of form
      * @param array  $values The values to submit
-     * @param array  $values The values to submit for $_FILES
+     * @param array  $files  The values to submit for $_FILES
      * @param string $method The method of form
      */
-    protected function postForm(string $name, array $values, array $files = [], string $method = 'POST'): void
+    protected static function postForm(string $name, array $values, array $files = [], string $method = 'POST'): void
     {
         $formAction = self::$client->getRequest()->getUri();
-        $values['_token'] = $this->getFormValue($name.'__token');
+        $values['_token'] = self::getFormValue($name.'__token');
         $filesValues = \count($files) > 0 ? [$name => $files] : [];
         self::$client->request($method, $formAction, [$name => $values], $filesValues);
     }

tests/DependencyInjection/ConfigurationTest.php

@@ -9,6 +9,6 @@ class ConfigurationTest extends \PHPUnit\Framework\TestCase
     public function testGetConfigTreeBuilder(): void
     {
         $configuration = new Configuration();
-        $this->assertInstanceOf(TreeBuilder::class, $configuration->getConfigTreeBuilder());
+        self::assertInstanceOf(TreeBuilder::class, $configuration->getConfigTreeBuilder());
     }
 }

tests/FakeFixture.php

@@ -5,7 +5,7 @@
 use Doctrine\Common\DataFixtures\FixtureInterface;
 use Doctrine\Common\Persistence\ObjectManager;
 
-class FakeFixture implements FixtureInterface
+final class FakeFixture implements FixtureInterface
 {
     public function load(ObjectManager $manager): void
     {

tests/FakeFixtureDependent.php

@@ -6,9 +6,9 @@
 use Doctrine\Common\DataFixtures\FixtureInterface;
 use Doctrine\Common\Persistence\ObjectManager;
 
-class FakeFixtureDependent implements DependentFixtureInterface, FixtureInterface
+final class FakeFixtureDependent implements DependentFixtureInterface, FixtureInterface
 {
-    public function getDependencies()
+    public function getDependencies(): array
     {
         return [
             'Beelab\TestBundle\FakeFixture',