fix: interval and watch

Author: cydrickn

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Cydrick Nonog
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,106 @@
+# PHP Watcher
+
+A simple directory and file watcher that was made using PHP.
+
+## Installation
+
+```shell
+composer require cydrickn/php-watcher
+```
+
+## Usage
+
+To use this package you just need to initialize the watcher and call the tick function
+
+```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();
+```
+
+## \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.
+
+For folders this will include its sub-folders.
+
+**excludes**
+
+List of files and folder that will be excluded in watching.
+
+For folders this will include its sub-folders.
+
+**handler**
+
+A function that will be called once their are changes
+
+**interval**
+
+This is delay for how long it will wait before it will do checking of the files / folders. Default to 1000 milliseconds.
+
+## \Cydrickn\PHPWatcher\Watcher::checkChanges
+
+\Cydrickn\PHPWatcher\Watcher::checkChanges - Check the changes
+
+### Description
+
+```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.
+
+- Swoole\Timer - Will be only use when swoole is enabled in your server
+- The do while - If the swoole is not enabled
+
+Once you pass your own handler, this will pass two argument
+
+- The first argument would be the checkChanges function
+- The second is the interval

src/Watcher.php

@@ -31,12 +31,12 @@ public function __construct(private array $watchFor, array $excludes, callable $
     }
 
 
-    public function addChange(string $filename, ChangeType $type): void
+    protected function addChange(string $filename, ChangeType $type): void
     {
         $this->changes[] = ['name' => $filename, 'type' => $type, 'data' => filemtime($filename)];
     }
 
-    public function checkFile(string $file): void
+    protected function checkFile(string $file): void
     {
         if (!array_key_exists($file, $this->files) && file_exists($file)) {
             $this->addChange($file, ChangeType::NEW);
@@ -60,12 +60,12 @@ public function checkFile(string $file): void
         }
     }
 
-    public function clearChanges(): void
+    protected function clearChanges(): void
     {
         $this->changes = [];
     }
 
-    public function commit(): void
+    protected function commit(): void
     {
         $totalChanges = count($this->changes);
         foreach ($this->changes as $change) {
@@ -94,7 +94,7 @@ public function checkChanges(): void
 
         foreach ($this->watchFor as $watchFor) {
             if (is_dir($watchFor)) {
-                $allFiles = new RecursiveTreeIterator(new RecursiveDirectoryIterator(__DIR__, RecursiveDirectoryIterator::SKIP_DOTS));
+                $allFiles = new RecursiveTreeIterator(new RecursiveDirectoryIterator($watchFor, RecursiveDirectoryIterator::SKIP_DOTS));
                 foreach ($allFiles as $file) {
                     $filename = trim(str_replace(['|', ' ', '~', '\\'], '', $file), '-');
                     $filename = is_dir($filename) ? $filename . '/' : $filename;
@@ -117,8 +117,11 @@ public function checkChanges(): void
 
         $this->commit();
 
+        if (!$this->initialized) {
+            $this->initialized = true;
+        }
+
         $this->checking = false;
-        $this->initialized = true;
     }
 
     public function tick(?callable $handler = null): void
@@ -136,7 +139,7 @@ public function tick(?callable $handler = null): void
             $this->tick(function ($checkChanges, $interval) {
                 do {
                     call_user_func($checkChanges);
-                    sleep($interval);
+                    sleep($interval / 1000);
                 } while (true);
             });
         }