Merge pull request #12 from intaro/phpstan

Phpstan and php cs are added
intaro · Jul 26, 2022 · eec98e5 · eec98e5
2 parents 29372fd + 083a92b
commit eec98e5
Show file tree

Hide file tree

Showing 8 changed files with 3,233 additions and 24 deletions.
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -11,7 +11,6 @@ permissions:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:
@@ -20,6 +19,11 @@ jobs:
     - name: Validate composer.json and composer.lock
       run: composer validate --strict
 
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: '7.4'
+
     - name: Cache Composer packages
       id: composer-cache
       uses: actions/cache@v3

diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+/vendor/
+/var/
+.php-cs-fixer.cache
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -14,9 +14,10 @@ public function getConfigTreeBuilder()
             $rootNode = $treeBuilder->getRootNode();
         } else {
             // BC layer for symfony/config 4.1 and older
+            // @phpstan-ignore-next-line
             $rootNode = $treeBuilder->root('intaro_file_uploader');
         }
-        
+
         $rootNode
             ->children()
                 ->arrayNode('uploaders')
@@ -56,7 +57,8 @@ public function getConfigTreeBuilder()
                         ->end()
                     ->end()
                 ->end()
-            ->end();
+            ->end()
+        ;
 
         return $treeBuilder;
     }

diff --git a/DependencyInjection/IntaroFileUploaderExtension.php b/DependencyInjection/IntaroFileUploaderExtension.php
@@ -26,19 +26,22 @@ public function prepend(ContainerBuilder $container): void
 
         foreach ($config['uploaders'] as $uploaderType => $uploaders) {
             foreach ($uploaders as $name => $options) {
-                $container->setDefinition("intaro.{$name}_uploader",
+                $container->setDefinition(
+                    "intaro.{$name}_uploader",
                     new Definition(
-                    '%intaro_file_uploader.class%',
-                    [
-                        new Reference("gaufrette.{$name}_filesystem"),
-                        $options['path'],
-                        $options['allowed_types'],
-                    ]
-                ));
+                        '%intaro_file_uploader.class%',
+                        [
+                            new Reference("gaufrette.{$name}_filesystem"),
+                            $options['path'],
+                            $options['allowed_types'],
+                        ]
+                    )
+                );
             }
         }
     }
 
+    // @phpstan-ignore-next-line у configs сложная структура
     public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration();
@@ -48,7 +51,8 @@ public function load(array $configs, ContainerBuilder $container): void
         $loader->load('services.yml');
     }
 
-    protected function generateGaufretteConfig($config)
+    // @phpstan-ignore-next-line у config и возвращаемого значения сложная структура
+    protected function generateGaufretteConfig(array $config): array
     {
         $filesystems = [];
         $adapters = [];

diff --git a/Services/FileUploader.php b/Services/FileUploader.php
@@ -4,6 +4,7 @@
 
 use Gaufrette\Adapter\AwsS3;
 use Gaufrette\Adapter\Local;
+use Gaufrette\Adapter\MetadataSupporter;
 use Gaufrette\Filesystem;
 use Symfony\Component\HttpFoundation\File\File;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
@@ -12,9 +13,11 @@ class FileUploader
 {
     private Filesystem $filesystem;
     private string $path;
-    private ?array $allowedTypes;
+    /** @var array<string> */
+    private array $allowedTypes;
     private \Transliterator $translator;
 
+    /** @param array<string> $allowedTypes */
     public function __construct(
         Filesystem $filesystem,
         string $path,
@@ -23,7 +26,12 @@ public function __construct(
         $this->filesystem = $filesystem;
         $this->path = $path;
         $this->allowedTypes = $allowedTypes;
-        $this->translator = \Transliterator::create('Any-Latin;Latin-ASCII;Lower;[\u0080-\u7fff] remove');
+
+        $translator = \Transliterator::create('Any-Latin;Latin-ASCII;Lower;[\u0080-\u7fff] remove');
+        if (!$translator) {
+            throw new \RuntimeException('Failed to create Transliterator');
+        }
+        $this->translator = $translator;
     }
 
     /**
@@ -42,14 +50,14 @@ public function upload(UploadedFile $file): string
 
         $adapter = $this->filesystem->getAdapter();
 
-        if (!($adapter instanceof Local)) {
+        if ($adapter instanceof MetadataSupporter) {
             $adapter->setMetadata(
                 $filename,
                 ['contentType' => $fileMimeType]
             );
         }
 
-        $adapter->write($filename, file_get_contents($file->getPathname()));
+        $adapter->write($filename, (string) file_get_contents($file->getPathname()));
 
         return $filename;
     }
@@ -68,14 +76,14 @@ public function uploadByPath(string $pathname, bool $unlinkAfterUpload = true):
 
         $adapter = $this->filesystem->getAdapter();
 
-        if (!($adapter instanceof Local)) {
+        if ($adapter instanceof MetadataSupporter) {
             $adapter->setMetadata(
                 $filename,
                 ['contentType' => $fileMimeType]
             );
         }
 
-        $adapter->write($filename, file_get_contents($file->getPathname()));
+        $adapter->write($filename, (string) file_get_contents($file->getPathname()));
 
         if ($unlinkAfterUpload) {
             unlink($file->getPathname());
@@ -94,7 +102,7 @@ public function uploadByContent(string $fileContent, string $filename, string $m
 
         $adapter = $this->filesystem->getAdapter();
 
-        if (!($adapter instanceof Local)) {
+        if ($adapter instanceof MetadataSupporter) {
             $adapter->setMetadata(
                 $filename,
                 ['contentType' => $mimeType]
@@ -131,16 +139,16 @@ protected function clearName(string $originalName): string
         return preg_replace(
             '/\s+/',
             '-',
-            $this->translator->transliterate($originalName)
+            (string) $this->translator->transliterate($originalName)
         );
     }
 
-    public function remove($name): bool
+    public function remove(string $name): bool
     {
         return $this->filesystem->delete($name);
     }
 
-    public function getUrl($name): string
+    public function getUrl(string $name): string
     {
         return $this->getPath() . $name;
     }
@@ -188,7 +196,8 @@ public function getPath(): string
         return $this->path;
     }
 
-    public function getAllowedTypes(): ?array
+    /** @return array<string> */
+    public function getAllowedTypes(): array
     {
         return $this->allowedTypes;
     }

diff --git a/composer.json b/composer.json
@@ -3,7 +3,7 @@
     "type": "symfony-bundle",
     "keywords": ["symfony2", "file upload"],
     "license": "MIT",
-    "Description": "Symfony2 bundle which is intended to simplify file uploading",
+    "description": "Symfony2 bundle which is intended to simplify file uploading",
     "authors": [
         {
             "name": "Intaro Soft",
@@ -18,5 +18,9 @@
         "psr-4": {
             "Intaro\\FileUploaderBundle\\": ""
         }
+    },
+    "require-dev": {
+        "phpstan/phpstan": "^1.8",
+        "friendsofphp/php-cs-fixer": "^3.9"
     }
 }