Merge pull request #131 from jolicode/php-cs-fixer

Update php-cs-fixer and its config and fix the codebase

Author: lyrixx

.github/workflows/ci.yml

@@ -28,16 +28,15 @@ jobs:
               uses: actions/checkout@v2
 
             - name: Install dependencies
-              run: composer update --prefer-dist --no-interaction
+              run: composer update --no-interaction
 
-            - name: Generate SDK in ci_generated directory
-              run: CI_TEST=1 vendor/bin/jane-openapi generate --config-file=.jane-openapi.php
+            - name: Regenerate SDK library
+              run: rm -rf generated && vendor/bin/jane-openapi generate --config-file=.jane-openapi.php
 
-            - name: Fix CS on ci_generated directory
-              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
+            - name: Check is something changed
+              run: |
+                  set -e
+                  git diff --exit-code
 
     tests:
         name: Test PHP ${{ matrix.php-version }} ${{ matrix.name }}
@@ -63,7 +62,7 @@ jobs:
                   extensions: mbstring, xml
 
             - name: Install dependencies
-              run: "composer update --prefer-dist --no-interaction ${{ matrix.composer-flags }}"
+              run: "composer update --no-interaction ${{ matrix.composer-flags }}"
 
             - name: Run tests
               run: php vendor/bin/simple-phpunit

.gitignore

@@ -6,7 +6,6 @@ composer.lock
 composer.phar
 
 # CS
-.php_cs.cache
 .php-cs-fixer.cache
 
 # tests

.jane-openapi.php

@@ -1,15 +1,9 @@
 <?php
 
-$directory = __DIR__ . '/generated/';
-
-if (!empty($_SERVER['CI_TEST'])) {
-    $directory = __DIR__ . '/ci_generated/';
-}
-
 return [
     'openapi-file' => __DIR__ . '/resources/slack-openapi-patched.json',
     'namespace' => 'JoliCode\Slack\Api',
-    'directory' => $directory,
+    'directory' => __DIR__ . '/generated/',
     'reference' => true,
     'strict' => false,
     'clean-generated' => true,

.php-cs-fixer.php

@@ -1,6 +1,17 @@
 <?php
 
-$header = <<<'EOF'
+declare(strict_types=1);
+
+/*
+ * 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.
+ */
+
+$fileHeaderComment = <<<'EOF'
 This file is part of JoliCode's Slack PHP API project.
 
 (c) JoliCode <coucou@jolicode.com>
@@ -13,18 +24,26 @@
     ->in(__DIR__)
     ->exclude('docs')
     ->exclude('ci_generated')
+    ->append([
+        __FILE__,
+    ])
 ;
-$config = new PhpCsFixer\Config();
 
-return $config->setRules([
+return (new PhpCsFixer\Config())
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@PHP71Migration' => true,
+        '@PhpCsFixer' => true,
         '@Symfony' => true,
         '@Symfony:risky' => true,
-        '@PHP71Migration' => true,
-        '@PHP71Migration:risky' => true,
-        'header_comment' => array('header' => $header),
-        'strict_param' => true,
-        'array_syntax' => ['syntax' => 'short'],
+        'php_unit_internal_class' => false, // From @PhpCsFixer but we don't want it
+        'php_unit_test_class_requires_covers' => false, // From @PhpCsFixer but we don't want it
+        'phpdoc_add_missing_param_annotation' => false, // From @PhpCsFixer but we don't want it
+        'header_comment' => ['header' => $fileHeaderComment],
+        'concat_space' => ['spacing' => 'one'],
+        'declare_strict_types' => true,
+        'ordered_class_elements' => true, // Symfony(PSR12) override the default value, but we don't want
+        'blank_line_before_statement' => true, // Symfony(PSR12) override the default value, but we don't want
     ])
-    ->setRiskyAllowed(true)
     ->setFinder($finder)
 ;

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": "^3.0",
+        "friendsofphp/php-cs-fixer": "^3.2.2",
         "symfony/phpunit-bridge": "^5.2",
         "opis/json-schema": "^1.0",
         "symfony/console": "^5.1",

generated/Runtime/Client/BaseEndpoint.php

@@ -78,7 +78,7 @@ protected function getMultipartBody($streamFactory = null): array
             $bodyBuilder->addResource($key, $value);
         }
 
-        return [['Content-Type' => ['multipart/form-data; boundary="'.($bodyBuilder->getBoundary().'"')]], $bodyBuilder->build()];
+        return [['Content-Type' => ['multipart/form-data; boundary="' . ($bodyBuilder->getBoundary() . '"')]], $bodyBuilder->build()];
     }
 
     protected function getFormOptionsResolver(): OptionsResolver

generated/Runtime/Client/Client.php

@@ -54,14 +54,14 @@ public function executeEndpoint(Endpoint $endpoint, string $fetch = self::FETCH_
         [$bodyHeaders, $body] = $endpoint->getBody($this->serializer, $this->streamFactory);
         $queryString = $endpoint->getQueryString();
         $uriGlue = false === strpos($endpoint->getUri(), '?') ? '?' : '&';
-        $uri = '' !== $queryString ? $endpoint->getUri().$uriGlue.$queryString : $endpoint->getUri();
+        $uri = '' !== $queryString ? $endpoint->getUri() . $uriGlue . $queryString : $endpoint->getUri();
         $request = $this->requestFactory->createRequest($endpoint->getMethod(), $uri);
         if ($body) {
             if ($body instanceof StreamInterface) {
                 $request = $request->withBody($body);
             } elseif (\is_resource($body)) {
                 $request = $request->withBody($this->streamFactory->createStreamFromResource($body));
-            } elseif (\strlen($body) <= 4000 && is_file($body)) {
+            } elseif (\strlen($body) <= 4000 && @file_exists($body)) {
                 // more than 4096 chars will trigger an error
                 $request = $request->withBody($this->streamFactory->createStreamFromFile($body));
             } else {

generated/Runtime/Client/Endpoint.php

@@ -23,8 +23,6 @@ interface Endpoint
      *
      * Return value consist of an array where the first item will be a list of headers to add on the request (like the Content Type)
      * And the second value consist of the body object.
-     *
-     * @param mixed|null $streamFactory
      */
     public function getBody(SerializerInterface $serializer, $streamFactory = null): array;
 

generated/Runtime/Client/EndpointTrait.php

@@ -29,6 +29,7 @@ public function parseResponse(ResponseInterface $response, SerializerInterface $
         if (Client::FETCH_RESPONSE === $fetchMode) {
             return $response;
         }
+
         throw new InvalidFetchModeException(sprintf('Fetch mode %s is not supported', $fetchMode));
     }
 

src/Checker/JsonSorter.php

@@ -34,11 +34,11 @@ public function recursiveAlphabeticalSort($item)
             }
 
             foreach ($asArray as $key => $subItem) {
-                $asArray[$key] = $this->recursiveAlphabeticalSort($item->$key);
+                $asArray[$key] = $this->recursiveAlphabeticalSort($item->{$key});
 
                 if ('parameters' === $key) {
                     usort($asArray['parameters'], function ($a, $b) {
-                        return (isset($a['name']) && isset($b['name']) && $a['name'] > $b['name']) ? 1 : 0;
+                        return (isset($a['name'], $b['name']) && $a['name'] > $b['name']) ? 1 : 0;
                     });
                 }
             }
@@ -47,7 +47,8 @@ public function recursiveAlphabeticalSort($item)
             ksort($item, \SORT_STRING);
 
             return $item;
-        } elseif (!\is_array($item)) {
+        }
+        if (!\is_array($item)) {
             return $item;
         }
 
@@ -97,10 +98,10 @@ private function mergeNodeItems($items)
     private function union($cargo, $addition)
     {
         foreach ($addition as $key => $value) {
-            if (isset($cargo->$key) && \is_object($cargo->$key)) {
-                $cargo->$key = $this->union($cargo->$key, $value);
+            if (isset($cargo->{$key}) && \is_object($cargo->{$key})) {
+                $cargo->{$key} = $this->union($cargo->{$key}, $value);
             } else {
-                $cargo->$key = $value;
+                $cargo->{$key} = $value;
             }
         }