Refactor tests and classes to use PHP attributes

This commit updates all test cases to use native PHP8 attribute syntax instead of comments for PHPUnit annotations. The method visibility has also been adjusted to be compliant with the PHPUnit v9. Additionally, multiple unnecessary comment blocks have been removed from the source codes for better readability. All changes have been made across various classes and test cases.

Signed-off-by: mesilov <[email protected]>

phpstan.neon.dist

@@ -4,11 +4,13 @@ parameters:
     - src/
     - tests/Integration/Services/Telephony
     - tests/Integration/Services/User
+    - tests/Unit/
   bootstrapFiles:
     - tests/bootstrap.php
   parallel:
     jobSize: 20
     maximumNumberOfProcesses: 8
     minimumNumberOfJobsPerProcess: 2
   editorUrlTitle: '%%relFile%%:%%line%%'
-  editorUrl: 'phpstorm://open?file=%%file%%&line=%%line%%'
+  editorUrl: 'phpstorm://open?file=%%file%%&line=%%line%%'
+  treatPhpDocTypesAsCertain: false

rector.php

@@ -10,10 +10,12 @@
 return RectorConfig::configure()
     ->withPaths([
         __DIR__ . '/src/Core/',
+        __DIR__ . '/src/Application/',
         __DIR__ . '/src/Services/Telephony',
         __DIR__ . '/tests/Integration/Services/Telephony',
         __DIR__ . '/src/Services/User',
         __DIR__ . '/tests/Integration/Services/User',
+        __DIR__ . '/tests/Unit/',
     ])
     ->withCache(cacheDirectory: __DIR__ . '.cache/rector')
     ->withSets(

src/Application/ApplicationStatus.php

@@ -10,16 +10,20 @@
 class ApplicationStatus
 {
     private const STATUS_SHORT_FREE = 'F';
+
     private const STATUS_SHORT_DEMO = 'D';
+
     private const STATUS_SHORT_TRIAL = 'T';
+
     private const STATUS_SHORT_PAID = 'P';
+
     private const STATUS_SHORT_LOCAL = 'L';
+
     private const STATUS_SHORT_SUBSCRIPTION = 'S';
-    private string $statusCode;
+
+    private readonly string $statusCode;
 
     /**
-     * @param string $statusShortCode
-     *
      * @throws InvalidArgumentException
      */
     public function __construct(string $statusShortCode)
@@ -42,17 +46,11 @@ public static function free(): self
         return new self(self::STATUS_SHORT_FREE);
     }
 
-    /**
-     * @return bool
-     */
     public function isFree(): bool
     {
         return 'free' === $this->statusCode;
     }
 
-    /**
-     * @return bool
-     */
     public function isDemo(): bool
     {
         return 'demo' === $this->statusCode;
@@ -63,9 +61,6 @@ public static function demo(): self
         return new self(self::STATUS_SHORT_DEMO);
     }
 
-    /**
-     * @return bool
-     */
     public function isTrial(): bool
     {
         return 'trial' === $this->statusCode;
@@ -76,9 +71,6 @@ public static function trial(): self
         return new self(self::STATUS_SHORT_TRIAL);
     }
 
-    /**
-     * @return bool
-     */
     public function isPaid(): bool
     {
         return 'paid' === $this->statusCode;
@@ -89,9 +81,6 @@ public static function paid(): self
         return new self(self::STATUS_SHORT_PAID);
     }
 
-    /**
-     * @return bool
-     */
     public function isLocal(): bool
     {
         return 'local' === $this->statusCode;
@@ -102,9 +91,6 @@ public static function local(): self
         return new self(self::STATUS_SHORT_LOCAL);
     }
 
-    /**
-     * @return bool
-     */
     public function isSubscription(): bool
     {
         return 'subscription' === $this->statusCode;
@@ -115,18 +101,12 @@ public static function subscription(): self
         return new self(self::STATUS_SHORT_SUBSCRIPTION);
     }
 
-    /**
-     * @return string
-     */
     public function getStatusCode(): string
     {
         return $this->statusCode;
     }
 
     /**
-     * @param Request $request
-     *
-     * @return self
      * @throws InvalidArgumentException
      */
     public static function initFromRequest(Request $request): self
@@ -135,9 +115,6 @@ public static function initFromRequest(Request $request): self
     }
 
     /**
-     * @param string $shortStatusCode
-     *
-     * @return self
      * @throws InvalidArgumentException
      */
     public static function initFromString(string $shortStatusCode): self

src/Application/Contracts/Bitrix24Accounts/Entity/Bitrix24AccountInterface.php

@@ -48,11 +48,7 @@ public function getStatus(): Bitrix24AccountStatus;
      */
     public function getAuthToken(): AuthToken;
 
-    /**
-     * @param RenewedAuthToken $renewedAuthToken
-     *
-     * @return void
-     */
+
     public function renewAuthToken(RenewedAuthToken $renewedAuthToken): void;
 
     /**

src/Application/Contracts/Bitrix24Accounts/Repository/Bitrix24AccountRepositoryInterface.php

@@ -12,11 +12,10 @@ interface Bitrix24AccountRepositoryInterface
     /**
      * Get Bitrix24 account by id
      */
-    public function getById(Uuid $id): Bitrix24Accounts\Entity\Bitrix24AccountInterface;
+    public function getById(Uuid $uuid): Bitrix24Accounts\Entity\Bitrix24AccountInterface;
 
     /**
-     * @param Bitrix24Accounts\Entity\Bitrix24AccountInterface $entity
      * @param bool $isFlush save entity to storage, commit transaction in oltp database
      */
-    public function save(Bitrix24Accounts\Entity\Bitrix24AccountInterface $entity, bool $isFlush = false): void;
+    public function save(Bitrix24Accounts\Entity\Bitrix24AccountInterface $bitrix24Account, bool $isFlush = false): void;
 }

src/Application/Requests/AbstractRequest.php

@@ -8,19 +8,10 @@
 
 abstract class AbstractRequest
 {
-    protected Request $request;
-
-    /**
-     * @param \Symfony\Component\HttpFoundation\Request $request
-     */
-    public function __construct(Request $request)
+    public function __construct(protected Request $request)
     {
-        $this->request = $request;
     }
 
-    /**
-     * @return \Symfony\Component\HttpFoundation\Request
-     */
     public function getRequest(): Request
     {
         return $this->request;

src/Application/Requests/Events/AbstractEventRequest.php

@@ -10,13 +10,13 @@
 abstract class AbstractEventRequest extends AbstractRequest implements EventInterface
 {
     protected string $eventCode;
+
     protected int $timestamp;
+
     protected array $eventPayload;
+
     protected int $eventId;
 
-    /**
-     * @param Request $request
-     */
     public function __construct(Request $request)
     {
         parent::__construct($request);

src/Application/Requests/Placement/PlacementRequest.php

@@ -12,19 +12,24 @@
 
 class PlacementRequest extends AbstractRequest
 {
-    private AuthToken $accessToken;
-    private string $memberId;
-    private ApplicationStatus $applicationStatus;
-    private string $code;
+    private readonly AuthToken $accessToken;
+
+    private readonly string $memberId;
+
+    private readonly ApplicationStatus $applicationStatus;
+
+    private readonly string $code;
+
     /**
      * @var array<string, mixed>
      */
-    private array $placementOptions;
-    private string $domainUrl;
-    private string $languageCode;
+    private readonly array $placementOptions;
+
+    private readonly string $domainUrl;
+
+    private readonly string $languageCode;
 
     /**
-     * @param \Symfony\Component\HttpFoundation\Request $request
      *
      * @throws \Bitrix24\SDK\Core\Exceptions\InvalidArgumentException
      * @throws \JsonException
@@ -47,10 +52,12 @@ public function __construct(Request $request)
         if ($options === null) {
             throw new InvalidArgumentException('invalid data in PLACEMENT_OPTIONS json payload');
         }
+
         // fix "undefined" string in options when placement loaded in telephony settings
         if (!is_array($options)) {
             $options = [];
         }
+
         $this->placementOptions = $options;
     }
 
@@ -59,50 +66,35 @@ public function getApplicationStatus(): ApplicationStatus
         return $this->applicationStatus;
     }
 
-    /**
-     * @return string
-     */
     public function getMemberId(): string
     {
         return $this->memberId;
     }
 
-    /**
-     * @return \Bitrix24\SDK\Core\Credentials\AuthToken
-     */
     public function getAccessToken(): AuthToken
     {
         return $this->accessToken;
     }
 
-    /**
-     * @return string
-     */
     public function getCode(): string
     {
         return $this->code;
     }
 
-    /**
-     * @return array|mixed
-     */
-    public function getPlacementOptions()
+
+    public function getPlacementOptions(): array
     {
         return $this->placementOptions;
     }
 
-    /**
-     * @return mixed|string
-     */
-    public function getDomainUrl()
+
+    public function getDomainUrl(): string
     {
         return $this->domainUrl;
     }
 
-    /**
-     * @return mixed|string
-     */
-    public function getLanguageCode()
+
+    public function getLanguageCode(): string
     {
         return $this->languageCode;
     }

tests/Unit/Application/ApplicationStatusTest.php

@@ -9,16 +9,14 @@
 use Generator;
 use PHPUnit\Framework\TestCase;
 
+#[\PHPUnit\Framework\Attributes\CoversClass(\Bitrix24\SDK\Application\ApplicationStatus::class)]
 class ApplicationStatusTest extends TestCase
 {
     /**
-     * @param string $shortCode
-     * @param string $longCode
      *
-     * @return void
-     * @dataProvider statusDataProvider
      * @throws \Bitrix24\SDK\Core\Exceptions\InvalidArgumentException
      */
+    #[\PHPUnit\Framework\Attributes\DataProvider('statusDataProvider')]
     public function testGetStatusCode(string $shortCode, string $longCode): void
     {
         $this->assertEquals(
@@ -27,19 +25,14 @@ public function testGetStatusCode(string $shortCode, string $longCode): void
         );
     }
 
-    /**
-     * @return void
-     */
     public function testInvalidStatusCode(): void
     {
         $this->expectException(InvalidArgumentException::class);
         new ApplicationStatus('foo');
     }
 
     /**
-     * @return void
      * @throws \Bitrix24\SDK\Core\Exceptions\InvalidArgumentException
-     * @covers \Bitrix24\SDK\Application\ApplicationStatus::initFromString
      */
     public function testInitFromString(): void
     {
@@ -76,9 +69,6 @@ public function testSubscription(): void
         $this->assertTrue(ApplicationStatus::subscription()->isSubscription());
     }
 
-    /**
-     * @return \Generator
-     */
     public static function statusDataProvider(): Generator
     {
         yield 'free' => [

tests/Unit/Application/Contracts/Bitrix24Accounts/Entity/Bitrix24AccountInterfaceReferenceImplementationTest.php

@@ -19,12 +19,12 @@
 class Bitrix24AccountInterfaceReferenceImplementationTest extends Bitrix24AccountInterfaceTest
 {
     protected function createBitrix24AccountImplementation(
-        Uuid                  $id,
+        Uuid                  $uuid,
         int                   $bitrix24UserId,
         bool                  $isBitrix24UserAdmin,
         string                $memberId,
         string                $domainUrl,
-        Bitrix24AccountStatus $accountStatus,
+        Bitrix24AccountStatus $bitrix24AccountStatus,
         AuthToken             $authToken,
         CarbonImmutable       $createdAt,
         CarbonImmutable       $updatedAt,
@@ -33,12 +33,12 @@ protected function createBitrix24AccountImplementation(
     ): Bitrix24AccountInterface
     {
         return new Bitrix24AccountReferenceEntityImplementation(
-            $id,
+            $uuid,
             $bitrix24UserId,
             $isBitrix24UserAdmin,
             $memberId,
             $domainUrl,
-            $accountStatus,
+            $bitrix24AccountStatus,
             $authToken,
             $createdAt,
             $updatedAt,