Update PHP-CS-Fixer rules

Author: PowerKiKi

.php_cs.dist

@@ -10,21 +10,27 @@ return PhpCsFixer\Config::create()
     ->setCacheFile(sys_get_temp_dir() . '/php-cs-fixer' . preg_replace('~\W~', '-', __DIR__))
     ->setRules([
         'align_multiline_comment' => true,
+        'array_indentation' => true,
         'array_syntax' => ['syntax' => 'short'],
         'backtick_to_shell_exec' => true,
         'binary_operator_spaces' => true,
         'blank_line_after_namespace' => true,
         'blank_line_after_opening_tag' => true,
+        'blank_line_before_return' => false, // Deprecated
         'blank_line_before_statement' => true,
         'braces' => true,
         'cast_spaces' => true,
         'class_attributes_separation' => ['elements' => ['method', 'property']], // const are often grouped with other related const
         'class_definition' => true,
-        'class_keyword_remove' => false, // ::class keyword gives us beter support in IDE
+        'class_keyword_remove' => false, // ::class keyword gives us better support in IDE
         'combine_consecutive_issets' => true,
         'combine_consecutive_unsets' => true,
+        'combine_nested_dirname' => true,
+        'comment_to_phpdoc' => true,
         'compact_nullable_typehint' => true,
         'concat_space' => ['spacing' => 'one'],
+        'constant_case' => true,
+        'date_time_immutable' => true,
         'declare_equal_normalize' => true,
         'declare_strict_types' => true,
         'dir_constant' => true,
@@ -35,39 +41,57 @@ return PhpCsFixer\Config::create()
         'elseif' => true,
         'encoding' => true,
         'ereg_to_preg' => true,
+        'error_suppression' => true,
         'escape_implicit_backslashes' => true,
         'explicit_indirect_variable' => false, // I feel it makes the code actually harder to read
-        'explicit_string_variable' => true,
+        'explicit_string_variable' => false, // I feel it makes the code actually harder to read
+        'final_class' => false, // We need non-final classes
         'final_internal_class' => true,
+        'final_public_method_for_abstract_class' => false, // We need non-final methods
+        'final_static_access' => true,
+        'fopen_flag_order' => true,
+        'fopen_flags' => true,
         'full_opening_tag' => true,
+        'fully_qualified_strict_types' => true,
         'function_declaration' => true,
         'function_to_constant' => true,
         'function_typehint_space' => true,
         'general_phpdoc_annotation_remove' => false, // No use for that
-        'hash_to_slash_comment' => true,
+        'global_namespace_import' => true,
+        'hash_to_slash_comment' => false, // Deprecated
         'header_comment' => false, // We don't use common header in all our files
+        'heredoc_indentation' => false, // Requires PHP >= 7.3
         'heredoc_to_nowdoc' => false, // Not sure about this one
+        'implode_call' => true,
         'include' => true,
         'increment_style' => true,
         'indentation_type' => true,
-        'is_null' => ['use_yoda_style' => false],
-        'linebreak_after_opening_tag' => true,
+        'is_null' => true,
         'line_ending' => true,
+        'linebreak_after_opening_tag' => true,
         'list_syntax' => ['syntax' => 'short'],
+        'logical_operators' => true,
         'lowercase_cast' => true,
-        'lowercase_constants' => true,
+        'lowercase_constants' => false, // Deprecated
         'lowercase_keywords' => true,
+        'lowercase_static_reference' => true,
         'magic_constant_casing' => true,
+        'magic_method_casing' => true,
         'mb_str_functions' => true,
         'method_argument_space' => true,
         'method_chaining_indentation' => true,
-        'method_separation' => true,
+        'method_separation' => false, // Deprecated
         'modernize_types_casting' => true,
         'multiline_comment_opening_closing' => true,
+        'multiline_whitespace_before_semicolons' => true,
+        'native_constant_invocation' => false, // Micro optimization that look messy
         'native_function_casing' => true,
         'native_function_invocation' => false, // I suppose this would be best, but I am still unconvinced about the visual aspect of it
+        'native_function_type_declaration_casing' => true,
         'new_with_braces' => true,
         'no_alias_functions' => true,
+        'no_alternative_syntax' => true,
+        'no_binary_string' => true,
         'no_blank_lines_after_class_opening' => true,
         'no_blank_lines_after_phpdoc' => true,
         'no_blank_lines_before_namespace' => false, // we want 1 blank line before namespace
@@ -77,46 +101,71 @@ return PhpCsFixer\Config::create()
         'no_empty_phpdoc' => true,
         'no_empty_statement' => true,
         'no_extra_blank_lines' => true,
+        'no_extra_consecutive_blank_lines' => false, // Deprecated
         'no_homoglyph_names' => true,
         'no_leading_import_slash' => true,
         'no_leading_namespace_whitespace' => true,
         'no_mixed_echo_print' => true,
         'no_multiline_whitespace_around_double_arrow' => true,
-        'no_multiline_whitespace_before_semicolons' => true,
-        'non_printable_character' => true,
+        'no_multiline_whitespace_before_semicolons' => false, // Deprecated
         'no_null_property_initialization' => true,
         'no_php4_constructor' => true,
-        'normalize_index_brace' => true,
         'no_short_bool_cast' => true,
         'no_short_echo_tag' => true,
         'no_singleline_whitespace_before_semicolons' => true,
         'no_spaces_after_function_name' => true,
         'no_spaces_around_offset' => true,
         'no_spaces_inside_parenthesis' => true,
         'no_superfluous_elseif' => true,
-        'not_operator_with_space' => false, // No we prefer to keep '!' without spaces
-        'not_operator_with_successor_space' => false, // idem
+        'no_superfluous_phpdoc_tags' => ['allow_mixed' => true],
         'no_trailing_comma_in_list_call' => true,
         'no_trailing_comma_in_singleline_array' => true,
-        'no_trailing_whitespace_in_comment' => true,
         'no_trailing_whitespace' => true,
+        'no_trailing_whitespace_in_comment' => true,
         'no_unneeded_control_parentheses' => true,
         'no_unneeded_curly_braces' => true,
         'no_unneeded_final_method' => true,
         'no_unreachable_default_argument_value' => true,
+        'no_unset_cast' => true,
+        'no_unset_on_property' => true,
         'no_unused_imports' => true,
         'no_useless_else' => true,
         'no_useless_return' => true,
         'no_whitespace_before_comma_in_array' => true,
         'no_whitespace_in_blank_line' => true,
+        'non_printable_character' => true,
+        'normalize_index_brace' => true,
+        'not_operator_with_space' => false, // No we prefer to keep '!' without spaces
+        'not_operator_with_successor_space' => false, // idem
+        'nullable_type_declaration_for_default_null_value' => true,
         'object_operator_without_whitespace' => true,
         'ordered_class_elements' => false, // We prefer to keep some freedom
         'ordered_imports' => true,
+        'ordered_interfaces' => true,
+        'php_unit_construct' => true,
+        'php_unit_dedicate_assert' => true,
+        'php_unit_dedicate_assert_internal_type' => true,
+        'php_unit_expectation' => true,
+        'php_unit_fqcn_annotation' => true,
+        'php_unit_internal_class' => false, // Because tests are excluded from package
+        'php_unit_method_casing' => true,
+        'php_unit_mock' => true,
+        'php_unit_mock_short_will_return' => true,
+        'php_unit_namespaced' => true,
+        'php_unit_no_expectation_annotation' => true,
+        'php_unit_ordered_covers' => true,
+        'php_unit_set_up_tear_down_visibility' => true,
+        'php_unit_size_class' => false, // That seems extra work to maintain for little benefits
+        'php_unit_strict' => false, // We sometime actually need assertEquals
+        'php_unit_test_annotation' => true,
+        'php_unit_test_case_static_method_calls' => ['call_type' => 'self'],
+        'php_unit_test_class_requires_covers' => false, // We don't care as much as we should about coverage
         'phpdoc_add_missing_param_annotation' => true,
         'phpdoc_align' => false, // Waste of time
         'phpdoc_annotation_without_dot' => true,
         'phpdoc_indent' => true,
         'phpdoc_inline_tag' => true,
+        'phpdoc_line_span' => true,
         'phpdoc_no_access' => true,
         'phpdoc_no_alias_tag' => true,
         'phpdoc_no_empty_return' => true,
@@ -129,43 +178,46 @@ return PhpCsFixer\Config::create()
         'phpdoc_single_line_var_spacing' => true,
         'phpdoc_summary' => false, // We usually don't generate documentation so punctuation is not important
         'phpdoc_to_comment' => true,
+        'phpdoc_to_param_type' => false, // Because experimental, but interesting for one shot use
+        'phpdoc_to_return_type' => false, // idem
         'phpdoc_trim' => true,
-        'phpdoc_types_order' => true,
+        'phpdoc_trim_consecutive_blank_line_separation' => true,
         'phpdoc_types' => true,
+        'phpdoc_types_order' => true,
+        'phpdoc_var_annotation_correct_order' => true,
         'phpdoc_var_without_name' => true,
-        'php_unit_construct' => true,
-        'php_unit_dedicate_assert' => true,
-        'php_unit_expectation' => true,
-        'php_unit_fqcn_annotation' => true,
-        'php_unit_mock' => true,
-        'php_unit_namespaced' => true,
-        'php_unit_no_expectation_annotation' => true,
-        'php_unit_strict' => false, // We sometime actually need assertEquals
-        'php_unit_test_annotation' => true,
-        'php_unit_test_class_requires_covers' => false, // We don't care as much as we should about coverage
         'pow_to_exponentiation' => true,
+        'pre_increment' => false, // Deprecated
         'protected_to_private' => true,
         'psr0' => true,
         'psr4' => true,
         'random_api_migration' => true,
+        'return_assignment' => false, // Sometimes useful for clarity or debug
         'return_type_declaration' => true,
         'self_accessor' => true,
+        'self_static_accessor' => true,
         'semicolon_after_instruction' => false, // We prefer to keep .phtml files without semicolon
+        'set_type_to_cast' => true,
         'short_scalar_cast' => true,
-        'silenced_deprecation_error' => true,
+        'silenced_deprecation_error' => false, // Deprecated
+        'simple_to_complex_string_variable' => false, // Would differ from TypeScript without obvious advantages
         'simplified_null_return' => false, // Even if technically correct we prefer to be explicit
         'single_blank_line_at_eof' => true,
         'single_blank_line_before_namespace' => true,
         'single_class_element_per_statement' => true,
         'single_import_per_statement' => true,
         'single_line_after_imports' => true,
         'single_line_comment_style' => true,
+        'single_line_throw' => false, // I don't see any reason for having a special case for Exception
         'single_quote' => true,
+        'single_trait_insert_per_statement' => true,
         'space_after_semicolon' => true,
+        'standardize_increment' => true,
         'standardize_not_equals' => true,
         'static_lambda' => false, // Risky if we can't guarantee nobody use `bindTo()`
         'strict_comparison' => true,
         'strict_param' => true,
+        'string_line_ending' => true,
         'switch_case_semicolon_to_colon' => true,
         'switch_case_space' => true,
         'ternary_operator_spaces' => true,

src/UploadMiddleware.php

@@ -23,10 +23,6 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
 
     /**
      * Process the request and return either a modified request or the original one
-     *
-     * @param ServerRequestInterface $request
-     *
-     * @return ServerRequestInterface
      */
     public function processRequest(ServerRequestInterface $request): ServerRequestInterface
     {
@@ -42,10 +38,6 @@ public function processRequest(ServerRequestInterface $request): ServerRequestIn
 
     /**
      * Inject uploaded files defined in the 'map' key into the 'variables' key
-     *
-     * @param ServerRequestInterface $request
-     *
-     * @return ServerRequestInterface
      */
     private function parseUploadedFiles(ServerRequestInterface $request): ServerRequestInterface
     {
@@ -78,8 +70,6 @@ private function parseUploadedFiles(ServerRequestInterface $request): ServerRequ
 
     /**
      * Validates that the request meet our expectations
-     *
-     * @param ServerRequestInterface $request
      */
     private function validateParsedBody(ServerRequestInterface $request): void
     {

src/UploadType.php

@@ -9,6 +9,7 @@
 use GraphQL\Type\Definition\ScalarType;
 use GraphQL\Utils\Utils;
 use Psr\Http\Message\UploadedFileInterface;
+use UnexpectedValueException;
 
 class UploadType extends ScalarType
 {
@@ -46,7 +47,7 @@ public function serialize($value)
     public function parseValue($value)
     {
         if (!$value instanceof UploadedFileInterface) {
-            throw new \UnexpectedValueException('Could not get uploaded file, be sure to conform to GraphQL multipart request specification. Instead got: ' . Utils::printSafe($value));
+            throw new UnexpectedValueException('Could not get uploaded file, be sure to conform to GraphQL multipart request specification. Instead got: ' . Utils::printSafe($value));
         }
 
         return $value;

tests/UploadMiddlewareTest.php

@@ -22,6 +22,7 @@
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Message\UploadedFileInterface;
 use Psr\Http\Server\RequestHandlerInterface;
+use stdClass;
 
 class UploadMiddlewareTest extends TestCase
 {
@@ -30,7 +31,7 @@ class UploadMiddlewareTest extends TestCase
      */
     private $middleware;
 
-    public function setUp(): void
+    protected function setUp(): void
     {
         $this->middleware = new UploadMiddleware();
     }
@@ -61,7 +62,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface
 
         // The request should be forward to processRequest()
         $request = new ServerRequest();
-        $middleware->expects($this->once())->method('processRequest')->with($request);
+        $middleware->expects(self::once())->method('processRequest')->with($request);
 
         $actualResponse = $middleware->process($request, $handler);
         self::assertSame($response, $actualResponse, 'should return the mocked response');
@@ -148,7 +149,7 @@ public function testInvalidRequestShouldThrows(): void
         $request = new ServerRequest();
         $request = $request
             ->withHeader('content-type', ['multipart/form-data'])
-            ->withParsedBody(new \stdClass());
+            ->withParsedBody(new stdClass());
 
         $this->expectException(RequestError::class);
         $this->expectExceptionMessage('GraphQL Server expects JSON object or array, but got []');
@@ -160,7 +161,7 @@ public function testOtherContentTypeShouldNotBeTouched(): void
         $request = new ServerRequest();
         $request = $request
             ->withHeader('content-type', ['application/json'])
-            ->withParsedBody(new \stdClass());
+            ->withParsedBody(new stdClass());
 
         $processedRequest = $this->middleware->processRequest($request);
         self::assertSame($request, $processedRequest);
@@ -206,17 +207,13 @@ public function testCanUploadFileWithStandardServer(): void
         $response = $server->executePsrRequest($processedRequest);
 
         $expected = ['testUpload' => 'Uploaded file was image.jpg (image/jpeg) with description: foo bar'];
-        $this->assertSame($expected, $response->data);
+        self::assertSame($expected, $response->data);
     }
 
     /**
-     * @param string $query
      * @param mixed[] $variables
      * @param string[][] $map
      * @param UploadedFile[] $files
-     * @param string $operation
-     *
-     * @return ServerRequestInterface
      */
     private function createRequest(string $query, array $variables, array $map, array $files, string $operation): ServerRequestInterface
     {

tests/UploadTypeTest.php

@@ -10,6 +10,7 @@
 use GraphQL\Upload\UploadType;
 use GraphQLTests\Upload\Psr7\PsrUploadedFileStub;
 use PHPUnit\Framework\TestCase;
+use UnexpectedValueException;
 
 class UploadTypeTest extends TestCase
 {
@@ -24,7 +25,7 @@ public function testCanParseUploadedFileInstance(): void
     public function testCannotParseNonUploadedFileInstance(): void
     {
         $type = new UploadType();
-        $this->expectException(\UnexpectedValueException::class);
+        $this->expectException(UnexpectedValueException::class);
         $this->expectExceptionMessage('Could not get uploaded file, be sure to conform to GraphQL multipart request specification. Instead got: foo');
 
         $type->parseValue('foo');