Merge branch 'develop'

* develop:
  specify next release
  update actions version
  directly use output diff when path is a directory
  use blackbox 5
  use psalm 5
  test against php 8.2 and 8.3
  remove test config

Author: Baptouuuu

.github/workflows/ci.yml

@@ -8,12 +8,12 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macOS-latest]
-        php-version: ['8.1']
+        php-version: ['8.2', '8.3']
         dependencies: ['lowest', 'highest']
     name: 'PHPUnit'
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
@@ -26,19 +26,19 @@ jobs:
           dependency-versions: ${{ matrix.dependencies }}
       - name: PHPUnit
         run: vendor/bin/phpunit --coverage-clover=coverage.clover
-      - uses: codecov/codecov-action@v1
+      - uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
   psalm:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-version: ['8.1']
+        php-version: ['8.2', '8.3']
         dependencies: ['lowest', 'highest']
     name: 'Psalm'
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
@@ -54,11 +54,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-version: ['8.1']
+        php-version: ['8.2']
     name: 'CS'
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 3.2.0 - 2023-11-12
+
+### Added
+
+- `Innmind\FileWatch\Watch\Kind`
+
+### Changed
+
+- Directly use an output diff when the watched path targets a directory
+
+### Removed
+
+- Support for PHP `8.1`
+
 ## 3.1.0 - 2023-01-29
 
 ### Changed

composer.json

@@ -15,15 +15,13 @@
         "issues": "http://github.com/Innmind/FileWatch/issues"
     },
     "require": {
-        "php": "~8.1",
+        "php": "~8.2",
         "innmind/url": "~4.0",
         "innmind/server-control": "~5.0",
         "innmind/time-warp": "~3.0",
         "innmind/time-continuum": "~3.0",
         "psr/log": "~3.0"
     },
-    "minimum-stability": "dev",
-    "prefer-stable": true,
     "autoload": {
         "psr-4": {
             "Innmind\\FileWatch\\": "src/"
@@ -35,9 +33,9 @@
         }
     },
     "require-dev": {
-        "phpunit/phpunit": "~9.0",
-        "vimeo/psalm": "~4.17",
+        "phpunit/phpunit": "~10.2",
+        "vimeo/psalm": "~5.12",
         "innmind/coding-standard": "~2.0",
-        "innmind/black-box": "^4.17"
+        "innmind/black-box": "~5.5"
     }
 }

phpunit.xml.dist

@@ -1,17 +1,22 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" bootstrap="vendor/autoload.php" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-  <coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" bootstrap="vendor/autoload.php" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd">
+  <extensions>
+    <bootstrap class="Innmind\BlackBox\PHPUnit\Extension">
+    </bootstrap>
+  </extensions>
+  <coverage/>
+  <testsuites>
+    <testsuite name="Test suite">
+      <directory>./tests</directory>
+    </testsuite>
+  </testsuites>
+  <source>
     <include>
       <directory>.</directory>
     </include>
     <exclude>
       <directory>./tests</directory>
       <directory>./vendor</directory>
     </exclude>
-  </coverage>
-  <testsuites>
-    <testsuite name="Test suite">
-      <directory>./tests</directory>
-    </testsuite>
-  </testsuites>
+  </source>
 </phpunit>

psalm.xml

@@ -2,6 +2,8 @@
 <psalm
     errorLevel="1"
     resolveFromConfigFile="true"
+    findUnusedCode="false"
+    findUnusedBaselineEntry="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"

src/Factory.php

@@ -17,13 +17,19 @@ public static function build(
         Halt $halt,
         Period $interval = null,
     ): Watch {
-        return new Watch\Fallback(
-            new Watch\Tailf($processes),
-            new Watch\Stat(
-                $processes,
-                $halt,
-                $interval ?? new Second(1),
+        $files = new Watch\Tailf($processes);
+        $directories = new Watch\Stat(
+            $processes,
+            $halt,
+            $interval ?? new Second(1),
+        );
+
+        return new Watch\Kind(
+            new Watch\Fallback(
+                $files,
+                $directories,
             ),
+            $directories,
         );
     }
 }

src/Ping/OutputDiff.php

@@ -73,6 +73,7 @@ public function __invoke(mixed $carry, callable $ping): Either
             );
         } while ($continue);
 
+        /** @var Either<Failed|L, C> */
         return $previous
             ->map(static fn($state) => $state[1])
             ->otherwise($this->switchStopValue(...));
@@ -140,9 +141,9 @@ private function diff(Output $previous, Output $now): bool
      */
     private function switchStopValue(mixed $value): Either
     {
-        return match ($value instanceof Stop) {
-            true => Either::right($value->value()),
-            false => Either::left($value),
+        return match (true) {
+            $value instanceof Stop => Either::right($value->value()),
+            default => Either::left($value),
         };
     }
 }

src/Ping/ProcessOutput.php

@@ -28,11 +28,24 @@ public function __construct(Processes $processes, Command $command)
         $this->command = $command;
     }
 
+    /**
+     * @template C
+     * @template L
+     *
+     * @param C $carry
+     * @param callable(C): Either<L|Stop<C>, C> $ping
+     *
+     * @return Either<Failed|L, C>
+     */
     public function __invoke(mixed $carry, callable $ping): Either
     {
         $process = $this->processes->execute($this->command);
 
         try {
+            /**
+             * @psalm-suppress InvalidArgument Due to the reduce where Either types are not enterily defined
+             * @var Either<Failed|L, C>
+             */
             return $process
                 ->output()
                 ->reduce(
@@ -91,9 +104,9 @@ private function kill(Process $process): void
      */
     private function switchStopValue(mixed $value): Either
     {
-        return match ($value instanceof Stop) {
-            true => Either::right($value->value()),
-            false => Either::left($value),
+        return match (true) {
+            $value instanceof Stop => Either::right($value->value()),
+            default => Either::left($value),
         };
     }
 }

src/Watch/Kind.php

@@ -0,0 +1,30 @@
+<?php
+declare(strict_types = 1);
+
+namespace Innmind\FileWatch\Watch;
+
+use Innmind\FileWatch\{
+    Watch,
+    Ping,
+};
+use Innmind\Url\Path;
+
+final class Kind implements Watch
+{
+    private Watch $files;
+    private Watch $directories;
+
+    public function __construct(Watch $files, Watch $directories)
+    {
+        $this->files = $files;
+        $this->directories = $directories;
+    }
+
+    public function __invoke(Path $file): Ping
+    {
+        return match ($file->directory()) {
+            true => ($this->directories)($file),
+            false => ($this->files)($file),
+        };
+    }
+}

tests/FunctionalTest.php

@@ -203,22 +203,17 @@ public function testLog()
         $inner = Factory::build($processes, new Usleep);
         $watch = Logger::psr($inner, $logger = $this->createMock(LoggerInterface::class));
         $logger
-            ->expects($this->exactly(3))
+            ->expects($matcher = $this->exactly(3))
             ->method('info')
-            ->withConsecutive(
-                [
-                    'Starting to watch {path}',
-                    ['path' => '/tmp/innmind/watch-file'],
-                ],
-                [
-                    'Content at {path} changed',
-                    ['path' => '/tmp/innmind/watch-file'],
-                ],
-                [
-                    'Content at {path} changed',
-                    ['path' => '/tmp/innmind/watch-file'],
-                ],
-            );
+            ->willReturnCallback(function($message, $context) use ($matcher) {
+                match ($matcher->numberOfInvocations()) {
+                    1 => $this->assertSame('Starting to watch {path}', $message),
+                    2 => $this->assertSame('Content at {path} changed', $message),
+                    3 => $this->assertSame('Content at {path} changed', $message),
+                };
+
+                $this->assertSame(['path' => '/tmp/innmind/watch-file'], $context);
+            });
 
         $either = $watch(Path::of('/tmp/innmind/watch-file'))(0, static function($count) {
             ++$count;