Next major release

.github/workflows/ci.yml

@@ -14,5 +14,3 @@ jobs:
     uses: innmind/github-workflows/.github/workflows/psalm-matrix.yml@main
   cs:
     uses: innmind/github-workflows/.github/workflows/cs.yml@main
-    with:
-      php-version: '8.2'

.github/workflows/extensive.yml

@@ -0,0 +1,12 @@
+name: Extensive CI
+
+on:
+  push:
+    tags:
+      - '*'
+    paths:
+      - '.github/workflows/extensive.yml'
+
+jobs:
+  blackbox:
+    uses: innmind/github-workflows/.github/workflows/extensive.yml@main

.gitignore

@@ -1,4 +1,3 @@
 composer.lock
 vendor
-.phpunit.result.cache
 .cache

CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## [Unreleased]
+
+### Added
+
+- `Innmind\Filesystem\Recover`
+
+### Changed
+
+- Requires PHP `8.4`
+- Links are not silently ignored when listing files/directories. An error is still returned when trying to remove a link.
+- `Innmind\Filesystem\Adapter\Filesystem::mount()` now returns an `Innmind\Immutable\Attempt`
+- `Innmind\Filesystem\Directory::removed()` is now flagged as internal
+- `Innmind\Filesystem\Adapter` is now a final class
+- `Innmind\Filesystem\Adapter\Filesystem` is now flagged as internal
+- `Innmind\Filesystem\Adapter\InMemory` is now flagged as internal
+- `Innmind\Filesystem\Adapter\Logger` is now flagged as internal
+- `Innmind\Filesystem\Adapter::mount()` no longer automatically create the directory if it doesn't exist
+
+### Removed
+
+- `Innmind\Filesystem\Adapter\InMemory::new()`
+- `Innmind\Filesystem\Adapter\Filesystem::withCaseSensitivity()`, case sensitivity can be specified as the second argument of `::mount()`
+- `Innmind\Filesystem\Exception\*`
+- `Innmind\Filesystem\File\Content::atPath()`, use `Content::io()` instead
+
 ## 8.1.0 - 2025-05-09
 
 ### Added

README.md

@@ -24,7 +24,7 @@ use Innmind\Filesystem\{
     File,
     File\Content,
     Directory,
-    Adapter\Filesystem,
+    Adapter,
 };
 use Innmind\Url\Path;
 
@@ -34,14 +34,13 @@ $directory = Directory::named('uploads')->add(
         Content::ofString(\file_get_contents($_FILES['my_upload']['tmp_name'])),
     ),
 );
-$adapter = Filesystem::mount(Path::of('/var/www/web/'));
+$adapter = Adapter::mount(Path::of('/var/www/web/'))->unwrap();
 $_ = $adapter
     ->add($directory)
     ->unwrap();
 ```
 
 This example show you how you can create a new directory `uploads` in the folder `/var/www/web/` of your filesystem and create the uploaded file into it.
 
-**Note**: For performance reasons the filesystem adapter only persist to disk the files that have changed (achievable via the immutable nature of file objects).
-
-All adapters implements [`Adapter`](src/Adapter.php), so you can easily replace them; especially for unit tests, that's why the library comes with an [`InMemory`](src/Adapter/InMemory.php) adapter that only keeps the files into memory so you won't mess up your file system.
+> [!NOTE]
+> For performance reasons the filesystem adapter only persist to disk the files that have changed (achievable via the immutable nature of file objects).

blackbox.php

@@ -12,6 +12,10 @@
 Application::new($argv)
     ->disableMemoryLimit() // because the generated trees can be quite large
     ->scenariiPerProof(20)
+    ->when(
+        \getenv('BLACKBOX_SET_SIZE') !== false,
+        static fn(Application $app) => $app->scenariiPerProof((int) \getenv('BLACKBOX_SET_SIZE')),
+    )
     ->when(
         \getenv('ENABLE_COVERAGE') !== false,
         static fn(Application $app) => $app
@@ -26,9 +30,6 @@
             )
             ->scenariiPerProof(1),
     )
-    ->when(
-        \method_exists(Application::class, 'allowProofsToNotMakeAnyAssertions'),
-        static fn($app) => $app->allowProofsToNotMakeAnyAssertions(),
-    )
+    ->allowProofsToNotMakeAnyAssertions()
     ->tryToProve(Load::everythingIn(__DIR__.'/proofs/'))
     ->exit();

composer.json

@@ -15,14 +15,13 @@
         "issues": "http://github.com/Innmind/filesystem/issues"
     },
     "require": {
-        "php": "~8.2",
-        "innmind/immutable": "~4.15|~5.0",
-        "symfony/filesystem": "~6.0|~7.0",
-        "innmind/media-type": "~2.1",
-        "innmind/url": "~4.2",
+        "php": "~8.4",
+        "innmind/immutable": "~6.0",
+        "innmind/media-type": "~3.0",
+        "innmind/url": "~5.0",
         "psr/log": "~3.0",
-        "innmind/io": "^3.0.1",
-        "innmind/validation": "~2.0"
+        "innmind/io": "~4.0",
+        "innmind/validation": "~3.0"
     },
     "autoload": {
         "psr-4": {
@@ -37,9 +36,10 @@
         }
     },
     "require-dev": {
-        "innmind/static-analysis": "^1.2.1",
-        "innmind/black-box": "^6.0.2",
+        "innmind/static-analysis": "~1.3",
+        "innmind/black-box": "~6.5",
         "innmind/coding-standard": "~2.0",
+        "symfony/filesystem": "~6.0|~7.0|~8.0",
         "ramsey/uuid": "^4.6"
     },
     "conflict": {

documentation/case_sensitivity.md

@@ -12,14 +12,16 @@ If you're dealing with a case insensitive filesystem then you need to specify it
 
 ```php
 use Innmind\Filesystem\{
-    Adapter\Filesystem,
+    Adapter,
     CaseSensitivity,
 };
 use Innmind\Url\Path;
 
-$adapter = Filesystem::mount(Path::of('somewhere/'))
-    ->withCaseSensitivity(CaseSensitivity::insensitive);
-$adapter instanceof Filesystem; // true, use $adapter as usual
+$adapter = Adapter::mount(
+    Path::of('somewhere/'),
+    CaseSensitivity::insensitive,
+)->unwrap()
+$adapter instanceof Adapter; // true, use $adapter as usual
 ```
 
 !!! tip ""

documentation/testing/in_app.md

@@ -1,12 +1,12 @@
 # In your application
 
-In your application you'll use most of the time the `Filesystem` adapter but in your tests writing to the filesystem can be slow. Instead you can use the `InMemory` adapter.
+In your application you'll use most of the time the `Adapter::mount()` adapter but in your tests writing to the filesystem can be slow. Instead you can use the `Adapter::inMemory()` one.
 
 ```php
-use Innmind\Filesystem\Adapter\InMemory;
+use Innmind\Filesystem\Adapter;
 
-$filesystem = InMemory::emulateFilesystem();
+$filesystem = Adapter::inMemory();
 // use $filesystem as usual
 ```
 
-This adapter is tested against the same [properties](own_adapter.md) as `Filesystem` to make sure there is no divergence of behaviour between the two.
+This adapter is tested against the same [properties](https://innmind.org/BlackBox/getting-started/property/) as `Adapter::mount()` to make sure there is no divergence of behaviour between the two.

documentation/use_cases/backup_directory.md

@@ -1,11 +1,11 @@
 # Backup a directory
 
 ```php
-use Innmind\Filesystem\Adapter\Filesystem;
+use Innmind\Filesystem\Adapter;
 use Innmind\Url\Path;
 
-$source = Filesystem::mount(Path::of('/var/data/'));
-$backup = Filesystem::mount(Path::of('/volumes/backup/'));
+$source = Adapter::mount(Path::of('/var/data/'))->unwrap();
+$backup = Adapter::mount(Path::of('/volumes/backup/'))->unwrap();
 $source
     ->root()
     ->foreach(static fn($file) => $backup->add($file)->unwrap());

documentation/use_cases/delete_file.md

@@ -4,12 +4,12 @@
 
 ```php
 use Innmind\Filesystem\{
-    Adapter\Filesystem,
+    Adapter,
     Name,
 };
 use Innmind\Url\Path;
 
-$filesystem = Filesystem::mount(Path::of('/var/data/'));
+$filesystem = Adapter::mount(Path::of('/var/data/'))->unwrap();
 $_ = $filesystem
     ->remove(Name::of('some file'))
     ->unwrap();
@@ -21,14 +21,14 @@ If the file doesn't exist it will do nothing and if the name corresponds to a di
 
 ```php
 use Innmind\Filesystem\{
-    Adapter\Filesystem,
+    Adapter,
     Name,
     Directory,
 };
 use Innmind\Url\Path;
 use Innmind\Immutable\Predicate\Instance;
 
-$filesystem = Filesystem::mount(Path::of('/var/data/'));
+$filesystem = Adapter::mount(Path::of('/var/data/'))->unwrap();
 $filesystem
     ->get(Name::of('some directory'))
     ->keep(Instance::of(Directory::class)) //(1)

documentation/use_cases/load_ftp_files.md

@@ -4,7 +4,7 @@ Say you have a client that push csv files in an unstructured manner inside a FTP
 
 ```php
 use Innmind\Filesystem\{
-    Adapter\Filesystem,
+    Adapter,
     File,
     Directory,
 };
@@ -24,11 +24,12 @@ function flatten(File|Directory $file): Sequence
     return Sequence::of($file);
 }
 
-Filesystem::mount(Path::of('/path/to/ftp/directory/'))
+Adapter::mount(Path::of('/path/to/ftp/directory/'))
+    ->unwrap()
     ->root()
     ->all()
     ->flatMap(flatten(...))
     ->foreach(static fn(File $csv) => doYourStuff($csv));
 ```
 
-The advantage of this approach is that you can easily test the whole program behaviour by replacing the `Filesystem` adapter by a `InMemory` one.
+The advantage of this approach is that you can easily test the whole program behaviour by replacing the `Adapter::mount()` adapter by `Adapter::inMemory()`.

documentation/use_cases/modify_file.md

@@ -7,7 +7,7 @@
 
 ```php
 use Innmind\Filesystem\{
-    Adapter\Filesystem,
+    Adapter,
     File,
     Name,
 };
@@ -34,8 +34,8 @@ $release = static function(File $changelog) use ($insertRelease): File {
         ),
     );
 }
-$filesystem = Filesystem::mount(Path::of('some/repository/'));
-$tmp = Filesystem::mount(Path::of('/tmp/'));
+$filesystem = Adapter::mount(Path::of('some/repository/'))->unwrap();
+$tmp = Adapter::mount(Path::of('/tmp/'))->unwrap();
 $filesystem
     ->get(Name::of('CHANGELOG.md'))
     ->keep(Instance::of(File::class))
@@ -59,7 +59,7 @@ This example modifies the `CHANGELOG.md` file to replace the `## [Unreleased]` t
 
 ```php
 use Innmind\Filesystem\{
-    Adapter\Filesystem,
+    Adapter,
     File,
     File\Content,
     File\Content\Line,
@@ -88,8 +88,8 @@ $update = static function(File $users) use ($updateUser): File {
         static fn($content) => $content->flatMap(static fn($line) => $updateUser($line)),
     );
 };
-$filesystem = Filesystem::mount(Path::of('/var/data/'));
-$tmp = Filesystem::mount(Path::of('/tmp/'));
+$filesystem = Adapter::mount(Path::of('/var/data/'))->unwrap();
+$tmp = Adapter::mount(Path::of('/tmp/'))->unwrap();
 $filesystem
     ->get(Name::of('users.csv'))
     ->keep(Instance::of(File::class))
@@ -113,7 +113,7 @@ This example will insert the user `Jane Doe` after `John Doe` wherever he is in
 
 ```php
 use Innmind\Filesystem\{
-    Adapter\Filesystem,
+    Adapter,
     File,
     File\Content,
     Name,
@@ -134,7 +134,7 @@ $merge = static function(File $file1, File $file2): File {
         ),
     );
 };
-$filesystem = Filesystem::mount(Path::of('/var/data/'));
+$filesystem = Adapter::mount(Path::of('/var/data/'))->unwrap();
 $users1 = $filesystem
     ->get(Name::of('users1.csv'))
     ->keep(Instance::of(File::class));

documentation/use_cases/persist_hand_file.md

@@ -4,13 +4,13 @@
 
 ```php
 use Innmind\Filesystem\{
-    Adapter\Filesystem,
+    Adapter,
     File,
     File\Content,
 };
 use Innmind\Url\Path;
 
-$filesystem = Filesystem::mount(Path::of('/var/data/'));
+$filesystem = Adapter::mount(Path::of('/var/data/'))->unwrap();
 $_ = $filesystem
     ->add(File::named('some name'), Content::none())
     ->unwrap();
@@ -22,7 +22,7 @@ This is equivalent of running the cli command `touch '/var/data/some name'`.
 
 ```php
 use Innmind\Filesystem\{
-    Adapter\Filesystem,
+    Adapter,
     File,
     File\Content,
     File\Content\Line,
@@ -33,7 +33,7 @@ use Innmind\Immutable\{
     Str,
 };
 
-$filesystem = Filesystem::mount(Path::of('/var/data/'));
+$filesystem = Adapter::mount(Path::of('/var/data/'))->unwrap();
 $_ = $filesystem
     ->add(File::named(
         'some name',
@@ -52,14 +52,14 @@ When the file is persisted the _end of line_ character will be automatically add
 
 ```php
 use Innmind\Filesystem\{
-    Adapter\Filesystem,
+    Adapter,
     File,
     File\Content,
     Directory,
 };
 use Innmind\Url\Path;
 
-$filesystem = Filesystem::mount(Path::of('/var/data/'));
+$filesystem = Adapter::mount(Path::of('/var/data/'))->unwrap();
 $_ = $filesystem
     ->add(
         Directory::named('whatever')->add(