Fixing tests and phpcs

Author: floriankraemer

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-version: ['7.4', '8.0']
+        php-version: ['7.4', '8.0', '8.1']
 
     steps:
     - uses: actions/checkout@v1

composer.json

@@ -15,12 +15,11 @@
         "ext-fileinfo": "*",
         "ext-json": "*",
         "ext-mbstring": "*",
-        "phauthentic/file-storage-factories": "dev-develop",
+        "phauthentic/file-storage-factories": "^1.0",
         "psr/http-message": "^1.0"
     },
     "require-dev": {
-        "instituteweb/composer-scripts": "^1.1",
-        "phauthentic/file-storage-image-processor": "dev-develop"
+        "phauthentic/file-storage-image-processor": "^1.0"
     },
     "suggest": {
         "phauthentic/file-storage-image-processor": "For image processing"
@@ -50,31 +49,24 @@
             "php config/composer_post_install.php"
         ],
         "test": [
-            "\\InstituteWeb\\ComposerScripts\\ImprovedScriptExecution::apply",
             "phpunit"
         ],
         "test-coverage": [
-            "\\InstituteWeb\\ComposerScripts\\ImprovedScriptExecution::apply",
             "phpunit --coverage-text"
         ],
         "test-coverage-html": [
-            "\\InstituteWeb\\ComposerScripts\\ImprovedScriptExecution::apply",
             "phpunit --coverage-html tmp/coverage/"
         ],
         "cscheck": [
-            "\\InstituteWeb\\ComposerScripts\\ImprovedScriptExecution::apply",
             "phpcs src/ tests/ --standard=phpcs.xml -s"
         ],
         "csfix": [
-            "\\InstituteWeb\\ComposerScripts\\ImprovedScriptExecution::apply",
             "phpcbf src/ tests/ --standard=phpcs.xml"
         ],
         "analyze": [
-            "\\InstituteWeb\\ComposerScripts\\ImprovedScriptExecution::apply",
             "phpstan analyse src/"
         ],
         "phive": [
-            "\\InstituteWeb\\ComposerScripts\\ImprovedScriptExecution::apply",
             "php config/composer_phive.php"
         ]
     }

phive.xml

@@ -27,8 +27,8 @@
         <phar url="https://some.tld/tool.phar" />
         <phar url="someone/somerepo" />
     -->
-  <phar name="phpunit" version="^9.4" installed="9.4.0" location="./bin/phpunit" copy="true"/>
-  <phar name="phpstan" version="^0.12.53" installed="0.12.53" location="./bin/phpstan" copy="true"/>
+  <phar name="phpunit" version="^9.5" installed="9.5.21" location="./bin/phpunit" copy="true"/>
+  <phar name="phpstan" version="^1.8.10" installed="1.8.10" location="./bin/phpstan" copy="true"/>
   <phar name="phpcs" version="^3.5.8" installed="3.5.8" location="./bin/phpcs" copy="true"/>
   <phar name="phpcbf" version="^3.5.8" installed="3.5.8" location="./bin/phpcbf" copy="true"/>
   <phar name="grumphp" version="^0.19.1" installed="0.19.1" location="./bin/grumphp" copy="true"/>

src/AdapterCollection.php

@@ -16,6 +16,7 @@
 
 namespace Phauthentic\Infrastructure\Storage;
 
+use Iterator;
 use League\Flysystem\AdapterInterface;
 use ArrayIterator;
 use RuntimeException;
@@ -119,7 +120,7 @@ public function getNameToClassmap(): array
     /**
      * @inheritDoc
      */
-    public function getIterator()
+    public function getIterator(): Iterator
     {
         return new ArrayIterator($this->adapters);
     }

src/File.php

@@ -425,11 +425,9 @@ public function withMetadata(array $metadata, bool $overwrite = false): FileInte
     }
 
     /**
-     * @param string $name Name
-     * @param mixed $data Data
-     * @return \Phauthentic\Infrastructure\Storage\FileInterface
+     * @inheritDoc
      */
-    public function withMetadataKey(string $name, $data): FileInterface
+    public function withMetadataByKey(string $name, $data): FileInterface
     {
         $that = clone $this;
         $that->metadata[$name] = $data;
@@ -438,10 +436,9 @@ public function withMetadataKey(string $name, $data): FileInterface
     }
 
     /**
-     * @param string $name Name
-     * @return \Phauthentic\Infrastructure\Storage\FileInterface
+     * @inheritDoc
      */
-    public function withoutMetadataKey(string $name): FileInterface
+    public function withoutMetadataByKey(string $name): FileInterface
     {
         $that = clone $this;
         unset($that->metadata[$name]);
@@ -450,7 +447,7 @@ public function withoutMetadataKey(string $name): FileInterface
     }
 
     /**
-     * @return $this
+     * @inheritDoc
      */
     public function withoutMetadata(): self
     {
@@ -461,7 +458,7 @@ public function withoutMetadata(): self
     }
 
     /**
-     * @return array
+     * @inheritDoc
      */
     public function metadata(): array
     {
@@ -540,6 +537,29 @@ public function variantPaths(): array
         return $paths;
     }
 
+    /**
+     * @param string $key
+     * @param mixed $data;
+     */
+    public function withMetadataKey(string $key, $data): FileInterface
+    {
+        $that = clone $this;
+        $that->metadata[$key] = $data;
+
+        return $that;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function withoutMetadataKey(string $key): FileInterface
+    {
+        $that = clone $this;
+        unset($that->metadata[$key]);
+
+        return $that;
+    }
+
     /**
      * Sets many variants at once
      *
@@ -612,7 +632,7 @@ public function toArray(): array
     /**
      * @inheritDoc
      */
-    public function jsonSerialize()
+    public function jsonSerialize(): array
     {
         return $this->toArray();
     }

src/FileInterface.php

@@ -70,7 +70,7 @@ public function modelId(): ?string;
     /**
      * Gets the metadata array
      *
-     * @return array
+     * @return array<mixed, mixed>
      */
     public function metadata(): array;
 
@@ -157,7 +157,8 @@ public function toArray(): array;
     /**
      * Adds (replaces) the existing metadata
      *
-     * @param array $metadata Metadata
+     * @param array<mixed, mixed> $metadata Metadata
+     * @param bool $overwrite
      * @return \Phauthentic\Infrastructure\Storage\FileInterface
      */
     public function withMetadata(array $metadata, bool $overwrite = false): FileInterface;
@@ -176,14 +177,14 @@ public function withoutMetadata(): FileInterface;
      * @param mixed $data
      * @return \Phauthentic\Infrastructure\Storage\FileInterface
      */
-    public function withMetadataKey(string $key, $data): FileInterface;
+    public function withMetadataByKey(string $key, $data): FileInterface;
 
     /**
      * Removes a key from the metadata array
      * @param string $name Name
      * @return \Phauthentic\Infrastructure\Storage\FileInterface
      */
-    public function withoutMetadataKey(string $name): FileInterface;
+    public function withoutMetadataByKey(string $name): FileInterface;
 
     /**
      * Stream resource of the file to be stored

tests/TestCase/FileFactoryTest.php

@@ -19,7 +19,6 @@
 use GuzzleHttp\Psr7\LazyOpenStream;
 use Phauthentic\Infrastructure\Storage\FileFactory;
 use Phauthentic\Infrastructure\Storage\FileInterface;
-use Psr\Http\Message\StreamInterface;
 use Psr\Http\Message\UploadedFileInterface;
 use RuntimeException;
 

tests/TestCase/FileStorageTest.php

@@ -58,7 +58,7 @@ public function testFileStorage(): void
         $file = FileFactory::fromDisk($fileOnDisk, 'local')
             ->withUuid('914e1512-9153-4253-a81e-7ee2edc1d973')
             ->belongsToModel('User', '1')
-            ->withMetadataKey('bar', 'foo');
+            ->withMetadataByKey('bar', 'foo');
 
         $file = $fileStorage->store($file);
 

tests/TestCase/FileTest.php

@@ -66,7 +66,7 @@ public function testFile(): void
                 'one' => 'two',
                 'two' => 'one'
             ])
-            ->withMetadataKey('bar', 'foo');
+            ->withMetadataByKey('bar', 'foo');
 
         $file = $file->buildPath($pathBuilder);