Add new linter: SameParametersLinter

Author: Lukasss93

src/Linters/SameParametersLinter.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Lukasss93\Larex\Linters;
+
+use Illuminate\Support\Collection;
+use Lukasss93\Larex\Contracts\Linter;
+use Lukasss93\Larex\Exceptions\LintException;
+use Lukasss93\Larex\Support\CsvReader;
+
+class SameParametersLinter implements Linter
+{
+    /**
+     * @inheritDoc
+     */
+    public static function description(): string
+    {
+        return 'Checking same parameters...';
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function handle(CsvReader $reader): void
+    {
+        $errors = collect([]);
+
+        //get headers
+        $headers = $reader->getHeader()->flip();
+
+        //check if all parameters are the same
+        $reader->getRows()->each(function (Collection $columns, int $line) use ($headers, &$errors) {
+            $line += 2;
+
+            $group = $columns->get('group');
+            $key = $columns->get('key');
+
+            //get parameters for every language
+            $parameters = $columns
+                ->skip(2)
+                ->map(function (string $item) {
+                    preg_match_all('/:\w+/', $item, $matches);
+
+                    return collect($matches[0] ?? []);
+                });
+
+            //get first item with max parameters count
+            /** @var Collection $max */
+            $max = $parameters->sortByDesc(fn ($item) => count($item))->first();
+
+            //check if all parameters are the same
+            foreach ($parameters as $lang => $items) {
+                $column = $headers->get($lang) + 1;
+                $value = $columns->get($lang);
+
+                if (blank($value) && config('larex.ignore_empty_values', false)) {
+                    continue;
+                }
+
+                foreach ($max->diff($items) as $param) {
+                    $errors->push("line $line ($group.$key), column $column ($lang): missing $param parameter");
+                }
+            }
+        });
+
+        if ($errors->isNotEmpty()) {
+            throw new LintException('Missing parameters found:', $errors->toArray());
+        }
+    }
+}

src/config/larex.php

@@ -58,8 +58,14 @@
         // Lukasss93\Larex\Linters\UntranslatedStringsLinter::class,
         // Lukasss93\Larex\Linters\UnusedStringsLinter::class,
         // Lukasss93\Larex\Linters\ValidHtmlValueLinter::class,
+        // Lukasss93\Larex\Linters\SameParametersLinter::class,
     ],
 
+    /**
+     * Used by SameParametersLinter
+     */
+    'ignore_empty_values' => false,
+
     /**
      * Search criteria for file used by:
      * - UntranslatedStringsLinter

tests/Linters/SameParametersLinterTest.php

@@ -0,0 +1,56 @@
+<?php
+
+use Lukasss93\Larex\Console\LarexLintCommand;
+use Lukasss93\Larex\Linters\SameParametersLinter;
+
+it('passes', function () {
+    config([
+        'larex.linters' => [SameParametersLinter::class],
+    ]);
+
+    initFromStub('linters.same-parameters.success');
+
+    $this->artisan(LarexLintCommand::class)
+        ->expectsOutput('OK (1 linter)')
+        ->assertExitCode(0);
+});
+
+it('fails', function () {
+    config([
+        'larex.linters' => [SameParametersLinter::class],
+    ]);
+
+    initFromStub('linters.same-parameters.failure');
+
+    $this->artisan(LarexLintCommand::class)
+        ->expectsOutput(' FAIL  Missing parameters found:')
+        ->expectsOutput('├ line 2 (app.hello), column 4 (it): missing :age parameter')
+        ->expectsOutput('├ line 2 (app.hello), column 5 (es): missing :name parameter')
+        ->expectsOutput('├ line 3 (app.cat), column 3 (en): missing :thing parameter')
+        ->expectsOutput('├ line 3 (app.cat), column 5 (es): missing :animal parameter')
+        ->expectsOutput('├ line 3 (app.cat), column 5 (es): missing :thing parameter')
+        ->expectsOutput('└ line 6 (app.bye), column 5 (es): missing :name parameter')
+        ->expectsOutput('FAILURES!')
+        ->expectsOutput('Linters: 1, Failures: 1')
+        ->assertExitCode(1);
+});
+
+it('fails ignoring empty values', function () {
+    config([
+        'larex.linters' => [SameParametersLinter::class],
+        'larex.ignore_empty_values' => true,
+    ]);
+
+    initFromStub('linters.same-parameters.failure');
+
+    $this->artisan(LarexLintCommand::class)
+        ->expectsOutput(' FAIL  Missing parameters found:')
+        ->expectsOutput('├ line 2 (app.hello), column 4 (it): missing :age parameter')
+        ->expectsOutput('├ line 2 (app.hello), column 5 (es): missing :name parameter')
+        ->expectsOutput('├ line 3 (app.cat), column 3 (en): missing :thing parameter')
+        ->expectsOutput('├ line 3 (app.cat), column 5 (es): missing :animal parameter')
+        ->expectsOutput('└ line 3 (app.cat), column 5 (es): missing :thing parameter')
+        ->expectsOutput('FAILURES!')
+        ->expectsOutput('Linters: 1, Failures: 1')
+        ->assertExitCode(1);
+});

tests/Stubs/linters/same-parameters/failure.stub

@@ -0,0 +1,6 @@
+group,key,en,it,es
+app,hello,My name is :name and I'm :age.,Il nome è :name.,Tengo :age años.
+app,cat,The :animal is on the table.,Il :animal è sul :thing.,El animal está sobre la mesa.
+app,yep,Yes :who can,Sì :who può,Sí :who puede
+app,nope,Nope,No,No
+app,bye,Bye :name,Ciao :name,

tests/Stubs/linters/same-parameters/success.stub

@@ -0,0 +1,2 @@
+group,key,en,it
+app,hello,My name is :name and I'm :age.,Il nome è :name e ho :age anni.