Refactor filesystem (#215)

## Description ## Checklist - [ ] Updated CHANGELOG files - [ ] Updated Documentation - [ ] Unit Tests Created - [ ] php-cs-fixer
SonsOfPHP · Aug 21, 2024 · fb8f737 · fb8f737
1 parent 7456a96
commit fb8f737
Show file tree

Hide file tree

Showing 30 changed files with 185 additions and 129 deletions.
diff --git a/docs/contracts/filesystem/index.md b/docs/contracts/filesystem/index.md
@@ -0,0 +1,9 @@
+---
+title: Filesystem Contract
+---
+
+## Installation
+
+```shell
+composer require sonsofphp/filesystem-contract
+```
diff --git a/src/SonsOfPHP/Component/Filesystem/Adapter/ChainAdapter.php b/src/SonsOfPHP/Component/Filesystem/Adapter/ChainAdapter.php
@@ -4,8 +4,12 @@
 
 namespace SonsOfPHP\Component\Filesystem\Adapter;
 
-use SonsOfPHP\Component\Filesystem\ContextInterface;
 use SonsOfPHP\Component\Filesystem\Exception\FileNotFoundException;
+use SonsOfPHP\Contract\Filesystem\Adapter\AdapterInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\CopyAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\DirectoryAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\MoveAwareInterface;
+use SonsOfPHP\Contract\Filesystem\ContextInterface;
 
 /**
  * Chain adapter allows you to use multiple adapters together.

diff --git a/src/SonsOfPHP/Component/Filesystem/Adapter/CopyAwareInterface.php b/src/SonsOfPHP/Component/Filesystem/Adapter/CopyAwareInterface.php
diff --git a/src/SonsOfPHP/Component/Filesystem/Adapter/InMemoryAdapter.php b/src/SonsOfPHP/Component/Filesystem/Adapter/InMemoryAdapter.php
@@ -4,8 +4,12 @@
 
 namespace SonsOfPHP\Component\Filesystem\Adapter;
 
-use SonsOfPHP\Component\Filesystem\ContextInterface;
 use SonsOfPHP\Component\Filesystem\Exception\UnableToReadFileException;
+use SonsOfPHP\Contract\Filesystem\Adapter\AdapterInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\CopyAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\DirectoryAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\MoveAwareInterface;
+use SonsOfPHP\Contract\Filesystem\ContextInterface;
 
 /**
  * Just keeps files in memory, does not write anything to disk

diff --git a/src/SonsOfPHP/Component/Filesystem/Adapter/MoveAwareInterface.php b/src/SonsOfPHP/Component/Filesystem/Adapter/MoveAwareInterface.php
diff --git a/src/SonsOfPHP/Component/Filesystem/Adapter/NativeAdapter.php b/src/SonsOfPHP/Component/Filesystem/Adapter/NativeAdapter.php
@@ -4,7 +4,11 @@
 
 namespace SonsOfPHP\Component\Filesystem\Adapter;
 
-use SonsOfPHP\Component\Filesystem\ContextInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\AdapterInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\CopyAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\DirectoryAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\MoveAwareInterface;
+use SonsOfPHP\Contract\Filesystem\ContextInterface;
 
 /**
  * The native adapter will use the underlying filesystem to store files.

diff --git a/src/SonsOfPHP/Component/Filesystem/Adapter/NullAdapter.php b/src/SonsOfPHP/Component/Filesystem/Adapter/NullAdapter.php
@@ -4,7 +4,8 @@
 
 namespace SonsOfPHP\Component\Filesystem\Adapter;
 
-use SonsOfPHP\Component\Filesystem\ContextInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\AdapterInterface;
+use SonsOfPHP\Contract\Filesystem\ContextInterface;
 
 /**
  * Null Adapter does absolutly nothing, it's good for testing and that's pretty

diff --git a/src/SonsOfPHP/Component/Filesystem/Adapter/ReadOnlyAdapter.php b/src/SonsOfPHP/Component/Filesystem/Adapter/ReadOnlyAdapter.php
@@ -4,8 +4,12 @@
 
 namespace SonsOfPHP\Component\Filesystem\Adapter;
 
-use SonsOfPHP\Component\Filesystem\ContextInterface;
 use SonsOfPHP\Component\Filesystem\Exception\FilesystemException;
+use SonsOfPHP\Contract\Filesystem\Adapter\AdapterInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\CopyAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\DirectoryAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\MoveAwareInterface;
+use SonsOfPHP\Contract\Filesystem\ContextInterface;
 
 /**
  * The Read Only adapter will only allow you to read existing files, if you try

diff --git a/src/SonsOfPHP/Component/Filesystem/Adapter/WormAdapter.php b/src/SonsOfPHP/Component/Filesystem/Adapter/WormAdapter.php
@@ -4,8 +4,12 @@
 
 namespace SonsOfPHP\Component\Filesystem\Adapter;
 
-use SonsOfPHP\Component\Filesystem\ContextInterface;
 use SonsOfPHP\Component\Filesystem\Exception\FilesystemException;
+use SonsOfPHP\Contract\Filesystem\Adapter\AdapterInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\CopyAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\DirectoryAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\MoveAwareInterface;
+use SonsOfPHP\Contract\Filesystem\ContextInterface;
 
 /**
  * WORM = Write Once, Read Many. Using this adapter allows you to create new

diff --git a/src/SonsOfPHP/Component/Filesystem/Context.php b/src/SonsOfPHP/Component/Filesystem/Context.php
@@ -6,6 +6,7 @@
 
 use ArrayIterator;
 use SonsOfPHP\Component\Filesystem\Exception\FilesystemException;
+use SonsOfPHP\Contract\Filesystem\ContextInterface;
 use Traversable;
 
 /**

diff --git a/src/SonsOfPHP/Component/Filesystem/Exception/FileNotFoundException.php b/src/SonsOfPHP/Component/Filesystem/Exception/FileNotFoundException.php
@@ -4,7 +4,9 @@
 
 namespace SonsOfPHP\Component\Filesystem\Exception;
 
+use SonsOfPHP\Contract\Filesystem\Exception\FileNotFoundExceptionInterface;
+
 /**
  * @author Joshua Estes <[email protected]>
  */
-final class FileNotFoundException extends FilesystemException {}
+final class FileNotFoundException extends FilesystemException implements FileNotFoundExceptionInterface {}
diff --git a/src/SonsOfPHP/Component/Filesystem/Exception/FilesystemException.php b/src/SonsOfPHP/Component/Filesystem/Exception/FilesystemException.php
@@ -5,8 +5,9 @@
 namespace SonsOfPHP\Component\Filesystem\Exception;
 
 use Exception;
+use SonsOfPHP\Contract\Filesystem\Exception\FilesystemExceptionInterface;
 
 /**
  * @author Joshua Estes <[email protected]>
  */
-class FilesystemException extends Exception {}
+class FilesystemException extends Exception implements FilesystemExceptionInterface {}
diff --git a/src/SonsOfPHP/Component/Filesystem/Filesystem.php b/src/SonsOfPHP/Component/Filesystem/Filesystem.php
@@ -4,10 +4,12 @@
 
 namespace SonsOfPHP\Component\Filesystem;
 
-use SonsOfPHP\Component\Filesystem\Adapter\AdapterInterface;
-use SonsOfPHP\Component\Filesystem\Adapter\CopyAwareInterface;
-use SonsOfPHP\Component\Filesystem\Adapter\MoveAwareInterface;
 use SonsOfPHP\Component\Filesystem\Exception\FilesystemException;
+use SonsOfPHP\Contract\Filesystem\Adapter\AdapterInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\CopyAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\MoveAwareInterface;
+use SonsOfPHP\Contract\Filesystem\ContextInterface;
+use SonsOfPHP\Contract\Filesystem\FilesystemInterface;
 
 /**
  * @author Joshua Estes <[email protected]>

diff --git a/src/SonsOfPHP/Component/Filesystem/Tests/Adapter/ChainAdapterTest.php b/src/SonsOfPHP/Component/Filesystem/Tests/Adapter/ChainAdapterTest.php
@@ -7,13 +7,13 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\TestCase;
-use SonsOfPHP\Component\Filesystem\Adapter\AdapterInterface;
 use SonsOfPHP\Component\Filesystem\Adapter\ChainAdapter;
-use SonsOfPHP\Component\Filesystem\Adapter\CopyAwareInterface;
-use SonsOfPHP\Component\Filesystem\Adapter\DirectoryAwareInterface;
 use SonsOfPHP\Component\Filesystem\Adapter\InMemoryAdapter;
-use SonsOfPHP\Component\Filesystem\Adapter\MoveAwareInterface;
-use SonsOfPHP\Component\Filesystem\Exception\FileNotFoundException;
+use SonsOfPHP\Contract\Filesystem\Adapter\AdapterInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\CopyAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\DirectoryAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\MoveAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Exception\FileNotFoundExceptionInterface;
 
 #[CoversClass(ChainAdapter::class)]
 #[UsesClass(InMemoryAdapter::class)]
@@ -64,7 +64,7 @@ public function testItWillThrowExceptionWhenFileNotFound(): void
         $this->adapters[] = $adp;
 
         $adapter = new ChainAdapter($this->adapters);
-        $this->expectException(FileNotFoundException::class);
+        $this->expectException(FileNotFoundExceptionInterface::class);
         $adapter->get('/path/to/file.txt');
     }
 

diff --git a/src/SonsOfPHP/Component/Filesystem/Tests/Adapter/InMemoryAdapterTest.php b/src/SonsOfPHP/Component/Filesystem/Tests/Adapter/InMemoryAdapterTest.php
@@ -6,9 +6,9 @@
 
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
-use SonsOfPHP\Component\Filesystem\Adapter\AdapterInterface;
 use SonsOfPHP\Component\Filesystem\Adapter\InMemoryAdapter;
 use SonsOfPHP\Component\Filesystem\Exception\UnableToReadFileException;
+use SonsOfPHP\Contract\Filesystem\Adapter\AdapterInterface;
 
 /**
  * @uses \SonsOfPHP\Component\Filesystem\Adapter\InMemoryAdapter

diff --git a/src/SonsOfPHP/Component/Filesystem/Tests/Adapter/NativeAdapterTest.php b/src/SonsOfPHP/Component/Filesystem/Tests/Adapter/NativeAdapterTest.php
@@ -6,11 +6,11 @@
 
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
-use SonsOfPHP\Component\Filesystem\Adapter\AdapterInterface;
-use SonsOfPHP\Component\Filesystem\Adapter\CopyAwareInterface;
-use SonsOfPHP\Component\Filesystem\Adapter\DirectoryAwareInterface;
-use SonsOfPHP\Component\Filesystem\Adapter\MoveAwareInterface;
 use SonsOfPHP\Component\Filesystem\Adapter\NativeAdapter;
+use SonsOfPHP\Contract\Filesystem\Adapter\AdapterInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\CopyAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\DirectoryAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\MoveAwareInterface;
 
 /**
  * @internal

diff --git a/src/SonsOfPHP/Component/Filesystem/Tests/Adapter/NullAdapterTest.php b/src/SonsOfPHP/Component/Filesystem/Tests/Adapter/NullAdapterTest.php
@@ -6,8 +6,8 @@
 
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
-use SonsOfPHP\Component\Filesystem\Adapter\AdapterInterface;
 use SonsOfPHP\Component\Filesystem\Adapter\NullAdapter;
+use SonsOfPHP\Contract\Filesystem\Adapter\AdapterInterface;
 
 /**
  * @internal

diff --git a/src/SonsOfPHP/Component/Filesystem/Tests/Adapter/ReadOnlyAdapterTest.php b/src/SonsOfPHP/Component/Filesystem/Tests/Adapter/ReadOnlyAdapterTest.php
@@ -8,13 +8,13 @@
 use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\MockObject;
 use PHPUnit\Framework\TestCase;
-use SonsOfPHP\Component\Filesystem\Adapter\AdapterInterface;
-use SonsOfPHP\Component\Filesystem\Adapter\CopyAwareInterface;
-use SonsOfPHP\Component\Filesystem\Adapter\DirectoryAwareInterface;
 use SonsOfPHP\Component\Filesystem\Adapter\InMemoryAdapter;
-use SonsOfPHP\Component\Filesystem\Adapter\MoveAwareInterface;
 use SonsOfPHP\Component\Filesystem\Adapter\ReadOnlyAdapter;
-use SonsOfPHP\Component\Filesystem\Exception\FilesystemException;
+use SonsOfPHP\Contract\Filesystem\Adapter\AdapterInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\CopyAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\DirectoryAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\MoveAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Exception\FilesystemExceptionInterface;
 
 #[CoversClass(ReadOnlyAdapter::class)]
 #[UsesClass(InMemoryAdapter::class)]
@@ -40,28 +40,28 @@ public function testItHasTheCorrectInterface(): void
     public function testItWillThrowExceptionWhenAddingFile(): void
     {
         $adapter = new ReadOnlyAdapter($this->adapter);
-        $this->expectException(FilesystemException::class);
+        $this->expectException(FilesystemExceptionInterface::class);
         $adapter->add('/path/to/file.ext', 'contents');
     }
 
     public function testItWillThrowExceptionWhenRemovingFile(): void
     {
         $adapter = new ReadOnlyAdapter($this->adapter);
-        $this->expectException(FilesystemException::class);
+        $this->expectException(FilesystemExceptionInterface::class);
         $adapter->remove('/path/to/file.ext');
     }
 
     public function testItWillThrowExceptionWhenCopyingFile(): void
     {
         $adapter = new ReadOnlyAdapter($this->adapter);
-        $this->expectException(FilesystemException::class);
+        $this->expectException(FilesystemExceptionInterface::class);
         $adapter->copy('/path/to/file.ext', '/path/to/dest.ext');
     }
 
     public function testItWillThrowExceptionWhenMovingFile(): void
     {
         $adapter = new ReadOnlyAdapter($this->adapter);
-        $this->expectException(FilesystemException::class);
+        $this->expectException(FilesystemExceptionInterface::class);
         $adapter->move('/path/to/file.ext', '/path/to/dest.ext');
     }
 

diff --git a/src/SonsOfPHP/Component/Filesystem/Tests/Adapter/WormAdapterTest.php b/src/SonsOfPHP/Component/Filesystem/Tests/Adapter/WormAdapterTest.php
@@ -7,13 +7,13 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\TestCase;
-use SonsOfPHP\Component\Filesystem\Adapter\AdapterInterface;
-use SonsOfPHP\Component\Filesystem\Adapter\CopyAwareInterface;
-use SonsOfPHP\Component\Filesystem\Adapter\DirectoryAwareInterface;
 use SonsOfPHP\Component\Filesystem\Adapter\InMemoryAdapter;
-use SonsOfPHP\Component\Filesystem\Adapter\MoveAwareInterface;
 use SonsOfPHP\Component\Filesystem\Adapter\WormAdapter;
-use SonsOfPHP\Component\Filesystem\Exception\FilesystemException;
+use SonsOfPHP\Contract\Filesystem\Adapter\AdapterInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\CopyAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\DirectoryAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Adapter\MoveAwareInterface;
+use SonsOfPHP\Contract\Filesystem\Exception\FilesystemExceptionInterface;
 
 #[CoversClass(WormAdapter::class)]
 #[UsesClass(InMemoryAdapter::class)]
@@ -41,23 +41,23 @@ public function testItCanAddFileOnlyOnce(): void
         $adapter = new WormAdapter($this->adapter);
 
         $adapter->add('/path/to/file.ext', 'contents');
-        $this->expectException(FilesystemException::class);
+        $this->expectException(FilesystemExceptionInterface::class);
         $adapter->add('/path/to/file.ext', 'contents');
     }
 
     public function testItCannotRemoveFile(): void
     {
         $adapter = new WormAdapter($this->adapter);
 
-        $this->expectException(FilesystemException::class);
+        $this->expectException(FilesystemExceptionInterface::class);
         $adapter->remove('/path/to/file.ext');
     }
 
     public function testItCannotMoveFile(): void
     {
         $adapter = new WormAdapter($this->adapter);
 
-        $this->expectException(FilesystemException::class);
+        $this->expectException(FilesystemExceptionInterface::class);
         $adapter->move('/path/to/file.ext', '/path/to/dest.ext');
     }
 
@@ -104,7 +104,7 @@ public function testItCanCopyFileOnlyIfDestinationExists(): void
         $adapter->copy('/path/to/source.ext', '/path/to/destination.txt');
 
         $adapter->add('/path/to/another.ext', 'contents');
-        $this->expectException(FilesystemException::class);
+        $this->expectException(FilesystemExceptionInterface::class);
         $adapter->copy('/path/to/source.ext', '/path/to/another.ext');
     }
 }