[BREAKING] Upgrading monolog dependency to 2.0

composer.json

@@ -2,11 +2,11 @@
   "name": "pluggit/logging",
   "description": "Logging provides a thin PSR-7 interface abstraction to connect any logging facility behind it.",
   "require": {
-    "php": "^5.4|^7.0",
+    "php": "^7.2",
     "psr/log": "^1.0"
   },
   "require-dev": {
-    "monolog/monolog": "^1.23",
+    "monolog/monolog": "^2.0",
     "phpspec/phpspec": "^2.5",
     "behat/behat": "^3.1",
     "phpunit/phpunit": "4.8.*",

spec/Monolog/Handler/RotatingFileHandlerBuilderSpec.php

@@ -11,7 +11,7 @@ class RotatingFileHandlerBuilderSpec extends ObjectBehavior
 {
     function let()
     {
-        $this->beConstructedWith('log', 'Y-m-d', '{channel}.log', 14, '{date}_{filename}', Logger::NOTICE);
+        $this->beConstructedWith('log', 'Y-m-d', 14, '{channel}.log', '{date}_{filename}', Logger::NOTICE);
         if( ! ini_get('date.timezone') )
         {
             date_default_timezone_set('UTC');

spec/Monolog/Handler/SyslogUdpHandlerBuilderSpec.php

@@ -11,7 +11,7 @@ class SyslogUdpHandlerBuilderSpec extends ObjectBehavior
 {
     function let()
     {
-        $this->beConstructedWith('log', 'Y-m-d', '{channel}.log', 14, '{date}_{filename}', Logger::NOTICE);
+        $this->beConstructedWith('syshost', 1234, Logger::NOTICE);
         if( ! ini_get('date.timezone') )
         {
             date_default_timezone_set('UTC');

spec/Monolog/LoggingFactorySpec.php

@@ -6,8 +6,10 @@
 use Cmp\Logging\Monolog\Handler\RotatingFileHandlerBuilder;
 use Cmp\Logging\Monolog\Handler\SyslogUdpHandlerBuilder;
 use Monolog\Formatter\FormatterInterface;
+use Monolog\Handler\AbstractHandler;
 use Monolog\Handler\HandlerInterface;
 use Monolog\Handler\RotatingFileHandler;
+use Monolog\Handler\SyslogUdpHandler;
 use Monolog\Logger;
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;
@@ -34,7 +36,7 @@ function it_should_return_logger_with_appropriate_channel()
         $this->get('test_a')->getName()->shouldReturn('test_a');
     }
 
-    function it_should_return_handler(HandlerBuilderInterface $handlerBuilder, HandlerInterface $handler, FormatterInterface $formatter)
+    function it_should_return_handler(HandlerBuilderInterface $handlerBuilder, AbstractHandler $handler, FormatterInterface $formatter)
     {
         $this->beConstructedWith('test', 'error', $formatter);
         $channelName = 'test';
@@ -43,20 +45,20 @@ function it_should_return_handler(HandlerBuilderInterface $handlerBuilder, Handl
         $this->get($channelName)->getHandlers()->shouldReturn([$handler]);
     }
 
-    function it_should_return_many_handlers(RotatingFileHandlerBuilder $rotatingFileHandlerBuilder, SyslogUdpHandlerBuilder $syslogUdpHandlerBuilder, RotatingFileHandler $rotatingFileHandler, FormatterInterface $formatter)
+    function it_should_return_many_handlers(RotatingFileHandlerBuilder $rotatingFileHandlerBuilder, SyslogUdpHandlerBuilder $syslogUdpHandlerBuilder, RotatingFileHandler $rotatingFileHandler, SyslogUdpHandler $syslogUdpHandler, FormatterInterface $formatter)
     {
         $this->beConstructedWith('test', 'error', $formatter);
         $channelName = 'test';
         $rotatingFileHandlerBuilder->build($channelName, $formatter, [])->willReturn($rotatingFileHandler);
-        $syslogUdpHandlerBuilder->build($channelName, $formatter, [])->willReturn($syslogUdpHandlerBuilder);
+        $syslogUdpHandlerBuilder->build($channelName, $formatter, [])->willReturn($syslogUdpHandler);
         $this->addHandlerBuilder($rotatingFileHandlerBuilder);
         $this->addHandlerBuilder($syslogUdpHandlerBuilder);
-        $this->get($channelName)->getHandlers()->shouldReturn([$rotatingFileHandler, $syslogUdpHandlerBuilder]);
+        $this->get($channelName)->getHandlers()->shouldReturn([$rotatingFileHandler, $syslogUdpHandler]);
     }
 
     function it_should_build_rotating_file_handler()
     {
-        $this->addRotatingFileHandlerBuilder('log', 'Y-m-d', '{channel}.log', 14, '{date}_{filename}', Logger::NOTICE);
+        $this->addRotatingFileHandlerBuilder('log', 'Y-m-d', 14, '{channel}.log', '{date}_{filename}', Logger::NOTICE);
         $this->get('test')->getHandlers()[0]->shouldBeAnInstanceOf('Monolog\Handler\RotatingFileHandler');
     }
 
@@ -75,7 +77,7 @@ function it_should_build_stdout_handler()
     function it_should_build_all_handlers()
     {
         $this->addSyslogUdpHandlerBuilder('123.34.4.45', 89, Logger::NOTICE);
-        $this->addRotatingFileHandlerBuilder('log', 'Y-m-d', '{channel}.log', 14, '{date}_{filename}', Logger::NOTICE);
+        $this->addRotatingFileHandlerBuilder('log', 'Y-m-d', 14, '{channel}.log', '{date}_{filename}', Logger::NOTICE);
         $this->addStdoutHandlerBuilder(Logger::NOTICE);
         $this->get('test')->getHandlers()[0]->shouldBeAnInstanceOf('Monolog\Handler\SyslogUdpHandler');
         $this->get('test')->getHandlers()[1]->shouldBeAnInstanceOf('Monolog\Handler\RotatingFileHandler');

src/Monolog/Formatter/ElasticSearchFormatter.php

@@ -19,7 +19,7 @@ class ElasticSearchFormatter extends JsonFormatter
      *
      * @return mixed The formatted record
      */
-    public function format(array $record)
+    public function format(array $record): string
     {
         $this->formatContextException($record);
         if (!empty($record['context'])) {
@@ -52,7 +52,7 @@ protected function removeContextFromRecordIfEmpty(array $record)
      *
      * @return string
      */
-    protected function formatBatchJson(array $records)
+    protected function formatBatchJson(array $records): string
     {
         $cleanRecords = array_map(
             function ($record) {

src/Monolog/Formatter/ExceptionFormatterTrait.php

@@ -11,11 +11,11 @@
 trait ExceptionFormatterTrait
 {
     /**
-     * @param \Exception $e
+     * @param \Throwable $e
      *
      * @return array
      */
-    protected function normalizeException($e)
+    protected function normalizeException(\Throwable $e, int $depth = 0): array
     {
         // TODO 2.0 only check for Throwable
         if (!$e instanceof \Exception && !$e instanceof \Throwable) {

src/Monolog/Handler/HandlerBuilderInterface.php

@@ -3,6 +3,7 @@
 
 use Monolog\Formatter\FormatterInterface;
 use Monolog\Handler\AbstractHandler;
+use Monolog\Handler\HandlerInterface;
 
 interface HandlerBuilderInterface
 {
@@ -13,5 +14,5 @@ interface HandlerBuilderInterface
      *
      * @return AbstractHandler
      */
-    public function build($channelName, FormatterInterface $formatter, $processors = []);
+    public function build($channelName, FormatterInterface $formatter, $processors = []): AbstractHandler;
 }

src/Monolog/Handler/RotatingFileHandlerBuilder.php

@@ -2,6 +2,7 @@
 namespace Cmp\Logging\Monolog\Handler;
 
 use Monolog\Formatter\FormatterInterface;
+use Monolog\Handler\AbstractHandler;
 use Monolog\Handler\RotatingFileHandler;
 
 class RotatingFileHandlerBuilder implements HandlerBuilderInterface
@@ -46,8 +47,14 @@ class RotatingFileHandlerBuilder implements HandlerBuilderInterface
      * @param $fileNameFormat
      * @param $level
      */
-    public function __construct($directoryPath, $dateFormat, $maxFiles, $fileName, $fileNameFormat, $level)
-    {
+    public function __construct(
+        string $directoryPath,
+        string $dateFormat,
+        int $maxFiles,
+        string $fileName,
+        string $fileNameFormat,
+        int $level
+    ) {
         $this->dateFormat = $dateFormat;
         $this->maxFiles = $maxFiles;
         $this->fileName = $fileName;
@@ -60,7 +67,7 @@ public function __construct($directoryPath, $dateFormat, $maxFiles, $fileName, $
     /**
      * @inheritDoc
      */
-    public function build($channelName, FormatterInterface $formatter, $processors = [])
+    public function build($channelName, FormatterInterface $formatter, $processors = []): AbstractHandler
     {
         $fileName = $this->directoryPath.'/'.str_replace('{channel}', $channelName, $this->fileName);
         $handler = new RotatingFileHandler($fileName, $this->maxFiles);

src/Monolog/Handler/StdoutHandlerBuilder.php

@@ -36,7 +36,7 @@ public function __construct($level)
      *
      * @throws \Exception
      */
-    public function build($channelName, FormatterInterface $formatter, $processors = [])
+    public function build($channelName, FormatterInterface $formatter, $processors = []): AbstractHandler
     {
         if (!$this->handler) {
             $this->handler = new StreamHandler("php://stdout");

src/Monolog/Handler/SyslogUdpHandlerBuilder.php

@@ -3,6 +3,7 @@
 
 use Monolog\Formatter\FormatterInterface;
 use Monolog\Handler\AbstractHandler;
+use Monolog\Handler\HandlerInterface;
 use Monolog\Handler\SyslogUdpHandler;
 
 class SyslogUdpHandlerBuilder implements HandlerBuilderInterface
@@ -18,7 +19,7 @@ class SyslogUdpHandlerBuilder implements HandlerBuilderInterface
     private $syslogUdpHost;
 
     /**
-     * @var string
+     * @var integer
      */
     private $syslogUdpPort;
 
@@ -31,10 +32,10 @@ class SyslogUdpHandlerBuilder implements HandlerBuilderInterface
      * SyslogUdpHandlerBuilder constructor.
      *
      * @param string  $syslogUdpHost
-     * @param string  $syslogUdpPort
+     * @param integer  $syslogUdpPort
      * @param integer $level
      */
-    public function __construct($syslogUdpHost, $syslogUdpPort, $level)
+    public function __construct(string $syslogUdpHost, int $syslogUdpPort, int $level)
     {
         $this->syslogUdpHost = $syslogUdpHost;
         $this->syslogUdpPort = $syslogUdpPort;
@@ -44,7 +45,7 @@ public function __construct($syslogUdpHost, $syslogUdpPort, $level)
     /**
      * @inheritDoc
      */
-    public function build($channelName, FormatterInterface $formatter, $processors = [])
+    public function build($channelName, FormatterInterface $formatter, $processors = []): AbstractHandler
     {
         if (!$this->syslogUdpHandler) {
             if (empty($this->syslogUdpHost)) {

src/Monolog/Handler/TestHandlerBuilder.php

@@ -2,6 +2,7 @@
 namespace Cmp\Logging\Monolog\Handler;
 
 use Monolog\Formatter\FormatterInterface;
+use Monolog\Handler\AbstractHandler;
 use Monolog\Handler\TestHandler;
 
 class TestHandlerBuilder implements HandlerBuilderInterface
@@ -14,7 +15,7 @@ class TestHandlerBuilder implements HandlerBuilderInterface
     /**
      * @inheritDoc
      */
-    public function build($channelName, FormatterInterface $formatter, $processors = [])
+    public function build($channelName, FormatterInterface $formatter, $processors = []): AbstractHandler
     {
         if (is_null($this->handler)) {
             $this->handler = new TestHandler();

src/Monolog/Logger/SilentLogger.php

@@ -16,7 +16,7 @@ class SilentLogger extends Logger
      * @param  array   $context The log context
      * @return Boolean Whether the record has been processed
      */
-    public function addRecord($level, $message, array $context = array())
+    public function addRecord($level, $message, array $context = array()): bool
     {
         try{
             $context = array_merge($this->defaultContext, $context);