Merge branch 'reduce-memory-usage'

lkrms · Mar 7, 2024 · f958f24 · f958f24
2 parents ba9f275 + b2e8ae2
commit f958f24
Show file tree

Hide file tree

Showing 16 changed files with 171 additions and 91 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -44,7 +44,7 @@ jobs:
           key: composer-cache-${{ runner.os }}-${{ hashFiles('**/composer.json', '**/composer.lock') }}
           restore-keys: composer-cache-${{ runner.os }}-
 
-      - name: Install dependencies
+      - name: Install PHP dependencies
         run: composer install --no-interaction --no-progress --no-dev
 
       - name: Run PHP CS Fixer
@@ -92,7 +92,7 @@ jobs:
           key: phpstan-cache-${{ runner.os }}-${{ matrix.php-version }}-${{ github.run_id }}
           restore-keys: phpstan-cache-${{ runner.os }}-${{ matrix.php-version }}-
 
-      - name: Install dependencies
+      - name: Install PHP dependencies
         run: composer install --no-interaction --no-progress
 
       - name: Run PHPStan
@@ -145,7 +145,7 @@ jobs:
           key: composer-cache-${{ runner.os }}-${{ hashFiles('**/composer.json', '**/composer.lock') }}
           restore-keys: composer-cache-${{ runner.os }}-
 
-      - name: Install dependencies
+      - name: Install PHP dependencies
         run: composer install --no-interaction --no-progress
 
       - name: Run PHPUnit tests and generate code coverage report
@@ -193,7 +193,7 @@ jobs:
           sudo apt-get update
           sudo apt-get install pandoc
 
-      - name: Install dependencies
+      - name: Install PHP dependencies
         run: composer install --no-interaction --no-progress
 
       # Run the phar and man builds separately and together to test each code

diff --git a/composer.json b/composer.json
@@ -21,7 +21,7 @@
         "ext-mbstring": "*",
         "ext-tokenizer": "*",
         "composer-runtime-api": "^2.2",
-        "salient/toolkit": "^0.99.0",
+        "salient/toolkit": "^0.99.10",
         "sebastian/diff": "^4 || ^5"
     },
     "autoload": {

diff --git a/composer.lock b/composer.lock
diff --git a/src/Command/FormatPhp.php b/src/Command/FormatPhp.php
@@ -33,15 +33,15 @@
 use Lkrms\PrettyPHP\Token\Token;
 use Lkrms\PrettyPHP\Formatter;
 use Lkrms\PrettyPHP\FormatterBuilder;
-use Salient\Cli\Catalog\CliHelpSectionName;
-use Salient\Cli\Catalog\CliOptionType;
-use Salient\Cli\Catalog\CliOptionValueType;
-use Salient\Cli\Catalog\CliOptionValueUnknownPolicy;
-use Salient\Cli\Catalog\CliOptionVisibility as Visibility;
 use Salient\Cli\Exception\CliInvalidArgumentsException;
 use Salient\Cli\CliCommand;
 use Salient\Cli\CliOption;
-use Salient\Console\Catalog\ConsoleLevel;
+use Salient\Contract\Cli\CliHelpSectionName;
+use Salient\Contract\Cli\CliOptionType;
+use Salient\Contract\Cli\CliOptionValueType;
+use Salient\Contract\Cli\CliOptionValueUnknownPolicy;
+use Salient\Contract\Cli\CliOptionVisibility as Visibility;
+use Salient\Contract\Core\MessageLevel as Level;
 use Salient\Core\Facade\Console;
 use Salient\Core\Facade\Profile;
 use Salient\Core\Utility\Arr;
@@ -778,7 +778,7 @@ protected function run(...$params)
         }
 
         if ($this->ReportTimers) {
-            $this->App->registerShutdownReport(ConsoleLevel::NOTICE);
+            $this->App->registerShutdownReport(Level::NOTICE);
         }
 
         if ($this->Tabs && $this->Spaces) {
@@ -1176,7 +1176,7 @@ protected function run(...$params)
         if ($this->Diff) {
             if ($this->Quiet < 2) {
                 if ($replaced) {
-                    Console::out('', ConsoleLevel::INFO);
+                    Console::out('', Level::INFO);
                 }
                 Console::log(Inflect::format(
                     $count,

diff --git a/src/Contract/Filter.php b/src/Contract/Filter.php
@@ -2,15 +2,17 @@
 
 namespace Lkrms\PrettyPHP\Contract;
 
-use Lkrms\PrettyPHP\Token\Token;
+use PhpToken;
 
 interface Filter extends Extension
 {
     /**
      * Apply the filter to an array of tokens
      *
-     * @param Token[] $tokens
-     * @return Token[]
+     * @template T of PhpToken
+     *
+     * @param T[] $tokens
+     * @return T[]
      */
     public function filterTokens(array $tokens): array;
 }
diff --git a/...xception/EnabledRulesAreNotCompatible.php → src/Exception/IncompatibleRulesException.php b/...xception/EnabledRulesAreNotCompatible.php → src/Exception/IncompatibleRulesException.php
@@ -9,7 +9,7 @@
 /**
  * Thrown when incompatible rules are enabled
  */
-class EnabledRulesAreNotCompatible extends AbstractException
+class IncompatibleRulesException extends AbstractException
 {
     /**
      * @var array<class-string<Rule>>

diff --git a/src/Filter/CollectColumn.php b/src/Filter/CollectColumn.php
@@ -2,19 +2,29 @@
 
 namespace Lkrms\PrettyPHP\Filter;
 
-use Lkrms\PrettyPHP\Concern\ExtensionTrait;
 use Lkrms\PrettyPHP\Contract\Filter;
+use Lkrms\PrettyPHP\Filter\Concern\FilterTrait;
+use Lkrms\PrettyPHP\Token\Token;
 use Salient\Core\Utility\Str;
 
 /**
  * Assign the starting column of each token to its $column property
  */
 final class CollectColumn implements Filter
 {
-    use ExtensionTrait;
+    use FilterTrait;
 
+    /**
+     * @inheritDoc
+     */
     public function filterTokens(array $tokens): array
     {
+        if (!$this->isArrayOf($tokens, Token::class)) {
+            // @codeCoverageIgnoreStart
+            return $tokens;
+            // @codeCoverageIgnoreEnd
+        }
+
         $tokens = array_values($tokens);
         $last = array_key_last($tokens);
         $column = 1;

diff --git a/src/Filter/Concern/FilterTrait.php b/src/Filter/Concern/FilterTrait.php
@@ -3,21 +3,35 @@
 namespace Lkrms\PrettyPHP\Filter\Concern;
 
 use Lkrms\PrettyPHP\Concern\ExtensionTrait;
-use Lkrms\PrettyPHP\Token\Token;
+use PhpToken;
 
 trait FilterTrait
 {
     use ExtensionTrait;
 
     /**
-     * @var Token[]
+     * @var PhpToken[]
      */
     protected array $Tokens;
 
+    /**
+     * Check if the given tokens are instances of the given class
+     *
+     * @template T of PhpToken
+     *
+     * @param PhpToken[] $tokens
+     * @param class-string<T> $class
+     * @phpstan-assert-if-true T[] $tokens
+     */
+    protected function isArrayOf(array $tokens, string $class): bool
+    {
+        return $tokens && reset($tokens) instanceof $class;
+    }
+
     /**
      * Get the given token's previous code token
      */
-    protected function prevCode(int $i): ?Token
+    protected function prevCode(int $i): ?PhpToken
     {
         while ($i--) {
             $token = $this->Tokens[$i];

diff --git a/src/Filter/RemoveHeredocIndentation.php b/src/Filter/RemoveHeredocIndentation.php
@@ -6,6 +6,7 @@
 use Lkrms\PrettyPHP\Contract\Filter;
 use Lkrms\PrettyPHP\Token\Token;
 use Salient\Core\Utility\Pcre;
+use PhpToken;
 
 /**
  * Remove indentation from heredocs
@@ -14,13 +15,19 @@ final class RemoveHeredocIndentation implements Filter
 {
     use ExtensionTrait;
 
+    /**
+     * @template T of PhpToken
+     *
+     * @param T[] $tokens
+     * @return T[]
+     */
     public function filterTokens(array $tokens): array
     {
-        /** @var array<int,Token[]> */
+        /** @var array<int,T[]> */
         $heredocTokens = [];
         /** @var array<int,string[]> */
         $heredocText = [];
-        /** @var array<int,Token> */
+        /** @var array<int,T> */
         $stack = [];
         foreach ($tokens as $i => $token) {
             if ($stack) {
@@ -73,7 +80,12 @@ public function filterTokens(array $tokens): array
 
             // Finally, update each token
             foreach ($stripped as $j => $code) {
-                $heredocTokens[$i][$j]->setText($code);
+                $token = $heredocTokens[$i][$j];
+                if ($token instanceof Token) {
+                    $token->setText($code);
+                } else {
+                    $token->text = $code;
+                }
             }
         }
 

diff --git a/src/Filter/SortImports.php b/src/Filter/SortImports.php
@@ -5,9 +5,9 @@
 use Lkrms\PrettyPHP\Catalog\ImportSortOrder;
 use Lkrms\PrettyPHP\Contract\Filter;
 use Lkrms\PrettyPHP\Filter\Concern\FilterTrait;
-use Lkrms\PrettyPHP\Token\Token;
 use Salient\Core\Utility\Arr;
 use Salient\Core\Utility\Pcre;
+use PhpToken;
 
 /**
  * Sort consecutive alias/import statements
@@ -34,7 +34,10 @@ final class SortImports implements Filter
     private array $SortableImports;
 
     /**
-     * @inheritDoc
+     * @template T of PhpToken
+     *
+     * @param T[] $tokens
+     * @return T[]
      */
     public function filterTokens(array $tokens): array
     {
@@ -44,7 +47,7 @@ public function filterTokens(array $tokens): array
 
         // Identify relevant `T_USE` tokens and exit early if possible
         $tokens = [];
-        /** @var array<int,Token> */
+        /** @var array<int,T> */
         $stack = [];
         foreach ($this->Tokens as $i => $token) {
             if ($this->TypeIndex->OpenBrace[$token->id]) {
@@ -79,11 +82,11 @@ public function filterTokens(array $tokens): array
         while ($tokens) {
             $i = array_shift($tokens);
 
-            /** @var array<non-empty-array<Token>> */
+            /** @var array<non-empty-array<T>> */
             $sort = [];
-            /** @var Token[] */
+            /** @var T[] */
             $current = [];
-            /** @var Token|null */
+            /** @var T|null */
             $terminator = null;
             while ($i < $count) {
                 $token = $this->Tokens[$i];
@@ -145,9 +148,11 @@ public function filterTokens(array $tokens): array
     }
 
     /**
-     * @param non-empty-array<non-empty-array<Token>> $sort
-     * @param Token[] $tokens
-     * @return Token[]
+     * @template T of PhpToken
+     *
+     * @param non-empty-array<non-empty-array<T>> $sort
+     * @param T[] $tokens
+     * @return T[]
      */
     private function sortImports(array $sort, array $tokens): array
     {
@@ -190,7 +195,9 @@ function (array $a, array $b): int {
     }
 
     /**
-     * @param Token[] $tokens
+     * @template T of PhpToken
+     *
+     * @param T[] $tokens
      * @return array{int,string}
      */
     private function sortableImport(array $tokens): array

diff --git a/src/Filter/TrimCasts.php b/src/Filter/TrimCasts.php
@@ -4,6 +4,7 @@
 
 use Lkrms\PrettyPHP\Concern\ExtensionTrait;
 use Lkrms\PrettyPHP\Contract\Filter;
+use Lkrms\PrettyPHP\Token\Token;
 
 /**
  * Remove whitespace inside cast operators
@@ -24,7 +25,12 @@ public function filterTokens(array $tokens): array
                     $token->id === \T_ARRAY_CAST ||
                     $token->id === \T_OBJECT_CAST ||
                     $token->id === \T_UNSET_CAST) {
-                $token->setText('(' . trim($token->text, " \n\r\t\v\0()") . ')');
+                $text = '(' . trim($token->text, " \n\r\t\v\0()") . ')';
+                if ($token instanceof Token) {
+                    $token->setText($text);
+                } else {
+                    $token->text = $text;
+                }
             }
         }