Add Rector Config & Apply some rules

SC-Networks · Mar 8, 2024 · 987b486 · 987b486
1 parent 2cc93c9
commit 987b486
Show file tree

Hide file tree

Showing 24 changed files with 192 additions and 249 deletions.
diff --git a/composer.json b/composer.json
@@ -33,7 +33,8 @@
         "phpstan/phpstan": "^1.4",
         "phpstan/phpstan-mockery": "^1.0",
         "phpstan/phpstan-strict-rules": "^1.1",
-        "phpunit/phpunit": "^11"
+        "phpunit/phpunit": "^11",
+        "rector/rector": "^1.0"
     },
     "autoload": {
         "psr-4": {

diff --git a/composer.lock b/composer.lock
diff --git a/rector.php b/rector.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\TypeDeclaration\Rector\ClassMethod\AddVoidReturnTypeWhereNoReturnRector;
+use Rector\Php74\Rector\Closure\ClosureToArrowFunctionRector;
+use Rector\Php74\Rector\LNumber\AddLiteralSeparatorToNumberRector;
+use Rector\PHPUnit\CodeQuality\Rector\MethodCall\AssertSameTrueFalseToAssertTrueFalseRector;
+use Rector\PHPUnit\PHPUnit100\Rector\Class_\StaticDataProviderClassMethodRector;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->withPreparedSets(deadCode: true, codeQuality: true)
+    ->withRules([
+        AddLiteralSeparatorToNumberRector::class,
+        ClosureToArrowFunctionRector::class,
+        AssertSameTrueFalseToAssertTrueFalseRector::class,
+        StaticDataProviderClassMethodRector::class,
+        AddVoidReturnTypeWhereNoReturnRector::class,
+    ]);
diff --git a/src/Handler/DeeplBatchTranslationRequestHandler.php b/src/Handler/DeeplBatchTranslationRequestHandler.php
@@ -49,14 +49,14 @@ public function getBody(): StreamInterface
                 [
                     'target_lang' => $this->translation->getTargetLang(),
                     'tag_handling' => implode(
-                        static::SEPARATOR,
+                        self::SEPARATOR,
                         $this->translation->getTagHandling()
                     ),
                     'non_splitting_tags' => implode(
-                        static::SEPARATOR,
+                        self::SEPARATOR,
                         $this->translation->getNonSplittingTags()
                     ),
-                    'ignore_tags' => implode(static::SEPARATOR, $this->translation->getIgnoreTags()),
+                    'ignore_tags' => implode(self::SEPARATOR, $this->translation->getIgnoreTags()),
                     'split_sentences' => $this->translation->getSplitSentences(),
                     'preserve_formatting' => $this->translation->getPreserveFormatting(),
                     'glossary_id' => $this->translation->getGlossaryId(),

diff --git a/src/Handler/DeeplTranslationRequestHandler.php b/src/Handler/DeeplTranslationRequestHandler.php
@@ -49,14 +49,14 @@ public function getBody(): StreamInterface
                         'target_lang' => $this->translation->getTargetLang(),
                         'source_lang' => $this->translation->getSourceLang(),
                         'tag_handling' => implode(
-                            static::SEPARATOR,
+                            self::SEPARATOR,
                             $this->translation->getTagHandling()
                         ),
                         'non_splitting_tags' => implode(
-                            static::SEPARATOR,
+                            self::SEPARATOR,
                             $this->translation->getNonSplittingTags()
                         ),
-                        'ignore_tags' => implode(static::SEPARATOR, $this->translation->getIgnoreTags()),
+                        'ignore_tags' => implode(self::SEPARATOR, $this->translation->getIgnoreTags()),
                         'split_sentences' => $this->translation->getSplitSentences(),
                         'preserve_formatting' => $this->translation->getPreserveFormatting(),
                         'glossary_id' => $this->translation->getGlossaryId(),

diff --git a/tests/DeeplClientFactoryTest.php b/tests/DeeplClientFactoryTest.php
@@ -18,26 +18,20 @@ public function testCreateReturnsClientWithCustomLibraries(): void
 
         $authKey = 'some-auth-key';
 
-        $this->assertInstanceOf(
-            DeeplClientInterface::class,
-            DeeplClientFactory::create(
-                $authKey,
-                $client,
-                $requestFactory,
-                $streamFactory
-            )
-        );
+        self::assertInstanceOf(DeeplClientInterface::class, DeeplClientFactory::create(
+            $authKey,
+            $client,
+            $requestFactory,
+            $streamFactory
+        ));
     }
 
     public function testCreateReturnsClientWithAutoDisovery(): void
     {
         $authKey = 'some-auth-key';
 
-        $this->assertInstanceOf(
-            DeeplClientInterface::class,
-            DeeplClientFactory::create(
-                $authKey
-            )
-        );
+        self::assertInstanceOf(DeeplClientInterface::class, DeeplClientFactory::create(
+            $authKey
+        ));
     }
 }
diff --git a/tests/DeeplClientTest.php b/tests/DeeplClientTest.php
@@ -120,7 +120,7 @@ public function testGetUsageCanReturnUsageModel(): void
             ->with($request)
             ->willReturn($response);
 
-        $this->assertInstanceOf(UsageInterface::class, $this->subject->getUsage());
+        self::assertInstanceOf(UsageInterface::class, $this->subject->getUsage());
     }
 
     public function testGetTranslationCanThrowException(): void
@@ -193,7 +193,7 @@ public function testGetTranslationCanReturnTranslationModel(): void
             ->with($request)
             ->willReturn($response);
 
-        $this->assertInstanceOf(TranslationInterface::class, $this->subject->getTranslation($translation));
+        self::assertInstanceOf(TranslationInterface::class, $this->subject->getTranslation($translation));
     }
 
     public function testTranslateCanReturnJsonEncodedObject(): void
@@ -234,7 +234,7 @@ public function testTranslateCanReturnJsonEncodedObject(): void
             ->with($request)
             ->willReturn($response);
 
-        $this->assertInstanceOf(TranslationInterface::class, $this->subject->translate('some text', 'some language'));
+        self::assertInstanceOf(TranslationInterface::class, $this->subject->translate('some text', 'some language'));
     }
 
     public function testTranslateBatchPerformsBatchTranslations(): void
@@ -274,10 +274,7 @@ public function testTranslateBatchPerformsBatchTranslations(): void
             ->with($request)
             ->willReturn($response);
 
-        $this->assertInstanceOf(
-            BatchTranslationInterface::class,
-            $this->subject->translateBatch(['some text'], 'some language')
-        );
+        self::assertInstanceOf(BatchTranslationInterface::class, $this->subject->translateBatch(['some text'], 'some language'));
     }
 
     public function testTranslateFileCanReturnInstanceOfResponseModel(): void
@@ -320,7 +317,7 @@ public function testTranslateFileCanReturnInstanceOfResponseModel(): void
             ->with($request)
             ->willReturn($response);
 
-        $this->assertInstanceOf(FileSubmissionInterface::class, $this->subject->translateFile($fileTranslation));
+        self::assertInstanceOf(FileSubmissionInterface::class, $this->subject->translateFile($fileTranslation));
     }
 
     public function testGetFileTranslationStatusCanReturnInstanceOfResponseModel(): void
@@ -363,7 +360,7 @@ public function testGetFileTranslationStatusCanReturnInstanceOfResponseModel():
             ->with($request)
             ->willReturn($response);
 
-        $this->assertInstanceOf(FileTranslationStatusInterface::class, $this->subject->getFileTranslationStatus($fileSubmission));
+        self::assertInstanceOf(FileTranslationStatusInterface::class, $this->subject->getFileTranslationStatus($fileSubmission));
     }
 
     public function testGetFileTranslationCanReturnInstanceOfResponseModel(): void
@@ -402,7 +399,7 @@ public function testGetFileTranslationCanReturnInstanceOfResponseModel(): void
             ->with($request)
             ->willReturn($response);
 
-        $this->assertInstanceOf(FileTranslationInterface::class, $this->subject->getFileTranslation($fileSubmission));
+        self::assertInstanceOf(FileTranslationInterface::class, $this->subject->getFileTranslation($fileSubmission));
     }
 
     public static function errorStatusCodeProvider(): array
@@ -487,7 +484,7 @@ public function testGetSupportedLanguagesReturnsSupportedLanguagesModel(): void
             ->with($request)
             ->willReturn($response);
 
-        $this->assertInstanceOf(SupportedLanguages::class, $this->subject->getSupportedLanguages());
+        self::assertInstanceOf(SupportedLanguages::class, $this->subject->getSupportedLanguages());
     }
 
     public function testGetGlossariesSupportedLanguagesPairsGetCorrectModel(): void
@@ -528,7 +525,7 @@ public function testGetGlossariesSupportedLanguagesPairsGetCorrectModel(): void
             ->with($request)
             ->willReturn($response);
 
-        $this->assertInstanceOf(GlossariesSupportedLanguagesPairs::class, $this->subject->getGlossariesSupportedLanguagesPairs());
+        self::assertInstanceOf(GlossariesSupportedLanguagesPairs::class, $this->subject->getGlossariesSupportedLanguagesPairs());
     }
 
     public function testGetGlossariesListGetCorrectModel(): void
@@ -569,7 +566,7 @@ public function testGetGlossariesListGetCorrectModel(): void
             ->with($request)
             ->willReturn($response);
 
-        $this->assertInstanceOf(Glossaries::class, $this->subject->getGlossariesList());
+        self::assertInstanceOf(Glossaries::class, $this->subject->getGlossariesList());
     }
 
     public function testCreateGlossaryGetCorrectModel(): void
@@ -612,7 +609,7 @@ public function testCreateGlossaryGetCorrectModel(): void
 
         $submission = $this->createMock(GlossarySubmission::class);
 
-        $this->assertInstanceOf(Glossary::class, $this->subject->createGlossary($submission));
+        self::assertInstanceOf(Glossary::class, $this->subject->createGlossary($submission));
     }
 
     public function testRetrieveGlossaryGetCorrectModel(): void
@@ -654,7 +651,7 @@ public function testRetrieveGlossaryGetCorrectModel(): void
             ->willReturn($response);
 
         $submission = $this->createMock(GlossaryIdSubmission::class);
-        $this->assertInstanceOf(Glossary::class, $this->subject->retrieveGlossary($submission));
+        self::assertInstanceOf(Glossary::class, $this->subject->retrieveGlossary($submission));
     }
 
     public function testDeleteGlossaryGetCorrectBoolean(): void
@@ -696,7 +693,7 @@ public function testDeleteGlossaryGetCorrectBoolean(): void
             ->willReturn($response);
 
         $submission = $this->createMock(GlossaryIdSubmission::class);
-        $this->assertTrue($this->subject->deleteGlossary($submission));
+        self::assertTrue($this->subject->deleteGlossary($submission));
     }
 
     public function testRetrieveGlossaryEntriesGetCorrectModel(): void
@@ -738,7 +735,7 @@ public function testRetrieveGlossaryEntriesGetCorrectModel(): void
             ->willReturn($response);
 
         $submission = $this->createMock(GlossaryIdSubmission::class);
-        $this->assertInstanceOf(GlossaryEntries::class, $this->subject->retrieveGlossaryEntries($submission));
+        self::assertInstanceOf(GlossaryEntries::class, $this->subject->retrieveGlossaryEntries($submission));
     }
 
     private function createRequestExpectations(

diff --git a/tests/Handler/DeeplFileRequestHandlerTest.php b/tests/Handler/DeeplFileRequestHandlerTest.php
@@ -42,7 +42,7 @@ public function testGetPathCanReturnPath(): void
         $this->fileSubmission->expects($this->once())
             ->method('getDocumentId')
             ->willReturn('documentId');
-        $this->assertSame(sprintf(DeeplFileRequestHandler::API_ENDPOINT, 'documentId'), $this->subject->getPath());
+        self::assertSame(sprintf(DeeplFileRequestHandler::API_ENDPOINT, 'documentId'), $this->subject->getPath());
     }
 
     public function testGetBodyCanReturnFilteredArray(): void
@@ -65,22 +65,16 @@ public function testGetBodyCanReturnFilteredArray(): void
             )
             ->willReturn($stream);
 
-        $this->assertSame(
-            $stream,
-            $this->subject->getBody()
-        );
+        self::assertSame($stream, $this->subject->getBody());
     }
 
     public function testGetMethodCanReturnMethod(): void
     {
-        $this->assertSame(DeeplRequestHandlerInterface::METHOD_POST, $this->subject->getMethod());
+        self::assertSame(DeeplRequestHandlerInterface::METHOD_POST, $this->subject->getMethod());
     }
 
     public function testGetContentTypeReturnsValue(): void
     {
-        $this->assertSame(
-            'application/x-www-form-urlencoded',
-            $this->subject->getContentType()
-        );
+        self::assertSame('application/x-www-form-urlencoded', $this->subject->getContentType());
     }
 }
diff --git a/tests/Handler/DeeplFileSubmissionRequestHandlerTest.php b/tests/Handler/DeeplFileSubmissionRequestHandlerTest.php
@@ -39,7 +39,7 @@ public function setUp(): void
 
     public function testGetPathCanReturnPath(): void
     {
-        $this->assertSame(DeeplFileSubmissionRequestHandler::API_ENDPOINT, $this->subject->getPath());
+        self::assertSame(DeeplFileSubmissionRequestHandler::API_ENDPOINT, $this->subject->getPath());
     }
 
     public function testGetBodyCanReturnFilteredArray(): void
@@ -79,10 +79,7 @@ public function testGetBodyCanReturnFilteredArray(): void
             ->method('build')
             ->willReturn($stream);
 
-        $this->assertSame(
-            $stream,
-            $this->subject->getBody()
-        );
+        self::assertSame($stream, $this->subject->getBody());
     }
 
     public function testGetBodyIgnoresSourceLangIfEmpty(): void
@@ -121,22 +118,16 @@ public function testGetBodyIgnoresSourceLangIfEmpty(): void
             ->method('build')
             ->willReturn($stream);
 
-        $this->assertSame(
-            $stream,
-            $this->subject->getBody()
-        );
+        self::assertSame($stream, $this->subject->getBody());
     }
 
     public function testGetMethodCanReturnMethod(): void
     {
-        $this->assertSame(DeeplRequestHandlerInterface::METHOD_POST, $this->subject->getMethod());
+        self::assertSame(DeeplRequestHandlerInterface::METHOD_POST, $this->subject->getMethod());
     }
 
     public function testGetContentTypeReturnsValue(): void
     {
-        $this->assertSame(
-            'multipart/form-data;boundary="boundary"',
-            $this->subject->getContentType()
-        );
+        self::assertSame('multipart/form-data;boundary="boundary"', $this->subject->getContentType());
     }
 }