Added phpstan

.github/workflows/phpstan.yml

@@ -0,0 +1,39 @@
+name: Tests PHPStan in environments
+
+on: [pull_request]
+
+jobs:
+  php82-laravel-latest-phpstan-postgres:
+    runs-on: ubuntu-latest
+    container:
+      image: escolalms/php:8.2
+
+    services:
+      postgres:
+        image: postgres:12
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: test
+          TZ: Europe/Warsaw
+        ports:
+          - 5432:5432
+
+    steps:
+      - name: Instantiate package
+        uses: actions/checkout@v2
+
+      - name: Setup environment
+        run: cp env/postgres/* .
+
+      - name: Update composer
+        run: COMPOSER_ROOT_VERSION=0.9.9 composer update
+
+      - name: Clear config
+        run: vendor/bin/testbench config:clear
+
+      - name: Publish things
+        run: vendor/bin/testbench migrate:fresh
+
+      - name: Run tests
+        run: vendor/bin/phpstan analyse

.github/workflows/test.yml

@@ -63,12 +63,12 @@ jobs:
       - name: Instantiate package
         uses: actions/checkout@v2
 
-      - name: Update composer
-        run: composer update
-
       - name: Setup environment
         run: cp env/postgres/* .
 
+      - name: Update composer
+        run: composer update
+
       - name: Clear config
         run: vendor/bin/testbench config:clear
 
@@ -107,12 +107,12 @@ jobs:
       - name: Instantiate package
         uses: actions/checkout@v2
 
-      - name: Update composer
-        run: composer update
-
       - name: Setup environment
         run: cp env/postgres/* .
 
+      - name: Update composer
+        run: composer update
+
       - name: Clear config
         run: vendor/bin/testbench config:clear
 

composer.json

@@ -16,8 +16,9 @@
     "escolalms/consultations": "^0",
     "escolalms/courses": "^0.4",
     "escolalms/cart": "^0",
-    "orchestra/testbench": "^5.0|^6.0",
-    "phpunit/phpunit": "^9.0"
+    "orchestra/testbench": ">=5.0",
+    "phpunit/phpunit": "^9.0",
+    "nunomaduro/larastan": "^2.0"
   },
   "license": "MIT",
   "authors": [

phpstan.neon

@@ -0,0 +1,10 @@
+includes:
+    - ./vendor/nunomaduro/larastan/extension.neon
+
+parameters:
+
+    paths:
+        - src/
+
+    # The level 9 is the highest level
+    level: 6

src/Consultations/ApprovedTermVariables.php

@@ -4,6 +4,9 @@
 
 class ApprovedTermVariables extends CommonConsultationVariables
 {
+    /**
+     * @return array<string, mixed>
+     */
     public static function defaultSectionsContent(): array
     {
         return [

src/Consultations/ApprovedTermWithTrainerVariables.php

@@ -4,6 +4,9 @@
 
 class ApprovedTermWithTrainerVariables extends CommonConsultationVariables
 {
+    /**
+     * @return array<string, mixed>
+     */
     public static function defaultSectionsContent(): array
     {
         return [

src/Consultations/CommonConsultationVariables.php

@@ -14,6 +14,9 @@ abstract class CommonConsultationVariables extends SmsVariables
     const VAR_CONSULTATION_TITLE = '@VarConsultationTitle';
     const VAR_CONSULTATION_PROPOSED_TERM = '@VarConsultationProposedTerm';
 
+    /**
+     * @return array<string, mixed>
+     */
     public static function mockedVariables(?User $user = null): array
     {
         $faker = \Faker\Factory::create();
@@ -23,17 +26,27 @@ public static function mockedVariables(?User $user = null): array
         ]);
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public static function variablesFromEvent(EventWrapper $event): array
     {
         return array_merge(parent::variablesFromEvent($event), [
+            // @phpstan-ignore-next-line
             self::VAR_USER_NAME => $event->getUser()->name,
+            // @phpstan-ignore-next-line
             self::VAR_CONSULTATION_TITLE => $event->getConsultationTerm()->consultation->name,
+            // @phpstan-ignore-next-line
             self::VAR_CONSULTATION_PROPOSED_TERM => Carbon::make($event->getConsultationTerm()->executed_at)
+                // @phpstan-ignore-next-line
                 ->setTimezone($event->getUser()->current_timezone)
                 ->format('Y-m-d H:i:s'),
         ]);
     }
 
+    /**
+     * @return string[]
+     */
     public static function requiredVariables(): array
     {
         return [
@@ -43,6 +56,9 @@ public static function requiredVariables(): array
         ];
     }
 
+    /**
+     * @return string[]
+     */
     public static function requiredVariablesInSection(string $sectionKey): array
     {
         if ($sectionKey === 'content') {

src/Consultations/RejectTermVariables.php

@@ -4,6 +4,9 @@
 
 class RejectTermVariables extends CommonConsultationVariables
 {
+    /**
+     * @return array<string, mixed>
+     */
     public static function defaultSectionsContent(): array
     {
         return [

src/Consultations/RejectTermWithTrainerVariables.php

@@ -4,6 +4,9 @@
 
 class RejectTermWithTrainerVariables extends CommonConsultationVariables
 {
+    /**
+     * @return array<string, mixed>
+     */
     public static function defaultSectionsContent(): array
     {
         return [

src/Consultations/ReminderAboutTermVariables.php

@@ -4,6 +4,9 @@
 
 class ReminderAboutTermVariables extends CommonConsultationVariables
 {
+    /**
+     * @return array<string, mixed>
+     */
     public static function defaultSectionsContent(): array
     {
         return [

src/Consultations/ReminderTrainerAboutTermVariables.php

@@ -8,13 +8,19 @@ class ReminderTrainerAboutTermVariables extends CommonConsultationVariables
 {
     const VAR_CONSULTATION_USER_NAME = '@VarConsultationUserName';
 
+    /**
+     * @return string[]
+     */
     public static function requiredVariables(): array
     {
         return array_merge(parent::requiredVariables(), [
             self::VAR_CONSULTATION_USER_NAME,
         ]);
     }
 
+    /**
+     * @return string[]
+     */
     public static function requiredVariablesInSection(string $sectionKey): array
     {
         if ($sectionKey === 'content') {
@@ -25,13 +31,20 @@ public static function requiredVariablesInSection(string $sectionKey): array
         return [];
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public static function variablesFromEvent(EventWrapper $event): array
     {
         return array_merge(parent::variablesFromEvent($event), [
+            // @phpstan-ignore-next-line
             self::VAR_CONSULTATION_USER_NAME => $event->getConsultationTerm()->user->name,
         ]);
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public static function defaultSectionsContent(): array
     {
         return [

src/Consultations/ReportTermVariables.php

@@ -8,13 +8,19 @@ class ReportTermVariables extends CommonConsultationVariables
 {
     const VAR_CONSULTATION_BUYER_NAME = '@VarConsultationBuyerName';
 
+    /**
+     * @return string[]
+     */
     public static function requiredVariables(): array
     {
         return array_merge(parent::requiredVariables(), [
             self::VAR_CONSULTATION_BUYER_NAME,
         ]);
     }
 
+    /**
+     * @return string[]
+     */
     public static function requiredVariablesInSection(string $sectionKey): array
     {
         if ($sectionKey === 'content') {
@@ -25,13 +31,20 @@ public static function requiredVariablesInSection(string $sectionKey): array
         return [];
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public static function variablesFromEvent(EventWrapper $event): array
     {
         return array_merge(parent::variablesFromEvent($event), [
+            // @phpstan-ignore-next-line
             self::VAR_CONSULTATION_BUYER_NAME => $event->getConsultationTerm()->user->name,
         ]);
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public static function defaultSectionsContent(): array
     {
         return [

src/Core/SmsChannel.php

@@ -14,6 +14,9 @@
 
 class SmsChannel extends AbstractTemplateChannelClass implements TemplateChannelContract
 {
+    /**
+     * @param array<string, mixed> $sections
+     */
     public static function send(EventWrapper $event, array $sections): bool
     {
         $user = $event->user();
@@ -31,26 +34,37 @@ public static function send(EventWrapper $event, array $sections): bool
         return self::sendMessage($user, $sections);
     }
 
+    /**
+     * @param array<string, mixed> $sections
+     */
     public static function preview(User $user, array $sections): bool
     {
         return self::sendMessage($user, $sections);
     }
 
+    /**
+     * @return Collection<int, TemplateSectionSchema>
+     */
     public static function sections(): Collection
     {
         return new Collection([
+            // @phpstan-ignore-next-line
             new TemplateSectionSchema('content', TemplateSectionTypeEnum::SECTION_TEXT(), true),
         ]);
     }
 
+    /**
+     * @param array<string, mixed> $sections
+     */
     private static function sendMessage(User $user, array $sections): bool
     {
+        // @phpstan-ignore-next-line
         if (!$user->phone) {
             return false;
         }
 
         try {
-           Sms::send($sections['content'])->to($user->phone)->dispatch();
+            Sms::send($sections['content'])->to($user->phone)->dispatch();
         } catch (\Exception $exception) {
             Log::error('[' . __CLASS__ . '] ' . $exception->getMessage());
             return false;

src/Core/SmsVariables.php

@@ -9,16 +9,25 @@
 
 abstract class SmsVariables extends AbstractTemplateVariableClass implements TemplateVariableContract
 {
+    /**
+     * @return array<string, mixed>
+     */
     public static function mockedVariables(?User $user = null): array
     {
         return [];
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public static function variablesFromEvent(EventWrapper $event): array
     {
         return [];
     }
 
+    /**
+     * @return string[]
+     */
     public static function requiredSections(): array
     {
         return [];