initial commit

Author: azjezz

.gitignore

@@ -0,0 +1,2 @@
+/vendor/
+/.idea/

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019-present Saif Eddin Gmati <[email protected]>
+
+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,73 @@
+# Assess
+
+Unix filesystem notifications library for PHP.
+
+## Features
+
+- Watch for file creations, modifications, accesses, changes, moves, and deletions.
+- Configurable polling interval.
+- Filter by file extensions.
+- Optionally watch directories.
+- Easy-to-use event registration.
+
+## Installation
+
+You can install the library via Composer:
+
+```bash
+composer require azjezz/assess
+```
+
+## Usage
+
+```php
+use Assess\Configuration;
+use Assess\Event\Event;
+use Assess\Event\EventType;
+use Assess\Watcher;
+use Revolt\EventLoop;
+
+$configuration = Configuration::createForDirectories([
+    '/path/to/directory',
+    '/another/path/to/directory',
+])
+    // poll interval in seconds
+    ->withPollInterval(0.5)
+    // do not watch directories
+    ->withWatchDirectories(false)
+    // include only PHP files
+    ->withExtensions(['php'])
+;
+
+$watcher = Watcher::create($configuration);
+
+$watcher->register(EventType::Created, function (Event $event): void {
+    $node = $event->newIndex->nodes[$event->id];
+
+    echo "File created: {$node->path}\n";
+});
+
+$watcher->register(EventType::Moved, function (Event $event): void {
+    $oldNode = $event->oldIndex->nodes[$event->id];
+    $newNode = $event->newIndex->nodes[$event->id];
+
+    echo "File moved: {$oldNode->path} -> {$newNode->path}\n";
+});
+
+$watcher->register(EventType::Deleted, function (Event $event): void {
+    $node = $event->oldIndex->nodes[$event->id];
+
+    echo "File deleted: {$node->path}\n";
+});
+
+$watcher->enable();
+$watcher->reference();
+
+EventLoop::run();
+```
+
+See [examples/command.php](examples/command.php) for a complete example.
+
+## License
+
+This library is licensed under the MIT license. See the [LICENSE](LICENSE) file for details.

composer.json

@@ -0,0 +1,26 @@
+{
+    "name": "azjezz/assess",
+    "description": "Unix filesystem notification library for PHP",
+    "type": "library",
+    "require": {
+        "php": "^8.3",
+        "revolt/event-loop": "^1.0",
+        "amphp/amp": "^3.0",
+        "amphp/file": "^3.1"
+    },
+    "require-dev": {
+        "ext-pcntl": "*"
+    },
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "Assess\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "azjezz",
+            "email": "[email protected]"
+        }
+    ]
+}