@averay/codeformat 0.2.7 → 0.2.10

package/vendor/friendsofphp/php-cs-fixer/src/Fixer/Import/OrderedImportsFixer.php

@@ -1,626 +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\Import;
-
-use PhpCsFixer\AbstractFixer;
-use PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException;
-use PhpCsFixer\Console\Application;
-use PhpCsFixer\Fixer\ConfigurableFixerInterface;
-use PhpCsFixer\Fixer\ConfigurableFixerTrait;
-use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
-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\Exception\InvalidOptionsException;
-use Symfony\Component\OptionsResolver\Options;
-
-/**
- * @author Sebastiaan Stok <s.stok@rollerscapes.net>
- * @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
- * @author Darius Matulionis <darius@matulionis.lt>
- * @author Adriano Pilger <adriano.pilger@gmail.com>
- *
- * @phpstan-type _UseImportInfo array{
- *  namespace: non-empty-string,
- *  startIndex: int,
- *  endIndex: int,
- *  importType: self::IMPORT_TYPE_*,
- *  group: bool,
- * }
- *
- * @implements ConfigurableFixerInterface<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration>
- *
- * @phpstan-type _AutogeneratedInputConfiguration array{
- *  case_sensitive?: bool,
- *  imports_order?: list<string>|null,
- *  sort_algorithm?: 'alpha'|'length'|'none',
- * }
- * @phpstan-type _AutogeneratedComputedConfiguration array{
- *  case_sensitive: bool,
- *  imports_order: list<string>|null,
- *  sort_algorithm: 'alpha'|'length'|'none',
- * }
- */
-final class OrderedImportsFixer extends AbstractFixer implements ConfigurableFixerInterface, WhitespacesAwareFixerInterface
-{
-    /** @use ConfigurableFixerTrait<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration> */
-    use ConfigurableFixerTrait;
-
-    /**
-     * @internal
-     */
-    public const IMPORT_TYPE_CLASS = 'class';
-
-    /**
-     * @internal
-     */
-    public const IMPORT_TYPE_CONST = 'const';
-
-    /**
-     * @internal
-     */
-    public const IMPORT_TYPE_FUNCTION = 'function';
-
-    /**
-     * @internal
-     */
-    public const SORT_ALPHA = 'alpha';
-
-    /**
-     * @TODO 4.0 remove the possibility to sort by length
-     *
-     * @internal
-     */
-    public const SORT_LENGTH = 'length';
-
-    /**
-     * @internal
-     */
-    public const SORT_NONE = 'none';
-
-    /**
-     * Array of supported sort types in configuration.
-     *
-     * @var list<string>
-     */
-    private const SUPPORTED_SORT_TYPES = [self::IMPORT_TYPE_CLASS, self::IMPORT_TYPE_CONST, self::IMPORT_TYPE_FUNCTION];
-
-    /**
-     * Array of supported sort algorithms in configuration.
-     *
-     * @var list<string>
-     */
-    private const SUPPORTED_SORT_ALGORITHMS = [self::SORT_ALPHA, self::SORT_LENGTH, self::SORT_NONE];
-
-    public function getDefinition(): FixerDefinitionInterface
-    {
-        return new FixerDefinition(
-            'Ordering `use` statements.',
-            [
-                new CodeSample(
-                    "<?php\nuse function AAC;\nuse const AAB;\nuse AAA;\n"
-                ),
-                new CodeSample(
-                    "<?php\nuse function Aaa;\nuse const AA;\n",
-                    ['case_sensitive' => true]
-                ),
-                new CodeSample(
-                    '<?php
-use Acme\Bar;
-use Bar1;
-use Acme;
-use Bar;
-',
-                    ['sort_algorithm' => self::SORT_LENGTH]
-                ),
-                new CodeSample(
-                    '<?php
-use const AAAA;
-use const BBB;
-
-use Bar;
-use AAC;
-use Acme;
-
-use function CCC\AA;
-use function DDD;
-',
-                    [
-                        'sort_algorithm' => self::SORT_LENGTH,
-                        'imports_order' => [
-                            self::IMPORT_TYPE_CONST,
-                            self::IMPORT_TYPE_CLASS,
-                            self::IMPORT_TYPE_FUNCTION,
-                        ],
-                    ]
-                ),
-                new CodeSample(
-                    '<?php
-use const BBB;
-use const AAAA;
-
-use Acme;
-use AAC;
-use Bar;
-
-use function DDD;
-use function CCC\AA;
-',
-                    [
-                        'sort_algorithm' => self::SORT_ALPHA,
-                        'imports_order' => [
-                            self::IMPORT_TYPE_CONST,
-                            self::IMPORT_TYPE_CLASS,
-                            self::IMPORT_TYPE_FUNCTION,
-                        ],
-                    ]
-                ),
-                new CodeSample(
-                    '<?php
-use const BBB;
-use const AAAA;
-
-use function DDD;
-use function CCC\AA;
-
-use Acme;
-use AAC;
-use Bar;
-',
-                    [
-                        'sort_algorithm' => self::SORT_NONE,
-                        'imports_order' => [
-                            self::IMPORT_TYPE_CONST,
-                            self::IMPORT_TYPE_CLASS,
-                            self::IMPORT_TYPE_FUNCTION,
-                        ],
-                    ]
-                ),
-            ]
-        );
-    }
-
-    /**
-     * {@inheritdoc}
-     *
-     * Must run before BlankLineBetweenImportGroupsFixer.
-     * Must run after FullyQualifiedStrictTypesFixer, GlobalNamespaceImportFixer, NoLeadingImportSlashFixer.
-     */
-    public function getPriority(): int
-    {
-        return -30;
-    }
-
-    public function isCandidate(Tokens $tokens): bool
-    {
-        return $tokens->isTokenKindFound(T_USE);
-    }
-
-    protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
-    {
-        $tokensAnalyzer = new TokensAnalyzer($tokens);
-        $namespacesImports = $tokensAnalyzer->getImportUseIndexes(true);
-
-        foreach (array_reverse($namespacesImports) as $usesPerNamespaceIndices) {
-            $count = \count($usesPerNamespaceIndices);
-
-            if (0 === $count) {
-                continue; // nothing to sort
-            }
-
-            if (1 === $count) {
-                $this->setNewOrder($tokens, $this->getNewOrder($usesPerNamespaceIndices, $tokens));
-
-                continue;
-            }
-
-            $groupUsesOffset = 0;
-            $groupUses = [$groupUsesOffset => [$usesPerNamespaceIndices[0]]];
-
-            // if there's some logic between two `use` statements, sort only imports grouped before that logic
-            for ($index = 0; $index < $count - 1; ++$index) {
-                $nextGroupUse = $tokens->getNextTokenOfKind($usesPerNamespaceIndices[$index], [';', [T_CLOSE_TAG]]);
-
-                if ($tokens[$nextGroupUse]->isGivenKind(T_CLOSE_TAG)) {
-                    $nextGroupUse = $tokens->getNextTokenOfKind($usesPerNamespaceIndices[$index], [[T_OPEN_TAG]]);
-                }
-
-                $nextGroupUse = $tokens->getNextMeaningfulToken($nextGroupUse);
-
-                if ($nextGroupUse !== $usesPerNamespaceIndices[$index + 1]) {
-                    $groupUses[++$groupUsesOffset] = [];
-                }
-
-                $groupUses[$groupUsesOffset][] = $usesPerNamespaceIndices[$index + 1];
-            }
-
-            for ($index = $groupUsesOffset; $index >= 0; --$index) {
-                $this->setNewOrder($tokens, $this->getNewOrder($groupUses[$index], $tokens));
-            }
-        }
-    }
-
-    protected function createConfigurationDefinition(): FixerConfigurationResolverInterface
-    {
-        $supportedSortTypes = self::SUPPORTED_SORT_TYPES;
-        $fixerName = $this->getName();
-
-        return new FixerConfigurationResolver([
-            (new FixerOptionBuilder('sort_algorithm', 'Whether the statements should be sorted alphabetically or by length (*deprecated*), or not sorted.')) // @TODO 4.0 drop 'length'
-                ->setAllowedValues(self::SUPPORTED_SORT_ALGORITHMS)
-                ->setDefault(self::SORT_ALPHA)
-                ->setNormalizer(static function (Options $options, ?string $value) use ($fixerName): ?string {
-                    if (self::SORT_LENGTH === $value) {
-                        Utils::triggerDeprecation(new InvalidFixerConfigurationException($fixerName, \sprintf(
-                            'Option "sort_algorithm:%s" is deprecated and will be removed in version %d.0.',
-                            self::SORT_LENGTH,
-                            Application::getMajorVersion() + 1,
-                        )));
-                    }
-
-                    return $value;
-                })
-                ->getOption(),
-            (new FixerOptionBuilder('imports_order', 'Defines the order of import types.'))
-                ->setAllowedTypes(['string[]', 'null'])
-                ->setAllowedValues([static function (?array $value) use ($supportedSortTypes): bool {
-                    if (null !== $value) {
-                        $missing = array_diff($supportedSortTypes, $value);
-                        if (\count($missing) > 0) {
-                            throw new InvalidOptionsException(\sprintf(
-                                'Missing sort %s %s.',
-                                1 === \count($missing) ? 'type' : 'types',
-                                Utils::naturalLanguageJoin($missing)
-                            ));
-                        }
-
-                        $unknown = array_diff($value, $supportedSortTypes);
-                        if (\count($unknown) > 0) {
-                            throw new InvalidOptionsException(\sprintf(
-                                'Unknown sort %s %s.',
-                                1 === \count($unknown) ? 'type' : 'types',
-                                Utils::naturalLanguageJoin($unknown)
-                            ));
-                        }
-                    }
-
-                    return true;
-                }])
-                ->setDefault(null) // @TODO 4.0 set to ['class', 'function', 'const']
-                ->getOption(),
-            (new FixerOptionBuilder('case_sensitive', 'Whether the sorting should be case sensitive.'))
-                ->setAllowedTypes(['bool'])
-                ->setDefault(false)
-                ->getOption(),
-        ]);
-    }
-
-    /**
-     * This method is used for sorting the uses in a namespace.
-     *
-     * @param _UseImportInfo $first
-     * @param _UseImportInfo $second
-     */
-    private function sortAlphabetically(array $first, array $second): int
-    {
-        // Replace backslashes by spaces and remove opening braces before sorting for correct sort order
-        $firstNamespace = str_replace(['\\', '{'], [' ', ''], $this->prepareNamespace($first['namespace']));
-        $secondNamespace = str_replace(['\\', '{'], [' ', ''], $this->prepareNamespace($second['namespace']));
-
-        return true === $this->configuration['case_sensitive']
-            ? $firstNamespace <=> $secondNamespace
-            : strcasecmp($firstNamespace, $secondNamespace);
-    }
-
-    /**
-     * This method is used for sorting the uses statements in a namespace by length.
-     *
-     * @param _UseImportInfo $first
-     * @param _UseImportInfo $second
-     */
-    private function sortByLength(array $first, array $second): int
-    {
-        $firstNamespace = (self::IMPORT_TYPE_CLASS === $first['importType'] ? '' : $first['importType'].' ').$this->prepareNamespace($first['namespace']);
-        $secondNamespace = (self::IMPORT_TYPE_CLASS === $second['importType'] ? '' : $second['importType'].' ').$this->prepareNamespace($second['namespace']);
-
-        $firstNamespaceLength = \strlen($firstNamespace);
-        $secondNamespaceLength = \strlen($secondNamespace);
-
-        if ($firstNamespaceLength === $secondNamespaceLength) {
-            $sortResult = true === $this->configuration['case_sensitive']
-                ? $firstNamespace <=> $secondNamespace
-                : strcasecmp($firstNamespace, $secondNamespace);
-        } else {
-            $sortResult = $firstNamespaceLength > $secondNamespaceLength ? 1 : -1;
-        }
-
-        return $sortResult;
-    }
-
-    private function prepareNamespace(string $namespace): string
-    {
-        return trim(Preg::replace('%/\*(.*)\*/%s', '', $namespace));
-    }
-
-    /**
-     * @param list<int> $uses
-     *
-     * @return array<int, _UseImportInfo>
-     */
-    private function getNewOrder(array $uses, Tokens $tokens): array
-    {
-        $indices = [];
-        $originalIndices = [];
-        $lineEnding = $this->whitespacesConfig->getLineEnding();
-        $usesCount = \count($uses);
-
-        for ($i = 0; $i < $usesCount; ++$i) {
-            $index = $uses[$i];
-
-            $startIndex = $tokens->getTokenNotOfKindsSibling($index + 1, 1, [T_WHITESPACE]);
-            $endIndex = $tokens->getNextTokenOfKind($startIndex, [';', [T_CLOSE_TAG]]);
-            $previous = $tokens->getPrevMeaningfulToken($endIndex);
-
-            $group = $tokens[$previous]->isGivenKind(CT::T_GROUP_IMPORT_BRACE_CLOSE);
-            if ($tokens[$startIndex]->isGivenKind(CT::T_CONST_IMPORT)) {
-                $type = self::IMPORT_TYPE_CONST;
-                $index = $tokens->getNextNonWhitespace($startIndex);
-            } elseif ($tokens[$startIndex]->isGivenKind(CT::T_FUNCTION_IMPORT)) {
-                $type = self::IMPORT_TYPE_FUNCTION;
-                $index = $tokens->getNextNonWhitespace($startIndex);
-            } else {
-                $type = self::IMPORT_TYPE_CLASS;
-                $index = $startIndex;
-            }
-
-            $namespaceTokens = [];
-
-            while ($index <= $endIndex) {
-                $token = $tokens[$index];
-
-                if ($index === $endIndex || (!$group && $token->equals(','))) {
-                    if ($group && self::SORT_NONE !== $this->configuration['sort_algorithm']) {
-                        // if group import, sort the items within the group definition
-
-                        // figure out where the list of namespace parts within the group def. starts
-                        $namespaceTokensCount = \count($namespaceTokens) - 1;
-                        $namespace = '';
-                        for ($k = 0; $k < $namespaceTokensCount; ++$k) {
-                            if ($namespaceTokens[$k]->isGivenKind(CT::T_GROUP_IMPORT_BRACE_OPEN)) {
-                                $namespace .= '{';
-
-                                break;
-                            }
-
-                            $namespace .= $namespaceTokens[$k]->getContent();
-                        }
-
-                        // fetch all parts, split up in an array of strings, move comments to the end
-                        $parts = [];
-                        $firstIndent = '';
-                        $separator = ', ';
-                        $lastIndent = '';
-                        $hasGroupTrailingComma = false;
-
-                        for ($k1 = $k + 1; $k1 < $namespaceTokensCount; ++$k1) {
-                            $comment = '';
-                            $namespacePart = '';
-                            for ($k2 = $k1;; ++$k2) {
-                                if ($namespaceTokens[$k2]->equalsAny([',', [CT::T_GROUP_IMPORT_BRACE_CLOSE]])) {
-                                    break;
-                                }
-
-                                if ($namespaceTokens[$k2]->isComment()) {
-                                    $comment .= $namespaceTokens[$k2]->getContent();
-
-                                    continue;
-                                }
-
-                                // if there is any line ending inside the group import, it should be indented properly
-                                if (
-                                    '' === $firstIndent
-                                    && $namespaceTokens[$k2]->isWhitespace()
-                                    && str_contains($namespaceTokens[$k2]->getContent(), $lineEnding)
-                                ) {
-                                    $lastIndent = $lineEnding;
-                                    $firstIndent = $lineEnding.$this->whitespacesConfig->getIndent();
-                                    $separator = ','.$firstIndent;
-                                }
-
-                                $namespacePart .= $namespaceTokens[$k2]->getContent();
-                            }
-
-                            $namespacePart = trim($namespacePart);
-                            if ('' === $namespacePart) {
-                                $hasGroupTrailingComma = true;
-
-                                continue;
-                            }
-
-                            $comment = trim($comment);
-                            if ('' !== $comment) {
-                                $namespacePart .= ' '.$comment;
-                            }
-
-                            $parts[] = $namespacePart;
-
-                            $k1 = $k2;
-                        }
-
-                        $sortedParts = $parts;
-                        sort($parts);
-
-                        // check if the order needs to be updated, otherwise don't touch as we might change valid CS (to other valid CS).
-                        if ($sortedParts === $parts) {
-                            $namespace = Tokens::fromArray($namespaceTokens)->generateCode();
-                        } else {
-                            $namespace .= $firstIndent.implode($separator, $parts).($hasGroupTrailingComma ? ',' : '').$lastIndent.'}';
-                        }
-                    } else {
-                        $namespace = Tokens::fromArray($namespaceTokens)->generateCode();
-                    }
-
-                    $indices[$startIndex] = [
-                        'namespace' => $namespace,
-                        'startIndex' => $startIndex,
-                        'endIndex' => $index - 1,
-                        'importType' => $type,
-                        'group' => $group,
-                    ];
-
-                    $originalIndices[] = $startIndex;
-
-                    if ($index === $endIndex) {
-                        break;
-                    }
-
-                    $namespaceTokens = [];
-                    $nextPartIndex = $tokens->getTokenNotOfKindSibling($index, 1, [',', [T_WHITESPACE]]);
-                    $startIndex = $nextPartIndex;
-                    $index = $nextPartIndex;
-
-                    continue;
-                }
-
-                $namespaceTokens[] = $token;
-                ++$index;
-            }
-        }
-
-        // Is sort types provided, sorting by groups and each group by algorithm
-        if (null !== $this->configuration['imports_order']) {
-            // Grouping indices by import type.
-            $groupedByTypes = [];
-
-            foreach ($indices as $startIndex => $item) {
-                $groupedByTypes[$item['importType']][$startIndex] = $item;
-            }
-
-            // Sorting each group by algorithm.
-            foreach ($groupedByTypes as $type => $groupIndices) {
-                $groupedByTypes[$type] = $this->sortByAlgorithm($groupIndices);
-            }
-
-            // Ordering groups
-            $sortedGroups = [];
-
-            foreach ($this->configuration['imports_order'] as $type) {
-                if (isset($groupedByTypes[$type]) && [] !== $groupedByTypes[$type]) {
-                    foreach ($groupedByTypes[$type] as $startIndex => $item) {
-                        $sortedGroups[$startIndex] = $item;
-                    }
-                }
-            }
-
-            $indices = $sortedGroups;
-        } else {
-            // Sorting only by algorithm
-            $indices = $this->sortByAlgorithm($indices);
-        }
-
-        $index = -1;
-        $usesOrder = [];
-
-        // Loop through the index but use original index order
-        foreach ($indices as $v) {
-            $usesOrder[$originalIndices[++$index]] = $v;
-        }
-
-        return $usesOrder;
-    }
-
-    /**
-     * @param array<int, _UseImportInfo> $indices
-     *
-     * @return array<int, _UseImportInfo>
-     */
-    private function sortByAlgorithm(array $indices): array
-    {
-        if (self::SORT_ALPHA === $this->configuration['sort_algorithm']) {
-            uasort($indices, [$this, 'sortAlphabetically']);
-        } elseif (self::SORT_LENGTH === $this->configuration['sort_algorithm']) {
-            uasort($indices, [$this, 'sortByLength']);
-        }
-
-        return $indices;
-    }
-
-    /**
-     * @param array<int, _UseImportInfo> $usesOrder
-     */
-    private function setNewOrder(Tokens $tokens, array $usesOrder): void
-    {
-        $mapStartToEnd = [];
-
-        foreach ($usesOrder as $use) {
-            $mapStartToEnd[$use['startIndex']] = $use['endIndex'];
-        }
-
-        // Now insert the new tokens, starting from the end
-        foreach (array_reverse($usesOrder, true) as $index => $use) {
-            $code = \sprintf(
-                '<?php use %s%s;',
-                self::IMPORT_TYPE_CLASS === $use['importType'] ? '' : ' '.$use['importType'].' ',
-                $use['namespace']
-            );
-
-            $numberOfInitialTokensToClear = 3; // clear `<?php use `
-            if (self::IMPORT_TYPE_CLASS !== $use['importType']) {
-                $prevIndex = $tokens->getPrevMeaningfulToken($index);
-                if ($tokens[$prevIndex]->equals(',')) {
-                    $numberOfInitialTokensToClear = 5; // clear `<?php use const ` or `<?php use function `
-                }
-            }
-
-            $declarationTokens = Tokens::fromCode($code);
-            $declarationTokens->clearRange(0, $numberOfInitialTokensToClear - 1);
-            $declarationTokens->clearAt(\count($declarationTokens) - 1); // clear `;`
-            $declarationTokens->clearEmptyTokens();
-
-            $tokens->overrideRange($index, $mapStartToEnd[$index], $declarationTokens);
-
-            if ($use['group']) {
-                // a group import must start with `use` and cannot be part of comma separated import list
-                self::fixCommaToUse($tokens, $tokens->getPrevMeaningfulToken($index));
-
-                $closeGroupIndex = $tokens->getNextTokenOfKind($index, [[CT::T_GROUP_IMPORT_BRACE_CLOSE]]);
-                self::fixCommaToUse($tokens, $tokens->getNextMeaningfulToken($closeGroupIndex));
-            }
-        }
-    }
-
-    private static function fixCommaToUse(Tokens $tokens, int $index): void
-    {
-        if (!$tokens[$index]->equals(',')) {
-            return;
-        }
-
-        $tokens[$index] = new Token(';');
-        $tokens->insertAt($index + 1, new Token([T_USE, 'use']));
-
-        if (!$tokens[$index + 2]->isWhitespace()) {
-            $tokens->insertAt($index + 2, new Token([T_WHITESPACE, ' ']));
-        }
-    }
-}