Merge pull request #7 from fabacino/feature/remove-monolog-dependency

Remove dependency to Monolog, accept any PSR-3 compatible logger

Author: fabacino

README.md

@@ -45,7 +45,6 @@ dbg([
 a string
 Array
 (
-    [id] => 123
     [token] => dp83kspo
     [is_default] => true
 )
@@ -105,10 +104,10 @@ dbginit(['log_file' => '/path/to/logfile']);
 dbglog($this->doSomething());
 ```
 
- Alternatively you can pass your own monolog logger instance:
+Alternatively you can pass your own PSR-3 compatible logger:
 
 ```php
-$logger = new Logger('channel-name');
+$logger = new YourLogger();
 ...
 dbginit(['logger' => $logger]);
 dbglog($this->doSomething());

composer.json

@@ -11,7 +11,7 @@
     ],
     "require": {
         "php": ">=7.0",
-        "monolog/monolog": "^1.23"
+        "psr/log": "^1.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^6.0"

composer.lock

@@ -11,10 +11,8 @@
 
 namespace Fabacino\Debug;
 
-use Monolog\Logger;
-use Monolog\Formatter\LineFormatter;
-use Monolog\Handler\NullHandler;
-use Monolog\Handler\StreamHandler;
+use Fabacino\Debug\Logger;
+use Psr\Log\LoggerInterface;
 
 /**
  * Main class.
@@ -27,13 +25,6 @@ class Debug
     const USE_VARDUMP = 1;
     const USE_HTMLENTITIES = 2;
 
-    /**
-     * Default values for Monolog options.
-     */
-    const CHANNEL_NAME = 'fabacino/debug';
-    const OUTPUT_FORMAT = "%datetime%: %message%\n";
-    const DATE_FORMAT = null;
-
     /**
      * Default flags for tweaking the output.
      *
@@ -42,9 +33,9 @@ class Debug
     private $defaultFlags;
 
     /**
-     * Monolog logger.
+     * The logger instance.
      *
-     * @var Logger
+     * @var LoggerInterface
      */
     private $Logger;
 
@@ -58,12 +49,12 @@ class Debug
     /**
      * Constructor.
      *
-     * @param int     $defaultFlags  Default flags for tweaking the output.
-     * @param Logger  $Logger        The monolog logger.
+     * @param int              $defaultFlags  Default flags for tweaking the output.
+     * @param LoggerInterface  $Logger        The logger instance.
      *
      * @return void
      */
-    private function __construct(int $defaultFlags, Logger $Logger)
+    private function __construct(int $defaultFlags, LoggerInterface $Logger)
     {
         $this->defaultFlags = $defaultFlags;
         $this->Logger = $Logger;
@@ -90,10 +81,11 @@ public static function getInstance(): Debug
      *  - use_vardump: Use vardump for debug output? (boolean, default = false)
      *  - use_htmlentities: Use htmlentities for debug output? (boolean, default = false)
      *  - log_file: The log file. (string, default = null)
-     *  - logger: The logger to use. (Logger, default = null)
+     *  - logger: The logger to use. (LoggerInterface, default = null)
      *
      * The settings `log_file` and `logger` are only used when calling `logValue()`.
-     * If `logger` is specified, `log_file` will be ignored.
+     * If `logger` is specified, `log_file` will be ignored. If neither is present,
+     * nothing will be logged.
      *
      * @param array  $settings  Settings.
      *
@@ -102,46 +94,28 @@ public static function getInstance(): Debug
     public static function init(array $settings = [])
     {
         $defaultFlags = 0;
+
         if (isset($settings['use_vardump']) && $settings['use_vardump']) {
             $defaultFlags |= self::USE_VARDUMP;
         }
         if (isset($settings['use_htmlentities']) && $settings['use_htmlentities']) {
             $defaultFlags |= self::USE_HTMLENTITIES;
         }
 
-        if (isset($settings['logger']) && $settings['logger'] instanceof Logger) {
+        if (isset($settings['logger']) && $settings['logger'] instanceof LoggerInterface) {
             $Logger = $settings['logger'];
         } else {
             if (isset($settings['log_file'])) {
-                $Stream = self::initStream($settings['log_file']);
+                $Logger = new Logger($settings['log_file']);
             } else {
                 // We didn't get any file to log.
-                $Stream = new NullHandler(Logger::DEBUG);
+                $Logger = new Logger();
             }
-
-            $Logger = new Logger(self::CHANNEL_NAME);
-            $Logger->pushHandler($Stream);
         }
 
         self::$Instance = new static($defaultFlags, $Logger);
     }
 
-    /**
-     * Create stream handler for logger.
-     *
-     * @param string  $logFile  The log file.
-     *
-     * @return StreamHandler
-     */
-    private static function initStream(string $logFile): StreamHandler
-    {
-        $Stream = new StreamHandler($logFile, Logger::DEBUG);
-        $Stream->setFormatter(
-            new LineFormatter(self::OUTPUT_FORMAT, self::DATE_FORMAT, true)
-        );
-        return $Stream;
-    }
-
     /**
      * Print debug value
      *
@@ -205,7 +179,7 @@ public function debugValue($var, int $flags = null)
      */
     public function logValue($var, int $flags = null)
     {
-        $this->Logger->addDebug(static::debugValue($var, $flags));
+        $this->Logger->debug(static::debugValue($var, $flags));
     }
 
     /**