Merge pull request #20 from phprtc/dev

v0.1.0

Author: Ahmard

.gitignore

@@ -5,4 +5,6 @@
 /.test1
 /.test2
 /.test.php
-.phpunit.result.cache
+.phpunit.result.cache
+
+/tests/bait

README.md

@@ -5,7 +5,7 @@ PHP-based file system changes watcher implemented using [**Swoole**](https://swo
 ## Installation
 
 ```
-composer require phprtc/watcher ^0.0 --dev
+composer require phprtc/watcher ^0.1 --dev
 ```
 
 ## Usage
@@ -14,6 +14,7 @@ composer require phprtc/watcher ^0.0 --dev
 
 ```php
 use RTC\Watcher\Watcher;
+use RTC\Watcher\Watching\EventInfo;
 
 require 'vendor/autoload.php';
 
@@ -22,14 +23,59 @@ Watcher::create()
     ->addPath(__DIR__ . '/views')
     ->onChange(function (EventInfo $eventInfo) {
         echo $eventInfo->getWatchedItem()->getFullPath() . PHP_EOL;
-    });
+    })
+    ->watch();
+```
+
+#### Any Event
+
+Listens to any event on given path
+
+Be careful using this method.
+
+```php
+use RTC\Watcher\Watcher;
+use RTC\Watcher\Watching\EventInfo;
+
+require 'vendor/autoload.php';
+
+Watcher::create()
+    ->addPath(__DIR__ . '/app')
+    ->onAny(function (EventInfo $eventInfo) {
+        echo date('H:i:s') . " - {$eventInfo->getName()} {$eventInfo->getWatchedItem()->getFullPath()}\n";
+    })
+    ->watch();
+```
+
+#### Ignoring Path
+
+Ignore files using regular expression
+
+```php
+use RTC\Watcher\Watcher;
+use RTC\Watcher\Watching\EventInfo;
+
+require 'vendor/autoload.php';
+
+Watcher::create()
+    ->addPath(__DIR__ . '/app')
+    ->ignore(__DIR__ . '/test1/t/*')   // Ignore files in "/test1/t/"
+    ->ignore([
+        __DIR__ . '/test1/t/.*(\.php$)',   // Ignore files that end with "php" in "/test1/t/"
+        __DIR__ . '/test1/t/.*(\.js)',   // Ignore files that end with "js" in "/test1/t/"
+    ])   
+    ->onChange(function (EventInfo $eventInfo) {
+        echo date('H:i:s') . " - {$eventInfo->getName()} {$eventInfo->getWatchedItem()->getFullPath()}\n";
+    })
+    ->watch();
 ```
 
 #### Filter
 
 - Make sure that the file whose event is being fired should not end with provided characters.
     ```php
     use RTC\Watcher\Watcher;
+    use RTC\Watcher\Watching\EventInfo;
 
     require 'vendor/autoload.php';
 
@@ -38,12 +84,14 @@ Watcher::create()
         ->fileShouldNotEndWith(['.php'])
         ->onChange(function (EventInfo $eventInfo) {
             echo $eventInfo->getWatchedItem()->getFullPath() . PHP_EOL;
-        });
+        })
+        ->watch();
     ```
 
 - Only listen to event with file name that matches given extension(s).
     ```php
     use RTC\Watcher\Watcher;
+    use RTC\Watcher\Watching\EventInfo;
 
     require 'vendor/autoload.php';
 
@@ -52,25 +100,32 @@ Watcher::create()
         ->addExtension('php')
         ->onChange(function (EventInfo $eventInfo) {
             echo $eventInfo->getWatchedItem()->getFullPath() . PHP_EOL;
-        });
+        })
+        ->watch();
     ```
 
-#### Any-event
-
-Listens to any event on given path
-
-Be careful using this method.
+#### Stopping Watcher
 
 ```php
+
 use RTC\Watcher\Watcher;
+use RTC\Watcher\Watching\EventInfo;
+use Swoole\Timer;
 
 require 'vendor/autoload.php';
 
-Watcher::create()
-    ->addPath(__DIR__ . '/app')
-    ->onAny(function (EventInfo $eventInfo) {
-        echo date('H:i:s') . " - {$eventInfo->getName()} {$eventInfo->getWatchedItem()->getFullPath()}\n";
+$watcher = Watcher::create()
+    ->addPath(__DIR__)
+    ->onCreate(function (EventInfo $eventInfo) {
+        echo date('H:i:s') . ": CREATED  - {$eventInfo->getWatchedItem()->getFullPath()}\n";
     });
+
+Timer::after(1000, fn() => $watcher->stop());   // Stop watching after 1 second
+
+$watcher->start();
+
+touch(__DIR__ . '/auto-created.txt');
+unlink(__DIR__ . '/auto-created.txt');
 ```
 
 #### Swoole Server Integration
@@ -94,7 +149,8 @@ $server->on('start', function (Server $server) {
     Watcher::create()
         ->addPath(__DIR__ . '/app')
         ->addPath(__DIR__ . '/views')
-        ->onChange(fn() => $server->reload());
+        ->onChange(fn() => $server->reload())
+        ->watch();
 });
 
 $server->start();

composer.json

@@ -15,7 +15,7 @@
         "evenement/evenement": "^3.0"
     },
     "require-dev": {
-        "phpstan/phpstan": "^0.12.90",
+        "phpstan/phpstan": "^1.5",
         "phpunit/phpunit": "^9.5",
         "symfony/var-dumper": "^6.0",
         "openswoole/ide-helper": "^4.10"
@@ -25,6 +25,11 @@
             "RTC\\Watcher\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "RTC\\Tests\\Watcher\\": "tests/"
+        }
+    },
     "scripts": {
         "analyse" : "vendor/bin/phpstan analyse --debug",
         "test" : "vendor/bin/phpunit"