#65 - purge mode (#86)

blumilksoftware · May 30, 2023 · f858620 · f858620
1 parent e7d822f
commit f858620
Show file tree

Hide file tree

Showing 12 changed files with 462 additions and 72 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 /.composer
 /.idea
+/playground
 /vendor
 
 composer.lock

diff --git a/composer.json b/composer.json
@@ -28,6 +28,11 @@
       "Blumilk\\Codestyle\\": "src/"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "Blumilk\\Codestyle\\Tests\\": "tests/codestyle/"
+    }
+  },
   "scripts": {
     "cs": "./vendor/bin/php-cs-fixer fix --dry-run --diff --config codestyle.php",
     "csf": "./vendor/bin/php-cs-fixer fix --diff --config codestyle.php",

diff --git a/src/Config.php b/src/Config.php
@@ -8,7 +8,9 @@
 use Blumilk\Codestyle\Configuration\Defaults\LaravelPaths;
 use Blumilk\Codestyle\Configuration\Paths;
 use Blumilk\Codestyle\Configuration\Rules;
+use Blumilk\Codestyle\Configuration\Utils\Rule;
 use Blumilk\Codestyle\Fixers\DoubleQuoteFixer;
+use Blumilk\Codestyle\Fixers\NoCommentFixer;
 use Blumilk\Codestyle\Fixers\NoLaravelMigrationsGeneratedCommentFixer;
 use JetBrains\PhpStorm\ArrayShape;
 use PhpCsFixer\Config as PhpCsFixerConfig;
@@ -42,8 +44,8 @@ public function config(): PhpCsFixerConfig
         }
 
         $finder = Finder::create()->directories()->append($files);
-
         $config = new PhpCsFixerConfig("Blumilk codestyle standard");
+
         return $config->setFinder($finder)
             ->setUsingCache(false)
             ->registerCustomFixers(new PhpCsFixerCustomFixers())
@@ -61,6 +63,13 @@ public function options(): array
         ];
     }
 
+    public function purgeMode(): static
+    {
+        $this->rules->add(new Rule(NoCommentFixer::class));
+
+        return $this;
+    }
+
     protected function getAllFiles(array &$paths, string $path): void
     {
         if (is_file($path) || !is_dir($path)) {
@@ -83,6 +92,7 @@ protected function getCustomFixers(): array
         return [
             new DoubleQuoteFixer(),
             new NoLaravelMigrationsGeneratedCommentFixer(),
+            new NoCommentFixer(),
         ];
     }
 }
diff --git a/src/Configuration/Utils/Rule.php b/src/Configuration/Utils/Rule.php
@@ -6,6 +6,9 @@
 
 class Rule
 {
+    /**
+     * @param class-string $fixer
+     */
     public function __construct(
         protected string $fixer,
         protected ?array $options = null,

diff --git a/src/Fixers/NoCommentFixer.php b/src/Fixers/NoCommentFixer.php
@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Blumilk\Codestyle\Fixers;
+
+use PhpCsFixer\Fixer\FixerInterface;
+use PhpCsFixer\Fixer\Whitespace\NoExtraBlankLinesFixer;
+use PhpCsFixer\FixerDefinition\CodeSample;
+use PhpCsFixer\FixerDefinition\FixerDefinition;
+use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
+use PhpCsFixer\Tokenizer\Tokens;
+use PhpCsFixerCustomFixers\TokenRemover;
+use SplFileInfo;
+
+final class NoCommentFixer implements FixerInterface
+{
+    public function getDefinition(): FixerDefinitionInterface
+    {
+        $codeSample = <<<'EOF'
+<?php
+
+class Migration
+{
+    public function up()
+    {
+        Schema::create("sessions", function (Blueprint $table) {
+        // test
+            $table->string("id")->primary();
+            $table->text("payload");
+        });
+    }
+};
+EOF;
+
+        return new FixerDefinition(
+            "There can be no comments.",
+            [
+                new CodeSample($codeSample),
+            ],
+        );
+    }
+
+    public function getName(): string
+    {
+        return "Blumilk/no_comments";
+    }
+
+    public function getPriority(): int
+    {
+        $fixer = new NoExtraBlankLinesFixer();
+        return $fixer->getPriority() + 1;
+    }
+
+    public function supports(SplFileInfo $file): bool
+    {
+        return true;
+    }
+
+    public function isCandidate(Tokens $tokens): bool
+    {
+        return $tokens->isAnyTokenKindsFound([T_COMMENT, T_DOC_COMMENT]);
+    }
+
+    public function isRisky(): bool
+    {
+        return true;
+    }
+
+    public function fix(SplFileInfo $file, Tokens $tokens): void
+    {
+        for ($index = $tokens->count() - 1; $index > 0; $index--) {
+            if (!$tokens[$index]->isGivenKind([T_COMMENT])) {
+                continue;
+            }
+
+            TokenRemover::removeWithLinesIfPossible($tokens, $index);
+        }
+    }
+}
diff --git a/tests/codestyle/CodestyleTest.php → tests/codestyle/CodestyleTestCase.php b/tests/codestyle/CodestyleTest.php → tests/codestyle/CodestyleTestCase.php
@@ -2,12 +2,15 @@
 
 declare(strict_types=1);
 
+namespace Blumilk\Codestyle\Tests;
+
+use Exception;
 use PhpCsFixer\Console\Application;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Console\Input\StringInput;
 use Symfony\Component\Console\Output\BufferedOutput;
 
-class CodestyleTest extends TestCase
+abstract class CodestyleTestCase extends TestCase
 {
     protected function setUp(): void
     {
@@ -19,75 +22,6 @@ protected function tearDown(): void
         $this->clearTempDirectory();
     }
 
-    /**
-     * @dataProvider providePhp80Fixtures
-     * @requires PHP >= 8.0
-     * @throws Exception
-     */
-    public function testPhp80Fixtures(string $name): void
-    {
-        $this->testFixture($name);
-    }
-
-    /**
-     * @dataProvider providePhp81Fixtures
-     * @requires PHP >= 8.1
-     * @throws Exception
-     */
-    public function testPhp81Fixtures(string $name): void
-    {
-        $this->testFixture($name);
-    }
-
-    /**
-     * @dataProvider providePhp82Fixtures
-     * @requires PHP >= 8.2
-     * @throws Exception
-     */
-    public function testPhp82Fixtures(string $name): void
-    {
-        $this->testFixture($name);
-    }
-
-    public static function providePhp80Fixtures(): array
-    {
-        return [
-            ["noExtraBlankLines"],
-            ["nullableTypeForDefaultNull"],
-            ["operatorSpacing"],
-            ["singleQuotes"],
-            ["strictTypes"],
-            ["trailingCommas"],
-            ["unionTypes"],
-            ["references"],
-            ["classAttributesSeparation"],
-            ["uselessParenthesis"],
-            ["laravelMigrations"],
-            ["phpdocs"],
-            ["yodaStyle"],
-            ["objectOperators"],
-            ["anonymousFunctions"],
-            ["namespaces"],
-            ["emptyLines"],
-            ["importsOrder"],
-        ];
-    }
-
-    public static function providePhp81Fixtures(): array
-    {
-        return [
-            ["enums"],
-            ["readonlies"],
-        ];
-    }
-
-    public static function providePhp82Fixtures(): array
-    {
-        return [
-            ["php82"],
-        ];
-    }
-
     /**
      * @dataProvider providePhp80Fixtures
      * @throws Exception
@@ -124,7 +58,8 @@ protected function runFixer(bool $fix = false): bool
         $application->setAutoExit(false);
 
         $output = new BufferedOutput();
-        $result = $application->run(new StringInput("fix {$dryRun} --diff --config ./tests/codestyle/config.php"), $output);
+        $config = $this->getConfigPath();
+        $result = $application->run(new StringInput("fix {$dryRun} --diff --config $config"), $output);
 
         return $result === 0;
     }
@@ -136,4 +71,9 @@ protected function clearTempDirectory(): void
             unlink($file);
         }
     }
+
+    protected function getConfigPath(): string
+    {
+        return "./tests/codestyle/config/config.php";
+    }
 }
diff --git a/tests/codestyle/CommonRulesetTest.php b/tests/codestyle/CommonRulesetTest.php
@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+namespace Blumilk\Codestyle\Tests;
+
+class CommonRulesetTest extends CodestyleTestCase
+{
+    /**
+     * @dataProvider providePhp80Fixtures
+     * @requires PHP >= 8.0
+     * @throws Exception
+     */
+    public function testPhp80Fixtures(string $name): void
+    {
+        $this->testFixture($name);
+    }
+
+    /**
+     * @dataProvider providePhp81Fixtures
+     * @requires PHP >= 8.1
+     * @throws Exception
+     */
+    public function testPhp81Fixtures(string $name): void
+    {
+        $this->testFixture($name);
+    }
+
+    /**
+     * @dataProvider providePhp82Fixtures
+     * @requires PHP >= 8.2
+     * @throws Exception
+     */
+    public function testPhp82Fixtures(string $name): void
+    {
+        $this->testFixture($name);
+    }
+
+    public static function providePhp80Fixtures(): array
+    {
+        return [
+            ["noExtraBlankLines"],
+            ["nullableTypeForDefaultNull"],
+            ["operatorSpacing"],
+            ["singleQuotes"],
+            ["strictTypes"],
+            ["trailingCommas"],
+            ["unionTypes"],
+            ["references"],
+            ["classAttributesSeparation"],
+            ["uselessParenthesis"],
+            ["laravelMigrations"],
+            ["phpdocs"],
+            ["yodaStyle"],
+            ["objectOperators"],
+            ["anonymousFunctions"],
+            ["namespaces"],
+            ["emptyLines"],
+            ["importsOrder"],
+        ];
+    }
+
+    public static function providePhp81Fixtures(): array
+    {
+        return [
+            ["enums"],
+            ["readonlies"],
+        ];
+    }
+
+    public static function providePhp82Fixtures(): array
+    {
+        return [
+            ["php82"],
+        ];
+    }
+}
diff --git a/tests/codestyle/PurgeTest.php b/tests/codestyle/PurgeTest.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Blumilk\Codestyle\Tests;
+class PurgeTest extends CodestyleTestCase
+{
+    /**
+     * @throws Exception
+     */
+    public function testPhp82Fixtures(): void
+    {
+        $this->testFixture("noComments");
+    }
+
+    protected function getConfigPath(): string
+    {
+        return "./tests/codestyle/config/config.purge.php";
+    }
+}
diff --git a/tests/codestyle/config.php → tests/codestyle/config/config.php b/tests/codestyle/config.php → tests/codestyle/config/config.php
diff --git a/tests/codestyle/config/config.purge.php b/tests/codestyle/config/config.purge.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+use Blumilk\Codestyle\Config;
+use Blumilk\Codestyle\Configuration\Defaults\Paths;
+
+$config = new Config(
+    paths: new Paths("tests/codestyle/tmp"),
+);
+
+return $config->purgeMode()->config();