feat: add adapter

BREAKING CHANGE: PHPWatcher mandatory construct arguments

Author: cydrickn

README.md

@@ -2,6 +2,10 @@
 
 A simple directory and file watcher that was made using PHP.
 
+## Requirements
+
+* PHP >= 8.1
+
 ## Installation
 
 ```shell
@@ -17,7 +21,10 @@ To use this package you just need to initialize the watcher and call the tick fu
 
 require_once './vendor/autoload.php';
 
+use \Cydrickn\PHPWatcher\Adapters\SwooleTimerAdapter;
+
 $watcher = new \Cydrickn\PHPWatcher\Watcher(
+    new SwooleTimerAdapter(),
     [__DIR__],
     [__DIR__ . '/vendor/'],
     function (array $changes) {
@@ -28,79 +35,42 @@ $watcher = new \Cydrickn\PHPWatcher\Watcher(
 $watcher->tick();
 ```
 
-## \Cydrickn\PHPWatcher\Watcher::__construct
-
-\Cydrickn\PHPWatcher\Watcher::__construct - Creates the instance representing the watcher
-
-### Description
-
-```php
-public \Cydrickn\PHPWatcher\Watcher::__construct(
-    array $watchFor,
-    array $excludes,
-    callable $handler,
-    int $interval = 1000
-)
-```
-
-### Parameters
-
-**watchFor**
-
-List of files and folder that will watch by the watcher.
+## Adapters
 
-For folders this will include its sub-folders.
+Currently, we have 3 premade adapters:
 
-**excludes**
+### \Cydrickn\PHPWatcher\Adapters\SwooleTimerAdapter
 
-List of files and folder that will be excluded in watching.
+If you are using Swoole/Openswoole then best choice to use this adapter
 
-For folders this will include its sub-folders.
+### \Cydrickn\PHPWatcher\Adapters\NativeAdapter
 
-**handler**
+If not using Swoole/Openswoole then you can go for this one, it uses PHP's do-while and sleep
 
-A function that will be called once their are changes
+### \Cydrickn\PHPWatcher\Adapters\HybridAdapter
 
-**interval**
+This is same as the version 1 where it will automatically use the SwooleTimerAdapter, if available or fallback to NativeAdapter.
+This might be useful in a mixed environment.
 
-This is delay for how long it will wait before it will do checking of the files / folders. Default to 1000 milliseconds.
+## Custom Adapter
 
-## \Cydrickn\PHPWatcher\Watcher::checkChanges
-
-\Cydrickn\PHPWatcher\Watcher::checkChanges - Check the changes
-
-### Description
+If you don't want to use any pre-made adapter you can create your own adapter.
+Example:
 
 ```php
-public \Cydrickn\PHPWatcher\Watcher::checkChanges(): void
-```
-
-## \Cydrickn\PHPWatcher\Watcher::tick
-
-\Cydrickn\PHPWatcher\Watcher::tick - Start the watching of files
-
-### Description
-
-```php
-public \Cydrickn\PHPWatcher\Watcher::tick(
-    ?callable $handler = null
-): void
-```
-
-### Parameters
-
-**handler**
-
-A callable use for watching the file, this is default to null.
-
-Once the handler is null, it will use the default handler.
-
-There are two default handler.
+<?php
 
-- Swoole\Timer - Will be only use when swoole is enabled in your server
-- The do while - If the swoole is not enabled
+namespace Your\Namespace;
 
-Once you pass your own handler, this will pass two argument
+use Cydrickn\PHPWatcher\Adapters\AdapterInterface;
 
-- The first argument would be the checkChanges function
-- The second is the interval
+class YourAdapter implements AdapterInterface
+{
+    public function tick(callable $handler, int $interval = 1000)
+    {
+        // Implement your own logic
+        // Also make sure to call the handler to trigger the checking of changed files
+        // e.g. call_user_func($handler);
+    }
+}
+```

UPGRADE.md

@@ -0,0 +1,52 @@
+# Upgrade Notes
+
+When upgrading to a newer version, some configuration structures must be updated before applying the modifications.
+
+## 2.0
+
+- Upgrade your PHP version to 8.1 or higher
+
+### Breaking changes
+
+It's expecting the when upgrading from version 1.x to 2.0 that it will break,
+this is due to the new version is now using Adapter, where you need to pass the Adapter instead of automatically
+detecting the Swoole Timer and use that.
+
+From this code (v1)
+```php
+<?php
+
+require_once './vendor/autoload.php';
+
+$watcher = new \Cydrickn\PHPWatcher\Watcher(
+    [__DIR__],
+    [__DIR__ . '/vendor/'],
+    function (array $changes) {
+        echo json_encode($changes) . PHP_EOL;
+    }
+);
+
+$watcher->tick();
+```
+
+To this code (v2)
+```php
+<?php
+
+require_once './vendor/autoload.php';
+
+use \Cydrickn\PHPWatcher\Adapters\SwooleTimerAdapter;
+
+$watcher = new \Cydrickn\PHPWatcher\Watcher(
+    new SwooleTimerAdapter(),
+    [__DIR__],
+    [__DIR__ . '/vendor/'],
+    function (array $changes) {
+        echo json_encode($changes) . PHP_EOL;
+    }
+);
+
+$watcher->tick();
+```
+
+Take note that `tick()` method now don't accept any parameter unlike from version 1.

composer.json

@@ -14,5 +14,7 @@
             "email": "cydrick.dev@gmail.com"
         }
     ],
-    "require": {}
+    "require": {
+        "php": ">=8.1"
+    }
 }

src/Adapters/AdapterInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cydrickn\PHPWatcher\Adapters;
+
+interface AdapterInterface
+{
+    public function tick(callable $handler, int $interval = 1000): void;
+}

src/Adapters/HybridAdapter.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cydrickn\PHPWatcher\Adapters;
+
+class HybridAdapter implements AdapterInterface
+{
+    private NativeAdapter $nativeAdapter;
+    private SwooleTimerAdapter $swooleTimer;
+
+    public function __construct()
+    {
+       $this->nativeAdapter = new NativeAdapter();
+       $this->swooleTimer  = new SwooleTimerAdapter();
+    }
+
+    public function tick(callable $handler, int $interval = 1000): void
+    {
+        if (extension_loaded('swoole') || extension_loaded('openswoole')) {
+            $this->swooleTimer->tick($handler, $interval);
+        } else {
+            $this->nativeAdapter->tick($handler, $interval);
+        }
+    }
+}

src/Adapters/NativeAdapter.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cydrickn\PHPWatcher\Adapters;
+
+class NativeAdapter implements AdapterInterface
+{
+    public function tick(callable $handler, int $interval = 1000): void
+    {
+        do {
+            call_user_func($handler);
+            sleep($interval / 1000);
+        } while (true);
+    }
+}

src/Adapters/SwooleTimerAdapter.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cydrickn\PHPWatcher\Adapters;
+
+use Swoole\Timer;
+
+class SwooleTimerAdapter implements AdapterInterface
+{
+    public function tick(callable $handler, int $interval = 1000): void
+    {
+        Timer::tick($interval, function () use ($handler) {
+            call_user_func($handler);
+        });
+    }
+}

src/Enum/ChangeType.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Cydrickn\PHPWatcher\Enum;
 
 enum ChangeType: int

src/Watcher.php

@@ -1,7 +1,9 @@
 <?php
+declare(strict_types=1);
 
 namespace Cydrickn\PHPWatcher;
 
+use Cydrickn\PHPWatcher\Adapters\AdapterInterface;
 use Cydrickn\PHPWatcher\Enum\ChangeType;
 use RecursiveDirectoryIterator;
 use RecursiveTreeIterator;
@@ -13,12 +15,11 @@ class Watcher
     private array $changes = [];
     private bool $initialized = false;
     private bool $checking = false;
-
     private array $excludeFiles = [];
     private array $excludeDirs = [];
     private mixed $handler;
 
-    public function __construct(private array $watchFor, array $excludes, callable $handler, private int $interval = 1000)
+    public function __construct(private readonly AdapterInterface $adapter, private readonly array $watchFor, array $excludes, callable $handler, private readonly int $interval = 1000)
     {
         foreach ($excludes as $exclude) {
             if (is_dir($exclude)) {
@@ -30,7 +31,6 @@ public function __construct(private array $watchFor, array $excludes, callable $
         $this->handler = $handler;
     }
 
-
     protected function addChange(string $filename, ChangeType $type): void
     {
         $this->changes[] = [
@@ -63,7 +63,7 @@ protected function checkFile(string $file, bool $checkForDelete = false): void
         $data = $this->files[$file];
         $checkData = filemtime($file);
 
-        if ($checkData != $data) {
+        if ($checkData !== $data) {
             $this->addChange($file, ChangeType::UPDATED);
         }
     }
@@ -81,7 +81,6 @@ protected function commit(): void
                 unset($this->files[$change['name']]);
                 continue;
             }
-
             $this->files[$change['name']] = $change['data'];
         }
 
@@ -106,11 +105,9 @@ public function checkChanges(): void
                 foreach ($allFiles as $file) {
                     $filename = trim(str_replace(['|', ' ', '~', '\\'], '', $file), '-');
                     $filename = is_dir($filename) ? $filename . '/' : $filename;
-
                     if ((is_file($filename) && in_array($filename, $this->excludeFiles)) || (is_dir($filename) && in_array($filename, $this->excludeDirs))) {
                         continue;
                     }
-
                     foreach ($this->excludeDirs as $dir) {
                         if (str_starts_with($filename, $dir)) {
                             continue 2;
@@ -123,7 +120,6 @@ public function checkChanges(): void
             $this->checkFile($watchFor);
         }
 
-
         // Checks the deleted files
         foreach ($this->files as $key => $file) {
             $this->checkFile($key, true);
@@ -138,24 +134,8 @@ public function checkChanges(): void
         $this->checking = false;
     }
 
-    public function tick(?callable $handler = null): void
+    public function tick(): void
     {
-        if ($handler !== null) {
-            call_user_func($handler, [$this, 'checkChanges'], $this->interval);
-            return;
-        }
-
-        if (class_exists(Timer::class)) {
-            Timer::tick($this->interval, function () {
-                $this->checkChanges();
-            });
-        } else {
-            $this->tick(function ($checkChanges, $interval) {
-                do {
-                    call_user_func($checkChanges);
-                    sleep($interval / 1000);
-                } while (true);
-            });
-        }
+        $this->adapter->tick([$this, 'checkChanges'], $this->interval);
     }
 }