fix: refactor configuration handling in DocBlockHeaderFixer and add getList method in Separate

Author: jackd248

src/Model/Separate.php

@@ -29,4 +29,12 @@ enum Separate: string
     case Bottom = 'bottom';
     case Both = 'both';
     case None = 'none';
+
+    /**
+     * @return non-empty-list<string>
+     */
+    public static function getList(): array
+    {
+        return array_column(self::cases(), 'value');
+    }
 }

src/Rules/DocBlockHeaderFixer.php

@@ -23,6 +23,7 @@
 
 namespace KonradMichalik\PhpDocBlockHeaderFixer\Rules;
 
+use KonradMichalik\PhpDocBlockHeaderFixer\Model\Separate;
 use PhpCsFixer\AbstractFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
@@ -43,9 +44,9 @@
 final class DocBlockHeaderFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
     /**
-     * @var array<string, mixed>|null
+     * @var array<string, mixed>
      */
-    protected ?array $configuration = null;
+    private array $resolvedConfiguration = [];
 
     public function getDefinition(): FixerDefinitionInterface
     {
@@ -77,20 +78,20 @@ public function getConfigurationDefinition(): FixerConfigurationResolverInterfac
                 ->setDefault(true)
                 ->getOption(),
             (new FixerOptionBuilder('separate', 'Separate the comment'))
-                ->setAllowedValues(['top', 'bottom', 'both', 'none'])
-                ->setDefault('both')
+                ->setAllowedValues(Separate::getList())
+                ->setDefault(Separate::Both->value)
                 ->getOption(),
         ]);
     }
 
     public function configure(?array $configuration = null): void
     {
-        $this->configuration = $this->getConfigurationDefinition()->resolve($configuration ?? []);
+        $this->resolvedConfiguration = $this->getConfigurationDefinition()->resolve($configuration ?? []);
     }
 
     protected function applyFix(SplFileInfo $file, Tokens $tokens): void
     {
-        $annotations = $this->configuration['annotations'] ?? [];
+        $annotations = $this->resolvedConfiguration['annotations'] ?? [];
         if (empty($annotations)) {
             return;
         }
@@ -112,7 +113,7 @@ protected function applyFix(SplFileInfo $file, Tokens $tokens): void
     private function processClassDocBlock(Tokens $tokens, int $classIndex, array $annotations): void
     {
         $existingDocBlockIndex = $this->findExistingDocBlock($tokens, $classIndex);
-        $preserveExisting = $this->configuration['preserve_existing'] ?? true;
+        $preserveExisting = $this->resolvedConfiguration['preserve_existing'] ?? true;
 
         if (null !== $existingDocBlockIndex) {
             if ($preserveExisting) {
@@ -174,7 +175,7 @@ private function replaceDocBlock(Tokens $tokens, int $docBlockIndex, array $anno
      */
     private function insertNewDocBlock(Tokens $tokens, int $classIndex, array $annotations): void
     {
-        $separate = $this->configuration['separate'] ?? 'both';
+        $separate = $this->resolvedConfiguration['separate'] ?? 'both';
         $insertIndex = $this->findInsertPosition($tokens, $classIndex);
 
         $tokensToInsert = [];