@averay/codeformat 0.2.7 → 0.2.9

package/vendor/friendsofphp/php-cs-fixer/src/Fixer/ClassNotation/FinalInternalClassFixer.php

@@ -1,374 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-/*
- * This file is part of PHP CS Fixer.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
- *
- * This source file is subject to the MIT license that is bundled
- * with this source code in the file LICENSE.
- */
-
-namespace PhpCsFixer\Fixer\ClassNotation;
-
-use PhpCsFixer\AbstractFixer;
-use PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException;
-use PhpCsFixer\DocBlock\DocBlock;
-use PhpCsFixer\Fixer\ConfigurableFixerInterface;
-use PhpCsFixer\Fixer\ConfigurableFixerTrait;
-use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
-use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
-use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
-use PhpCsFixer\FixerDefinition\CodeSample;
-use PhpCsFixer\FixerDefinition\FixerDefinition;
-use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
-use PhpCsFixer\Preg;
-use PhpCsFixer\Tokenizer\CT;
-use PhpCsFixer\Tokenizer\Token;
-use PhpCsFixer\Tokenizer\Tokens;
-use PhpCsFixer\Tokenizer\TokensAnalyzer;
-use PhpCsFixer\Utils;
-use Symfony\Component\OptionsResolver\Options;
-
-/**
- * @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
- *
- * @implements ConfigurableFixerInterface<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration>
- *
- * @phpstan-type _AutogeneratedInputConfiguration array{
- *  annotation_exclude?: list<string>,
- *  annotation_include?: list<string>,
- *  consider_absent_docblock_as_internal_class?: bool,
- *  exclude?: list<string>,
- *  include?: list<string>,
- * }
- * @phpstan-type _AutogeneratedComputedConfiguration array{
- *  annotation_exclude: array<string, string>,
- *  annotation_include: array<string, string>,
- *  consider_absent_docblock_as_internal_class: bool,
- *  exclude: array<string, string>,
- *  include: array<string, string>,
- * }
- */
-final class FinalInternalClassFixer extends AbstractFixer implements ConfigurableFixerInterface
-{
-    /** @use ConfigurableFixerTrait<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration> */
-    use ConfigurableFixerTrait;
-
-    private const DEFAULTS = [
-        'include' => [
-            'internal',
-        ],
-        'exclude' => [
-            'final',
-            'Entity',
-            'ORM\Entity',
-            'ORM\Mapping\Entity',
-            'Mapping\Entity',
-            'Document',
-            'ODM\Document',
-        ],
-    ];
-
-    private bool $checkAttributes;
-
-    public function __construct()
-    {
-        parent::__construct();
-
-        $this->checkAttributes = \PHP_VERSION_ID >= 8_00_00;
-    }
-
-    public function getDefinition(): FixerDefinitionInterface
-    {
-        return new FixerDefinition(
-            'Internal classes should be `final`.',
-            [
-                new CodeSample("<?php\n/**\n * @internal\n */\nclass Sample\n{\n}\n"),
-                new CodeSample(
-                    "<?php\n/**\n * @CUSTOM\n */\nclass A{}\n\n/**\n * @CUSTOM\n * @not-fix\n */\nclass B{}\n",
-                    [
-                        'include' => ['@Custom'],
-                        'exclude' => ['@not-fix'],
-                    ]
-                ),
-            ],
-            null,
-            'Changing classes to `final` might cause code execution to break.'
-        );
-    }
-
-    /**
-     * {@inheritdoc}
-     *
-     * Must run before ProtectedToPrivateFixer, SelfStaticAccessorFixer.
-     * Must run after PhpUnitInternalClassFixer.
-     */
-    public function getPriority(): int
-    {
-        return 67;
-    }
-
-    public function isCandidate(Tokens $tokens): bool
-    {
-        return $tokens->isTokenKindFound(T_CLASS);
-    }
-
-    public function isRisky(): bool
-    {
-        return true;
-    }
-
-    protected function configurePostNormalisation(): void
-    {
-        $this->assertConfigHasNoConflicts();
-    }
-
-    protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
-    {
-        $tokensAnalyzer = new TokensAnalyzer($tokens);
-
-        for ($index = $tokens->count() - 1; 0 <= $index; --$index) {
-            if (!$tokens[$index]->isGivenKind(T_CLASS) || !$this->isClassCandidate($tokensAnalyzer, $tokens, $index)) {
-                continue;
-            }
-
-            // make class 'final'
-            $tokens->insertSlices([
-                $index => [
-                    new Token([T_FINAL, 'final']),
-                    new Token([T_WHITESPACE, ' ']),
-                ],
-            ]);
-        }
-    }
-
-    protected function createConfigurationDefinition(): FixerConfigurationResolverInterface
-    {
-        $annotationsAsserts = [static function (array $values): bool {
-            foreach ($values as $value) {
-                if ('' === $value) {
-                    return false;
-                }
-            }
-
-            return true;
-        }];
-
-        $annotationsNormalizer = static function (Options $options, array $value): array {
-            $newValue = [];
-            foreach ($value as $key) {
-                if (str_starts_with($key, '@')) {
-                    $key = substr($key, 1);
-                }
-
-                $newValue[strtolower($key)] = true;
-            }
-
-            return $newValue;
-        };
-
-        return new FixerConfigurationResolver([
-            (new FixerOptionBuilder('annotation_include', 'Class level attribute or annotation tags that must be set in order to fix the class (case insensitive).'))
-                ->setAllowedTypes(['string[]'])
-                ->setAllowedValues($annotationsAsserts)
-                ->setDefault(
-                    array_map(
-                        static fn (string $string) => '@'.$string,
-                        self::DEFAULTS['include'],
-                    ),
-                )
-                ->setNormalizer($annotationsNormalizer)
-                ->setDeprecationMessage('Use `include` to configure PHPDoc annotations tags and attributes.')
-                ->getOption(),
-            (new FixerOptionBuilder('annotation_exclude', 'Class level attribute or annotation tags that must be omitted to fix the class, even if all of the white list ones are used as well (case insensitive).'))
-                ->setAllowedTypes(['string[]'])
-                ->setAllowedValues($annotationsAsserts)
-                ->setDefault(
-                    array_map(
-                        static fn (string $string) => '@'.$string,
-                        self::DEFAULTS['exclude'],
-                    ),
-                )
-                ->setNormalizer($annotationsNormalizer)
-                ->setDeprecationMessage('Use `exclude` to configure PHPDoc annotations tags and attributes.')
-                ->getOption(),
-            (new FixerOptionBuilder('include', 'Class level attribute or annotation tags that must be set in order to fix the class (case insensitive).'))
-                ->setAllowedTypes(['string[]'])
-                ->setAllowedValues($annotationsAsserts)
-                ->setDefault(self::DEFAULTS['include'])
-                ->setNormalizer($annotationsNormalizer)
-                ->getOption(),
-            (new FixerOptionBuilder('exclude', 'Class level attribute or annotation tags that must be omitted to fix the class, even if all of the white list ones are used as well (case insensitive).'))
-                ->setAllowedTypes(['string[]'])
-                ->setAllowedValues($annotationsAsserts)
-                ->setDefault(self::DEFAULTS['exclude'])
-                ->setNormalizer($annotationsNormalizer)
-                ->getOption(),
-            (new FixerOptionBuilder('consider_absent_docblock_as_internal_class', 'Whether classes without any DocBlock should be fixed to final.'))
-                ->setAllowedTypes(['bool'])
-                ->setDefault(false)
-                ->getOption(),
-        ]);
-    }
-
-    /**
-     * @param int $index T_CLASS index
-     */
-    private function isClassCandidate(TokensAnalyzer $tokensAnalyzer, Tokens $tokens, int $index): bool
-    {
-        if ($tokensAnalyzer->isAnonymousClass($index)) {
-            return false;
-        }
-
-        $modifiers = $tokensAnalyzer->getClassyModifiers($index);
-
-        if (isset($modifiers['final']) || isset($modifiers['abstract'])) {
-            return false; // ignore class; it is abstract or already final
-        }
-
-        $decisions = [];
-        $currentIndex = $index;
-
-        $acceptTypes = [
-            CT::T_ATTRIBUTE_CLOSE,
-            T_DOC_COMMENT,
-            T_COMMENT, // Skip comments
-        ];
-
-        if (\defined('T_READONLY')) {
-            // Skip readonly classes for PHP 8.2+
-            $acceptTypes[] = T_READONLY;
-        }
-
-        while (null !== $currentIndex) {
-            $currentIndex = $tokens->getPrevNonWhitespace($currentIndex);
-
-            if (!$tokens[$currentIndex]->isGivenKind($acceptTypes)) {
-                break;
-            }
-
-            if ($this->checkAttributes && $tokens[$currentIndex]->isGivenKind(CT::T_ATTRIBUTE_CLOSE)) {
-                $attributeStartIndex = $tokens->findBlockStart(Tokens::BLOCK_TYPE_ATTRIBUTE, $currentIndex);
-                $decisions[] = $this->isClassCandidateBasedOnAttribute($tokens, $attributeStartIndex, $currentIndex);
-
-                $currentIndex = $attributeStartIndex;
-            }
-
-            if ($tokens[$currentIndex]->isGivenKind([T_DOC_COMMENT])) {
-                $decisions[] = $this->isClassCandidateBasedOnPhpDoc($tokens, $currentIndex);
-            }
-        }
-
-        if (\in_array(false, $decisions, true)) {
-            return false;
-        }
-
-        return \in_array(true, $decisions, true)
-            || ([] === $decisions && true === $this->configuration['consider_absent_docblock_as_internal_class']);
-    }
-
-    private function isClassCandidateBasedOnPhpDoc(Tokens $tokens, int $index): ?bool
-    {
-        $doc = new DocBlock($tokens[$index]->getContent());
-        $tags = [];
-
-        foreach ($doc->getAnnotations() as $annotation) {
-            if (!Preg::match('/@([^\(\s]+)/', $annotation->getContent(), $matches)) {
-                continue;
-            }
-            $tag = strtolower(substr(array_shift($matches), 1));
-
-            $tags[$tag] = true;
-        }
-
-        if (\count(array_intersect_key($this->configuration['exclude'], $tags)) > 0) {
-            return false;
-        }
-
-        if ($this->isConfiguredAsInclude($tags)) {
-            return true;
-        }
-
-        return null;
-    }
-
-    private function isClassCandidateBasedOnAttribute(Tokens $tokens, int $startIndex, int $endIndex): ?bool
-    {
-        $attributeCandidates = [];
-        $attributeString = '';
-        $currentIndex = $startIndex;
-
-        while ($currentIndex < $endIndex && null !== ($currentIndex = $tokens->getNextMeaningfulToken($currentIndex))) {
-            if (!$tokens[$currentIndex]->isGivenKind([T_STRING, T_NS_SEPARATOR])) {
-                if ('' !== $attributeString) {
-                    $attributeCandidates[$attributeString] = true;
-                    $attributeString = '';
-                }
-
-                continue;
-            }
-
-            $attributeString .= strtolower($tokens[$currentIndex]->getContent());
-        }
-
-        if (\count(array_intersect_key($this->configuration['exclude'], $attributeCandidates)) > 0) {
-            return false;
-        }
-
-        if ($this->isConfiguredAsInclude($attributeCandidates)) {
-            return true;
-        }
-
-        return null;
-    }
-
-    /**
-     * @param array<string, bool> $attributes
-     */
-    private function isConfiguredAsInclude(array $attributes): bool
-    {
-        if (0 === \count($this->configuration['include'])) {
-            return true;
-        }
-
-        return \count(array_intersect_key($this->configuration['include'], $attributes)) > 0;
-    }
-
-    private function assertConfigHasNoConflicts(): void
-    {
-        foreach (['include' => 'annotation_include', 'exclude' => 'annotation_exclude'] as $newConfigKey => $oldConfigKey) {
-            $defaults = [];
-
-            foreach (self::DEFAULTS[$newConfigKey] as $foo) {
-                $defaults[strtolower($foo)] = true;
-            }
-
-            $newConfigIsSet = $this->configuration[$newConfigKey] !== $defaults;
-            $oldConfigIsSet = $this->configuration[$oldConfigKey] !== $defaults;
-
-            if ($newConfigIsSet && $oldConfigIsSet) {
-                throw new InvalidFixerConfigurationException($this->getName(), \sprintf('Configuration cannot contain deprecated option "%s" and new option "%s".', $oldConfigKey, $newConfigKey));
-            }
-
-            if ($oldConfigIsSet) {
-                $this->configuration[$newConfigKey] = $this->configuration[$oldConfigKey]; // @phpstan-ignore-line crazy mapping, to be removed while cleaning up deprecated options
-                $this->checkAttributes = false; // run in old mode
-            }
-
-            // if ($newConfigIsSet) - only new config is set, all good
-            // if (!$newConfigIsSet && !$oldConfigIsSet) - both are set as to default values, all good
-
-            unset($this->configuration[$oldConfigKey]); // @phpstan-ignore-line crazy mapping, to be removed while cleaning up deprecated options
-        }
-
-        $intersect = array_intersect_assoc($this->configuration['include'], $this->configuration['exclude']);
-
-        if (\count($intersect) > 0) {
-            throw new InvalidFixerConfigurationException($this->getName(), \sprintf('Annotation cannot be used in both "include" and "exclude" list, got duplicates: %s.', Utils::naturalLanguageJoin(array_keys($intersect))));
-        }
-    }
-}

package/vendor/friendsofphp/php-cs-fixer/src/Fixer/ClassNotation/FinalPublicMethodForAbstractClassFixer.php

@@ -1,160 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-/*
- * This file is part of PHP CS Fixer.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
- *
- * This source file is subject to the MIT license that is bundled
- * with this source code in the file LICENSE.
- */
-
-namespace PhpCsFixer\Fixer\ClassNotation;
-
-use PhpCsFixer\AbstractFixer;
-use PhpCsFixer\FixerDefinition\CodeSample;
-use PhpCsFixer\FixerDefinition\FixerDefinition;
-use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
-use PhpCsFixer\Tokenizer\Token;
-use PhpCsFixer\Tokenizer\Tokens;
-
-/**
- * @author Filippo Tessarotto <zoeslam@gmail.com>
- */
-final class FinalPublicMethodForAbstractClassFixer extends AbstractFixer
-{
-    /**
-     * @var array<string, true>
-     */
-    private array $magicMethods = [
-        '__construct' => true,
-        '__destruct' => true,
-        '__call' => true,
-        '__callstatic' => true,
-        '__get' => true,
-        '__set' => true,
-        '__isset' => true,
-        '__unset' => true,
-        '__sleep' => true,
-        '__wakeup' => true,
-        '__tostring' => true,
-        '__invoke' => true,
-        '__set_state' => true,
-        '__clone' => true,
-        '__debuginfo' => true,
-    ];
-
-    public function getDefinition(): FixerDefinitionInterface
-    {
-        return new FixerDefinition(
-            'All `public` methods of `abstract` classes should be `final`.',
-            [
-                new CodeSample(
-                    '<?php
-
-abstract class AbstractMachine
-{
-    public function start()
-    {}
-}
-'
-                ),
-            ],
-            'Enforce API encapsulation in an inheritance architecture. '
-            .'If you want to override a method, use the Template method pattern.',
-            'Risky when overriding `public` methods of `abstract` classes.'
-        );
-    }
-
-    public function isCandidate(Tokens $tokens): bool
-    {
-        return $tokens->isAllTokenKindsFound([T_ABSTRACT, T_PUBLIC, T_FUNCTION]);
-    }
-
-    public function isRisky(): bool
-    {
-        return true;
-    }
-
-    protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
-    {
-        $abstracts = array_keys($tokens->findGivenKind(T_ABSTRACT));
-
-        foreach (array_reverse($abstracts) as $abstractIndex) {
-            $classIndex = $tokens->getNextTokenOfKind($abstractIndex, [[T_CLASS], [T_FUNCTION]]);
-            if (!$tokens[$classIndex]->isGivenKind(T_CLASS)) {
-                continue;
-            }
-
-            $classOpen = $tokens->getNextTokenOfKind($classIndex, ['{']);
-            $classClose = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_CURLY_BRACE, $classOpen);
-
-            $this->fixClass($tokens, $classOpen, $classClose);
-        }
-    }
-
-    private function fixClass(Tokens $tokens, int $classOpenIndex, int $classCloseIndex): void
-    {
-        for ($index = $classCloseIndex - 1; $index > $classOpenIndex; --$index) {
-            // skip method contents
-            if ($tokens[$index]->equals('}')) {
-                $index = $tokens->findBlockStart(Tokens::BLOCK_TYPE_CURLY_BRACE, $index);
-
-                continue;
-            }
-
-            // skip non public methods
-            if (!$tokens[$index]->isGivenKind(T_PUBLIC)) {
-                continue;
-            }
-
-            $nextIndex = $tokens->getNextMeaningfulToken($index);
-            $nextToken = $tokens[$nextIndex];
-
-            if ($nextToken->isGivenKind(T_STATIC)) {
-                $nextIndex = $tokens->getNextMeaningfulToken($nextIndex);
-                $nextToken = $tokens[$nextIndex];
-            }
-
-            // skip uses, attributes, constants etc
-            if (!$nextToken->isGivenKind(T_FUNCTION)) {
-                continue;
-            }
-
-            $nextIndex = $tokens->getNextMeaningfulToken($nextIndex);
-            $nextToken = $tokens[$nextIndex];
-
-            // skip magic methods
-            if (isset($this->magicMethods[strtolower($nextToken->getContent())])) {
-                continue;
-            }
-
-            $prevIndex = $tokens->getPrevMeaningfulToken($index);
-            $prevToken = $tokens[$prevIndex];
-
-            if ($prevToken->isGivenKind(T_STATIC)) {
-                $index = $prevIndex;
-                $prevIndex = $tokens->getPrevMeaningfulToken($index);
-                $prevToken = $tokens[$prevIndex];
-            }
-
-            // skip abstract or already final methods
-            if ($prevToken->isGivenKind([T_ABSTRACT, T_FINAL])) {
-                $index = $prevIndex;
-
-                continue;
-            }
-
-            $tokens->insertAt(
-                $index,
-                [
-                    new Token([T_FINAL, 'final']),
-                    new Token([T_WHITESPACE, ' ']),
-                ]
-            );
-        }
-    }
-}

package/vendor/friendsofphp/php-cs-fixer/src/Fixer/ClassNotation/NoBlankLinesAfterClassOpeningFixer.php

@@ -1,93 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-/*
- * This file is part of PHP CS Fixer.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
- *
- * This source file is subject to the MIT license that is bundled
- * with this source code in the file LICENSE.
- */
-
-namespace PhpCsFixer\Fixer\ClassNotation;
-
-use PhpCsFixer\AbstractFixer;
-use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
-use PhpCsFixer\FixerDefinition\CodeSample;
-use PhpCsFixer\FixerDefinition\FixerDefinition;
-use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
-use PhpCsFixer\Tokenizer\Token;
-use PhpCsFixer\Tokenizer\Tokens;
-
-/**
- * @author Ceeram <ceeram@cakephp.org>
- */
-final class NoBlankLinesAfterClassOpeningFixer extends AbstractFixer implements WhitespacesAwareFixerInterface
-{
-    public function isCandidate(Tokens $tokens): bool
-    {
-        return $tokens->isAnyTokenKindsFound(Token::getClassyTokenKinds());
-    }
-
-    public function getDefinition(): FixerDefinitionInterface
-    {
-        return new FixerDefinition(
-            'There should be no empty lines after class opening brace.',
-            [
-                new CodeSample(
-                    '<?php
-final class Sample
-{
-
-    protected function foo()
-    {
-    }
-}
-'
-                ),
-            ]
-        );
-    }
-
-    /**
-     * {@inheritdoc}
-     *
-     * Must run after OrderedClassElementsFixer, PhpUnitDataProviderMethodOrderFixer.
-     */
-    public function getPriority(): int
-    {
-        return 0;
-    }
-
-    protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
-    {
-        foreach ($tokens as $index => $token) {
-            if (!$token->isClassy()) {
-                continue;
-            }
-
-            $startBraceIndex = $tokens->getNextTokenOfKind($index, ['{']);
-            if (!$tokens[$startBraceIndex + 1]->isWhitespace()) {
-                continue;
-            }
-
-            $this->fixWhitespace($tokens, $startBraceIndex + 1);
-        }
-    }
-
-    /**
-     * Cleanup a whitespace token.
-     */
-    private function fixWhitespace(Tokens $tokens, int $index): void
-    {
-        $content = $tokens[$index]->getContent();
-        // if there is more than one new line in the whitespace, then we need to fix it
-        if (substr_count($content, "\n") > 1) {
-            // the final bit of the whitespace must be the next statement's indentation
-            $tokens[$index] = new Token([T_WHITESPACE, $this->whitespacesConfig->getLineEnding().substr($content, strrpos($content, "\n") + 1)]);
-        }
-    }
-}