Use local filesystem interface for services

Author: coisa

src/Agent/Skills/SkillsSynchronizer.php

@@ -20,9 +20,9 @@
 namespace FastForward\DevTools\Agent\Skills;
 
 use FastForward\DevTools\Filesystem\FinderFactoryInterface;
+use FastForward\DevTools\Filesystem\FilesystemInterface;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerInterface;
-use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Filesystem\Path;
 
 /**
@@ -37,12 +37,12 @@ final class SkillsSynchronizer implements LoggerAwareInterface
     /**
      * Initializes the synchronizer with a filesystem and finder factory.
      *
-     * @param Filesystem $filesystem Filesystem instance for file operations
+     * @param FilesystemInterface $filesystem Filesystem instance for file operations
      * @param FinderFactoryInterface $finderFactory Factory for locating skill directories in the package
      * @param LoggerInterface $logger Logger for recording synchronization actions and decisions
      */
     public function __construct(
-        private readonly Filesystem $filesystem,
+        private readonly FilesystemInterface $filesystem,
         private readonly FinderFactoryInterface $finderFactory,
         private LoggerInterface $logger,
     ) {}

src/Console/Command/GitAttributesCommand.php

@@ -19,9 +19,9 @@
 
 namespace FastForward\DevTools\Console\Command;
 
+use Composer\Command\BaseCommand;
 use FastForward\DevTools\Composer\Json\ComposerJsonInterface;
 use FastForward\DevTools\Filesystem\FilesystemInterface;
-use Composer\Command\BaseCommand;
 use FastForward\DevTools\GitAttributes\CandidateProviderInterface;
 use FastForward\DevTools\GitAttributes\ExistenceCheckerInterface;
 use FastForward\DevTools\GitAttributes\ExportIgnoreFilterInterface;
@@ -31,7 +31,6 @@
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\Filesystem\Filesystem;
 
 use function Safe\getcwd;
 
@@ -66,7 +65,7 @@ final class GitAttributesCommand extends BaseCommand
      * @param MergerInterface $merger the merger component
      * @param ReaderInterface $reader the reader component
      * @param WriterInterface $writer the writer component
-     * @param Filesystem $filesystem the filesystem component
+     * @param FilesystemInterface $filesystem the filesystem component
      * @param ComposerJsonInterface $composer the composer.json accessor
      */
     public function __construct(

src/Filesystem/Filesystem.php

@@ -102,6 +102,44 @@ public function chmod(string|iterable $files, int $mode, int $umask = 0o000, boo
         parent::chmod($this->getAbsolutePath($files), $mode, $umask, $recursive);
     }
 
+    /**
+     * Removes files, symbolic links, or directories.
+     *
+     * @param iterable<string>|string $files the file(s), link(s), or directory(ies) to remove
+     */
+    #[Override]
+    public function remove(string|iterable $files): void
+    {
+        parent::remove($this->getAbsolutePath($files));
+    }
+
+    /**
+     * Creates a symbolic link.
+     *
+     * @param string $originDir the origin path the link MUST point to
+     * @param string $targetDir the link path to create
+     * @param bool $copyOnWindows whether directories SHOULD be copied on Windows instead of linked
+     */
+    #[Override]
+    public function symlink(string $originDir, string $targetDir, bool $copyOnWindows = false): void
+    {
+        parent::symlink($this->getAbsolutePath($originDir), $this->getAbsolutePath($targetDir), $copyOnWindows);
+    }
+
+    /**
+     * Reads a symbolic link target.
+     *
+     * @param string $path the symbolic link path
+     * @param bool $canonicalize whether the returned path SHOULD be canonicalized
+     *
+     * @return string|null the link target, or null when the path is not a symbolic link
+     */
+    #[Override]
+    public function readlink(string $path, bool $canonicalize = false): ?string
+    {
+        return parent::readlink($this->getAbsolutePath($path), $canonicalize);
+    }
+
     /**
      * Resolves a path or iterable of paths into their absolute path representation.
      *

src/Filesystem/FilesystemInterface.php

@@ -75,6 +75,32 @@ public function copy(string $originFile, string $targetFile, bool $overwriteNewe
      */
     public function chmod(string|iterable $files, int $mode, int $umask = 0o000, bool $recursive = false): void;
 
+    /**
+     * Removes files, symbolic links, or directories.
+     *
+     * @param iterable<string>|string $files the file(s), link(s), or directory(ies) to remove
+     */
+    public function remove(string|iterable $files): void;
+
+    /**
+     * Creates a symbolic link.
+     *
+     * @param string $originDir the origin path the link MUST point to
+     * @param string $targetDir the link path to create
+     * @param bool $copyOnWindows whether directories SHOULD be copied on Windows instead of linked
+     */
+    public function symlink(string $originDir, string $targetDir, bool $copyOnWindows = false): void;
+
+    /**
+     * Reads a symbolic link target.
+     *
+     * @param string $path the symbolic link path
+     * @param bool $canonicalize whether the returned path SHOULD be canonicalized
+     *
+     * @return string|null the link target, or null when the path is not a symbolic link
+     */
+    public function readlink(string $path, bool $canonicalize = false): ?string;
+
     /**
      * Resolves a path or iterable of paths into their absolute path representation.
      *

src/GitAttributes/ExistenceChecker.php

@@ -19,7 +19,8 @@
 
 namespace FastForward\DevTools\GitAttributes;
 
-use Symfony\Component\Filesystem\Filesystem;
+use FastForward\DevTools\Filesystem\Filesystem;
+use FastForward\DevTools\Filesystem\FilesystemInterface;
 
 /**
  * Checks the existence of files and directories in a given base path.
@@ -30,10 +31,10 @@
 final readonly class ExistenceChecker implements ExistenceCheckerInterface
 {
     /**
-     * @param Filesystem $filesystem
+     * @param FilesystemInterface $filesystem
      */
     public function __construct(
-        private Filesystem $filesystem = new Filesystem()
+        private FilesystemInterface $filesystem = new Filesystem()
     ) {}
 
     /**

src/GitAttributes/Writer.php

@@ -19,7 +19,7 @@
 
 namespace FastForward\DevTools\GitAttributes;
 
-use Symfony\Component\Filesystem\Filesystem;
+use FastForward\DevTools\Filesystem\FilesystemInterface;
 
 use function Safe\preg_split;
 
@@ -33,10 +33,10 @@
 final readonly class Writer implements WriterInterface
 {
     /**
-     * @param Filesystem $filesystem the filesystem service responsible for writing the file
+     * @param FilesystemInterface $filesystem the filesystem service responsible for writing the file
      */
     public function __construct(
-        private Filesystem $filesystem
+        private FilesystemInterface $filesystem
     ) {}
 
     /**

src/GitIgnore/Writer.php

@@ -19,7 +19,7 @@
 
 namespace FastForward\DevTools\GitIgnore;
 
-use Symfony\Component\Filesystem\Filesystem;
+use FastForward\DevTools\Filesystem\FilesystemInterface;
 
 /**
  * Renders and persists normalized .gitignore content.
@@ -37,11 +37,11 @@
      * The provided filesystem implementation MUST support writing file contents
      * to the target path returned by a GitIgnoreInterface instance.
      *
-     * @param Filesystem $filesystem The filesystem service responsible for
-     *                               writing the rendered .gitignore content.
+     * @param FilesystemInterface $filesystem The filesystem service responsible for
+     *                                        writing the rendered .gitignore content.
      */
     public function __construct(
-        private Filesystem $filesystem
+        private FilesystemInterface $filesystem
     ) {}
 
     /**

src/License/Generator.php

@@ -21,8 +21,8 @@
 
 use Throwable;
 use FastForward\DevTools\Composer\Json\ComposerJsonInterface;
+use FastForward\DevTools\Filesystem\FilesystemInterface;
 use Psr\Clock\ClockInterface;
-use Symfony\Component\Filesystem\Filesystem;
 use Twig\Environment;
 
 /**
@@ -44,7 +44,7 @@
      *
      * @param ResolverInterface $resolver The resolver for mapping license identifiers to templates
      * @param ComposerJsonInterface $composer
-     * @param Filesystem $filesystem The filesystem component for file operations
+     * @param FilesystemInterface $filesystem The filesystem component for file operations
      * @param ClockInterface $clock
      * @param Environment $renderer
      */
@@ -53,7 +53,7 @@ public function __construct(
         private ComposerJsonInterface $composer,
         private ClockInterface $clock,
         private Environment $renderer,
-        private Filesystem $filesystem,
+        private FilesystemInterface $filesystem,
     ) {}
 
     /**

tests/Agent/Skills/SkillsSynchronizerTest.php

@@ -23,14 +23,14 @@
 use FastForward\DevTools\Agent\Skills\SkillsSynchronizer;
 use FastForward\DevTools\Agent\Skills\SynchronizeResult;
 use FastForward\DevTools\Filesystem\FinderFactoryInterface;
+use FastForward\DevTools\Filesystem\FilesystemInterface;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\TestCase;
 use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Log\LoggerInterface;
-use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Finder\SplFileInfo;
 
@@ -45,7 +45,7 @@ final class SkillsSynchronizerTest extends TestCase
     private const string CONSUMER_SKILLS_PATH = '/consumer/.agents/skills';
 
     /**
-     * @var ObjectProphecy<Filesystem>
+     * @var ObjectProphecy<FilesystemInterface>
      */
     private ObjectProphecy $filesystem;
 
@@ -69,7 +69,7 @@ final class SkillsSynchronizerTest extends TestCase
      */
     protected function setUp(): void
     {
-        $this->filesystem = $this->prophesize(Filesystem::class);
+        $this->filesystem = $this->prophesize(FilesystemInterface::class);
         $this->finderFactory = $this->prophesize(FinderFactoryInterface::class);
         $this->finder = $this->prophesize(Finder::class);
         $this->logger = $this->prophesize(LoggerInterface::class);

tests/Filesystem/FilesystemTest.php

@@ -25,6 +25,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Filesystem\Path;
 
+use function Safe\file_put_contents;
 use function Safe\getcwd;
 
 #[CoversClass(Filesystem::class)]
@@ -152,4 +153,33 @@ public function mkdirWillCreateDirectoryWithRelativePath(): void
         self::assertTrue($this->filesystem->exists($dirName, $this->tempDir));
         self::assertDirectoryExists($this->tempDir . '/' . $dirName);
     }
+
+    /**
+     * @return void
+     */
+    #[Test]
+    public function removeWillDeleteRelativePathAgainstCurrentWorkingDirectory(): void
+    {
+        $filename = $this->tempDir . '/remove-me.txt';
+        file_put_contents($filename, 'temporary');
+
+        $this->filesystem->remove($filename);
+
+        self::assertFileDoesNotExist($filename);
+    }
+
+    /**
+     * @return void
+     */
+    #[Test]
+    public function symlinkAndReadlinkWillUseAbsolutePaths(): void
+    {
+        $origin = $this->tempDir . '/origin';
+        $target = $this->tempDir . '/target';
+
+        $this->filesystem->mkdir($origin);
+        $this->filesystem->symlink($origin, $target);
+
+        self::assertSame($origin, $this->filesystem->readlink($target, true));
+    }
 }