Changed process of excluding code samples

Author: shudd3r

.github/workflows/build.yml

@@ -50,7 +50,7 @@ jobs:
       - name: "Coding standard CodeSniffer checks"
         run: |
           vendor/bin/phpcs --extensions=php --standard=phpcs.xml.dist src
-          vendor/bin/phpcs --extensions=php --standard=phpcs.xml.dist --ignore=tests/CodeSamples/* tests
+          vendor/bin/phpcs --extensions=php --standard=phpcs.xml.dist --ignore=*/code-samples/* tests
       - name: "Package skeleton validation"
         run: php polymorphine-skeleton check
       - name: "Run PhpUnit tests with coverage"

composer.json

@@ -25,7 +25,8 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Polymorphine\\Dev\\Tests\\": "tests/"
+            "Polymorphine\\Dev\\Tests\\": "tests/",
+            "Polymorphine\\Dev\\CodeSamples\\": "tests/Fixtures/code-samples/"
         }
     },
     "bin": [
@@ -35,7 +36,7 @@
         "test-cs": [
             "php-cs-fixer --dry-run -v --config=cs-fixer.php.dist --path-mode=intersection fix src tests",
             "phpcs --extensions=php --standard=phpcs.xml.dist src",
-            "phpcs --extensions=php --standard=phpcs.xml.dist --ignore=tests/CodeSamples/* tests"
+            "phpcs --extensions=php --standard=phpcs.xml.dist --ignore=*/code-samples/* tests"
         ],
         "test-php": "phpunit",
         "test-skeleton": "@php polymorphine-skeleton check"

cs-fixer.php.dist

@@ -11,9 +11,4 @@
 
 use Polymorphine\Dev\FixerFactory;
 
-$filter = function (SplFileInfo $file) {
-    $samples = __DIR__ . DIRECTORY_SEPARATOR . 'tests' . DIRECTORY_SEPARATOR . 'CodeSamples';
-    return strpos($file->getPath(), $samples) !== 0;
-};
-
-return FixerFactory::createFor('Polymorphine/Dev', __DIR__, [$filter]);
+return FixerFactory::createFor('Polymorphine/Dev', __DIR__);

src/FixerFactory.php

@@ -13,6 +13,7 @@
 
 use PhpCsFixer\Config;
 use PhpCsFixer\Finder;
+use SplFileInfo;
 
 
 final class FixerFactory
@@ -83,13 +84,12 @@ final class FixerFactory
     ];
 
     /**
-     * @param string     $packageName
-     * @param string     $workingDir
-     * @param callable[] $filters     fn(SplFileInfo) => bool - false will ignore file
+     * @param string $packageName
+     * @param string $workingDir
      *
      * @return Config
      */
-    public static function createFor(string $packageName, string $workingDir, array $filters = []): Config
+    public static function createFor(string $packageName, string $workingDir): Config
     {
         self::$rules['header_comment']['header'] = str_replace('{{name}}', $packageName, self::HEADER);
         self::$rules['no_extra_blank_lines']['tokens'] = [
@@ -108,16 +108,18 @@ public static function createFor(string $packageName, string $workingDir, array
         self::$rules['Polymorphine/declare_strict_first_line']               = true;
         self::$rules['Polymorphine/brace_after_multiline_param_method']      = true;
 
-        $finder = Finder::create()->in($workingDir);
-        foreach ($filters as $filter) {
-            $finder = $finder->filter($filter);
-        }
+        $excludeSamples = function (SplFileInfo $file) use ($workingDir) {
+            $filePath   = $file->getPath();
+            $testsPath  = $workingDir . DIRECTORY_SEPARATOR . 'tests' . DIRECTORY_SEPARATOR;
+            $samplesDir = DIRECTORY_SEPARATOR . 'code-samples' . DIRECTORY_SEPARATOR;
+            return strpos($filePath, $testsPath) !== 0 || strpos($filePath, $samplesDir) === false;
+        };
 
         $config = new Config();
         return $config
             ->setRiskyAllowed(true)
             ->setRules(self::$rules)
-            ->setFinder($finder)
+            ->setFinder(Finder::create()->in($workingDir)->filter($excludeSamples))
             ->setUsingCache(false)
             ->registerCustomFixers([
                 new Fixer\DoubleLineBeforeClassDefinitionFixer(),

template/.github/workflows/build.yml

@@ -50,7 +50,7 @@ jobs:
       - name: "Coding standard CodeSniffer checks"
         run: |
           vendor/bin/phpcs --extensions=php --standard=${tpl.PHPCS} src
-          vendor/bin/phpcs --extensions=php --standard=${tpl.PHPCS} --ignore=tests/CodeSamples/* tests
+          vendor/bin/phpcs --extensions=php --standard=${tpl.PHPCS} --ignore=*/code-samples/* tests
       - name: "Package skeleton validation"
         run: ${tpl.PHP_EXEC}polymorphine-skeleton check
       - name: "Run PhpUnit tests with coverage"

template/composer.json.sk_file

@@ -32,7 +32,7 @@
         "test-cs": [
             "php-cs-fixer --dry-run -v --config=cs-fixer.php.dist --path-mode=intersection fix src tests",
             "phpcs --extensions=php --standard={$tpl.PHPCS} src",
-            "phpcs --extensions=php --standard={$tpl.PHPCS} --ignore=tests/CodeSamples/* tests"
+            "phpcs --extensions=php --standard={$tpl.PHPCS} --ignore=*/code-samples/* tests"
         ],
         "test-php": "phpunit",
         "test-skeleton": "{$tpl.PHP_EXEC}polymorphine-skeleton check"

template/cs-fixer.php.dist

@@ -10,5 +10,5 @@
  */
 
 use Polymorphine\Dev\FixerFactory;
-{original.content}
-return FixerFactory::createFor('{package.name}', __DIR__{original.content});
+
+return FixerFactory::createFor('{package.name}', __DIR__);

tests/CompoundFixerTest.php

@@ -44,11 +44,11 @@ public function testFixedFiles_MatchExpectations(string $fileExpected, string $f
     public function fileList(): array
     {
         $files = [];
-        foreach (array_diff(scandir(__DIR__ . '/CodeSamples/Fixer'), ['..', '.']) as $file) {
+        foreach (array_diff(scandir(__DIR__ . '/Fixtures/code-samples/Fixer'), ['..', '.']) as $file) {
             [$type, $index] = explode('-', $file, 2) + [false, false];
             $id = ($type === 'expected') ? 0 : 1;
             isset($files[$index]) or $files[$index] = [];
-            $files[$index][$id] = __DIR__ . '/CodeSamples/Fixer/' . $file;
+            $files[$index][$id] = __DIR__ . '/Fixtures/code-samples/Fixer/' . $file;
         }
 
         return $files;

tests/FixerFactoryTest.php

@@ -20,7 +20,18 @@ class FixerFactoryTest extends TestCase
 {
     public function testConfigInstantiation()
     {
-        $filters = [fn () => true];
-        $this->assertInstanceOf(ConfigInterface::class, FixerFactory::createFor('package/name', __DIR__, $filters));
+        $this->assertInstanceOf(ConfigInterface::class, FixerFactory::createFor('package/name', __DIR__));
+    }
+
+    public function testConfigFinder_IgnoresCodeSamples()
+    {
+        $excluded = __DIR__ . str_replace('/', DIRECTORY_SEPARATOR, '/Fixtures/code-samples');
+        $finder   = FixerFactory::createFor('package/name', dirname(__DIR__))->getFinder();
+
+        $this->assertTrue($finder->hasResults());
+
+        foreach ($finder->getIterator() as $file) {
+            $this->assertFalse(strpos($file->getPath(), $excluded));
+        }
     }
 }