Add a new contracts package (#7)

Author: szvsky

composer.json

@@ -28,6 +28,7 @@
         "aether/cache": "self.version",
         "aether/clock": "self.version",
         "aether/config": "self.version",
+        "aether/contracts": "self.version",
         "aether/crypto": "self.version",
         "aether/database": "self.version",
         "aether/dependency-injection": "self.version",
@@ -54,6 +55,7 @@
             "Aether\\Cache\\": "packages/Cache/src/",
             "Aether\\Clock\\": "packages/Clock/src/",
             "Aether\\Config\\": "packages/Config/src/",
+            "Aether\\Contracts\\": "packages/Contracts/",
             "Aether\\Crypto\\": "packages/Crypto/src/",
             "Aether\\Database\\": "packages/Database/src/",
             "Aether\\DependencyInjection\\": "packages/DependencyInjection/src/",

…s/Filesystem/src/FilesystemInterface.php …ages/Contracts/Filesystem/Filesystem.phppackages/Filesystem/src/FilesystemInterface.php renamed to packages/Contracts/Filesystem/Filesystem.php packages/Filesystem/src/FilesystemInterface.php renamed to packages/Contracts/Filesystem/Filesystem.php

@@ -1,24 +1,15 @@
 <?php
 
-/*
- * This file is part of the aether/aether.
- *
- * Copyright (C) 2024 Dominik Szamburski
- *
- * This software may be modified and distributed under the terms
- * of the MIT license. See the LICENSE file for details.
- */
-
-namespace Aether\Filesystem;
-
-interface FilesystemInterface
+namespace Aether\Contracts\Filesystem;
+
+interface Filesystem
 {
     /**
      * Checks if a file exists at the given path.
      *
      * @param string $path
      * @return bool
-     * @throws \Aether\Filesystem\IOException
+     * @throws \Aether\Contracts\Filesystem\IOException
      */
     public function exists(string $path): bool;
 
@@ -37,7 +28,7 @@ public function read(string $path): string;
      * @param string $contents
      * @param bool $lock
      * @return void
-     * @throws \Aether\Filesystem\IOException
+     * @throws \Aether\Contracts\Filesystem\IOException
      */
     public function write(string $path, string $contents, bool $lock = false): void;
 
@@ -46,10 +37,9 @@ public function write(string $path, string $contents, bool $lock = false): void;
      *
      * @param string $source
      * @param string $destination
-
-     * @return void
+ * @return void
      *
-     * @throws \Aether\Filesystem\IOException
+     * @throws \Aether\Contracts\Filesystem\IOException
      */
     public function copy(string $source, string $destination): void;
 
@@ -61,7 +51,7 @@ public function copy(string $source, string $destination): void;
      *
      * @return void
      *
-     * @throws \Aether\Filesystem\IOException
+     * @throws \Aether\Contracts\Filesystem\IOException
      */
     public function move(string $source, string $destination): void;
 
@@ -86,10 +76,10 @@ public function touch(string $filename, ?int $mtime = null, ?int $atime = null):
     /**
      * Deletes a file.
      *
-     * @param string|array $filename
+     * @param string|string[] $filename
      * @return void
      *
-     * @throws \Aether\Filesystem\IOException
+     * @throws \Aether\Contracts\Filesystem\IOException
      */
     public function unlink(string|array $filename): void;
 
@@ -102,7 +92,7 @@ public function unlink(string|array $filename): void;
      *
      * @return void
      *
-     * @throws \Aether\Filesystem\IOException
+     * @throws \Aether\Contracts\Filesystem\IOException
      */
     public function mkdir(string $directory, int $mode = 0777, bool $recursive = true): void;
 
@@ -112,7 +102,7 @@ public function mkdir(string $directory, int $mode = 0777, bool $recursive = tru
      * @param string $directory
      * @return void
      *
-     * @throws \Aether\Filesystem\IOException
+     * @throws \Aether\Contracts\Filesystem\IOException
      */
     public function rmdir(string $directory): void;
 
@@ -154,7 +144,7 @@ public function extension(string $path): string;
      * @param string $path
      * @return int
      *
-     * @throws \Aether\Filesystem\IOException
+     * @throws \Aether\Contracts\Filesystem\IOException
      */
     public function filesize(string $path): int;
 
@@ -180,7 +170,7 @@ public function isFile(string $path): bool;
      * @param string $path
      * @return string
      *
-     * @throws \Aether\Filesystem\IOException
+     * @throws \Aether\Contracts\Filesystem\IOException
      */
     public function mimeType(string $path): string;
 }

packages/Filesystem/src/IOException.php …ges/Contracts/Filesystem/IOException.phppackages/Filesystem/src/IOException.php renamed to packages/Contracts/Filesystem/IOException.php packages/Filesystem/src/IOException.php renamed to packages/Contracts/Filesystem/IOException.php

@@ -9,7 +9,7 @@
  * of the MIT license. See the LICENSE file for details.
  */
 
-namespace Aether\Filesystem;
+namespace Aether\Contracts\Filesystem;
 
 class IOException extends \RuntimeException
 {

packages/Contracts/composer.json

@@ -0,0 +1,23 @@
+{
+    "name": "aether/contracts",
+    "description": "The Aether contracts package.",
+    "license": "MIT",
+    "type": "library",
+    "support": {
+        "issues": "https://github.com/sxbrsky/aether/issues",
+        "source": "https://github.com/sxbrsky/aether"
+    },
+    "require": {
+        "php": "^8.2",
+        "ext-fileinfo": "*"
+    },
+    "minimum-stability": "dev",
+    "autoload": {
+        "psr-4": {
+            "Aether\\Contracts\\": ""
+        }
+    },
+    "config": {
+        "sort-packages": true
+    }
+}

packages/Filesystem/composer.json

@@ -9,7 +9,8 @@
   },
   "require": {
     "php": "^8.2",
-    "ext-fileinfo": "*"
+    "ext-fileinfo": "*",
+    "aether/contract": "dev-master"
   },
   "minimum-stability": "dev",
   "autoload": {

packages/Filesystem/src/Filesystem.php

@@ -1,5 +1,7 @@
 <?php
 
+namespace Aether\Filesystem;
+
 /*
  * This file is part of the aether/aether.
  *
@@ -9,9 +11,10 @@
  * of the MIT license. See the LICENSE file for details.
  */
 
-namespace Aether\Filesystem;
+use Aether\Contracts\Filesystem\Filesystem as FilesystemContract;
+use Aether\Contracts\Filesystem\IOException;
 
-class Filesystem implements FilesystemInterface
+class Filesystem implements FilesystemContract
 {
     public function exists(string $path): bool
     {

packages/Filesystem/tests/FilesystemTest.php

@@ -11,16 +11,16 @@
 
 namespace Aether\Tests\Filesystem;
 
+use Aether\Contracts\Filesystem\Filesystem as FilesystemContract;
 use Aether\Filesystem\Filesystem;
-use Aether\Filesystem\FilesystemInterface;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
 
 #[CoversClass(Filesystem::class)]
 class FilesystemTest extends TestCase
 {
     private ?string $tempDir;
-    private FilesystemInterface $filesystem;
+    private FilesystemContract $filesystem;
 
     protected function setUp(): void
     {