phpstan updates

Author: J-T-McC

composer.json

@@ -18,7 +18,8 @@
         "mockery/mockery": "^1.6.10",
         "phpunit/phpunit": "^10.5.35|^11.3.6",
         "orchestra/testbench": "^9.0",
-        "laravel/pint": "^1.20"
+        "laravel/pint": "^1.20",
+        "phpstan/phpstan": "^2.1"
     },
     "autoload": {
         "psr-4": {

src/Commands/DeployCommand.php

@@ -18,7 +18,7 @@ class DeployCommand extends BaseCommand
 
     protected $description = 'Deploy a clone of your latest build and attach symlink';
 
-    public function handle()
+    public function handle(): void
     {
         Output::alert('Running Atomic Deployment');
 
@@ -30,7 +30,8 @@ public function handle()
 
             $deploymentModel = AtomicDeployment::successful()->where('commit_hash', $hash)->first();
 
-            if (! $deploymentModel || ! $deploymentModel->hasDeployment) {
+            /** @var AtomicDeployment $deploymentModel */
+            if (! $deploymentModel || ! $deploymentModel->has_deployment) {
                 Output::warn("Build not found for hash: {$hash}");
             } else {
                 $atomicDeployment = AtomicDeploymentService::create(

src/Commands/ListCommand.php

@@ -25,7 +25,7 @@ public function handle()
             'deployment_status',
             'created_at',
         )->get()->map(function ($deployment) {
-            $deployment->append('isCurrentlyDeployed');
+            $deployment->append('is_currently_deployed');
             $deployment->deployment_status = DeploymentStatus::getNameFromValue($deployment->deployment_status);
 
             return $deployment;

src/Helpers/ConsoleOutput.php

@@ -4,11 +4,18 @@
 
 use Illuminate\Console\Command;
 
+/**
+ * @method static void line(string $string)
+ * @method static void alert(string $string)
+ * @method static void error(string $string)
+ * @method static void info(string $string)
+ * @method static void table(string $string)
+ */
 class ConsoleOutput
 {
     public static ?Command $runningCommand = null;
 
-    public function setOutput(Command $runningCommand)
+    public function setOutput(Command $runningCommand): void
     {
         static::$runningCommand = $runningCommand;
     }

src/Models/AtomicDeployment.php

@@ -2,13 +2,23 @@
 
 namespace JTMcC\AtomicDeployments\Models;
 
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Support\Facades\File;
 use JTMcC\AtomicDeployments\Exceptions\AreYouInsaneException;
 use JTMcC\AtomicDeployments\Models\Enums\DeploymentStatus;
 use JTMcC\AtomicDeployments\Services\Exec;
 
+/**
+ * @mixin Builder
+ *
+ * @method static Builder successful()
+ *
+ * @property-read bool $has_deployment
+ * @property-read bool $is_currently_deployed
+ */
 class AtomicDeployment extends Model
 {
     use SoftDeletes;
@@ -25,7 +35,7 @@ protected static function boot()
     {
         parent::boot();
         static::deleting(function ($model) {
-            if ($model->isCurrentlyDeployed) {
+            if ($model->is_currently_deployed) {
                 throw new AreYouInsaneException('Cannot delete live deployment');
             }
             $model->deleteDeployment();
@@ -37,28 +47,23 @@ public function scopeSuccessful($query)
         return $query->where('deployment_status', DeploymentStatus::SUCCESS);
     }
 
-    public function getHasDeploymentAttribute()
+    public function hasDeployment(): Attribute
     {
-        return File::isDirectory($this->deployment_path);
+        return Attribute::make(
+            get: fn () => File::isDirectory($this->deployment_path),
+        );
     }
 
-    /**
-     * @return bool
-     *
-     * @throws \JTMcC\AtomicDeployments\Exceptions\ExecuteFailedException
-     */
-    public function getIsCurrentlyDeployedAttribute()
+    public function isCurrentlyDeployed(): Attribute
     {
-        if (! $this->hasDeployment) {
-            return false;
-        }
-
-        return Exec::readlink($this->deployment_link) === $this->deployment_path;
+        return Attribute::make(
+            get: fn () => $this->has_deployment && Exec::readlink($this->deployment_link) === $this->deployment_path,
+        );
     }
 
     public function deleteDeployment()
     {
-        if ($this->hasDeployment) {
+        if ($this->has_deployment) {
             File::deleteDirectory($this->deployment_path);
         }
 

src/Services/AtomicDeploymentService.php

@@ -317,7 +317,7 @@ public function cleanBuilds(int $limit): void
         Output::info('Found '.$countOfBuildsToRemove.' '.Pluralizer::plural('folder', $countOfBuildsToRemove).' to be removed');
 
         foreach ($buildsToRemove as $deployment) {
-            if ($deployment->isCurrentlyDeployed) {
+            if ($deployment->is_currently_deployed) {
                 Output::warn('Current linked path has appeared in the directory cleaning logic');
                 Output::warn('This either means you currently have an old build deployed or there is a problem with your deployment data');
                 Output::warn('Skipping deletion');

tests/Feature/Commands/DeployCommandTest.php

@@ -116,14 +116,14 @@ public function test_it_allows_swapping_between_deployments()
         Artisan::call('atomic-deployments:deploy --directory=test-dir-1');
         Artisan::call('atomic-deployments:deploy --directory=test-dir-2');
         $deployment1 = AtomicDeployment::where('commit_hash', 'test-dir-1')->first()->append(
-            'isCurrentlyDeployed'
+            'is_currently_deployed'
         )->toArray();
         $deployment2 = AtomicDeployment::where('commit_hash', 'test-dir-2')->first()->append(
-            'isCurrentlyDeployed'
+            'is_currently_deployed'
         )->toArray();
 
-        $this->assertFalse($deployment1['isCurrentlyDeployed']);
-        $this->assertTrue($deployment2['isCurrentlyDeployed']);
+        $this->assertFalse($deployment1['is_currently_deployed']);
+        $this->assertTrue($deployment2['is_currently_deployed']);
 
         // Act
         Artisan::call('atomic-deployments:deploy --hash=test-dir-fake');
@@ -144,14 +144,14 @@ public function test_it_allows_swapping_between_deployments()
         ]);
 
         $deployment1 = AtomicDeployment::where('commit_hash', 'test-dir-1')->first()->append(
-            'isCurrentlyDeployed'
+            'is_currently_deployed'
         )->toArray();
         $deployment2 = AtomicDeployment::where('commit_hash', 'test-dir-2')->first()->append(
-            'isCurrentlyDeployed'
+            'is_currently_deployed'
         )->toArray();
 
-        $this->assertTrue($deployment1['isCurrentlyDeployed']);
-        $this->assertFalse($deployment2['isCurrentlyDeployed']);
+        $this->assertTrue($deployment1['is_currently_deployed']);
+        $this->assertFalse($deployment2['is_currently_deployed']);
     }
 
     public function test_it_cleans_old_build_folders_based_on_build_limit()
@@ -190,18 +190,18 @@ public function test_it_dispatches_deployment_successful_event_on_deployment_swa
         Artisan::call('atomic-deployments:deploy --directory=test-dir-1');
         Artisan::call('atomic-deployments:deploy --directory=test-dir-2');
         $deployment = AtomicDeployment::where('commit_hash', 'test-dir-2')->first()->append(
-            'isCurrentlyDeployed'
+            'is_currently_deployed'
         )->toArray();
-        $this->assertTrue($deployment['isCurrentlyDeployed']);
+        $this->assertTrue($deployment['is_currently_deployed']);
 
         // Act
         Artisan::call('atomic-deployments:deploy --hash=test-dir-1');
 
         // Assert
         $deployment = AtomicDeployment::where('commit_hash', 'test-dir-1')->first()->append(
-            'isCurrentlyDeployed'
+            'is_currently_deployed'
         )->toArray();
-        $this->assertTrue($deployment['isCurrentlyDeployed']);
+        $this->assertTrue($deployment['is_currently_deployed']);
         Event::assertDispatched(DeploymentSuccessful::class);
     }