add ability to extend Filesystem class with Macros.

Author: Awilum

README.md

@@ -11,6 +11,7 @@ Filesystem Component provide a fluent, object-oriented interface for working wit
 
 * [Installation](#installation)
 * [Usage](#usage)
+* [Exteding](#extending)
 * [Methods](#methods)
   - [Filesystem](#filesystem)
   - [File](#file)
@@ -38,6 +39,30 @@ $filesystem = new Filesystem();
 $filesystem = filesystem();
 ```
 
+### Extending
+
+Filesystem are "macroable", which allows you to add additional methods to the Filesystem class at run time. For example, the following code adds a customMethod method to the Filesystem class:
+
+```php
+use Atomastic\Filesystem\Filesystem;
+use Atomastic\Macroable\Macroable;
+
+Filesystem::macro('countFiles', function($path) {
+    return count(iterator_to_array($this->find()->in($path)->files(), false));
+});
+
+$filesytem = new Filesystem();
+
+echo $filesytem->countFiles('/directory');
+```
+
+##### The above example will output:
+
+```
+1
+```
+
+
 ### Methods
 
 #### Filesystem

composer.json

@@ -20,7 +20,8 @@
         "ext-spl": "*",
         "ext-fileinfo": "*",
         "php": "^7.3 || ^8.0",
-        "symfony/finder": "^5.1"
+        "symfony/finder": "^5.1",
+        "atomastic/macroable": "^1.0"
     },
     "autoload":{
         "psr-4": {

src/Filesystem.php

@@ -5,6 +5,7 @@
 namespace Atomastic\Filesystem;
 
 use Symfony\Component\Finder\Finder;
+use Atomastic\Macroable\Macroable;
 
 use function chmod;
 use function fileperms;
@@ -16,6 +17,8 @@
 
 class Filesystem
 {
+    use Macroable;
+    
     /**
      * Create a Finder instance.
      */

tests/FilesystemTest.php

@@ -382,3 +382,17 @@
     $this->assertEquals($this->tempDir . '/1.txt', $filesytem->file($this->tempDir . '/1.txt')->path());
     $this->assertEquals($this->tempDir, $filesytem->directory($this->tempDir)->path());
 });
+
+test('test macro() method', function (): void {
+    @mkdir($this->tempDir . '/1');
+    $filesytem = new Filesystem();
+    $filesytem->file($this->tempDir . '/1/1.txt')->put('hello world');
+    $filesytem->file($this->tempDir . '/1/2.txt')->put('hello world');
+
+    Filesystem::macro('countFiles', function($path) {
+        return count(iterator_to_array($this->find()->in($path)->files(), false));
+    });
+
+    $filesytem = new Filesystem();
+    $this->assertEquals(2, $filesytem->countFiles($this->tempDir . '/1'));
+});