Merge pull request #122 from jolicode/update/php-cs-fixer-v3

lyrixx · web-flow · commit 227518efb598 · 2021-05-10T19:02:59.000+02:00
Make the CI green again (update to PHP-CS-Fixer v3)
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -18,7 +18,7 @@ jobs:
             - name: PHP-CS-Fixer
               uses: docker://oskarstark/php-cs-fixer-ga
               with:
-                  args: --config=.php_cs --diff --dry-run
+                  args: --config=.php-cs-fixer.php --diff --dry-run
 
     check-spec:
         name: Check SDK is in sync with spec
@@ -34,7 +34,7 @@ jobs:
               run: CI_TEST=1 vendor/bin/jane-openapi generate --config-file=.jane-openapi.php
 
             - name: Fix CS on ci_generated directory
-              run: vendor/bin/php-cs-fixer fix --diff --dry-run ci_generated
+              run: vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --diff --dry-run ci_generated
 
             - name: Check ci_generated and generated directories are equal
               run: diff ci_generated generated
diff --git a/.gitignore b/.gitignore
@@ -7,8 +7,9 @@ composer.phar
 
 # CS
 .php_cs.cache
-phpunit.xml
+.php-cs-fixer.cache
 
 # tests
+phpunit.xml
 ci_generated
 .phpunit.result.cache
diff --git a/.jane-openapi.php b/.jane-openapi.php
@@ -14,5 +14,5 @@
     'strict' => false,
     'clean-generated' => true,
     'use-fixer' => true,
-    'fixer-config-file' => __DIR__ . '/.php_cs',
+    'fixer-config-file' => __DIR__ . '/.php-cs-fixer.php',
 ];
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -0,0 +1,30 @@
+<?php
+
+$header = <<<'EOF'
+This file is part of JoliCode's Slack PHP API project.
+
+(c) JoliCode <coucou@jolicode.com>
+
+For the full copyright and license information, please view the LICENSE
+file that was distributed with this source code.
+EOF;
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__)
+    ->exclude('docs')
+    ->exclude('ci_generated')
+;
+$config = new PhpCsFixer\Config();
+
+return $config->setRules([
+        '@Symfony' => true,
+        '@Symfony:risky' => true,
+        '@PHP71Migration' => true,
+        '@PHP71Migration:risky' => true,
+        'header_comment' => array('header' => $header),
+        'strict_param' => true,
+        'array_syntax' => ['syntax' => 'short'],
+    ])
+    ->setRiskyAllowed(true)
+    ->setFinder($finder)
+;
diff --git a/.php_cs b/.php_cs
diff --git a/composer.json b/composer.json
@@ -37,7 +37,7 @@
         "jane-php/open-api-2": "~6.3.0",
         "symfony/http-client": "^4.3.3 || ^5.1",
         "nyholm/psr7": "^1.2",
-        "friendsofphp/php-cs-fixer": "^2.17",
+        "friendsofphp/php-cs-fixer": "^3.0",
         "symfony/phpunit-bridge": "^5.2",
         "opis/json-schema": "^1.0",
         "symfony/console": "^5.1",
diff --git a/src/Client.php b/src/Client.php
@@ -17,7 +17,7 @@
 
 class Client extends ApiClient
 {
-    const CURSOR_PAGINATION = [
+    public const CURSOR_PAGINATION = [
         'channelsList' => 'channels',
         'conversationsHistory' => 'messages',
         'conversationsList' => 'channels',
diff --git a/src/Command/CheckerCommand.php b/src/Command/CheckerCommand.php
@@ -23,7 +23,7 @@ class CheckerCommand extends Command
 {
     protected static $defaultName = 'checker';
 
-    protected function configure()
+    protected function configure(): void
     {
         $this
             ->setDescription('Checks the patched file and displays a summary table.')
diff --git a/src/Command/GeneratePatchCommand.php b/src/Command/GeneratePatchCommand.php
@@ -25,7 +25,7 @@ class GeneratePatchCommand extends Command
 {
     protected static $defaultName = 'spec:generate-patch';
 
-    protected function configure()
+    protected function configure(): void
     {
         $this
             ->setDescription('Generates the patch by comparing Slack\'s official sorted spec to the currently patched one.')
diff --git a/src/Command/UpdateSpecificationCommand.php b/src/Command/UpdateSpecificationCommand.php
@@ -26,7 +26,7 @@ class UpdateSpecificationCommand extends Command
 {
     protected static $defaultName = 'spec:update';
 
-    protected function configure()
+    protected function configure(): void
     {
         $this
             ->setDescription('Downloads a new version of the official Slack OpenAPI file, and applies our patches to it.')
diff --git a/tests/ApiTest.php b/tests/ApiTest.php
@@ -20,7 +20,7 @@
 
 class ApiTest extends TestCase
 {
-    public function testItWorksOnTestSuccess()
+    public function testItWorksOnTestSuccess(): void
     {
         $client = ClientFactory::create('');
         $response = $client->apiTest();
@@ -29,7 +29,7 @@ public function testItWorksOnTestSuccess()
         self::assertTrue($response->getOk());
     }
 
-    public function testItThrowsExceptionOnTestError()
+    public function testItThrowsExceptionOnTestError(): void
     {
         $client = ClientFactory::create('');
 
diff --git a/tests/ClientTest.php b/tests/ClientTest.php
@@ -17,7 +17,7 @@
 
 class ClientTest extends SlackTokenDependentTest
 {
-    public function testItCanIterate()
+    public function testItCanIterate(): void
     {
         $client = $this->createClient();
 
@@ -33,7 +33,7 @@ public function testItCanIterate()
         self::assertInstanceOf(ObjsUser::class, $users[0]);
     }
 
-    public function testItThrowsExceptionOnUnknownIterate()
+    public function testItThrowsExceptionOnUnknownIterate(): void
     {
         $client = $this->createClient();
 
@@ -43,7 +43,7 @@ public function testItThrowsExceptionOnUnknownIterate()
         $client->iterateFooBar();
     }
 
-    public function testItThrowsExceptionOnUnknownMethod()
+    public function testItThrowsExceptionOnUnknownMethod(): void
     {
         $client = $this->createClient();
 
diff --git a/tests/JsonSorterTest.php b/tests/JsonSorterTest.php
@@ -28,7 +28,7 @@ protected function setUp(): void
     /**
      * @dataProvider provideJsonStrings
      */
-    public function testItCanSortJsonString(string $source, string $expectedResult)
+    public function testItCanSortJsonString(string $source, string $expectedResult): void
     {
         $this->sorter->sort($source);
         $this->assertSame(
diff --git a/tests/ReadingTest.php b/tests/ReadingTest.php
@@ -23,7 +23,7 @@
 
 class ReadingTest extends SlackTokenDependentTest
 {
-    public function testItWorksOnUserListWithCorrectToken()
+    public function testItWorksOnUserListWithCorrectToken(): void
     {
         $client = $this->createClient();
 
@@ -35,7 +35,7 @@ public function testItWorksOnUserListWithCorrectToken()
         self::assertGreaterThan(2, \count($response->getMembers()));
     }
 
-    public function testItThrowsExceptionOnUserListWithoutToken()
+    public function testItThrowsExceptionOnUserListWithoutToken(): void
     {
         $client = $this->createClient('');
 
@@ -45,7 +45,7 @@ public function testItThrowsExceptionOnUserListWithoutToken()
         $client->usersList();
     }
 
-    public function testItCanReadAConversationHistory()
+    public function testItCanReadAConversationHistory(): void
     {
         $client = $this->createClient();
 
@@ -73,7 +73,7 @@ public function testItCanReadAConversationHistory()
         $this->assertTrue($hadAFileMessage, 'We expect a message in File in the history, cf \JoliCode\Slack\Tests\WritingTest::testItCanUploadFile');
     }
 
-    public function testItCanGetTheImList()
+    public function testItCanGetTheImList(): void
     {
         $client = $this->createClient();
 
@@ -83,7 +83,7 @@ public function testItCanGetTheImList()
         self::assertNotEmpty($results->getChannels());
     }
 
-    public function testItCanReadConversationsAndHydrateThem()
+    public function testItCanReadConversationsAndHydrateThem(): void
     {
         $client = $this->createClient();
 
@@ -101,7 +101,7 @@ public function testItCanReadConversationsAndHydrateThem()
         }
     }
 
-    public function testItCanGetConversationLocale()
+    public function testItCanGetConversationLocale(): void
     {
         $client = $this->createClient();
 
@@ -118,7 +118,7 @@ public function testItCanGetConversationLocale()
         $this->assertNotNull($channel->getLocale());
     }
 
-    public function testItCanSearchMessages()
+    public function testItCanSearchMessages(): void
     {
         $client = $this->createClient();
 
diff --git a/tests/UserInfoTest.php b/tests/UserInfoTest.php
@@ -17,7 +17,7 @@
 
 class UserInfoTest extends SlackTokenDependentTest
 {
-    public function testItCanFetchUserInfo()
+    public function testItCanFetchUserInfo(): void
     {
         $client = $this->createClient();
 
diff --git a/tests/WritingTest.php b/tests/WritingTest.php
@@ -19,7 +19,7 @@
 
 class WritingTest extends SlackTokenDependentTest
 {
-    public function testItCanPostAttachment()
+    public function testItCanPostAttachment(): void
     {
         $client = $this->createClient();
 
@@ -42,7 +42,7 @@ public function testItCanPostAttachment()
         }
     }
 
-    public function testItCanPostMessageWithBlock()
+    public function testItCanPostMessageWithBlock(): void
     {
         $client = $this->createClient();
 
@@ -77,7 +77,7 @@ public function testItCanPostMessageWithBlock()
         self::assertNotEmpty($response->getMessage()->getBlocks());
     }
 
-    public function testItCanPostAMessageAndThenAThreadResponse()
+    public function testItCanPostAMessageAndThenAThreadResponse(): void
     {
         $client = $this->createClient();
 
@@ -98,7 +98,7 @@ public function testItCanPostAMessageAndThenAThreadResponse()
         $this->assertTrue($response2->getOk());
     }
 
-    public function testItCanUploadFile()
+    public function testItCanUploadFile(): void
     {
         $client = $this->createClient();
 
@@ -122,7 +122,7 @@ public function testItCanUploadFile()
         }
     }
 
-    public function testScheduleMessage()
+    public function testScheduleMessage(): void
     {
         $client = $this->createClient();
         $futureTs = (new \DateTime('+1 hour'))->getTimestamp();
@@ -136,7 +136,7 @@ public function testScheduleMessage()
         $this->assertTrue($response->getOk());
     }
 
-    public function testItCanMarkConversation()
+    public function testItCanMarkConversation(): void
     {
         $client = $this->createClient();
 

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`
`18`	`18`	`class Client extends ApiClient`
`19`	`19`	`{`
`20`		`- const CURSOR_PAGINATION = [`
	`20`	`+ public const CURSOR_PAGINATION = [`
`21`	`21`	`'channelsList' => 'channels',`
`22`	`22`	`'conversationsHistory' => 'messages',`
`23`	`23`	`'conversationsList' => 'channels',`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ class CheckerCommand extends Command`
`23`	`23`	`{`
`24`	`24`	`protected static $defaultName = 'checker';`
`25`	`25`
`26`		`- protected function configure()`
	`26`	`+ protected function configure(): void`
`27`	`27`	`{`
`28`	`28`	`$this`
`29`	`29`	`->setDescription('Checks the patched file and displays a summary table.')`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ class GeneratePatchCommand extends Command`
`25`	`25`	`{`
`26`	`26`	`protected static $defaultName = 'spec:generate-patch';`
`27`	`27`
`28`		`- protected function configure()`
	`28`	`+ protected function configure(): void`
`29`	`29`	`{`
`30`	`30`	`$this`
`31`	`31`	`->setDescription('Generates the patch by comparing Slack\'s official sorted spec to the currently patched one.')`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ class UpdateSpecificationCommand extends Command`
`26`	`26`	`{`
`27`	`27`	`protected static $defaultName = 'spec:update';`
`28`	`28`
`29`		`- protected function configure()`
	`29`	`+ protected function configure(): void`
`30`	`30`	`{`
`31`	`31`	`$this`
`32`	`32`	`->setDescription('Downloads a new version of the official Slack OpenAPI file, and applies our patches to it.')`