use php-parser for deadcode

Author: QuentinGab

composer.json

@@ -22,6 +22,7 @@
         "php": "^8.2",
         "deeplcom/deepl-php": "^1.7",
         "illuminate/contracts": "^10.0||^11.0",
+        "nikic/php-parser": "^5.1",
         "openai-php/laravel": "^0.10.1",
         "spatie/laravel-package-tools": "^1.16",
         "spatie/regex": "^3.1",

config/translator.php

@@ -41,10 +41,10 @@
     ],
 
     'searchcode' => [
-        'service' => 'regex',
+        'service' => 'php-parser',
 
         'services' => [
-            'regex' => [
+            'php-parser' => [
                 'paths' => [
                     app_path(),
                     resource_path(),

src/Services/SearchCode/RegexService.php renamed to src/Services/SearchCode/PhpParserService.php

@@ -2,17 +2,17 @@
 
 namespace Elegantly\Translator\Services\SearchCode;
 
-use Spatie\Regex\MatchResult;
-use Spatie\Regex\Regex;
+use Illuminate\Support\Facades\Blade;
+use PhpParser\Node;
+use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Scalar\String_;
+use PhpParser\NodeFinder;
+use PhpParser\ParserFactory;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Finder\SplFileInfo;
 
-class RegexService implements SearchCodeServiceInterface
+class PhpParserService implements SearchCodeServiceInterface
 {
-    public static $patterns = [
-        '/__\(["\'](?<key>[a-z0-9.\-_]+)["\']\)/i',
-    ];
-
     public function __construct(
         public array $paths
     ) {
@@ -38,22 +38,41 @@ public function finder(): Finder
      */
     public static function scanCode(string $code): array
     {
-        $chunks = collect(explode("\n", $code));
 
-        return $chunks
-            ->flatMap(function (string $code) {
-                return collect(static::$patterns)
-                    ->flatMap(fn (string $pattern) => Regex::matchAll($pattern, $code)->results())
-                    ->map(fn (MatchResult $matchResult) => $matchResult->group('key'));
+        $parser = (new ParserFactory)->createForNewestSupportedVersion();
+
+        $ast = $parser->parse($code);
+
+        $nodeFinder = new NodeFinder;
+
+        /** @var FuncCall[] $results */
+        $results = $nodeFinder->find($ast, function (Node $node) {
+            return $node instanceof FuncCall
+                && in_array($node->name->name, ['__', 'trans', 'trans_choice']);
+        });
+
+        return collect($results)
+            ->map(function (FuncCall $funcCall) {
+                $args = collect($funcCall->getArgs());
+                $argKey = $args->firstWhere('name.name', 'key') ?? $args->first();
+                $value = $argKey->value;
+
+                return $value instanceof String_ ? $value->value : null;
             })
+            ->values()
             ->toArray();
     }
 
     public function translationsByFiles(): array
     {
         return collect($this->finder())
-            ->keyBy(fn (SplFileInfo $file) => $file->getRealPath())
-            ->map(fn (SplFileInfo $file) => static::scanCode($file->getContents()))
+            ->map(function (SplFileInfo $file) {
+                $content = str($file->getFilename())->endsWith('.blade.php')
+                    ? Blade::compileString($file->getContents())
+                    : $file->getContents();
+
+                return static::scanCode($content);
+            })
             ->filter()
             ->toArray();
     }

src/Services/SearchCode/SearchCodeServiceInterface.php

@@ -4,6 +4,9 @@
 
 interface SearchCodeServiceInterface
 {
+    /**
+     * @return array<string, string[]>
+     */
     public function translationsByFiles(): array;
 
     /**

src/TranslatorServiceProvider.php

@@ -8,7 +8,7 @@
 use Elegantly\Translator\Commands\TranslateTranslationsCommand;
 use Elegantly\Translator\Services\Grammar\GrammarServiceInterface;
 use Elegantly\Translator\Services\Grammar\OpenAiService as GrammarOpenAiService;
-use Elegantly\Translator\Services\SearchCode\RegexService;
+use Elegantly\Translator\Services\SearchCode\PhpParserService;
 use Elegantly\Translator\Services\SearchCode\SearchCodeServiceInterface;
 use Elegantly\Translator\Services\Translate\DeepLService;
 use Elegantly\Translator\Services\Translate\OpenAiService;
@@ -88,7 +88,7 @@ public static function getSearchcodeServiceFromConfig(?string $serviceName = nul
         $service = $serviceName ?? config('translator.searchcode.service');
 
         return match ($service) {
-            'regex', RegexService::class => new RegexService(
+            'php-parser', PhpParserService::class => new PhpParserService(
                 config('translator.searchcode.services.regex.paths')
             ),
             '', null => null,

tests/Feature/TranslatorTest.php

@@ -1,6 +1,6 @@
 <?php
 
-use Elegantly\Translator\Services\SearchCode\RegexService;
+use Elegantly\Translator\Services\SearchCode\PhpParserService;
 use Elegantly\Translator\Translator;
 
 it('gets locales', function () {
@@ -88,7 +88,7 @@
 it('finds dead translations', function () {
     $translator = new Translator(
         storage: $this->getStorage(),
-        searchcodeService: new RegexService([
+        searchcodeService: new PhpParserService([
             $this->getAppPath(),
             $this->getResourcesPath(),
         ])

tests/Unit/RegexServiceTest.php renamed to tests/Unit/PhpParserServiceTest.php

@@ -1,13 +1,27 @@
 <?php
 
-use Elegantly\Translator\Services\SearchCode\RegexService;
+use Elegantly\Translator\Services\SearchCode\PhpParserService;
+
+it('finds all occurences of __ in code', function (string $code) {
+    $results = PhpParserService::scanCode($code);
+
+    expect($results)->toHaveLength(1);
+})->with([
+    "<?php __('messages.dummy.class');",
+    "<?php trans('messages.dummy.class');",
+    "<?php trans_choice('messages.dummy.class', 1);",
+    "<?php __('messages.dummy.class', []);",
+    "<?php __('messages.dummy.class', [], 'en');",
+    "<?php __(key: 'messages.dummy.class');",
+    "<?php __(key: 'messages.dummy.class', replace: [], locale: 'en');",
+]);
 
 it('gets all the translations keys grouped by files', function () {
 
     $appPath = $this->getAppPath();
     $resourcesPath = $this->getResourcesPath();
 
-    $service = new RegexService(
+    $service = new PhpParserService(
         paths: [
             $appPath,
             $resourcesPath,
@@ -34,7 +48,7 @@
     $appPath = $this->getAppPath();
     $resourcesPath = $this->getResourcesPath();
 
-    $service = new RegexService(
+    $service = new PhpParserService(
         paths: [
             $appPath,
             $resourcesPath,

tests/src/app/DummyClass.php

@@ -6,6 +6,6 @@ class DummyClass
 {
     public function getLabel()
     {
-        return __('messages.dummy.class');
+        return __(key: 'messages.dummy.class');
     }
 }