Merge pull request #3 from kodedphp/3

v3.0.0

Author: kodeart

.scrutinizer.yml

@@ -7,7 +7,7 @@ build:
           - php-scrutinizer-run
       environment:
         php:
-          version: '7.3'
+          version: '8.0.1'
 
 before_commands:
   - 'composer update -o --prefer-source --no-interaction'

.travis.yml

@@ -1,14 +1,12 @@
 language: php
 os: linux
-dist: xenial
+dist: bionic
 
 notifications:
   email: false
 
 php:
-  - 7.2
-  - 7.3
-  - 7.4
+  - 8.0
   - nightly
 
 cache:

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2019, Mihail Binev
+Copyright (c) 2021, Mihail Binev
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

Log.php

@@ -13,6 +13,7 @@
 namespace Koded\Logging;
 
 use Koded\Logging\Processors\{Cli, Processor};
+use DateTimeZone;
 use Psr\Log\LoggerTrait;
 use Throwable;
 
@@ -65,27 +66,27 @@ class Log implements Logger
     /**
      * @var bool Flag to control the messages processing
      */
-    private $deferred = false;
+    private bool $deferred = false;
 
     /**
      * @var string The date format for the message.
      */
-    private $dateFormat;
+    private string $dateFormat;
 
     /**
-     * @var string Valid timezone for the message.
+     * @var DateTimeZone Valid timezone for the message.
      */
-    private $timezone = 'UTC';
+    private DateTimeZone|bool $timezone;
 
     /**
      * @var Processor[] Hash with all registered log processors.
      */
-    private $processors = [];
+    private array $processors = [];
 
     /**
      * @var array List with all accumulated messages.
      */
-    private $messages = [];
+    private array $messages = [];
 
     /**
      * Creates all requested log processors.
@@ -96,70 +97,48 @@ public function __construct(array $settings)
     {
         $this->deferred = (bool)($settings['deferred'] ?? false);
         $this->dateFormat = (string)($settings['dateformat'] ?? 'd/m/Y H:i:s.u');
-        $this->timezone = (string)($settings['timezone'] ?? $this->timezone);
-
+        if (false === $this->timezone = @\timezone_open((string)($settings['timezone'] ?? 'UTC'))) {
+            $this->timezone = \timezone_open('UTC');
+        }
         foreach ((array)($settings['loggers'] ?? []) as $processor) {
             $this->attach(new $processor['class']($processor));
         }
-
         if ($this->deferred) {
-            register_shutdown_function([$this, 'process']);
+            \register_shutdown_function([$this, 'process']);
         }
     }
 
     public function attach(Processor $processor): Logger
     {
         if (0 !== $processor->levels()) {
-            $this->processors[spl_object_hash($processor)] = $processor;
+            $this->processors[\spl_object_hash($processor)] = $processor;
         }
-
         return $this;
     }
 
     public function log($level, $message, array $context = [])
     {
         try {
-            $levelname = strtoupper($level);
-            $level = constant('self::' . $levelname);
-        } catch (Throwable $e) {
-            $levelname = 'LOG';
+            $levelName = \strtoupper($level);
+            $level = \constant('static::' . $levelName);
+        } catch (Throwable) {
+            $levelName = 'LOG';
             $level = -1;
         }
-
         $this->messages[] = [
             'level'     => $level,
-            'levelname' => $levelname,
+            'levelname' => $levelName,
             'message'   => $this->formatMessage($message, $context),
-            'timestamp' => date_create_immutable('now', timezone_open($this->timezone) ?: null)->format($this->dateFormat),
+            'timestamp' => \date_create_immutable('now', $this->timezone ?: null)->format($this->dateFormat),
         ];
-
         $this->deferred || $this->process();
     }
 
-    /**
-     * Parses the message as in the interface specification.
-     *
-     * @param string|object $message A string or object that implements __toString
-     * @param array         $params  [optional] Arbitrary data with key-value pairs replacements
-     *
-     * @return string
-     */
-    private function formatMessage($message, array $params = []): string
-    {
-        $replacements = [];
-        foreach ($params as $k => $v) {
-            $replacements['{' . $k . '}'] = $v;
-        }
-
-        return strtr((string)$message, $replacements);
-    }
-
     public function process(): void
     {
         foreach ($this->processors as $processor) {
             $processor->update($this->messages);
         }
-
         $this->messages = [];
     }
 
@@ -175,8 +154,24 @@ public function exception(Throwable $e, Processor $processor = null): void
 
     public function detach(Processor $processor): Logger
     {
-        unset($this->processors[spl_object_hash($processor)]);
-
+        unset($this->processors[\spl_object_hash($processor)]);
         return $this;
     }
+
+    /**
+     * Parses the message as in the interface specification.
+     *
+     * @param object|string $message A string or object that implements __toString
+     * @param array         $params  [optional] Arbitrary data with key-value pairs replacements
+     *
+     * @return string
+     */
+    private function formatMessage(object|string $message, array $params = []): string
+    {
+        $replacements = [];
+        foreach ($params as $k => $v) {
+            $replacements['{' . $k . '}'] = $v;
+        }
+        return \strtr((string)$message, $replacements);
+    }
 }

Processors/Cli.php

@@ -13,27 +13,24 @@
 namespace Koded\Logging\Processors;
 
 /**
- * Log processor for CLI apps.
+ * Log processor for CLI.
  *
  */
 class Cli extends Processor
 {
-    /** @var string Message format */
-    protected $format = '> [timestamp][levelname] - message';
+    protected string $format = '> [timestamp][levelname] - message';
 
-    /** @var bool */
-    private $buffer;
+    /** @var resource */
+    private $handle;
 
     public function __construct(array $settings)
     {
         parent::__construct($settings);
-        $this->buffer = defined('STDERR');
+        $this->handle = \defined('STDERR') ? STDERR : \fopen('php://stderr', 'w');
     }
 
-    protected function parse(array $message): void
+    protected function process(array $message): void
     {
-        if ($this->buffer) {
-            fwrite(STDERR, strtr($this->format, $message) . PHP_EOL);
-        }
+        \fwrite($this->handle, \strtr($this->format, $message) . PHP_EOL);
     }
 }

Processors/ErrorLog.php

@@ -18,8 +18,8 @@
  */
 class ErrorLog extends Processor
 {
-    protected function parse(array $message): void
+    protected function process(array $message): void
     {
-        error_log(strtr($this->format, $message), 0);
+        \error_log(strtr($this->format, $message), 0);
     }
 }

Processors/File.php

@@ -31,8 +31,8 @@
  */
 class File extends Processor
 {
-    private $dir = '';
-    private $ext = '';
+    private string $dir = '';
+    private string $ext = '';
 
     /**
      * {@inheritdoc}
@@ -41,29 +41,29 @@ public function __construct(array $settings)
     {
         parent::__construct($settings);
 
-        umask(umask() | 0002);
+        \umask(\umask() | 0002);
         $this->ext = (string)($settings['extension'] ?? '.log');
-        $this->dir = rtrim((string)$settings['dir'], '/');
+        $this->dir = \rtrim((string)$settings['dir'], '/');
 
-        if (false === is_dir($this->dir)) {
+        if (false === \is_dir($this->dir)) {
             throw FileProcessorException::directoryDoesNotExist($this->dir);
         }
 
-        if (false === is_writable($this->dir)) {
+        if (false === \is_writable($this->dir)) {
             throw FileProcessorException::directoryIsNotWritable($this->dir);
         }
 
         $this->dir .= '/';
     }
 
-    protected function parse(array $message): void
+    protected function process(array $message): void
     {
         try {
             // The filename should be calculated at the moment of writing
-            $dir = $this->dir . date('Y/m');
-            is_dir($dir) || mkdir($dir, 0775, true);
+            $dir = $this->dir . \date('Y/m');
+            \is_dir($dir) || \mkdir($dir, 0775, true);
 
-            file_put_contents($dir . '/' . date('d') . $this->ext, strtr($this->format, $message) . PHP_EOL,
+            \file_put_contents($dir . '/' . \date('d') . $this->ext, \strtr($this->format, $message) . PHP_EOL,
                 FILE_APPEND);
 
             // @codeCoverageIgnoreStart
@@ -78,20 +78,21 @@ protected function parse(array $message): void
 class FileProcessorException extends KodedException
 {
     private const
-        E_DIRECTORY_DOES_NOT_EXIST = 1, E_DIRECTORY_NOT_WRITABLE = 2;
+        E_DIRECTORY_DOES_NOT_EXIST = 1,
+        E_DIRECTORY_NOT_WRITABLE = 2;
 
-    protected $messages = [
+    protected array $messages = [
         self::E_DIRECTORY_DOES_NOT_EXIST => 'Log directory ":dir" must exist',
         self::E_DIRECTORY_NOT_WRITABLE   => 'Log directory ":dir" must be writable',
     ];
 
-    public static function directoryDoesNotExist(string $directory): self
+    public static function directoryDoesNotExist(string $directory): static
     {
-        return new self(self::E_DIRECTORY_DOES_NOT_EXIST, [':dir' => $directory]);
+        return new static(static::E_DIRECTORY_DOES_NOT_EXIST, [':dir' => $directory]);
     }
 
-    public static function directoryIsNotWritable(string $directory): self
+    public static function directoryIsNotWritable(string $directory): static
     {
-        return new self(self::E_DIRECTORY_NOT_WRITABLE, [':dir' => $directory]);
+        return new static(static::E_DIRECTORY_NOT_WRITABLE, [':dir' => $directory]);
     }
 }

Processors/Memory.php

@@ -18,8 +18,8 @@
  */
 class Memory extends Processor
 {
-    protected function parse(array $message): void
+    protected function process(array $message): void
     {
-        $this->formatted .= PHP_EOL . strtr($this->format, $message);
+        $this->formatted .= PHP_EOL . \strtr($this->format, $message);
     }
 }

Processors/Processor.php

@@ -27,7 +27,7 @@ abstract class Processor
     /**
      * @var string The log message format.
      */
-    protected $format = 'timestamp [levelname]: message';
+    protected string $format = 'timestamp [levelname]: message';
 
     /**
      * @var string Keeps all formatted log messages in this property.
@@ -55,7 +55,7 @@ public function update(array $messages): void
     {
         foreach ($messages as $message) {
             if ($message['level'] & $this->levels) {
-                $this->parse($message);
+                $this->process($message);
             }
         }
     }
@@ -68,7 +68,7 @@ public function update(array $messages): void
      *
      * @return void
      */
-    abstract protected function parse(array $message): void;
+    abstract protected function process(array $message): void;
 
     /**
      * Returns all enabled log levels for the processor object.

Processors/Syslog.php

@@ -21,9 +21,9 @@
  */
 class Syslog extends Processor
 {
-    protected $format = '[levelname] message';
+    protected string $format = '[levelname] message';
 
-    protected function parse(array $message): void
+    protected function process(array $message): void
     {
         $levels = [
             Logger::DEBUG     => LOG_DEBUG,
@@ -37,10 +37,10 @@ protected function parse(array $message): void
         ];
 
         try {
-            openlog(null, LOG_CONS, LOG_USER);
-            syslog($levels[$message['level']] ?? LOG_DEBUG, strtr($this->format, $message));
+            \openlog(null, LOG_CONS, LOG_USER);
+            \syslog($levels[$message['level']] ?? LOG_DEBUG, \strtr($this->format, $message));
         } finally {
-            closelog();
+            \closelog();
         }
     }
 }