Simplify - Back to basic (#10)

realodix · Jun 30, 2024 · c2dafe5 · c2dafe5
1 parent 5aec29b
commit c2dafe5
Show file tree

Hide file tree

Showing 10 changed files with 88 additions and 242 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -11,6 +11,8 @@
 $finder = Finder::base()
     ->append(['.php-cs-fixer.dist.php', 'bin/relax']);
 
-return Config::create(new Realodix, $localRules)
+return Config::create(new Realodix)
+    ->setRules($localRules)
     ->setFinder($finder)
+    ->setParallelConfig(\PhpCsFixer\Runner\Parallel\ParallelConfigFactory::detect())
     ->setCacheFile(__DIR__.'/.tmp/.php-cs-fixer.cache');
diff --git a/README.md b/README.md
@@ -32,15 +32,20 @@ In your PHP CS Fixer configuration file, use the following contents:
 use Realodix\Relax\Config;
 use Realodix\Relax\RuleSet\Sets\Laravel;
 
-return Config::create(new Laravel);
+$localRules = [
+    // ...
+];
+
+return Config::create(new Laravel)
+    ->setRules($localRules);
 ```
 
-#### Presets
+#### Rulesets
 
-Presets defines a set of rules that can be used to fix code style issues in your code. To use presets in your PHP code, you need to use the `Realodix\Relax\RuleSet\Sets\` namespace.
+Rulesets defines a set of rules that can be used to fix code style issues in your code. To use rulesets in your PHP code, you need to use the `Realodix\Relax\RuleSet\Sets\` namespace.
 
-| Preset                     | Description |
-| -------------------------- |-------------|
+| Rulesets                  | Description |
+| ------------------------- |-------------|
 | [`Laravel`][rs_laravel]   | Rules that follow the official Laravel coding standards |
 | [`Realodix`][rs_realodix] | Inherits `Laravel` with some tweaks |
 | [`Spatie`][rs_spatie]     | The rule set used by Spatie |
@@ -102,7 +107,8 @@ $finder = Finder::laravel(__DIR__.'Foo')
     ->notName('*.foo.php')
     ->append(['.php-cs-fixer.dist.php']);
 
-return Config::create(new Laravel, $localRules)
+return Config::create(new Laravel)
+    ->setRules($localRules)
     ->setFinder($finder)
     ->setRiskyAllowed(false)
     ->registerCustomFixers(new \PhpCsFixerCustomFixers\CustomFixer());
@@ -123,7 +129,8 @@ $localRules = [
     'ordered_imports' => ['sort_algorithm' => 'alpha'],
 ];
 
-return Config::create($localRules);
+return Config::create()
+    ->setRules($localRules);
 ```
 
 ## Custom Rule Set
@@ -156,7 +163,8 @@ $localRules = [
     // ...
 ];
 
-return Config::create(new MyRuleSet(), $localRules);
+return Config::create(new MyRuleSet())
+    ->setRules($localRules);
 ```
 
 ## Troubleshooting

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -10,9 +10,6 @@
         <testsuite name="Unit">
             <directory suffix="Test.php">./tests/Unit</directory>
         </testsuite>
-        <testsuite name="Feature">
-            <directory suffix="Test.php">./tests/Feature</directory>
-        </testsuite>
     </testsuites>
 
     <coverage cacheDirectory=".tmp/PHPUnit">

diff --git a/src/Commands/GenerateConfigCommand.php b/src/Commands/GenerateConfigCommand.php
@@ -74,13 +74,13 @@ protected function generateAndSaveCode($output): bool
         $code = <<<'CODE'
             <?php
             use Realodix\Relax\Config;
-            use Realodix\Relax\RuleSet\Sets\Realodix;
 
             $localRules = [
                 // ...
             ];
 
-            return Config::create(new Realodix, $localRules);
+            return Config::create()
+                ->setRules($localRules);
             CODE;
 
         if (file_put_contents($this->getOutputFilename(), $code) === false) {

diff --git a/src/Config.php b/src/Config.php
@@ -2,27 +2,41 @@
 
 namespace Realodix\Relax;
 
+use PhpCsFixer\Config as PhpCsFixerConfig;
 use PhpCsFixer\ConfigInterface;
-use Realodix\Relax\RuleSet\RuleSet;
 use Realodix\Relax\RuleSet\RuleSetInterface;
 
-class Config
+class Config extends PhpCsFixerConfig
 {
+    const LOCAL_RULES_NAME = 'Local Rules';
+
+    private ?RuleSetInterface $ruleSet;
+
+    public function __construct(?RuleSetInterface $ruleSet)
+    {
+        $this->ruleSet = $ruleSet;
+        $name = $this->ruleSet ? $this->ruleSet->name() : self::LOCAL_RULES_NAME;
+
+        parent::__construct($name);
+        $this->registerCustomFixers(new \PhpCsFixerCustomFixers\Fixers);
+        $this->setFinder(Finder::base());
+        $this->setRiskyAllowed(true);
+    }
+
+    public function setRules(array $rules = []): ConfigInterface
+    {
+        $ruleSet = $this->ruleSet ? $this->ruleSet->rules() : [];
+
+        return parent::setRules(array_merge($ruleSet, $rules));
+    }
+
     /**
-     * @param array|string|RuleSetInterface $rules
+     * Create a new config instance
+     *
+     * @return self
      */
-    public static function create($rules, array $localRules = []): ConfigInterface
+    public static function create(?RuleSetInterface $ruleSet = null)
     {
-        $ruleSet = new RuleSet($rules);
-        $numberOfRules = count($localRules) === 0 ?
-            ' ('.count($ruleSet->getRules()).' rules)'
-            : ' ('.count($ruleSet->getRules()).' + '.count($localRules).' rules)';
-        $ruleSetName = $ruleSet->getName().$numberOfRules;
-
-        return (new \PhpCsFixer\Config($ruleSetName))
-            ->registerCustomFixers(new \PhpCsFixerCustomFixers\Fixers)
-            ->setRiskyAllowed(true)
-            ->setRules(array_merge($ruleSet->getRules(), $localRules))
-            ->setFinder(Finder::base());
+        return new self($ruleSet);
     }
 }
diff --git a/src/RuleSet/RuleSet.php b/src/RuleSet/RuleSet.php
diff --git a/tests/Feature/ConfigTest.php b/tests/Feature/ConfigTest.php
diff --git a/tests/Feature/ConfigTestProvider.php b/tests/Feature/ConfigTestProvider.php
diff --git a/tests/Unit/ConfigTest.php b/tests/Unit/ConfigTest.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace Realodix\Relax\Tests\Unit;
+
+use PHPUnit\Framework\TestCase;
+use Realodix\Relax\Config;
+use Realodix\Relax\Tests\Fixtures\RuleSetFile;
+
+class ConfigTest extends TestCase
+{
+    public function testSetRuleset(): void
+    {
+        $this->assertSame('@RuleSetFile', Config::create(new RuleSetFile)->getName());
+    }
+
+    public function testAddLocalRules(): void
+    {
+        $rules1 = (new RuleSetFile)->rules();
+        $rules2 = ['foo' => 'bar'];
+
+        $this->assertSame(
+            count($rules1) + count($rules2),
+            count(
+                Config::create(new RuleSetFile)
+                    ->setRules($rules2)->getRules()
+            )
+        );
+    }
+
+    public function testOnlyLocalRules(): void
+    {
+        $rules = Config::create()->setRules(['foo' => 'bar']);
+
+        $this->assertSame(1, count($rules->getRules()));
+        $this->assertSame(Config::LOCAL_RULES_NAME, $rules->getName());
+    }
+}