PHPStan level 5

Author: Holger Lösken

.github/workflows/tests.yml

@@ -49,6 +49,9 @@ jobs:
         env:
           APP_ENV: testing
 
+      - name: Run PHPStan
+        run: ./vendor/bin/phpstan
+
       - name: Run tests
         run: ./vendor/bin/phpunit
         env:

composer.json

@@ -29,7 +29,9 @@
         "ext-json": "*",
         "ext-zip": "*",
         "guzzlehttp/guzzle": "^7.0",
-        "laravel/framework": "^8.0 || ^9.0"
+        "laravel/framework": "^8.0 || ^9.0",
+        "phpstan/extension-installer": "^1.1",
+        "phpstan/phpstan-phpunit": "^1.0"
     },
     "require-dev": {
         "dg/bypass-finals": "^1.3",
@@ -54,7 +56,10 @@
         }
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "phpstan/extension-installer": true
+        }
     },
     "extra": {
         "laravel": {

phpstan.neon.dist

@@ -0,0 +1,6 @@
+parameters:
+    level: 5
+    paths:
+        - src
+        - config
+        - tests

src/Contracts/SourceRepositoryTypeContract.php

@@ -10,9 +10,6 @@ interface SourceRepositoryTypeContract
 {
     /**
      * Fetches the latest version. If you do not want the latest version, specify one and pass it.
-     *
-     * @param  string  $version
-     * @return Release
      */
     public function fetch(string $version = ''): Release;
 

src/Events/UpdateAvailable.php

@@ -4,21 +4,13 @@
 
 class UpdateAvailable
 {
-    /**
-     * @var string
-     */
-    protected $newVersion;
+    protected string $newVersion;
 
     public function __construct(string $newVersion)
     {
         $this->newVersion = $newVersion;
     }
 
-    /**
-     * Get the new version.
-     *
-     * @return string
-     */
     public function getVersionAvailable(): string
     {
         return $this->newVersion;

src/Events/UpdateFailed.php

@@ -6,7 +6,7 @@
 
 class UpdateFailed
 {
-    protected $release;
+    protected Release $release;
 
     public function __construct(Release $release)
     {

src/Events/UpdateSucceeded.php

@@ -6,21 +6,13 @@
 
 class UpdateSucceeded
 {
-    /**
-     * @var Release
-     */
-    protected $release;
+    protected Release $release;
 
     public function __construct(Release $release)
     {
         $this->release = $release;
     }
 
-    /**
-     * Get the new version.
-     *
-     * @return string
-     */
     public function getVersionUpdatedTo(): ?string
     {
         return $this->release->getVersion();

src/Models/Release.php

@@ -19,84 +19,57 @@ final class Release
     /**
      * Name of release file.
      * Example: release-1.1.zip.
-     *
-     * @var string
      */
-    private $release;
+    private ?string $release = null;
 
     /**
      * Path to download the release to.
      * Example: /tmp/release-1.1.zip.
-     *
-     * @var string
      */
-    private $storagePath;
+    private ?string $storagePath = null;
 
     /**
      * Path where the update should be applied to. Most probably to your base_path() - that's where your
      * current Laravel installation runs.
-     *
-     * @var Finder
      */
-    private $updatePath;
+    private ?Finder $updatePath = null;
 
     /**
      * The version name.
      * Example: 1.1 or v1.1.
-     *
-     * @var string
      */
-    private $version;
+    private ?string $version = null;
 
     /**
      * Url to download the release from.
-     *
-     * @var string
      */
-    private $downloadUrl;
+    private ?string $downloadUrl = null;
 
-    /**
-     * @var Filesystem
-     */
-    protected $filesystem;
+    protected Filesystem $filesystem;
 
     public function __construct(Filesystem $filesystem)
     {
         $this->filesystem = $filesystem;
     }
 
-    /**
-     * @return string
-     */
     public function getRelease(): ?string
     {
         return $this->release;
     }
 
-    /**
-     * @param  string  $release
-     * @return Release
-     */
-    public function setRelease(string $release): self
+    public function setRelease(string $release): Release
     {
         $this->release = $release;
 
         return $this;
     }
 
-    /**
-     * @return string
-     */
     public function getStoragePath(): ?string
     {
         return $this->storagePath;
     }
 
-    /**
-     * @param  string  $storagePath
-     * @return Release
-     */
-    public function setStoragePath(string $storagePath): self
+    public function setStoragePath(string $storagePath): Release
     {
         $this->storagePath = $storagePath;
 
@@ -109,10 +82,8 @@ public function setStoragePath(string $storagePath): self
 
     /**
      * Update the storage path to include the release name.
-     *
-     * @return Release
      */
-    public function updateStoragePath(): self
+    public function updateStoragePath(): Release
     {
         if (! empty($this->getRelease())) {
             $this->storagePath = Str::finish($this->storagePath, DIRECTORY_SEPARATOR).$this->getRelease();
@@ -123,58 +94,36 @@ public function updateStoragePath(): self
         return $this;
     }
 
-    /**
-     * @return Finder
-     */
     public function getUpdatePath(): ?Finder
     {
         return $this->updatePath;
     }
 
-    /**
-     * @param  string  $updatePath
-     * @param  array  $excluded
-     * @return Release
-     */
-    public function setUpdatePath(string $updatePath, array $excluded = []): self
+    public function setUpdatePath(string $updatePath, array $excluded = []): Release
     {
         $this->updatePath = (new Finder())->in($updatePath)->exclude($excluded);
 
         return $this;
     }
 
-    /**
-     * @return string
-     */
     public function getVersion(): ?string
     {
         return $this->version;
     }
 
-    /**
-     * @param  string  $version
-     * @return Release
-     */
-    public function setVersion(string $version): self
+    public function setVersion(string $version): Release
     {
         $this->version = $version;
 
         return $this;
     }
 
-    /**
-     * @return string
-     */
     public function getDownloadUrl(): ?string
     {
         return $this->downloadUrl;
     }
 
-    /**
-     * @param  string  $downloadUrl
-     * @return Release
-     */
-    public function setDownloadUrl(string $downloadUrl): self
+    public function setDownloadUrl(string $downloadUrl): Release
     {
         $this->downloadUrl = $downloadUrl;
 
@@ -242,8 +191,6 @@ public function download(ClientInterface $client): ResponseInterface
     /**
      * Create a release sub-folder inside the storage dir.
      * Example: /tmp/release-1.2/.
-     *
-     * @return bool
      */
     protected function createReleaseFolder(): bool
     {
@@ -273,8 +220,6 @@ protected function createReleaseFolder(): bool
 
     /**
      * Check if the release file has already been downloaded.
-     *
-     * @return bool
      */
     public function isSourceAlreadyFetched(): bool
     {

src/Models/UpdateExecutor.php

@@ -19,10 +19,8 @@ final class UpdateExecutor
 
     /**
      * Define the base path where the update should be applied into.
-     *
-     * @var string
      */
-    protected $basePath;
+    protected string $basePath;
 
     public function __construct()
     {
@@ -44,16 +42,19 @@ public function setBasePath(string $path): self
     }
 
     /**
-     * @param  Release  $release
-     * @return bool
-     *
      * @throws Exception
      */
     public function run(Release $release): bool
     {
         if (checkPermissions($this->basePath)) {
             $releaseFolder = createFolderFromFile($release->getStoragePath());
 
+            if($releaseFolder === '') {
+                event(new UpdateFailed($release));
+
+                return false;
+            }
+
             // Move all directories first
             $this->moveFolders($releaseFolder);
 

src/Notifications/EventHandler.php

@@ -14,8 +14,7 @@
 
 final class EventHandler
 {
-    /** @var Repository */
-    protected $config;
+    protected Repository $config;
 
     public function __construct(Repository $config)
     {

src/Notifications/Notifications/UpdateSucceeded.php

@@ -10,10 +10,7 @@
 
 final class UpdateSucceeded extends BaseNotification
 {
-    /**
-     * @var UpdateSucceededEvent
-     */
-    protected $event;
+    protected UpdateSucceededEvent $event;
 
     public function toMail(): MailMessage
     {
@@ -22,7 +19,7 @@ public function toMail(): MailMessage
             ->subject(config('app.name').': Update succeeded');
     }
 
-    public function setEvent(UpdateSucceededEvent $event)
+    public function setEvent(UpdateSucceededEvent $event): UpdateSucceeded
     {
         $this->event = $event;