Renaming

VincentLanglet · Aug 17, 2024 · 6faa507 · 6faa507
1 parent 63ca2e7
commit 6faa507
Show file tree

Hide file tree

Showing 18 changed files with 29 additions and 32 deletions.
diff --git a/docs/custom.md b/docs/custom.md
@@ -128,9 +128,9 @@ The `TwigCsFixer\Token\Tokenizer` transform the file into a list of tokens which
 
   The `#}` delimiter.
 
-- **TwigCsFixer\Token\Token::NAMED_ARGUMENT_OPERATOR_TYPE**:
+- **TwigCsFixer\Token\Token::NAMED_ARGUMENT_SEPARATOR_TYPE**:
 
-  The `=` or `:` operator used when using named argument. Like `{{ foo(bar=true, baz: false) }}`.
+  The `=` or `:` separator used when using named argument. Like `{{ foo(bar=true, baz: false) }}`.
 
 Then, the easiest way to write a custom rule is to implement the `TwigCsFixer\Rules\AbstractRule` class
 or the `TwigCsFixer\Rules\AbstractFixableRule` if the rule can be automatically fixed.

diff --git a/docs/rules.md b/docs/rules.md
@@ -36,7 +36,7 @@
     - `spaceRatio`: how many spaces replace a tab (default 4).
     - `useTab`: indentation must be done with tab (default false).
 
-- **NamedArgumentOperatorRule**:
+- **NamedArgumentSeparatorRule**:
 
   Ensures named arguments use `:` syntax instead of `=` (For `twig/twig >= 3.12.0`).
 

diff --git a/src/Environment/StubbedEnvironment.php b/src/Environment/StubbedEnvironment.php
@@ -4,7 +4,6 @@
 
 namespace TwigCsFixer\Environment;
 
-use Composer\InstalledVersions;
 use Symfony\Bridge\Twig\TokenParser\DumpTokenParser;
 use Symfony\Bridge\Twig\TokenParser\FormThemeTokenParser;
 use Symfony\Bridge\Twig\TokenParser\StopwatchTokenParser;

diff --git a/...es/Operator/NamedArgumentOperatorRule.php → ...s/Function/NamedArgumentSeparatorRule.php b/...es/Operator/NamedArgumentOperatorRule.php → ...s/Function/NamedArgumentSeparatorRule.php
@@ -2,10 +2,8 @@
 
 declare(strict_types=1);
 
-namespace TwigCsFixer\Rules\Operator;
+namespace TwigCsFixer\Rules\Function;
 
-use Composer\InstalledVersions;
-use Composer\Semver\VersionParser;
 use TwigCsFixer\Environment\StubbedEnvironment;
 use TwigCsFixer\Rules\AbstractFixableRule;
 use TwigCsFixer\Token\Token;
@@ -14,7 +12,7 @@
 /**
  * Ensures named arguments use `:` syntax instead of `=` (For `twig/twig >= 3.12.0`).
  */
-final class NamedArgumentOperatorRule extends AbstractFixableRule
+final class NamedArgumentSeparatorRule extends AbstractFixableRule
 {
     public function __construct()
     {
@@ -26,7 +24,7 @@ public function __construct()
     protected function process(int $tokenIndex, Tokens $tokens): void
     {
         $token = $tokens->get($tokenIndex);
-        if (!$token->isMatching(Token::NAMED_ARGUMENT_OPERATOR_TYPE)) {
+        if (!$token->isMatching(Token::NAMED_ARGUMENT_SEPARATOR_TYPE)) {
             return;
         }
 
@@ -35,7 +33,7 @@ protected function process(int $tokenIndex, Tokens $tokens): void
         }
 
         $fixer = $this->addFixableError(
-            \sprintf('Named arguments should be declared with the operator "%s".', ':'),
+            \sprintf('Named arguments should be declared with the separator "%s".', ':'),
             $token
         );
 

diff --git a/...les/Operator/NamedArgumentSpacingRule.php → ...les/Function/NamedArgumentSpacingRule.php b/...les/Operator/NamedArgumentSpacingRule.php → ...les/Function/NamedArgumentSpacingRule.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace TwigCsFixer\Rules\Operator;
+namespace TwigCsFixer\Rules\Function;
 
 use TwigCsFixer\Rules\AbstractSpacingRule;
 use TwigCsFixer\Token\Token;
@@ -16,7 +16,7 @@ final class NamedArgumentSpacingRule extends AbstractSpacingRule
     protected function getSpaceBefore(int $tokenIndex, Tokens $tokens): ?int
     {
         $token = $tokens->get($tokenIndex);
-        if ($token->isMatching(Token::NAMED_ARGUMENT_OPERATOR_TYPE)) {
+        if ($token->isMatching(Token::NAMED_ARGUMENT_SEPARATOR_TYPE)) {
             return 0;
         }
 
@@ -26,10 +26,10 @@ protected function getSpaceBefore(int $tokenIndex, Tokens $tokens): ?int
     protected function getSpaceAfter(int $tokenIndex, Tokens $tokens): ?int
     {
         $token = $tokens->get($tokenIndex);
-        if ($token->isMatching(Token::NAMED_ARGUMENT_OPERATOR_TYPE, '=')) {
+        if ($token->isMatching(Token::NAMED_ARGUMENT_SEPARATOR_TYPE, '=')) {
             return 0;
         }
-        if ($token->isMatching(Token::NAMED_ARGUMENT_OPERATOR_TYPE, ':')) {
+        if ($token->isMatching(Token::NAMED_ARGUMENT_SEPARATOR_TYPE, ':')) {
             return 1;
         }
 

diff --git a/src/Standard/Twig.php b/src/Standard/Twig.php
@@ -5,7 +5,7 @@
 namespace TwigCsFixer\Standard;
 
 use TwigCsFixer\Rules\Delimiter\DelimiterSpacingRule;
-use TwigCsFixer\Rules\Operator\NamedArgumentSpacingRule;
+use TwigCsFixer\Rules\Function\NamedArgumentSpacingRule;
 use TwigCsFixer\Rules\Operator\OperatorNameSpacingRule;
 use TwigCsFixer\Rules\Operator\OperatorSpacingRule;
 use TwigCsFixer\Rules\Punctuation\PunctuationSpacingRule;

diff --git a/src/Token/Token.php b/src/Token/Token.php
@@ -42,7 +42,7 @@ final class Token
     public const COMMENT_TAB_TYPE = 'COMMENT_TAB_TYPE';
     public const COMMENT_EOL_TYPE = 'COMMENT_EOL_TYPE';
     public const COMMENT_END_TYPE = 'COMMENT_END_TYPE';
-    public const NAMED_ARGUMENT_OPERATOR_TYPE = 'NAMED_ARGUMENT_OPERATOR_TYPE';
+    public const NAMED_ARGUMENT_SEPARATOR_TYPE = 'NAMED_ARGUMENT_SEPARATOR_TYPE';
 
     public const WHITESPACE_TOKENS = [
         self::WHITESPACE_TYPE => self::WHITESPACE_TYPE,

diff --git a/src/Token/Tokenizer.php b/src/Token/Tokenizer.php
@@ -594,8 +594,8 @@ private function lexOperator(string $operator): void
             ) {
                 $bracket = end($this->bracketsAndTernary);
                 if (false !== $bracket && '(' === $bracket->getValue()) {
-                    // This is a named argument operator instead
-                    $this->pushToken(Token::NAMED_ARGUMENT_OPERATOR_TYPE, $operator);
+                    // This is a named argument separator instead
+                    $this->pushToken(Token::NAMED_ARGUMENT_SEPARATOR_TYPE, $operator);
 
                     return;
                 }
@@ -699,8 +699,8 @@ private function lexPunctuation(): void
                 return;
             }
             if ('(' === $bracket->getValue()) {
-                // This is a named argument operator instead
-                $this->pushToken(Token::NAMED_ARGUMENT_OPERATOR_TYPE, $currentCode);
+                // This is a named argument separator instead
+                $this->pushToken(Token::NAMED_ARGUMENT_SEPARATOR_TYPE, $currentCode);
 
                 return;
             }

diff --git a/.../NamedArgumentOperatorRuleTest.fixed.twig → ...NamedArgumentSeparatorRuleTest.fixed.twig b/.../NamedArgumentOperatorRuleTest.fixed.twig → ...NamedArgumentSeparatorRuleTest.fixed.twig
diff --git a/...perator/NamedArgumentOperatorRuleTest.php → ...nction/NamedArgumentSeparatorRuleTest.php b/...perator/NamedArgumentOperatorRuleTest.php → ...nction/NamedArgumentSeparatorRuleTest.php
@@ -2,23 +2,23 @@
 
 declare(strict_types=1);
 
-namespace TwigCsFixer\Tests\Rules\Operator\NamedArgumentOperator;
+namespace TwigCsFixer\Tests\Rules\Function;
 
 use Composer\InstalledVersions;
 use Composer\Semver\VersionParser;
-use TwigCsFixer\Rules\Operator\NamedArgumentOperatorRule;
+use TwigCsFixer\Rules\Function\NamedArgumentSeparatorRule;
 use TwigCsFixer\Tests\Rules\AbstractRuleTestCase;
 
-final class NamedArgumentOperatorRuleTest extends AbstractRuleTestCase
+final class NamedArgumentSeparatorRuleTest extends AbstractRuleTestCase
 {
     public function testRule(): void
     {
         if (!InstalledVersions::satisfies(new VersionParser(), 'twig/twig', '>=3.12.0')) {
             $this->expectException(\InvalidArgumentException::class);
         }
 
-        $this->checkRule(new NamedArgumentOperatorRule(), [
-            'NamedArgumentOperator.Error:1:11' => 'Named arguments should be declared with the operator ":".',
+        $this->checkRule(new NamedArgumentSeparatorRule(), [
+            'NamedArgumentSeparator.Error:1:11' => 'Named arguments should be declared with the separator ":".',
         ]);
     }
 }
diff --git a/...erator/NamedArgumentOperatorRuleTest.twig → ...ction/NamedArgumentSeparatorRuleTest.twig b/...erator/NamedArgumentOperatorRuleTest.twig → ...ction/NamedArgumentSeparatorRuleTest.twig
diff --git a/...g/NamedArgumentSpacingRuleTest.fixed.twig → ...g/NamedArgumentSpacingRuleTest.fixed.twig b/...g/NamedArgumentSpacingRuleTest.fixed.twig → ...g/NamedArgumentSpacingRuleTest.fixed.twig
diff --git a/...tSpacing/NamedArgumentSpacingRuleTest.php → ...tSpacing/NamedArgumentSpacingRuleTest.php b/...tSpacing/NamedArgumentSpacingRuleTest.php → ...tSpacing/NamedArgumentSpacingRuleTest.php
@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace TwigCsFixer\Tests\Rules\Operator\NamedArgumentSpacing;
+namespace TwigCsFixer\Tests\Rules\Function\NamedArgumentSpacing;
 
-use TwigCsFixer\Rules\Operator\NamedArgumentSpacingRule;
+use TwigCsFixer\Rules\Function\NamedArgumentSpacingRule;
 use TwigCsFixer\Tests\Rules\AbstractRuleTestCase;
 
 final class NamedArgumentSpacingRuleTest extends AbstractRuleTestCase

diff --git a/...Spacing/NamedArgumentSpacingRuleTest.twig → ...Spacing/NamedArgumentSpacingRuleTest.twig b/...Spacing/NamedArgumentSpacingRuleTest.twig → ...Spacing/NamedArgumentSpacingRuleTest.twig
diff --git a/tests/Standard/SymfonyTest.php b/tests/Standard/SymfonyTest.php
@@ -9,7 +9,7 @@
 use TwigCsFixer\Rules\File\DirectoryNameRule;
 use TwigCsFixer\Rules\File\FileExtensionRule;
 use TwigCsFixer\Rules\File\FileNameRule;
-use TwigCsFixer\Rules\Operator\NamedArgumentSpacingRule;
+use TwigCsFixer\Rules\Function\NamedArgumentSpacingRule;
 use TwigCsFixer\Rules\Operator\OperatorNameSpacingRule;
 use TwigCsFixer\Rules\Operator\OperatorSpacingRule;
 use TwigCsFixer\Rules\Punctuation\PunctuationSpacingRule;

diff --git a/tests/Standard/TwigCsFixerTest.php b/tests/Standard/TwigCsFixerTest.php
@@ -8,7 +8,7 @@
 use TwigCsFixer\Rules\Delimiter\BlockNameSpacingRule;
 use TwigCsFixer\Rules\Delimiter\DelimiterSpacingRule;
 use TwigCsFixer\Rules\Function\IncludeFunctionRule;
-use TwigCsFixer\Rules\Operator\NamedArgumentSpacingRule;
+use TwigCsFixer\Rules\Function\NamedArgumentSpacingRule;
 use TwigCsFixer\Rules\Operator\OperatorNameSpacingRule;
 use TwigCsFixer\Rules\Operator\OperatorSpacingRule;
 use TwigCsFixer\Rules\Punctuation\PunctuationSpacingRule;

diff --git a/tests/Standard/TwigTest.php b/tests/Standard/TwigTest.php
@@ -6,7 +6,7 @@
 
 use PHPUnit\Framework\TestCase;
 use TwigCsFixer\Rules\Delimiter\DelimiterSpacingRule;
-use TwigCsFixer\Rules\Operator\NamedArgumentSpacingRule;
+use TwigCsFixer\Rules\Function\NamedArgumentSpacingRule;
 use TwigCsFixer\Rules\Operator\OperatorNameSpacingRule;
 use TwigCsFixer\Rules\Operator\OperatorSpacingRule;
 use TwigCsFixer\Rules\Punctuation\PunctuationSpacingRule;

diff --git a/tests/Token/Tokenizer/TokenizerTest.php b/tests/Token/Tokenizer/TokenizerTest.php
@@ -707,7 +707,7 @@ public static function tokenizeDataProvider(): iterable
                 12 => Token::FUNCTION_NAME_TYPE,
                 13 => Token::PUNCTUATION_TYPE,
                 14 => Token::NAME_TYPE,
-                15 => Token::NAMED_ARGUMENT_OPERATOR_TYPE,
+                15 => Token::NAMED_ARGUMENT_SEPARATOR_TYPE,
                 16 => Token::NUMBER_TYPE,
                 17 => Token::PUNCTUATION_TYPE,
                 18 => Token::WHITESPACE_TYPE,
@@ -718,7 +718,7 @@ public static function tokenizeDataProvider(): iterable
                 23 => Token::FUNCTION_NAME_TYPE,
                 24 => Token::PUNCTUATION_TYPE,
                 25 => Token::NAME_TYPE,
-                26 => Token::NAMED_ARGUMENT_OPERATOR_TYPE,
+                26 => Token::NAMED_ARGUMENT_SEPARATOR_TYPE,
                 27 => Token::NUMBER_TYPE,
                 28 => Token::PUNCTUATION_TYPE,
                 29 => Token::WHITESPACE_TYPE,