Upgrading Symfony components to be compatible with Symfony 5

Author: moufmouf

composer.json

@@ -28,10 +28,9 @@
         "mouf/classname-mapper": "~1.0",
         "doctrine/cache": "^1.6",
         "greenlion/php-sql-parser": "^4.3.0",
-        "phlib/logger": "^3.0.1",
-        "symfony/console": "^2 || ^3 || ^4",
+        "symfony/console": "^2 || ^3 || ^4 || ^5",
         "mouf/utils.log.psr.multi-logger": "^1.0",
-        "symfony/filesystem": "^2.7 || ^3 || ^4",
+        "symfony/filesystem": "^2.7 || ^3 || ^4 || ^5",
         "ramsey/uuid": "^3.7",
         "doctrine/annotations": "^1.6",
         "zendframework/zend-code": "^3.3.1",
@@ -46,7 +45,7 @@
         "php-coveralls/php-coveralls": "^2.1",
         "wa72/simplelogger" : "^1.0",
         "friendsofphp/php-cs-fixer": "^2.15.1",
-        "symfony/process": "^3 || ^4",
+        "symfony/process": "^3 || ^4 || ^5",
         "thecodingmachine/tdbm-fluid-schema-builder": "^1.0.0",
         "phpstan/phpstan": "^0.11.5",
         "thecodingmachine/phpstan-strict-rules": "^0.11.0",

src/Commands/GenerateCommand.php

@@ -57,5 +57,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $tdbmService->generateAllDaosAndBeans();
 
         $multiLogger->notice('Finished regenerating DAOs and beans');
+
+        return 0;
     }
 }

src/TDBMService.php

@@ -39,10 +39,10 @@
 use TheCodingMachine\TDBM\QueryFactory\FindObjectsFromSqlQueryFactory;
 use TheCodingMachine\TDBM\QueryFactory\FindObjectsQueryFactory;
 use TheCodingMachine\TDBM\QueryFactory\FindObjectsFromRawSqlQueryFactory;
+use TheCodingMachine\TDBM\Utils\Logs\LevelFilter;
 use TheCodingMachine\TDBM\Utils\ManyToManyRelationshipPathDescriptor;
 use TheCodingMachine\TDBM\Utils\NamingStrategyInterface;
 use TheCodingMachine\TDBM\Utils\TDBMDaoGenerator;
-use Phlib\Logger\Decorator\LevelFilter;
 use Psr\Log\LoggerInterface;
 use Psr\Log\LogLevel;
 use Psr\Log\NullLogger;

src/Utils/Logs/LevelFilter.php

@@ -0,0 +1,85 @@
+<?php
+
+
+namespace TheCodingMachine\TDBM\Utils\Logs;
+
+use Psr\Log\AbstractLogger;
+use Psr\Log\InvalidArgumentException;
+use Psr\Log\LoggerInterface;
+use Psr\Log\LogLevel;
+use function array_search;
+use function sprintf;
+
+class LevelFilter extends AbstractLogger
+{
+    /**
+     * Logging levels from syslog protocol defined in RFC 5424
+     *
+     * @var string[] $levels Logging levels
+     */
+    private static $levels = array(
+        LogLevel::EMERGENCY, // 0
+        LogLevel::ALERT,     // 1
+        LogLevel::CRITICAL,  // 2
+        LogLevel::ERROR,     // 3
+        LogLevel::WARNING,   // 4
+        LogLevel::NOTICE,    // 5
+        LogLevel::INFO,      // 6
+        LogLevel::DEBUG      // 7
+    );
+
+    /**
+     * @var int
+     */
+    private $logLevel;
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * @param LoggerInterface $logger
+     * @param string $level \Psr\Log\LogLevel string
+     */
+    public function __construct(LoggerInterface $logger, $level)
+    {
+        $this->logger = $logger;
+
+        $this->logLevel = array_search($level, self::$levels, true);
+        if ($this->logLevel === false) {
+            throw new InvalidArgumentException(
+                sprintf(
+                    'Cannot use logging level "%s"',
+                    $level
+                )
+            );
+        }
+    }
+
+    /**
+     * Logs with an arbitrary level.
+     *
+     * @param mixed  $level
+     * @param string $message
+     * @param array  $context
+     *
+     * @return void
+     */
+    public function log($level, $message, array $context = array())
+    {
+        $levelCode = array_search($level, self::$levels, true);
+        if ($levelCode === false) {
+            throw new InvalidArgumentException(
+                sprintf(
+                    'Cannot use unknown logging level "%s"',
+                    $level
+                )
+            );
+        }
+        if ($levelCode > $this->logLevel) {
+            return;
+        }
+
+        $this->logger->log($level, $message, $context);
+    }
+}

tests/TDBMDaoGeneratorTest.php

@@ -1552,7 +1552,7 @@ public function testCorrectTypeForPrimaryKeyAfterSave(): void
      */
     public function testPSR2Compliance(): void
     {
-        $process = new Process('vendor/bin/php-cs-fixer fix src/Test/  --dry-run --diff --rules=@PSR2');
+        $process = new Process(['vendor/bin/php-cs-fixer', 'fix', 'src/Test/', '--dry-run', '--diff', '--rules=@PSR2']);
         $process->run();
 
         // executes after the command finishes

tests/Utils/Logs/LevelFilterTest.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace TheCodingMachine\TDBM\Utils\Logs;
+
+use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
+use Psr\Log\LogLevel;
+
+class LevelFilterTest extends TestCase
+{
+    public function testIsPsrLog()
+    {
+        $levelFilter = new LevelFilter($this->getMockLoggerInterface(), LogLevel::DEBUG);
+        $this->assertInstanceOf('\Psr\Log\LoggerInterface', $levelFilter);
+    }
+
+    public function testLog()
+    {
+        $loggerInterface = $this->getMockLoggerInterface();
+
+        // We expect this test to call the loggerInterface twice to log the ERROR and CRITICAL messages
+        // and to ignore the WARNING log message
+        $loggerInterface->expects($this->exactly(2))
+            ->method('log')
+            ->withConsecutive(
+                [LogLevel::ERROR],
+                [LogLevel::CRITICAL]
+            );
+
+        $levelFilter = new LevelFilter($loggerInterface, LogLevel::ERROR);
+
+        // Log message with equal priority to the level filter (should be get logged)
+        $levelFilter->log(LogLevel::ERROR, 'TEST ERROR MESSAGE');
+
+        // Log message with higher priority than the level filter (should be logged)
+        $levelFilter->log(LogLevel::CRITICAL, 'TEST CRITICAL MESSAGE');
+
+        // Log message with lower priority than the level filter (should not be logged)
+        $levelFilter->log(LogLevel::WARNING, 'TEST WARNING MESSAGE');
+    }
+
+    public function testInvalidConstructorLogLevel()
+    {
+        // We expect an exception to be thrown when specifying an invalid logging level in the constructor
+        $this->expectException('\Psr\Log\InvalidArgumentException');
+        $levelFilter = new LevelFilter($this->getMockLoggerInterface(), 'InvalidLogLevel');
+    }
+
+    public function testInvalidLogLogLevel()
+    {
+        // We expect an exception to be thrown when specifying an invalid logging level in the log method parameter
+        $levelFilter = new LevelFilter($this->getMockLoggerInterface(), LogLevel::DEBUG);
+
+        $this->expectException('\Psr\Log\InvalidArgumentException');
+        $levelFilter->log('InvalidLogLevel', 'TEST LOG MESSAGE');
+    }
+
+    /**
+     * @return LoggerInterface
+     */
+    protected function getMockLoggerInterface()
+    {
+        $loggerInterface = $this->createMock('\Psr\Log\LoggerInterface');
+        return $loggerInterface;
+    }
+}