Merge pull request #5 from Micro-PHP/v1.4

Asisyas · web-flow · commit 67440057eab4 · 2023-01-16T00:30:07.000+03:00
Version 1.4
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -21,7 +21,7 @@
             <directory suffix=".php">src/</directory>
             <exclude>
                 <directory>src/Exception</directory>
-                <file>src/LoggerMonologPlugin.php</file>
+                <file>src/MonologPlugin.php</file>
             </exclude>
         </whitelist>
     </filter>
diff --git a/psalm.xml b/psalm.xml
@@ -18,19 +18,19 @@
 
         <UnnecessaryVarAnnotation>
             <errorLevel type="suppress">
-                <file name="src/LoggerMonologPlugin.php"/>
+                <file name="src/MonologPlugin.php"/>
             </errorLevel>
         </UnnecessaryVarAnnotation>
 
         <MissingConstructor>
             <errorLevel type="suppress">
-                <file name="src/LoggerMonologPlugin.php"/>
+                <file name="src/MonologPlugin.php"/>
             </errorLevel>
         </MissingConstructor>
 
         <ImplementedReturnTypeMismatch>
             <errorLevel type="suppress">
-                <file name="src/LoggerMonologPlugin.php"/>
+                <file name="src/MonologPlugin.php"/>
             </errorLevel>
         </ImplementedReturnTypeMismatch>
     </issueHandlers>
diff --git a/src/Business/Handler/HandlerFactory.php b/src/Business/Handler/HandlerFactory.php
@@ -12,6 +12,7 @@
 namespace Micro\Plugin\Logger\Monolog\Business\Handler;
 
 use Micro\Component\DependencyInjection\Container;
+use Micro\Plugin\Logger\Configuration\LoggerProviderTypeConfigurationInterface;
 use Micro\Plugin\Logger\Monolog\Configuration\Handler\HandlerConfigurationFactoryInterface;
 use Monolog\Handler\HandlerInterface;
 
@@ -23,14 +24,15 @@ public function __construct(
     ) {
     }
 
-    public function create(string $handlerName): HandlerInterface
+    public function create(LoggerProviderTypeConfigurationInterface $loggerProviderTypeConfiguration, string $handlerName): HandlerInterface
     {
         $handlerConfiguration = $this->handlerConfigurationFactory->create($handlerName);
         $handlerClassName = $handlerConfiguration->getHandlerClassName();
 
         return new $handlerClassName(
             $this->container,
-            $handlerConfiguration
+            $handlerConfiguration,
+            $loggerProviderTypeConfiguration
         );
     }
 }
diff --git a/src/Business/Handler/HandlerFactoryInterface.php b/src/Business/Handler/HandlerFactoryInterface.php
@@ -11,9 +11,10 @@
 
 namespace Micro\Plugin\Logger\Monolog\Business\Handler;
 
+use Micro\Plugin\Logger\Configuration\LoggerProviderTypeConfigurationInterface;
 use Monolog\Handler\HandlerInterface;
 
 interface HandlerFactoryInterface
 {
-    public function create(string $handlerName): HandlerInterface;
+    public function create(LoggerProviderTypeConfigurationInterface $loggerProviderTypeConfiguration, string $handlerName): HandlerInterface;
 }
diff --git a/src/Business/Handler/HandlerProvider.php b/src/Business/Handler/HandlerProvider.php
@@ -11,6 +11,7 @@
 
 namespace Micro\Plugin\Logger\Monolog\Business\Handler;
 
+use Micro\Plugin\Logger\Configuration\LoggerProviderTypeConfigurationInterface;
 use Monolog\Handler\HandlerInterface;
 
 class HandlerProvider implements HandlerProviderInterface
@@ -25,13 +26,10 @@ public function __construct(private HandlerFactoryInterface $handlerFactory)
         $this->handlerCollection = [];
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function getHandler(string $handlerName): HandlerInterface
+    public function getHandler(LoggerProviderTypeConfigurationInterface $loggerProviderTypeConfiguration, string $handlerName): HandlerInterface
     {
         if (!\array_key_exists($handlerName, $this->handlerCollection)) {
-            $this->handlerCollection[$handlerName] = $this->handlerFactory->create($handlerName);
+            $this->handlerCollection[$handlerName] = $this->handlerFactory->create($loggerProviderTypeConfiguration, $handlerName);
         }
 
         return $this->handlerCollection[$handlerName];
diff --git a/src/Business/Handler/HandlerProviderInterface.php b/src/Business/Handler/HandlerProviderInterface.php
@@ -11,9 +11,10 @@
 
 namespace Micro\Plugin\Logger\Monolog\Business\Handler;
 
+use Micro\Plugin\Logger\Configuration\LoggerProviderTypeConfigurationInterface;
 use Monolog\Handler\HandlerInterface;
 
 interface HandlerProviderInterface
 {
-    public function getHandler(string $handlerName): HandlerInterface;
+    public function getHandler(LoggerProviderTypeConfigurationInterface $loggerProviderTypeConfiguration, string $handlerName): HandlerInterface;
 }
diff --git a/src/Business/Handler/HandlerResolver.php b/src/Business/Handler/HandlerResolver.php
@@ -14,21 +14,22 @@
 use Micro\Plugin\Logger\Configuration\LoggerProviderTypeConfigurationInterface;
 use Micro\Plugin\Logger\Monolog\Configuration\Logger\MonologPluginConfigurationInterface;
 
-class HandlerResolver implements HandlerResolverInterface
+readonly class HandlerResolver implements HandlerResolverInterface
 {
     public function __construct(
-        private readonly MonologPluginConfigurationInterface $pluginConfiguration,
-        private readonly HandlerProviderInterface $handlerProvider,
-        private readonly LoggerProviderTypeConfigurationInterface $loggerProviderTypeConfiguration
+        private MonologPluginConfigurationInterface $pluginConfiguration,
+        private HandlerProviderInterface $handlerProvider,
+        private LoggerProviderTypeConfigurationInterface $loggerProviderTypeConfiguration
     ) {
     }
 
     public function resolve(): \Traversable
     {
-        $loggerConfiguration = $this->pluginConfiguration->getLoggerConfiguration($this->loggerProviderTypeConfiguration->getLoggerName());
+        $loggerConfiguration = $this->pluginConfiguration
+            ->getLoggerConfiguration($this->loggerProviderTypeConfiguration->getLoggerName());
 
         foreach ($loggerConfiguration->getHandlerList() as $handlerName) {
-            yield $this->handlerProvider->getHandler($handlerName);
+            yield $this->handlerProvider->getHandler($this->loggerProviderTypeConfiguration, $handlerName);
         }
     }
 }
diff --git a/src/MonologPlugin.php b/src/MonologPlugin.php
@@ -37,7 +37,7 @@
  *
  * @method MonologPluginConfigurationInterface configuration()
  */
-class LoggerMonologPlugin implements DependencyProviderInterface, PluginDependedInterface, LoggerProviderPluginInterface, ConfigurableInterface
+class MonologPlugin implements DependencyProviderInterface, PluginDependedInterface, LoggerProviderPluginInterface, ConfigurableInterface
 {
     use PluginConfigurationTrait;
 
diff --git a/tests/Unit/Business/Handler/HandlerFactoryTest.php b/tests/Unit/Business/Handler/HandlerFactoryTest.php
@@ -14,6 +14,7 @@
 namespace Micro\Plugin\Logger\Monolog\Test\Unit\Business\Handler;
 
 use Micro\Component\DependencyInjection\Container;
+use Micro\Plugin\Logger\Configuration\LoggerProviderTypeConfigurationInterface;
 use Micro\Plugin\Logger\Monolog\Business\Handler\HandlerFactory;
 use Micro\Plugin\Logger\Monolog\Configuration\Handler\HandlerConfigurationFactoryInterface;
 use Micro\Plugin\Logger\Monolog\Configuration\Handler\HandlerConfigurationInterface;
@@ -36,7 +37,9 @@ public function testCreate()
             ->willReturn($handlerConfig);
 
         $handlerFactory = new HandlerFactory($container, $handlerConfigurationFactory);
-        $handler = $handlerFactory->create('test');
+        $handler = $handlerFactory->create(
+            $this->createMock(LoggerProviderTypeConfigurationInterface::class),
+            'test');
 
         $this->assertInstanceOf(TestHandlerImpl::class, $handler);
     }
diff --git a/tests/Unit/Business/Handler/HandlerProviderTest.php b/tests/Unit/Business/Handler/HandlerProviderTest.php
@@ -13,6 +13,7 @@
 
 namespace Micro\Plugin\Logger\Monolog\Test\Unit\Business\Handler;
 
+use Micro\Plugin\Logger\Configuration\LoggerProviderTypeConfigurationInterface;
 use Micro\Plugin\Logger\Monolog\Business\Handler\HandlerFactoryInterface;
 use Micro\Plugin\Logger\Monolog\Business\Handler\HandlerProvider;
 use Monolog\Handler\HandlerInterface;
@@ -22,15 +23,18 @@ class HandlerProviderTest extends TestCase
 {
     public function testGetHandler()
     {
+        $loggerProviderTypeCfg = $this->createMock(LoggerProviderTypeConfigurationInterface::class);
         $handlerFactory = $this->createMock(HandlerFactoryInterface::class);
         $handlerFactory->expects($this->once())
             ->method('create')
             ->willReturn(new TestHandlerImpl());
 
         $provider = new HandlerProvider($handlerFactory);
-        $handler = $provider->getHandler('test');
+        $handler = $provider->getHandler(
+            $loggerProviderTypeCfg,
+            'test');
 
-        $this->assertSame($handler, $provider->getHandler('test'));
+        $this->assertSame($handler, $provider->getHandler($loggerProviderTypeCfg, 'test'));
         $this->assertInstanceOf(HandlerInterface::class, $handler);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`namespace Micro\Plugin\Logger\Monolog\Business\Handler;`
`13`	`13`
`14`	`14`	`use Micro\Component\DependencyInjection\Container;`
	`15`	`+use Micro\Plugin\Logger\Configuration\LoggerProviderTypeConfigurationInterface;`
`15`	`16`	`use Micro\Plugin\Logger\Monolog\Configuration\Handler\HandlerConfigurationFactoryInterface;`
`16`	`17`	`use Monolog\Handler\HandlerInterface;`
`17`	`18`
`@@ -23,14 +24,15 @@ public function __construct(`
`23`	`24`	`) {`
`24`	`25`	`}`
`25`	`26`
`26`		`- public function create(string $handlerName): HandlerInterface`
	`27`	`+ public function create(LoggerProviderTypeConfigurationInterface $loggerProviderTypeConfiguration, string $handlerName): HandlerInterface`
`27`	`28`	`{`
`28`	`29`	`$handlerConfiguration = $this->handlerConfigurationFactory->create($handlerName);`
`29`	`30`	`$handlerClassName = $handlerConfiguration->getHandlerClassName();`
`30`	`31`
`31`	`32`	`return new $handlerClassName(`
`32`	`33`	`$this->container,`
`33`		`- $handlerConfiguration`
	`34`	`+ $handlerConfiguration,`
	`35`	`+ $loggerProviderTypeConfiguration`
`34`	`36`	`);`
`35`	`37`	`}`
`36`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,9 +11,10 @@`
`11`	`11`
`12`	`12`	`namespace Micro\Plugin\Logger\Monolog\Business\Handler;`
`13`	`13`
	`14`	`+use Micro\Plugin\Logger\Configuration\LoggerProviderTypeConfigurationInterface;`
`14`	`15`	`use Monolog\Handler\HandlerInterface;`
`15`	`16`
`16`	`17`	`interface HandlerFactoryInterface`
`17`	`18`	`{`
`18`		`- public function create(string $handlerName): HandlerInterface;`
	`19`	`+ public function create(LoggerProviderTypeConfigurationInterface $loggerProviderTypeConfiguration, string $handlerName): HandlerInterface;`
`19`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Micro\Plugin\Logger\Monolog\Business\Handler;`
`13`	`13`
	`14`	`+use Micro\Plugin\Logger\Configuration\LoggerProviderTypeConfigurationInterface;`
`14`	`15`	`use Monolog\Handler\HandlerInterface;`
`15`	`16`
`16`	`17`	`class HandlerProvider implements HandlerProviderInterface`
`@@ -25,13 +26,10 @@ public function __construct(private HandlerFactoryInterface $handlerFactory)`
`25`	`26`	`$this->handlerCollection = [];`
`26`	`27`	`}`
`27`	`28`
`28`		`- /**`
`29`		`- * {@inheritDoc}`
`30`		`- */`
`31`		`- public function getHandler(string $handlerName): HandlerInterface`
	`29`	`+ public function getHandler(LoggerProviderTypeConfigurationInterface $loggerProviderTypeConfiguration, string $handlerName): HandlerInterface`
`32`	`30`	`{`
`33`	`31`	`if (!\array_key_exists($handlerName, $this->handlerCollection)) {`
`34`		`- $this->handlerCollection[$handlerName] = $this->handlerFactory->create($handlerName);`
	`32`	`+ $this->handlerCollection[$handlerName] = $this->handlerFactory->create($loggerProviderTypeConfiguration, $handlerName);`
`35`	`33`	`}`
`36`	`34`
`37`	`35`	`return $this->handlerCollection[$handlerName];`
Original file line number	Diff line number	Diff line change
`@@ -14,21 +14,22 @@`
`14`	`14`	`use Micro\Plugin\Logger\Configuration\LoggerProviderTypeConfigurationInterface;`
`15`	`15`	`use Micro\Plugin\Logger\Monolog\Configuration\Logger\MonologPluginConfigurationInterface;`
`16`	`16`
`17`		`-class HandlerResolver implements HandlerResolverInterface`
	`17`	`+readonly class HandlerResolver implements HandlerResolverInterface`
`18`	`18`	`{`
`19`	`19`	`public function __construct(`
`20`		`- private readonly MonologPluginConfigurationInterface $pluginConfiguration,`
`21`		`- private readonly HandlerProviderInterface $handlerProvider,`
`22`		`- private readonly LoggerProviderTypeConfigurationInterface $loggerProviderTypeConfiguration`
	`20`	`+ private MonologPluginConfigurationInterface $pluginConfiguration,`
	`21`	`+ private HandlerProviderInterface $handlerProvider,`
	`22`	`+ private LoggerProviderTypeConfigurationInterface $loggerProviderTypeConfiguration`
`23`	`23`	`) {`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`public function resolve(): \Traversable`
`27`	`27`	`{`
`28`		`- $loggerConfiguration = $this->pluginConfiguration->getLoggerConfiguration($this->loggerProviderTypeConfiguration->getLoggerName());`
	`28`	`+ $loggerConfiguration = $this->pluginConfiguration`
	`29`	`+ ->getLoggerConfiguration($this->loggerProviderTypeConfiguration->getLoggerName());`
`29`	`30`
`30`	`31`	`foreach ($loggerConfiguration->getHandlerList() as $handlerName) {`
`31`		`- yield $this->handlerProvider->getHandler($handlerName);`
	`32`	`+ yield $this->handlerProvider->getHandler($this->loggerProviderTypeConfiguration, $handlerName);`
`32`	`33`	`}`
`33`	`34`	`}`
`34`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@`
`37`	`37`	`*`
`38`	`38`	`* @method MonologPluginConfigurationInterface configuration()`
`39`	`39`	`*/`
`40`		`-class LoggerMonologPlugin implements DependencyProviderInterface, PluginDependedInterface, LoggerProviderPluginInterface, ConfigurableInterface`
	`40`	`+class MonologPlugin implements DependencyProviderInterface, PluginDependedInterface, LoggerProviderPluginInterface, ConfigurableInterface`
`41`	`41`	`{`
`42`	`42`	`use PluginConfigurationTrait;`
`43`	`43`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`
`14`	`14`	`namespace Micro\Plugin\Logger\Monolog\Test\Unit\Business\Handler;`
`15`	`15`
	`16`	`+use Micro\Plugin\Logger\Configuration\LoggerProviderTypeConfigurationInterface;`
`16`	`17`	`use Micro\Plugin\Logger\Monolog\Business\Handler\HandlerFactoryInterface;`
`17`	`18`	`use Micro\Plugin\Logger\Monolog\Business\Handler\HandlerProvider;`
`18`	`19`	`use Monolog\Handler\HandlerInterface;`
`@@ -22,15 +23,18 @@ class HandlerProviderTest extends TestCase`
`22`	`23`	`{`
`23`	`24`	`public function testGetHandler()`
`24`	`25`	`{`
	`26`	`+ $loggerProviderTypeCfg = $this->createMock(LoggerProviderTypeConfigurationInterface::class);`
`25`	`27`	`$handlerFactory = $this->createMock(HandlerFactoryInterface::class);`
`26`	`28`	`$handlerFactory->expects($this->once())`
`27`	`29`	`->method('create')`
`28`	`30`	`->willReturn(new TestHandlerImpl());`
`29`	`31`
`30`	`32`	`$provider = new HandlerProvider($handlerFactory);`
`31`		`- $handler = $provider->getHandler('test');`
	`33`	`+ $handler = $provider->getHandler(`
	`34`	`+ $loggerProviderTypeCfg,`
	`35`	`+ 'test');`
`32`	`36`
`33`		`- $this->assertSame($handler, $provider->getHandler('test'));`
	`37`	`+ $this->assertSame($handler, $provider->getHandler($loggerProviderTypeCfg, 'test'));`
`34`	`38`	`$this->assertInstanceOf(HandlerInterface::class, $handler);`
`35`	`39`	`}`
`36`	`40`	`}`