optionable

Author: cesargb

src/ErrorHandler.php

@@ -4,10 +4,16 @@
 
 use Throwable;
 
-class ErrorHandler
+trait ErrorHandler
 {
     private $catchCallable = null;
 
+    /**
+     * Call function if roteted catch any Exception.
+     *
+     * @param callable $callable
+     * @return self
+     */
     public function catch(callable $callable): self
     {
         $this->catchCallable = $callable;

src/Optionable.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Cesargb\Log;
+
+use LogicException;
+
+trait Optionable
+{
+    private $validMethods = [];
+
+    /**
+     * Set options
+     *
+     * @param array $options
+     * @throws LogicException
+     * @return self
+     */
+    public function options(array $options): self
+    {
+        foreach ($options as $key => $value) {
+            $this->setMethod($key, $value);
+        }
+
+        return $this;
+    }
+
+    protected function methodsOptionables(array $methods): self
+    {
+        $this->validMethods = $methods;
+
+        return $this;
+    }
+
+    private function setMethod($key, $value)
+    {
+        $method = $this->convert($key);
+
+        if (in_array($method, $this->validMethods)) {
+            $this->{$method}($value);
+        } else {
+            throw new LogicException("option {$key} is not valid.", 30);
+        }
+    }
+
+    private function convert(string $key): string
+    {
+        return lcfirst(
+            str_replace(
+                ' ',
+                '',
+                ucwords(str_replace(['-', '_'], ' ', $key))
+            )
+        );
+    }
+
+
+}

src/Rotation.php

@@ -8,6 +8,8 @@
 
 class Rotation
 {
+    use Optionable, ErrorHandler;
+
     private RotativeProcessor $processor;
 
     private bool $_compress = false;
@@ -16,13 +18,19 @@ class Rotation
 
     private $thenCallback = null;
 
-    private $errorHandler = null;
-
-    public function __construct()
+    public function __construct(array $options = [])
     {
         $this->processor = new RotativeProcessor();
 
-        $this->errorHandler = new ErrorHandler();
+        $this->methodsOptionables([
+            'compress',
+            'minSize',
+            'files',
+            'then',
+            'catch',
+        ]);
+
+        $this->options($options);
     }
 
     /**
@@ -41,11 +49,12 @@ public function files(int $count): self
     /**
      * Old versions of log files are compressed
      *
+     *@param bool $compress
      * @return self
      */
-    public function compress(): self
+    public function compress(bool $compress = true): self
     {
-        $this->_compress = true;
+        $this->_compress = $compress;
 
         $this->processor->compress();
 
@@ -79,19 +88,6 @@ public function then(callable $callable): self
         return $this;
     }
 
-    /**
-     * Call function if roteted catch any Exception.
-     *
-     * @param callable $callable
-     * @return self
-     */
-    public function catch(callable $callable): self
-    {
-        $this->errorHandler->catch($callable);
-
-        return $this;
-    }
-
     /**
      * Rotate file
      *
@@ -114,7 +110,7 @@ public function rotate(string $file): bool
             try {
                 $fileRotated = $gz->handler($fileRotated);
             } catch (Exception $error) {
-                $this->errorHandler->exception($error);
+                $this->exception($error);
 
                 $fileRotated = null;
             }
@@ -157,7 +153,7 @@ private function runProcessor(string $originalFile, ?string $fileRotated): ?stri
     private function canRotate(string $file): bool
     {
         if (! $this->fileIsValid($file)) {
-            $this->errorHandler->exception(
+            $this->exception(
                 new Exception(sprintf('the file %s not is valid.', $file), 10)
             );
 
@@ -204,7 +200,7 @@ private function moveContentToTempFile(string $file): ?string
         $fd = fopen($file, 'r+');
 
         if (! $fd) {
-            $this->errorHandler->exception(
+            $this->exception(
                 new Exception(sprintf('the file %s not can open.', $file), 20)
             );
 
@@ -214,7 +210,7 @@ private function moveContentToTempFile(string $file): ?string
         if (! flock($fd, LOCK_EX)) {
             fclose($fd);
 
-            $this->errorHandler->exception(
+            $this->exception(
                 new Exception(sprintf('the file %s not can lock.', $file), 21)
             );
 
@@ -224,7 +220,7 @@ private function moveContentToTempFile(string $file): ?string
         if (! copy($file, $fileDestination)) {
             fclose($fd);
 
-            $this->errorHandler->exception(
+            $this->exception(
                 new Exception(
                     sprintf('the file %s not can copy to temp file %s.', $file, $fileDestination),
                     22
@@ -239,7 +235,7 @@ private function moveContentToTempFile(string $file): ?string
 
             unlink($fileDestination);
 
-            $this->errorHandler->exception(
+            $this->exception(
                 new Exception(sprintf('the file %s not can truncate.', $file), 23)
             );
 

tests/OptionTest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Cesargb\Log\Test;
+
+use Exception;
+use Cesargb\Log\Rotation;
+use Cesargb\Log\Test\TestCase;
+
+class OptionTest extends TestCase
+{
+    public function test_pass_options()
+    {
+        $rotation = new Rotation([
+            'files' => 1,
+            'compress' => true,
+            'min-size' => 10,
+            'then' => function ($filename) {},
+            'catch' => function ($error) {},
+        ]);
+
+        $this->assertNotNull($rotation);
+    }
+
+    public function test_catch_exceptio_if_method_is_not_permited()
+    {
+        $this->expectException(\LogicException::class);
+
+        $r = new Rotation([
+            'bad-method' => null,
+        ]);
+    }
+}