Merge pull request #20 from minvws/replace-yml-driver

Author: Ilyes512

phpstan-baseline.neon

@@ -0,0 +1,11 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Parameter \\#1 \\$config \\(array\\{encryption\\: array\\{public_key\\: string, private_key\\: string\\}, loggers\\: array\\{psr_logger\\?\\: array\\{enabled\\: bool, encrypted\\: bool, log_pii\\: bool\\}, doctrine_logger\\?\\: array\\{enabled\\: bool, encrypted\\: bool, log_pii\\: bool\\}, file_logger\\?\\: array\\{enabled\\: bool, encrypted\\: bool, log_pii\\: bool, path\\: string\\}, rabbitmq_logger\\?\\: array\\{enabled\\: bool, encrypted\\: bool, log_pii\\: bool, path\\: string, producer_service\\: string, routing_key\\: string, additional_events\\: array\\<string, string\\>\\}\\}\\}\\) of method MinVWS\\\\AuditLoggerBundle\\\\AuditLoggerBundle\\:\\:loadExtension\\(\\) should be contravariant with parameter \\$config \\(array\\) of method Symfony\\\\Component\\\\DependencyInjection\\\\Extension\\\\ConfigurableExtensionInterface\\:\\:loadExtension\\(\\)$#"
+			count: 1
+			path: src/AuditLoggerBundle.php
+
+		-
+			message: "#^Parameter \\#1 \\$config \\(array\\{encryption\\: array\\{public_key\\: string, private_key\\: string\\}, loggers\\: array\\{psr_logger\\?\\: array\\{enabled\\: bool, encrypted\\: bool, log_pii\\: bool\\}, doctrine_logger\\?\\: array\\{enabled\\: bool, encrypted\\: bool, log_pii\\: bool\\}, file_logger\\?\\: array\\{enabled\\: bool, encrypted\\: bool, log_pii\\: bool, path\\: string\\}, rabbitmq_logger\\?\\: array\\{enabled\\: bool, encrypted\\: bool, log_pii\\: bool, path\\: string, producer_service\\: string, routing_key\\: string, additional_events\\: array\\<string, string\\>\\}\\}\\}\\) of method MinVWS\\\\AuditLoggerBundle\\\\AuditLoggerBundle\\:\\:loadExtension\\(\\) should be contravariant with parameter \\$config \\(array\\) of method Symfony\\\\Component\\\\HttpKernel\\\\Bundle\\\\AbstractBundle\\:\\:loadExtension\\(\\)$#"
+			count: 1
+			path: src/AuditLoggerBundle.php

phpstan.neon.dist

@@ -1,4 +1,5 @@
 includes:
+    - phpstan-baseline.neon
     - vendor/phpstan/phpstan-mockery/extension.neon
     - vendor/phpstan/phpstan-strict-rules/rules.neon
     - vendor/phpstan/phpstan-symfony/extension.neon
@@ -10,5 +11,3 @@ parameters:
         - tests
     tmpDir: ./.phpstan.cache
     level: max
-    excludePaths:
-        - src/AuditLoggerBundle.php

sonar-project.properties

@@ -19,3 +19,6 @@ sonar.php.coverage.reportPaths=coverage-phpunit.xml
 
 # Additional reports
 sonar.php.phpstan.reportPaths=phpstan.json
+
+sonar.coverage.exclusions=\
+    src/AuditLoggerBundle.php

src/AuditLoggerBundle.php

@@ -12,18 +12,57 @@
 use MinVWS\AuditLoggerBundle\Loggers\DoctrineLogger;
 use MinVWS\AuditLoggerBundle\Loggers\RabbitmqLogger;
 use OldSound\RabbitMqBundle\OldSoundRabbitMqBundle;
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Configurator\DefinitionConfigurator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\Bundle\AbstractBundle;
 
+use function realpath;
+
+/**
+ * @phpstan-type ConfigEncryptionArray array{public_key: string, private_key: string}
+ * @phpstan-type ConfigLoggersArray array{
+ *      enabled: bool,
+ *      encrypted: bool,
+ *      log_pii: bool,
+ *  }
+ * @phpstan-type ConfigFileLoggersArray array{
+ *      enabled: bool,
+ *      encrypted: bool,
+ *      log_pii: bool,
+ *      path: string,
+ *  }
+ * @phpstan-type ConfigRabbitMqLoggersArray array{
+ *      enabled: bool,
+ *      encrypted: bool,
+ *      log_pii: bool,
+ *      path: string,
+ *      producer_service: string,
+ *      routing_key: string,
+ *      additional_events: array<string,string>,
+ *  }
+ * @phpstan-type ConfigArray array{
+ *      encryption: ConfigEncryptionArray,
+ *      loggers: array{
+ *          psr_logger?: ConfigLoggersArray,
+ *          doctrine_logger?: ConfigLoggersArray,
+ *          file_logger?: ConfigFileLoggersArray,
+ *          rabbitmq_logger?: ConfigRabbitMqLoggersArray,
+ *      }
+ *  }
+ */
 class AuditLoggerBundle extends AbstractBundle
 {
     public function configure(DefinitionConfigurator $definition): void
     {
-        $definition->rootNode()
+        $arrayDef = $definition->rootNode();
+
+        assert($arrayDef instanceof ArrayNodeDefinition);
+
+        $arrayDef
             ->children()
             ->arrayNode('encryption')
                 ->children()
@@ -76,6 +115,9 @@ public function configure(DefinitionConfigurator $definition): void
             ->end();
     }
 
+    /**
+     * @phpstan-param ConfigArray $config
+     */
     public function loadExtension(array $config, ContainerConfigurator $container, ContainerBuilder $builder): void
     {
         $container->import('Resources/config/services.yml');
@@ -159,11 +201,14 @@ public function build(ContainerBuilder $container): void
     {
         parent::build($container);
 
-        $mappings = [
-            realpath(__DIR__ . '/Resources/config/doctrine') => 'MinVWS\AuditLoggerBundle\Entity',
-        ];
+        $path = realpath(__DIR__ . '/Entity');
+        assert($path !== false);
 
-        $container->addCompilerPass(DoctrineOrmMappingsPass::createYamlMappingDriver($mappings));
+        $container->addCompilerPass(DoctrineOrmMappingsPass::createAttributeMappingDriver(
+            ['MinVWS\AuditLoggerBundle\Entity'],
+            [$path],
+            reportFieldsWhereDeclared: true,
+        ));
     }
 
     public function getAlias(): string