Fix compatiblity with orisai/stream-wrapper-contracts

Author: mabar

src/VfsStreamWrapper.php

@@ -282,7 +282,7 @@ public function rmdir(string $path, int $options): bool
 		return true;
 	}
 
-	public function stream_cast(int $cast_as): bool
+	public function stream_cast(int $cast_as)
 	{
 		return false;
 	}
@@ -637,7 +637,7 @@ private function getStatDefault(): array
 			'uid' => 0,
 			'gid' => 0,
 			'rdev' => 0,
-			'size' => 123,
+			'size' => 0,
 			'atime' => 0,
 			'mtime' => 0,
 			'ctime' => 0,
@@ -648,7 +648,7 @@ private function getStatDefault(): array
 		return array_merge(array_values($assoc), $assoc);
 	}
 
-	public function stream_stat(): array
+	public function stream_stat()
 	{
 		assert($this->currentFile !== null);
 		$file = $this->currentFile->getFile();

src/Wrapper/FileHandler.php

@@ -5,6 +5,7 @@
 use Orisai\VFS\Lock;
 use Orisai\VFS\Structure\File;
 use Orisai\VFS\VfsStreamWrapper;
+use function assert;
 use function min;
 use function strlen;
 use function substr;
@@ -19,6 +20,7 @@ final class FileHandler
 	private const ReadMode = 1,
 		WriteMode = 2;
 
+	/** @var int<0, max> */
 	private int $position = 0;
 
 	private int $mode = 0;
@@ -37,7 +39,8 @@ public function getFile(): File
 
 	/**
 	 * Writes to file and moves pointer.
-	 * Returns number of written bytes.
+	 *
+	 * @return int<0, max> number of written bytes
 	 */
 	public function write(string $data): int
 	{
@@ -64,18 +67,25 @@ public function read(int $bytes): string
 
 		$newPosition = $this->getPosition() + $bytes;
 		$newPosition = min($newPosition, strlen($content));
+		assert($newPosition >= 0);
 		$this->setPosition($newPosition);
 
 		$this->file->setAccessTime(time());
 
 		return $return;
 	}
 
+	/**
+	 * @return int<0, max>
+	 */
 	public function getPosition(): int
 	{
 		return $this->position;
 	}
 
+	/**
+	 * @param int<0, max> $position
+	 */
 	public function setPosition(int $position): void
 	{
 		$this->position = $position;
@@ -92,6 +102,9 @@ public function seekToEnd(): int
 		return $position;
 	}
 
+	/**
+	 * @param int<0, max> $offset
+	 */
 	public function offsetPosition(int $offset): void
 	{
 		$this->position += $offset;

tools/phpstan.baseline.neon

@@ -1,5 +1,23 @@
 parameters:
 	ignoreErrors:
+		-
+			message: '#^Method Orisai\\VFS\\VfsStreamWrapper\:\:stream_stat\(\) never returns false so it can be removed from the return type\.$#'
+			identifier: return.unusedType
+			count: 1
+			path: ../src/VfsStreamWrapper.php
+
+		-
+			message: '#^Method Orisai\\VFS\\VfsStreamWrapper\:\:stream_stat\(\) should return array\{0\: int, 1\: int, 2\: int, 3\: int, 4\: int, 5\: int, 6\: int, 7\: int, \.\.\.\}\|false but returns non\-empty\-array\<int\|string, int\>\.$#'
+			identifier: return.type
+			count: 1
+			path: ../src/VfsStreamWrapper.php
+
+		-
+			message: '#^Method Orisai\\VFS\\VfsStreamWrapper\:\:url_stat\(\) should return array\{0\: int, 1\: int, 2\: int, 3\: int, 4\: int, 5\: int, 6\: int, 7\: int, \.\.\.\}\|false but returns non\-empty\-array\<int\|string, int\>\.$#'
+			identifier: return.type
+			count: 1
+			path: ../src/VfsStreamWrapper.php
+
 		-
 			message: '#^Call to static method PHPUnit\\Framework\\Assert\:\:assertFalse\(\) with false and ''Directory not…'' will always evaluate to true\.$#'
 			identifier: staticMethod.alreadyNarrowedType