catch exceptions

Author: cesargb

.vscode/launch.json

@@ -0,0 +1,22 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Listen for XDebug",
+            "type": "php",
+            "request": "launch",
+            "port": 9000
+        },
+        {
+            "name": "Launch currently open script",
+            "type": "php",
+            "request": "launch",
+            "program": "${file}",
+            "cwd": "${fileDirname}",
+            "port": 9000
+        }
+    ]
+}

README.md

@@ -26,6 +26,8 @@ $rotation
     ->compress() // Optional, compress the file after rotated
     ->files(30) // Optional, files are rotated 30 times before being removed
     ->minSize(1024) // Optional, are rotated when they grow bigger than 1024 bytes
+    ->then(function ($filename) {}) // Optional, to get filename rotated
+    ->catch(function ($exception) {}) // Optional, to catch a exception in rotating
     ->rotate('file.log');
 ```
 

src/Compress/Gz.php

@@ -2,26 +2,28 @@
 
 namespace Cesargb\Log\Compress;
 
+use Exception;
+
 class Gz
 {
     const EXTENSION_COMPRESS = 'gz';
 
-    public function handler($file): ?string
+    public function handler($file): string
     {
         $fileCompress = $file.'.'.self::EXTENSION_COMPRESS;
 
         $fd = fopen($file, 'r');
 
         if (!$fd) {
-            return null;
+            throw new Exception("file {$file} not can read.", 100);
         }
 
         $gz = gzopen($fileCompress, 'wb');
 
         if (! $gz) {
             fclose($fd);
 
-            return null;
+            throw new Exception("file {$fileCompress} not can open.", 101);
         }
 
         while (! feof($fd)) {

src/ErrorHandler.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Cesargb\Log;
+
+use Throwable;
+
+class ErrorHandler
+{
+    private $catchCallable = null;
+
+    public function catch(callable $callable): self
+    {
+        $this->catchCallable = $callable;
+
+        return $this;
+    }
+
+    public function exception(Throwable $exception): self
+    {
+        if ($this->catchCallable) {
+            call_user_func($this->catchCallable, $exception);
+        } else {
+            throw $exception;
+        }
+
+        return $this;
+    }
+}

src/Rotation.php

@@ -4,7 +4,7 @@
 
 use Cesargb\Log\Compress\Gz;
 use Cesargb\Log\Processors\RotativeProcessor;
-use LogicException;
+use Exception;
 
 class Rotation
 {
@@ -16,9 +16,13 @@ class Rotation
 
     private $thenCallback = null;
 
+    private $errorHandler = null;
+
     public function __construct()
     {
         $this->processor = new RotativeProcessor();
+
+        $this->errorHandler = new ErrorHandler();
     }
 
     /**
@@ -75,6 +79,19 @@ 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
      *
@@ -94,7 +111,14 @@ public function rotate(string $file): bool
         if ($fileRotated && $this->_compress) {
             $gz = new Gz();
 
-            $fileRotated = $gz->handler($fileRotated);
+            try {
+                $fileRotated = $gz->handler($fileRotated);
+            } catch (Exception $error) {
+                $this->errorHandler->exception($error);
+
+                $fileRotated = null;
+            }
+
         }
 
         if ($fileRotated && $this->thenCallback) {
@@ -129,12 +153,15 @@ private function runProcessor(string $originalFile, ?string $fileRotated): ?stri
      *
      * @param string $file
      * @return boolean
-     * @throws LogicException
      */
     private function canRotate(string $file): bool
     {
         if (! $this->fileIsValid($file)) {
-            throw new LogicException(sprintf('the file %s not is valid.', $file), 2);
+            $this->errorHandler->exception(
+                new Exception(sprintf('the file %s not is valid.', $file), 10)
+            );
+
+            return false;
         }
 
         return filesize($file) > ($this->_minSize > 0 ? $this->_minSize : 0);
@@ -177,18 +204,33 @@ private function moveContentToTempFile(string $file): ?string
         $fd = fopen($file, 'r+');
 
         if (! $fd) {
+            $this->errorHandler->exception(
+                new Exception(sprintf('the file %s not can open.', $file), 20)
+            );
+
             return null;
         }
 
         if (! flock($fd, LOCK_EX)) {
             fclose($fd);
 
+            $this->errorHandler->exception(
+                new Exception(sprintf('the file %s not can lock.', $file), 21)
+            );
+
             return null;
         }
 
         if (! copy($file, $fileDestination)) {
             fclose($fd);
 
+            $this->errorHandler->exception(
+                new Exception(
+                    sprintf('the file %s not can copy to temp file %s.', $file, $fileDestination),
+                    22
+                )
+            );
+
             return null;
         }
 
@@ -197,6 +239,10 @@ private function moveContentToTempFile(string $file): ?string
 
             unlink($fileDestination);
 
+            $this->errorHandler->exception(
+                new Exception(sprintf('the file %s not can truncate.', $file), 23)
+            );
+
             return null;
         }
 

tests/ErrorHandlerTest.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Cesargb\Log\Test;
+
+use Exception;
+use Cesargb\Log\Rotation;
+use Cesargb\Log\Test\TestCase;
+
+class ErrorHandlerTest extends TestCase
+{
+    public function test_throws_exception()
+    {
+        $this->expectException(Exception::class);
+
+        $rotation = new Rotation();
+
+        $result = $rotation->rotate(self::DIR_WORK.'file.log');
+
+        $this->assertFalse($result);
+    }
+
+    public function test_catch_exception()
+    {
+        $rotation = new Rotation();
+
+        $result = $rotation
+            ->catch(function ($error) {
+
+            })
+            ->rotate(self::DIR_WORK.'file.log');
+
+        $this->assertFalse($result);
+    }
+}

tests/RotationTest.php

@@ -2,15 +2,15 @@
 
 namespace Cesargb\Log\Test;
 
-use LogicException;
+use Exception;
 use Cesargb\Log\Rotation;
 use Cesargb\Log\Test\TestCase;
 
 class RotationTest extends TestCase
 {
     public function test_log_rotating_if_file_not_exists()
     {
-        $this->expectException(LogicException::class);
+        $this->expectException(Exception::class);
 
         $rotation = new Rotation();