Changed header comment setup in FixerFactory

Author: shudd3r

cs-fixer.php.dist

@@ -11,4 +11,4 @@
 
 use Polymorphine\Dev\FixerFactory;
 
-return FixerFactory::createFor('Polymorphine/Dev', __DIR__);
+return FixerFactory::createFor(__FILE__);

src/FixerFactory.php

@@ -18,15 +18,6 @@
 
 final class FixerFactory
 {
-    public const HEADER = <<<'EOF'
-        This file is part of {{name}} package.
-        
-        (c) Shudd3r <q3.shudder@gmail.com>
-        
-        This source file is subject to the MIT license that is bundled
-        with this source code in the file LICENSE.
-        EOF;
-
     private static array $rules = [
         '@Symfony'                              => true,
         'align_multiline_comment'               => true,
@@ -42,7 +33,6 @@ final class FixerFactory
         'explicit_string_variable'              => false,
         'final_internal_class'                  => true,
         'function_to_constant'                  => true,
-        'header_comment'                        => ['comment_type' => 'comment'],
         'heredoc_to_nowdoc'                     => true,
         'increment_style'                       => false,
         'list_syntax'                           => ['syntax' => 'short'],
@@ -83,15 +73,12 @@ final class FixerFactory
         'yoda_style'                            => false
     ];
 
-    /**
-     * @param string $packageName
-     * @param string $workingDir
-     *
-     * @return Config
-     */
-    public static function createFor(string $packageName, string $workingDir): Config
+    public static function createFor(string $launchFile): Config
     {
-        self::$rules['header_comment']['header'] = str_replace('{{name}}', $packageName, self::HEADER);
+        $workingDir = dirname($launchFile);
+
+        self::setHeaderFrom($launchFile);
+
         self::$rules['no_extra_blank_lines']['tokens'] = [
             'break', 'continue', 'extra', 'return', 'throw', 'parenthesis_brace_block',
             'square_brace_block', 'curly_brace_block'
@@ -134,4 +121,22 @@ public static function createFor(string $packageName, string $workingDir): Confi
                 new Fixer\BraceAfterMultilineParamMethodFixer()
             ]);
     }
+
+    private static function setHeaderFrom(string $filename): void
+    {
+        self::$rules['header_comment'] = false;
+
+        $contents    = file_get_contents($filename) ?: '';
+        $headerStart = strpos($contents, "\n/*\n");
+        $headerEnd   = strpos($contents, "\n */\n");
+        if (!$headerStart || !$headerEnd) { return; }
+
+        $header = substr($contents, $headerStart + 4, $headerEnd - $headerStart - 4);
+        if (!$header) { return; }
+
+        self::$rules['header_comment'] = [
+            'comment_type' => 'comment',
+            'header'       => str_replace([' * ', ' *'], '', $header)
+        ];
+    }
 }

template/cs-fixer.php.dist.sk_file

@@ -3,12 +3,12 @@
 /*
  * This file is part of {package.name} package.
  *
- * (c) Shudd3r <q3.shudder@gmail.com>
+ * (c) {author.name} <{author.email}>
  *
  * This source file is subject to the MIT license that is bundled
  * with this source code in the file LICENSE.
  */
 
 use Polymorphine\Dev\FixerFactory;
 
-return FixerFactory::createFor('{package.name}', __DIR__);
+return FixerFactory::createFor(__FILE__);

tests/CompoundFixerTest.php

@@ -16,16 +16,14 @@
 use Polymorphine\Dev\Tests\Fixtures\FixerTestRunner;
 
 
-/**
- * @group integrated
- */
+/** @group integrated */
 class CompoundFixerTest extends TestCase
 {
     private FixerTestRunner $runner;
 
     protected function setUp(): void
     {
-        $config = FixerFactory::createFor('Polymorphine/Dev', __DIR__);
+        $config = FixerFactory::createFor(dirname(__DIR__) . DIRECTORY_SEPARATOR . 'cs-fixer.php.dist');
         $this->runner = FixerTestRunner::withConfig($config);
     }
 

tests/FixerFactoryTest.php

@@ -20,18 +20,47 @@ class FixerFactoryTest extends TestCase
 {
     public function testConfigInstantiation()
     {
-        $this->assertInstanceOf(ConfigInterface::class, FixerFactory::createFor('package/name', __DIR__));
+        $this->assertInstanceOf(ConfigInterface::class, FixerFactory::createFor(__FILE__));
     }
 
     public function testConfigFinder_IgnoresCodeSamples()
     {
-        $excluded = __DIR__ . str_replace('/', DIRECTORY_SEPARATOR, '/Fixtures/code-samples');
-        $finder   = FixerFactory::createFor('package/name', dirname(__DIR__))->getFinder();
+        $finder = FixerFactory::createFor($this->packagePath('cs-fixer.php.dist'))->getFinder();
 
         $this->assertTrue($finder->hasResults());
 
+        $excludedPath = $this->packagePath('tests/Fixtures/code-samples');
         foreach ($finder->getIterator() as $file) {
-            $this->assertFalse(strpos($file->getPath(), $excluded));
+            $this->assertStringNotContainsString($excludedPath, $file->getPath());
         }
     }
+
+    public function testHeaderIsReadFromLaunchFile()
+    {
+        $expectedHeader = <<<'HEADER'
+            This file is part of Polymorphine/Dev package.
+
+            (c) Shudd3r <q3.shudder@gmail.com>
+
+            This source file is subject to the MIT license that is bundled
+            with this source code in the file LICENSE.
+            HEADER;
+
+        $rules = FixerFactory::createFor($this->packagePath('cs-fixer.php.dist'))->getRules();
+        $this->assertSame($expectedHeader, $rules['header_comment']['header']);
+
+        $file  = $this->packagePath('tests/Fixtures/code-samples/Fixer/given-global.php');
+        $rules = FixerFactory::createFor($file)->getRules();
+        $this->assertSame('LOL surprise comment!', $rules['header_comment']['header']);
+
+        $file  = $this->packagePath('tests/Fixtures/code-samples/Fixer/given-ExampleClass.php');
+        $rules = FixerFactory::createFor($file)->getRules();
+        $this->assertFalse($rules['header_comment']);
+    }
+
+    private function packagePath(string $relativePath): string
+    {
+        $relativePath = str_replace('/', DIRECTORY_SEPARATOR, trim($relativePath, DIRECTORY_SEPARATOR));
+        return dirname(__DIR__) . DIRECTORY_SEPARATOR . $relativePath;
+    }
 }