IBX-8121: Introduced Ibexa Rule Sets (#8)

For more details see https://issues.ibexa.co/browse/IBX-8121 and #8

Key changes:

* Introduced Ibexa Rule Sets

* [Tests] Added test coverage for rule sets

* Fixed deprecation notices

* [SonarCloud][Tests] Excluded extracted rule set files from analysis

---------

Co-Authored-By: Mikolaj Adamczyk <[email protected]>

Author: Steveb-p

.github/workflows/ci.yaml

@@ -40,5 +40,8 @@ jobs:
       - name: Run PHPStan analysis
         run: composer run-script phpstan
 
+      - name: Run tests suite
+        run: composer run-script test
+
       - name: Run code style check
         run: composer run-script check-cs -- --format=checkstyle | cs2pr

.php-cs-fixer.php

@@ -7,11 +7,16 @@
 declare(strict_types=1);
 
 use Ibexa\CodeStyle\PhpCsFixer\InternalConfigFactory;
+use Ibexa\CodeStyle\PhpCsFixer\Sets;
 
 $finder = PhpCsFixer\Finder::create()
     ->in(__DIR__)
     ->files()->name('*.php');
 
-return InternalConfigFactory::build()
-    ->setFinder($finder)
-;
+$configFactory = new InternalConfigFactory();
+$configFactory->withRuleSet(new Sets\Ibexa50RuleSet());
+
+$config = $configFactory->buildConfig();
+$config->setFinder($finder);
+
+return $config;

.sonarcloud.properties

@@ -0,0 +1 @@
+sonar.exclusions=tests/lib/Sets/expected_rules/**/*

composer.json

@@ -19,14 +19,21 @@
     },
     "require-dev": {
         "roave/security-advisories": "dev-master",
-        "phpstan/phpstan": "^1.10"
+        "phpstan/phpstan": "^1.10",
+        "phpunit/phpunit": "^9.6"
     },
     "autoload": {
         "psr-4": {
             "Ibexa\\CodeStyle\\": "src/lib/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Ibexa\\Tests\\CodeStyle\\PhpCsFixer\\": "tests/lib/"
+        }
+    },
     "scripts": {
+        "test": "phpunit",
         "check-cs": "php-cs-fixer fix -v --diff --dry-run --show-progress=dots",
         "fix-cs": "php-cs-fixer fix -v --show-progress=dots",
         "phpstan": "phpstan analyse -c phpstan.neon"

phpunit.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.6/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheResultFile=".phpunit.cache/test-results"
+         beStrictAboutCoversAnnotation="true"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutTodoAnnotatedTests="true"
+         convertDeprecationsToExceptions="true"
+         failOnRisky="true"
+         failOnWarning="true"
+         verbose="true">
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <coverage cacheDirectory=".phpunit.cache/code-coverage"
+              processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
+</phpunit>

src/lib/PhpCsFixer/Config.php

@@ -10,181 +10,17 @@
 
 use PhpCsFixer\Config as ConfigBase;
 
+/**
+ * @deprecated 1.3.0 The "Config" class has been deprecated, will be removed in 2.0. Use RuleSetInterface or InternalConfigFactory instead.
+ */
 class Config extends ConfigBase
 {
-    /**
-     * @param string $name
-     */
-    public function __construct($name = 'default')
+    public function __construct(string $name = 'default')
     {
         parent::__construct($name);
 
         $this->setRiskyAllowed(true);
-        $this->setRules([
-            'declare_strict_types' => true,
-            'encoding' => true,
-            'full_opening_tag' => true,
-            'blank_line_after_namespace' => true,
-            'elseif' => true,
-            'function_declaration' => true,
-            'indentation_type' => true,
-            'line_ending' => true,
-            'constant_case' => ['case' => 'lower'],
-            'lowercase_keywords' => true,
-            'no_closing_tag' => true,
-            'no_spaces_after_function_name' => true,
-            'no_spaces_inside_parenthesis' => true,
-            'no_trailing_whitespace' => true,
-            'no_trailing_whitespace_in_comment' => true,
-            'single_blank_line_at_eof' => true,
-            'single_import_per_statement' => true,
-            'single_line_after_imports' => true,
-            'switch_case_semicolon_to_colon' => true,
-            'switch_case_space' => true,
-            'visibility_required' => true,
-            'binary_operator_spaces' => true,
-            'blank_line_before_statement' => [
-                'statements' => ['return'],
-            ],
-            'braces' => [
-                'allow_single_line_closure' => true,
-            ],
-            'class_attributes_separation' => [
-                'elements' => [
-                    'method' => 'one',
-                    'property' => 'one',
-                ],
-            ],
-            'declare_equal_normalize' => true,
-            'function_typehint_space' => true,
-            'include' => true,
-            'increment_style' => true,
-            'lowercase_cast' => true,
-            'lowercase_static_reference' => true,
-            'magic_constant_casing' => true,
-            'magic_method_casing' => true,
-            'method_argument_space' => true,
-            'native_function_casing' => true,
-            'native_function_type_declaration_casing' => true,
-            'new_with_braces' => true,
-            'no_blank_lines_after_class_opening' => true,
-            'no_blank_lines_after_phpdoc' => true,
-            'no_empty_comment' => true,
-            'no_empty_phpdoc' => true,
-            'no_empty_statement' => true,
-            'no_extra_blank_lines' => ['tokens' => [
-                'curly_brace_block',
-                'extra',
-                'parenthesis_brace_block',
-                'square_brace_block',
-                'throw',
-                'use',
-            ]],
-            'no_leading_import_slash' => true,
-            'no_leading_namespace_whitespace' => true,
-            'no_mixed_echo_print' => true,
-            'no_multiline_whitespace_around_double_arrow' => true,
-            'no_short_bool_cast' => true,
-            'no_singleline_whitespace_before_semicolons' => true,
-            'no_spaces_around_offset' => true,
-            'no_trailing_comma_in_list_call' => true,
-            'no_trailing_comma_in_singleline_array' => true,
-            'no_unneeded_control_parentheses' => true,
-            'no_unneeded_curly_braces' => true,
-            'no_unneeded_final_method' => true,
-            'no_unused_imports' => true,
-            'no_whitespace_before_comma_in_array' => true,
-            'no_whitespace_in_blank_line' => true,
-            'normalize_index_brace' => true,
-            'object_operator_without_whitespace' => true,
-            'php_unit_fqcn_annotation' => true,
-            'phpdoc_annotation_without_dot' => false,
-            'phpdoc_indent' => true,
-            'phpdoc_inline_tag_normalizer' => true,
-            'phpdoc_tag_type' => [
-                'tags' => [
-                    'inheritdoc' => 'inline',
-                ],
-            ],
-            'general_phpdoc_tag_rename' => true,
-            'phpdoc_no_access' => true,
-            'phpdoc_no_alias_tag' => [
-                'replacements' => [
-                    'type' => 'var',
-                ],
-            ],
-            'phpdoc_no_empty_return' => true,
-            'phpdoc_no_package' => true,
-            'phpdoc_no_useless_inheritdoc' => true,
-            'phpdoc_return_self_reference' => true,
-            'phpdoc_scalar' => true,
-            'phpdoc_separation' => true,
-            'phpdoc_single_line_var_spacing' => true,
-            'phpdoc_summary' => true,
-            'phpdoc_trim' => true,
-            'phpdoc_types' => true,
-            'phpdoc_var_without_name' => true,
-            'protected_to_private' => true,
-            'return_type_declaration' => true,
-            'semicolon_after_instruction' => true,
-            'short_scalar_cast' => true,
-            'single_class_element_per_statement' => true,
-            'single_line_comment_style' => [
-                'comment_types' => ['hash'],
-            ],
-            'single_quote' => true,
-            'single_trait_insert_per_statement' => true,
-            'standardize_increment' => true,
-            'standardize_not_equals' => true,
-            'ternary_operator_spaces' => true,
-            'trailing_comma_in_multiline' => true,
-            'trim_array_spaces' => true,
-            'unary_operator_spaces' => true,
-            'whitespace_after_comma_in_array' => true,
-            'dir_constant' => true,
-            'ereg_to_preg' => true,
-            'error_suppression' => true,
-            'fopen_flag_order' => true,
-            'fopen_flags' => false,
-            'function_to_constant' => true,
-            'implode_call' => true,
-            'is_null' => true,
-            'modernize_types_casting' => true,
-            'native_constant_invocation' => [
-                'fix_built_in' => false,
-                'include' => [
-                    'DIRECTORY_SEPARATOR',
-                    'PHP_SAPI',
-                    'PHP_VERSION_ID',
-                ],
-                'scope' => 'namespaced',
-            ],
-            'no_alias_functions' => true,
-            'no_homoglyph_names' => true,
-            'non_printable_character' => true,
-            'php_unit_construct' => true,
-            'psr_autoloading' => true,
-            'set_type_to_cast' => true,
-            'concat_space' => ['spacing' => 'one'],
-            'array_syntax' => ['syntax' => 'short'],
-            'simplified_null_return' => false,
-            'phpdoc_align' => false,
-            'phpdoc_to_comment' => false,
-            'cast_spaces' => false,
-            'blank_line_after_opening_tag' => false,
-            'single_blank_line_before_namespace' => true,
-            'space_after_semicolon' => false,
-            'native_function_invocation' => false,
-            'phpdoc_types_order' => [
-                'null_adjustment' => 'always_last',
-                'sort_algorithm' => 'none',
-            ],
-            'php_unit_mock_short_will_return' => false,
-            'yoda_style' => false,
-            'no_break_comment' => false,
-            'self_accessor' => false,
-            'static_lambda' => true,
-            'ordered_imports' => true,
-        ]);
+        $ruleSet = new Sets\Ibexa46RuleSet();
+        $this->setRules($ruleSet->getRules());
     }
 }

src/lib/PhpCsFixer/InternalConfigFactory.php

@@ -8,7 +8,7 @@
 
 namespace Ibexa\CodeStyle\PhpCsFixer;
 
-use AdamWojs\PhpCsFixerPhpdocForceFQCN\Fixer\Phpdoc\ForceFQCNFixer;
+use Ibexa\CodeStyle\PhpCsFixer\Sets\RuleSetInterface;
 use PhpCsFixer\ConfigInterface;
 
 /**
@@ -18,16 +18,16 @@
  */
 final class InternalConfigFactory
 {
-    /** @deprecated Use IBEXA_PHP_HEADER constant instead. */
+    /** @deprecated 1.3.0 The "InternalConfigFactory::EZPLATFORM_PHP_HEADER" constant has been deprecated, will be removed in 2.0. Use AbstractIbexaRuleSet::IBEXA_PHP_HEADER constant instead. */
     public const EZPLATFORM_PHP_HEADER = self::IBEXA_PHP_HEADER;
 
-    public const IBEXA_PHP_HEADER = <<<'EOF'
-@copyright Copyright (C) Ibexa AS. All rights reserved.
-@license For full copyright and license information view LICENSE file distributed with this source code.
-EOF;
+    /** @deprecated 1.3.0 The "InternalConfigFactory::IBEXA_PHP_HEADER" constant has been deprecated, will be removed in 2.0. Use AbstractIbexaRuleSet::IBEXA_PHP_HEADER constant instead. */
+    public const IBEXA_PHP_HEADER = Sets\AbstractIbexaRuleSet::IBEXA_PHP_HEADER;
 
     /** @var array<string, mixed> */
-    private $customRules = [];
+    private array $customRules = [];
+
+    private RuleSetInterface $ruleSet;
 
     /**
      * @param array<string, mixed> $rules
@@ -39,26 +39,24 @@ public function withRules(array $rules): self
         return $this;
     }
 
+    public function withRuleSet(RuleSetInterface $ruleSet): self
+    {
+        $this->ruleSet = $ruleSet;
+
+        return $this;
+    }
+
+    public function getRuleSet(): RuleSetInterface
+    {
+        return $this->ruleSet ??= new Sets\Ibexa46RuleSet();
+    }
+
     public function buildConfig(): ConfigInterface
     {
-        $config = new Config();
-        $config->registerCustomFixers([
-            new ForceFQCNFixer(),
-        ]);
-
-        $specificRules = [
-            'header_comment' => [
-                'comment_type' => 'PHPDoc',
-                'header' => static::IBEXA_PHP_HEADER,
-                'location' => 'after_open',
-                'separate' => 'top',
-            ],
-            'AdamWojs/phpdoc_force_fqcn_fixer' => true,
-        ];
+        $config = $this->getRuleSet()->buildConfig();
         $config->setRules(array_merge(
             $config->getRules(),
-            $specificRules,
-            $this->customRules
+            $this->customRules,
         ));
 
         return $config;