Refactor language key generation

Author: dmason30

src/Contracts/Collections/ResultObjectCollection.php

@@ -10,7 +10,7 @@
 
 /**
  * @method self __construct(ResultObject[] $items = null)
- * @method self push(ResultObject[] ...$items)
+ * @method self push(ResultObject $item)
  */
 interface ResultObjectCollection extends Arrayable, Enumerable
 {

src/Contracts/Factories/LanguageKeyFactory.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Fidum\LaravelTranslationLinter\Contracts\Factories;
+
+use Symfony\Component\Finder\SplFileInfo;
+
+interface LanguageKeyFactory
+{
+    public function getLanguageKey(SplFileInfo $file, string $locale, string $key): string;
+}

src/Contracts/Readers/LanguageFileReader.php

@@ -6,5 +6,5 @@
 
 interface LanguageFileReader
 {
-    public function execute(SplFileInfo $file): array;
+    public function getTranslations(SplFileInfo $file): array;
 }

src/Factories/LanguageKeyFactory.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Fidum\LaravelTranslationLinter\Factories;
+
+use Fidum\LaravelTranslationLinter\Contracts\Factories\LanguageKeyFactory as LanguageKeyFactoryContract;
+use Fidum\LaravelTranslationLinter\Managers\LanguageFileReaderManager;
+use Symfony\Component\Finder\SplFileInfo;
+
+class LanguageKeyFactory implements LanguageKeyFactoryContract
+{
+    public function __construct(protected LanguageFileReaderManager $manager) {}
+
+    public function getLanguageKey(SplFileInfo $file, string $locale, string $key): string
+    {
+        $extension = $file->getExtension();
+
+        if ($this->manager->isEnabled($extension)) {
+            $reader = $this->manager->driver($extension);
+
+            if ($reader instanceof LanguageKeyFactoryContract) {
+                return $reader->getLanguageKey($file, $locale, $key);
+            }
+        }
+
+        return $key;
+    }
+}

src/LaravelTranslationLinterServiceProvider.php

@@ -9,13 +9,15 @@
 use Fidum\LaravelTranslationLinter\Contracts\Collections\ResultObjectCollection as ResultObjectCollectionContract;
 use Fidum\LaravelTranslationLinter\Contracts\Collections\UnusedFieldCollection as UnusedFieldCollectionContract;
 use Fidum\LaravelTranslationLinter\Contracts\Collections\UnusedFilterCollection as UnusedFilterCollectionContract;
+use Fidum\LaravelTranslationLinter\Contracts\Factories\LanguageKeyFactory as LanguageKeyFactoryContract;
 use Fidum\LaravelTranslationLinter\Contracts\Finders\ApplicationFileFinder as ApplicationFileFinderContract;
 use Fidum\LaravelTranslationLinter\Contracts\Finders\LanguageFileFinder as LanguageFileFinderContract;
 use Fidum\LaravelTranslationLinter\Contracts\Finders\LanguageNamespaceFinder as LanguageNamespaceFinderContract;
 use Fidum\LaravelTranslationLinter\Contracts\Linters\UnusedTranslationLinter as UnusedTranslationLinterContract;
 use Fidum\LaravelTranslationLinter\Contracts\Parsers\ApplicationFileParser as ApplicationFileParserContract;
 use Fidum\LaravelTranslationLinter\Contracts\Readers\ApplicationFileReader as ApplicationFileReaderContract;
 use Fidum\LaravelTranslationLinter\Contracts\Readers\LanguageFileReader as LanguageFileReaderContract;
+use Fidum\LaravelTranslationLinter\Factories\LanguageKeyFactory;
 use Fidum\LaravelTranslationLinter\Finders\ApplicationFileFinder;
 use Fidum\LaravelTranslationLinter\Finders\LanguageFileFinder;
 use Fidum\LaravelTranslationLinter\Finders\LanguageNamespaceFinder;
@@ -68,6 +70,8 @@ public function registeringPackage()
             ->needs('$driverConfig')
             ->giveConfig('translation-linter.lang.readers');
 
+        $this->app->bind(LanguageKeyFactoryContract::class, LanguageKeyFactory::class);
+
         $this->app->bind(LanguageNamespaceFinderContract::class, LanguageNamespaceFinder::class);
 
         $this->app->bind(ResultObjectCollectionContract::class, ResultObjectCollection::class);
@@ -96,6 +100,7 @@ public function provides()
             LanguageFileFinderContract::class,
             LanguageFileReaderContract::class,
             LanguageFileReaderManager::class,
+            LanguageKeyFactoryContract::class,
             LanguageNamespaceFinderContract::class,
             ResultObjectCollectionContract::class,
             UnusedFieldCollectionContract::class,

src/Linters/UnusedTranslationLinter.php

@@ -3,12 +3,13 @@
 namespace Fidum\LaravelTranslationLinter\Linters;
 
 use Fidum\LaravelTranslationLinter\Contracts\Collections\ResultObjectCollection;
+use Fidum\LaravelTranslationLinter\Contracts\Factories\LanguageKeyFactory;
 use Fidum\LaravelTranslationLinter\Contracts\Finders\LanguageFileFinder;
+use Fidum\LaravelTranslationLinter\Contracts\Finders\LanguageNamespaceFinder;
 use Fidum\LaravelTranslationLinter\Contracts\Linters\UnusedTranslationLinter as UnusedTranslationLinterContract;
+use Fidum\LaravelTranslationLinter\Contracts\Readers\ApplicationFileReader;
+use Fidum\LaravelTranslationLinter\Contracts\Readers\LanguageFileReader;
 use Fidum\LaravelTranslationLinter\Data\ResultObject;
-use Fidum\LaravelTranslationLinter\Finders\LanguageNamespaceFinder;
-use Fidum\LaravelTranslationLinter\Readers\ApplicationFileReader;
-use Fidum\LaravelTranslationLinter\Readers\LanguageFileReader;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
 use Illuminate\Support\Stringable;
@@ -20,6 +21,7 @@ public function __construct(
         protected ApplicationFileReader $used,
         protected LanguageFileFinder $files,
         protected LanguageFileReader $translations,
+        protected LanguageKeyFactory $factory,
         protected LanguageNamespaceFinder $namespaces,
         protected ResultObjectCollection $results,
         protected array $locales,
@@ -37,10 +39,10 @@ public function execute(): ResultObjectCollection
 
                 /** @var SplFileInfo $file */
                 foreach ($files as $file) {
-                    $translations = $this->translations->execute($file);
+                    $translations = $this->translations->getTranslations($file);
 
                     foreach ($translations as $field => $children) {
-                        $group = $this->getLanguageKey($file, $locale, $field);
+                        $group = $this->factory->getLanguageKey($file, $locale, $field);
 
                         foreach (Arr::dot(Arr::wrap($children)) as $key => $value) {
                             $groupedKey = Str::of($group)
@@ -70,19 +72,4 @@ public function execute(): ResultObjectCollection
 
         return $this->results;
     }
-
-    protected function getLanguageKey(SplFileInfo $file, string $language, string $key): string
-    {
-        if ($file->getExtension() === 'json') {
-            return $key;
-        }
-
-        return Str::of($file->getPath())
-            ->finish(DIRECTORY_SEPARATOR)
-            ->after(DIRECTORY_SEPARATOR.$language.DIRECTORY_SEPARATOR)
-            ->append($file->getFilenameWithoutExtension())
-            ->append('.')
-            ->append($key)
-            ->toString();
-    }
 }

src/Readers/JsonFileReader.php

@@ -8,7 +8,7 @@
 
 class JsonFileReader implements LanguageFileReaderContract
 {
-    public function execute(SplFileInfo $file): array
+    public function getTranslations(SplFileInfo $file): array
     {
         $translations = json_decode($file->getContents(), true);
 

src/Readers/LanguageFileReader.php

@@ -11,13 +11,13 @@ class LanguageFileReader implements LanguageFileReaderContract
 {
     public function __construct(protected LanguageFileReaderManager $manager) {}
 
-    public function execute(SplFileInfo $file): array
+    public function getTranslations(SplFileInfo $file): array
     {
         $extension = $file->getExtension();
         $translations = [];
 
         if ($this->manager->isEnabled($extension)) {
-            $translations = $this->manager->driver($extension)->execute($file);
+            $translations = $this->manager->driver($extension)->getTranslations($file);
 
             if (! $translations) {
                 throw new InvalidArgumentException("Unable to extract any data from {$file->getPathname()}!");

src/Readers/PhpFileReader.php

@@ -2,13 +2,26 @@
 
 namespace Fidum\LaravelTranslationLinter\Readers;
 
+use Fidum\LaravelTranslationLinter\Contracts\Factories\LanguageKeyFactory as LanguageKeyFactoryContract;
 use Fidum\LaravelTranslationLinter\Contracts\Readers\LanguageFileReader as LanguageFileReaderContract;
+use Illuminate\Support\Str;
 use InvalidArgumentException;
 use Symfony\Component\Finder\SplFileInfo;
 
-class PhpFileReader implements LanguageFileReaderContract
+class PhpFileReader implements LanguageFileReaderContract, LanguageKeyFactoryContract
 {
-    public function execute(SplFileInfo $file): array
+    public function getLanguageKey(SplFileInfo $file, string $locale, string $key): string
+    {
+        return Str::of($file->getPath())
+            ->finish(DIRECTORY_SEPARATOR)
+            ->after(DIRECTORY_SEPARATOR.$locale.DIRECTORY_SEPARATOR)
+            ->append($file->getFilenameWithoutExtension())
+            ->append('.')
+            ->append($key)
+            ->toString();
+    }
+
+    public function getTranslations(SplFileInfo $file): array
     {
         $translations = include $file->getPathname();