Clean code after refactoring

Author: jakubboucek

README.md

@@ -9,7 +9,7 @@ at any environment.
 Package allows your app to switch to Debug Mode:
 - automatically on localhost's environment by IP,
 - semi-automatically on any environment where you set `APP_DEBUG` environment variable (useful for Docker dev-stack),
-- semi-automatically disable Debug mode on any environment where you set `app-debug-mode` cookie variable (useful for
+- semi-automatically **disable** Debug mode on any environment where you set `app-debug-mode` cookie variable (useful for
 tests and similar cases),
 - manually enable/disable (force turn-on or turn-off) Debug Mode.
 
@@ -20,7 +20,10 @@ Package is optimized for invoking in very early lifecycle phase of your App
 ## Requirements
 Package requires:
 
-- PHP version at least 7.3
+- PHP version at least 7.4
+
+Enabler requires:
+ 
 - Temporary directory with writable access
 
 ## Installation
@@ -31,17 +34,15 @@ composer require redbitcz/debug-mode-enabler
 ## Using
 Anywhere in your app you can determine if app is running in Debug mode by simple code:
 ```php
-$debugMode = \Redbitcz\DebugMode\Detector::detect($tempDir); //bool
+$debugMode = \Redbitcz\DebugMode\Detector::detect(); //bool
 ```
-where `$tempDir` is required path to temporary directory.
 
 It returns `$debugMode` = `true` when it detects Debug environment or manually switched.
 
 ### Using with Nette
 In Boostrap use package like in this example:
 ```php
-$tempDir = __DIR__ . '/../temp';
-$debugModeDetector = new \Redbitcz\DebugMode\Detector($tempDir);
+$debugModeDetector = new \Redbitcz\DebugMode\Detector();
 
 $configurator = new Configurator();
 $configurator->setDebugMode($debugModeDetector->isDebugMode());
@@ -72,6 +73,9 @@ Enabler provide feature to force enable or disable Debug Mode anywhere for user'
 This example turn on Debug Mode for user's browser:
 ```php
 $enabler = new \Redbitcz\DebugMode\Enabler($tempDir);
+
+$detector = new \Redbitcz\DebugMode\Detector(\Redbitcz\DebugMode\Detector::MODE_FULL, $enabler);
+
 $enabler->activate(true);
 ```
 
@@ -93,7 +97,8 @@ internally with `Detector` instance in `Bootstrap`.
 To re-use already existing instance you can inject it to DI Container:
 ```php
 $tempDir = __DIR__ . '/../temp';
-$debugModeDetector = new \Redbitcz\DebugMode\Detector($tempDir);
+$enabler = new \Redbitcz\DebugMode\Enabler($tempDir);
+$debugModeDetector = new \Redbitcz\DebugMode\Detector(\Redbitcz\DebugMode\Detector::MODE_FULL, $enabler);
 
 $configurator = new Configurator();
 $configurator->setDebugMode($debugModeDetector->isDebugMode());

src/Detector.php

@@ -35,12 +35,10 @@ class Detector
     public const MODE_FULL = self::MODE_ENABLER | self::MODE_SIMPLE;
 
 
-    /** @var Enabler|null */
-    private $enabler;
-    /** @var int */
-    private $mode;
+    private ?Enabler $enabler;
+    private int $mode;
     /** @var string[] */
-    private $ips = ['::1', '127.0.0.1'];
+    private array $ips = ['::1', '127.0.0.1'];
 
     /**
      * @param int $mode Enables methods which is used to detect Debug mode
@@ -49,7 +47,7 @@ class Detector
     public function __construct(int $mode = self::MODE_SIMPLE, ?Enabler $enabler = null)
     {
         if ($enabler === null && $mode & self::MODE_ENABLER) {
-            throw new MissingEnablerException(
+            throw new InconsistentEnablerModeException(
                 'Enabler mode (and Full mode) requires the Enabler instance in constructor'
             );
         }
@@ -61,7 +59,7 @@ public function __construct(int $mode = self::MODE_SIMPLE, ?Enabler $enabler = n
     public function getEnabler(): Enabler
     {
         if ($this->enabler === null) {
-            throw new MissingEnablerException('Unable to get Enabler because Detector constructed without it');
+            throw new InconsistentEnablerModeException('Unable to get Enabler because Detector constructed without it');
         }
 
         return $this->enabler;
@@ -183,7 +181,7 @@ public static function detect(
         ?bool $default = false
     ): ?bool {
         if ($tempDir === null && $mode & self::MODE_ENABLER) {
-            throw new MissingEnablerException('Enabler mode requires \'tempDir\' argument');
+            throw new InconsistentEnablerModeException('Enabler mode (and Full mode) requires \'tempDir\' argument');
         }
 
         $enabler = $tempDir === null ? null : new Enabler($tempDir);

src/MissingEnablerException.php renamed to src/InconsistentEnablerModeException.php

@@ -4,6 +4,6 @@
 
 namespace Redbitcz\DebugMode;
 
-class MissingEnablerException extends \LogicException
+class InconsistentEnablerModeException extends \LogicException
 {
 }

tests/DetectorTest.php

@@ -6,7 +6,7 @@
 
 use Redbitcz\DebugMode\Detector;
 use Redbitcz\DebugMode\Enabler;
-use Redbitcz\DebugMode\MissingEnablerException;
+use Redbitcz\DebugMode\InconsistentEnablerModeException;
 use Tester\Assert;
 use Tester\Helpers;
 use Tester\TestCase;
@@ -195,22 +195,22 @@ public function testMissingEnablerMode(): void
     {
         Assert::exception(function () {
             $detector = new Detector(Detector::MODE_FULL);
-        }, MissingEnablerException::class);
+        }, InconsistentEnablerModeException::class);
     }
 
     public function testMissingEnabler(): void
     {
         Assert::exception(function () {
             $detector = new Detector(Detector::MODE_SIMPLE);
             $detector->getEnabler();
-        }, MissingEnablerException::class);
+        }, InconsistentEnablerModeException::class);
     }
 
     public function testMissingEnablerShortcut(): void
     {
         Assert::exception(function () {
             Detector::detect(Detector::MODE_FULL);
-        }, MissingEnablerException::class);
+        }, InconsistentEnablerModeException::class);
     }
 }