Stan fixes

Author: tiagof

composer.json

@@ -16,7 +16,7 @@
         }
     ],
     "require": {
-        "php": "^8.1",
+        "php": "^8.1|^8.2",
         "illuminate/contracts": "^10.0",
         "spatie/laravel-package-tools": "^1.14.0",
         "spatie/laravel-permission": "^5.10"
@@ -36,8 +36,7 @@
     "autoload": {
         "psr-4": {
             "Squarebit\\Workflows\\": "src/",
-            "Squarebit\\Workflows\\Database\\Factories\\": "database/factories/",
-            "Domains\\": "domains/"
+            "Squarebit\\Workflows\\Database\\Factories\\": "database/factories/"
         }
     },
     "autoload-dev": {
@@ -69,6 +68,6 @@
             }
         }
     },
-    "minimum-stability": "dev",
+    "minimum-stability": "stable",
     "prefer-stable": true
 }

config/workflow.php

@@ -3,6 +3,7 @@
 // config for Squarebit/Workflows
 
 return [
+    /** @phpstan-ignore-next-line  */
     'user_model' => App\Models\User::class,
     'allow_guests_to_transition' => false,
 ];

database/factories/WorkflowFactory.php

@@ -12,11 +12,6 @@ class WorkflowFactory extends Factory
 {
     protected $model = Workflow::class;
 
-    /**
-     * Define the model's default state.
-     *
-     * @return array<string, mixed>
-     */
     public function definition(): array
     {
         return [

database/factories/WorkflowStatusFactory.php

@@ -6,17 +6,12 @@
 use Squarebit\Workflows\Models\WorkflowStatus;
 
 /**
- * @extends \Illuminate\Database\Eloquent\Factories\Factory<WorkflowStatus>
+ * @extends Factory<WorkflowStatus>
  */
 class WorkflowStatusFactory extends Factory
 {
     protected $model = WorkflowStatus::class;
 
-    /**
-     * Define the model's default state.
-     *
-     * @return array<string, mixed>
-     */
     public function definition(): array
     {
         return [

database/factories/WorkflowTransitionFactory.php

@@ -6,22 +6,20 @@
 use Squarebit\Workflows\Models\WorkflowTransition;
 
 /**
- * @extends \Illuminate\Database\Eloquent\Factories\Factory<\Squarebit\Workflows\Models\WorkflowTransition>
+ * @extends Factory<WorkflowTransition>
  */
 class WorkflowTransitionFactory extends Factory
 {
     protected $model = WorkflowTransition::class;
 
-    /**
-     * Define the model's default state.
-     *
-     * @return array<string, mixed>
-     */
     public function definition(): array
     {
         return [
+            /** @phpstan-ignore-next-line */
             'workflow_id' => WorkflowFactory::new()->create()->id,
+            /** @phpstan-ignore-next-line */
             'from_id' => WorkflowStatusFactory::new()->create()->id,
+            /** @phpstan-ignore-next-line */
             'to_id' => WorkflowStatusFactory::new()->create()->id,
             'order' => random_int(1, 999),
         ];

phpstan.neon.dist

@@ -2,7 +2,7 @@ includes:
     - phpstan-baseline.neon
 
 parameters:
-    level: 4
+    level: 8
     paths:
         - src
         - config
@@ -11,4 +11,3 @@ parameters:
     checkOctaneCompatibility: true
     checkModelProperties: true
     checkMissingIterableValueType: false
-

src/Exceptions/UnauthorizedTransitionException.php

@@ -7,8 +7,8 @@
 
 class UnauthorizedTransitionException extends Exception
 {
-    public function __construct(?string $message = null, ?Throwable $previous = null, array $headers = [], ?int $code = 0)
+    public function __construct(?string $message = null, ?Throwable $previous = null)
     {
-        parent::__construct($message ?? __('Unauthorized transition'), $code, $previous);
+        parent::__construct($message ?? __('Unauthorized transition'), 403, $previous);
     }
 }

src/Models/Workflow.php

@@ -20,16 +20,25 @@ class Workflow extends Model
 
     protected $table = 'workflows';
 
+    /**
+     * @return HasMany<WorkflowTransition>
+     */
     public function transitions(): HasMany
     {
         return $this->hasMany(WorkflowTransition::class);
     }
 
+    /**
+     * @return HasMany<WorkflowTransition>
+     */
     public function entryTransitions(): HasMany
     {
         return $this->transitions()->entry();
     }
 
+    /**
+     * @return HasMany<WorkflowTransition>
+     */
     public function exitTransitions(): HasMany
     {
         return $this->transitions()->exit();

src/Models/WorkflowModelStatus.php

@@ -7,6 +7,7 @@
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Illuminate\Database\Eloquent\SoftDeletes;
+use Illuminate\Foundation\Auth\User;
 use Squarebit\Workflows\Traits\BelongsToWorkflow;
 
 /**
@@ -18,23 +19,33 @@
  */
 class WorkflowModelStatus extends Model
 {
-    use BelongsToWorkflow;
     use SoftDeletes;
+    /** @use BelongsToWorkflow<WorkflowModelStatus> */
+    use BelongsToWorkflow;
 
     protected $with = ['status'];
 
     protected $table = 'workflow_model_statuses';
 
+    /**
+     * @return MorphTo<Model, WorkflowModelStatus>
+     */
     public function model(): MorphTo
     {
         return $this->morphTo('model');
     }
 
+    /**
+     * @return BelongsTo<User, WorkflowModelStatus>
+     */
     public function user(): BelongsTo
     {
         return $this->belongsTo(config('workflow.user_model'));
     }
 
+    /**
+     * @return BelongsTo<WorkflowStatus, WorkflowModelStatus>
+     */
     public function status(): BelongsTo
     {
         return $this->belongsTo(WorkflowStatus::class, 'workflow_status_id');

src/Models/WorkflowTransition.php

@@ -23,59 +23,88 @@
  * @method static Builder fromTo(WorkflowStatus $from, WorkflowStatus $to)
  * @method static Builder entry()
  * @method static Builder exit()
+ *
  */
 class WorkflowTransition extends Model
 {
     use SoftDeletes;
+    /** @use BelongsToWorkflow<WorkflowTransition> */
     use BelongsToWorkflow;
     use HasPermissions;
 
     public string $guard_name = 'web';
 
-    public function getMorphClass():string
+    protected $table = 'workflow_transitions';
+
+    public function getMorphClass(): string
     {
         return 'Workflow.WorkflowTransition';
     }
 
-    protected $table = 'workflow_transitions';
-
+    /**
+     * @return BelongsTo<WorkflowStatus, WorkflowTransition>
+     */
     public function fromStatus(): BelongsTo
     {
         return $this->belongsTo(WorkflowStatus::class, 'from_id');
     }
 
+    /**
+     * @return BelongsTo<WorkflowStatus, WorkflowTransition>
+     */
     public function toStatus(): BelongsTo
     {
         return $this->belongsTo(WorkflowStatus::class, 'to_id');
     }
 
+    /**
+     * @param Builder<WorkflowTransition> $query
+     * @return Builder<WorkflowTransition>
+     */
     public function scopeFrom(Builder $query, ?WorkflowStatus $from): Builder
     {
         return $query->where('from_id', $from?->id);
     }
 
+    /**
+     * @param Builder<WorkflowTransition> $query
+     * @return Builder<WorkflowTransition>
+     */
     public function scopeTo(Builder $query, ?WorkflowStatus $to): Builder
     {
         return $query->where('to_id', $to?->id);
     }
 
+    /**
+     * @param Builder<WorkflowTransition> $query
+     * @return Builder<WorkflowTransition>
+     */
     public function scopeFromTo(Builder $query, ?WorkflowStatus $from, ?WorkflowStatus $to): Builder
     {
-        return $query->from($from)->to($to);
+        return $query->from($from)
+            ->to($to);
     }
 
+    /**
+     * @param Builder<WorkflowTransition> $query
+     * @return Builder<WorkflowTransition>
+     */
     public function scopeEntry(Builder $query): Builder
     {
         return $query->whereNull('from_id');
     }
 
+    /**
+     * @param Builder<WorkflowTransition> $query
+     * @return Builder<WorkflowTransition>
+     */
     public function scopeExit(Builder $query): Builder
     {
         return $query->whereNull('to_id');
     }
 
     public function __toString()
     {
-        return $this->workflow.': '.($this->fromStatus ?? 'o').' -> '.($this->toStatus ?? 'x');
+        return $this->workflow . ': ' . ($this->fromStatus ?? 'o') . ' -> ' . ($this->toStatus ?? 'x');
     }
 }

src/Services/TransitionService.php

@@ -12,6 +12,9 @@
 
 class TransitionService
 {
+    /**
+     * @return Collection<int, WorkflowTransition>
+     */
     public static function availableTransitions(WorkflowModelStatus $modelStatus, Authenticatable $user = null): Collection
     {
         return WorkflowTransition::query()
@@ -26,7 +29,7 @@ public static function isAllowed(WorkflowTransition $transition, Authenticatable
         $user = $user ?? Auth::user();
 
         if ($user === null) {
-            return config('workflow.allow_guests_to_transition');
+            return (bool) config('workflow.allow_guests_to_transition');
         }
 
         $requiredPermissions = $transition->getAllPermissions();

src/Traits/BelongsToWorkflow.php

@@ -3,22 +3,31 @@
 namespace Squarebit\Workflows\Traits;
 
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Squarebit\Workflows\Models\Workflow;
 
 /**
+ * @template T of Model
  * @property int $workflow_id
  * @property \Squarebit\Workflows\Models\Workflow $workflow
  *
  * @method static Builder forWorkflow(int|Workflow $workflow)
  */
 trait BelongsToWorkflow
 {
+    /**
+     * @return BelongsTo<Workflow, T>
+     */
     public function workflow(): BelongsTo
     {
         return $this->belongsTo(Workflow::class);
     }
 
+    /**
+     * @param Builder<T> $query
+     * @return Builder<T>
+     */
     public function scopeForWorkflow(Builder $query, int|Workflow $workflow): Builder
     {
         return $query->where('workflow_id', is_int($workflow) ? $workflow : $workflow->id);