Add translation generator tests

src/Generators/TranslationsGenerator.php

@@ -13,16 +13,16 @@ public function __construct()
     {
         parent::__construct();
 
-        $this->translationPath = Arr::get($this->paths, 'translations', 'resources/lang/en/validation.php');
+        $this->translationPath = base_path(Arr::get($this->paths, 'translations', 'resources/lang/en/validation.php'));
     }
 
     public function generate(): void
     {
         if (!file_exists($this->translationPath) && $this->isStubExists('validation')) {
             $this->createTranslate();
         }
-        
-        if ($this->isTranslationMissed('validation.exceptions.not_found') && $this->isStubExists('translation_not_found')) {
+
+        if (file_exists($this->translationPath) && $this->isTranslationMissed('validation.exceptions.not_found') && $this->isStubExists('translation_not_found')) {
             $this->appendNotFoundException();
         }
     }
@@ -41,20 +41,20 @@ protected function createTranslate(): void
         file_put_contents($this->translationPath, $content);
 
         $createMessage = "Created a new Translations dump on path: {$this->translationPath}";
-        
+
         event(new SuccessCreateMessage($createMessage));
     }
 
     protected function appendNotFoundException(): void
     {
         $content = file_get_contents($this->translationPath);
-        
+
         $stubPath = config('entity-generator.stubs.translation_not_found');
-        
+
         $stubContent = view($stubPath)->render();
 
-        $fixedContent = preg_replace('/\]\;\s*$/', "\n\t{$stubContent}", $content);
-        
+        $fixedContent = preg_replace('/\]\;\s*$/', "\n    {$stubContent}", $content);
+
         file_put_contents($this->translationPath, $fixedContent);
     }
-}
+}

stubs/translation_not_found.blade.php

@@ -9,6 +9,6 @@
 
     'exceptions' => [
         'not_found' => ':Entity does not exist',
-    ]
+    ],
 
 ];

stubs/validation.blade.php

@@ -127,6 +127,6 @@
 
     'exceptions' => [
         'not_found' => ':Entity does not exist',
-    ]
+    ],
 
 ];

tests/Support/FileSystemMock.php

@@ -17,6 +17,7 @@ class FileSystemMock
     public ?array $testClasses = null;
     public ?array $routes = null;
     public ?array $factories = null;
+    public ?array $translations = null;
 
     public function setStructure(): void
     {
@@ -106,6 +107,14 @@ public function setStructure(): void
             }
         }
 
+        if (!is_null($this->translations)) {
+            $structure['resources']['lang']['en'] = [];
+
+            foreach ($this->translations as $translation => $content) {
+                $structure['resources']['lang']['en'][$translation] = $content;
+            }
+        }
+
         vfsStream::create($structure);
     }
 }

tests/Support/Translation/TranslationMockTrait.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace RonasIT\Support\Tests\Support\Translation;
+
+use RonasIT\Support\Tests\Support\FileSystemMock;
+use RonasIT\Support\Tests\Support\GeneratorMockTrait;
+
+trait TranslationMockTrait
+{
+    use GeneratorMockTrait;
+
+    public function mockFilesystem(): void
+    {
+        $fileSystemMock = new FileSystemMock();
+
+        $fileSystemMock->translations = [];
+
+        $fileSystemMock->setStructure();
+    }
+
+    public function mockFilesystemForAppend(): void
+    {
+        $validation = file_get_contents(getcwd() . '/tests/Support/Translation/validation_without_exceptions.php');
+
+        $fileSystemMock = new FileSystemMock();
+
+        $fileSystemMock->translations = ['validation.php' => $validation];
+
+        $fileSystemMock->setStructure();
+    }
+}

tests/Support/Translation/validation_without_exceptions.php

@@ -0,0 +1,3 @@
+<?php 
+
+return [];

tests/TranslationGeneratorTest.php

@@ -0,0 +1,82 @@
+<?php
+
+namespace RonasIT\Support\Tests;
+
+use Illuminate\Support\Facades\Event;
+use Illuminate\Support\Facades\Lang;
+use RonasIT\Support\Events\SuccessCreateMessage;
+use RonasIT\Support\Events\WarningEvent;
+use RonasIT\Support\Generators\TranslationsGenerator;
+use RonasIT\Support\Tests\Support\Translation\TranslationMockTrait;
+
+class TranslationGeneratorTest extends TestCase
+{
+    use TranslationMockTrait;
+
+    public function testCreate()
+    {
+        $translations = $this->getJsonFixture('validation.json');
+
+        Lang::shouldReceive('get')->andReturn($translations);
+
+        $this->mockFilesystem();
+
+        app(TranslationsGenerator::class)
+            ->setModel('Post')
+            ->generate();
+
+        $this->assertGeneratedFileEquals('validation.php', 'resources/lang/en/validation.php');
+
+        $this->assertEventPushed(
+            className: SuccessCreateMessage::class,
+            message: 'Created a new Translations dump on path: vfs://root/resources/lang/en/validation.php',
+        );
+    }
+
+    public function testCreateStubNotExist()
+    {
+        config(['entity-generator.stubs.validation' => 'incorrect_stub']);
+
+        app(TranslationsGenerator::class)
+            ->setModel('Post')
+            ->generate();
+
+        $this->assertFileDoesNotExist('resources/lang/en/validation.php');
+
+        $this->assertEventPushed(
+            className: WarningEvent::class,
+            message: 'Generation of validation has been skipped cause the view incorrect_stub from the config entity-generator.stubs.validation is not exists. Please check that config has the correct view name value.',
+        );
+    }
+
+    public function testAppendNotFoundException()
+    {
+        $this->mockFilesystemForAppend();
+
+        app(TranslationsGenerator::class)
+            ->setModel('Post')
+            ->generate();
+
+        $this->assertGeneratedFileEquals('validation_append_not_found_exception.php', 'resources/lang/en/validation.php');
+
+        Event::assertNothingDispatched();
+    }
+
+    public function testAppendNotFoundExceptionStubNotExist()
+    {
+        config(['entity-generator.stubs.translation_not_found' => 'incorrect_stub']);
+
+        $this->mockFilesystemForAppend();
+
+        app(TranslationsGenerator::class)
+            ->setModel('Post')
+            ->generate();
+
+        $this->assertFileDoesNotExist('validation.php', 'resources/lang/en/validation.php');
+
+        $this->assertEventPushed(
+            className: WarningEvent::class,
+            message: 'Generation of translation not found has been skipped cause the view incorrect_stub from the config entity-generator.stubs.translation_not_found is not exists. Please check that config has the correct view name value.',
+        );
+    }
+}

tests/fixtures/TranslationGeneratorTest/validation.json

@@ -0,0 +1,158 @@
+{
+    "accepted": "The :attribute field must be accepted.",
+    "accepted_if": "The :attribute field must be accepted when :other is :value.",
+    "active_url": "The :attribute field must be a valid URL.",
+    "after": "The :attribute field must be a date after :date.",
+    "after_or_equal": "The :attribute field must be a date after or equal to :date.",
+    "alpha": "The :attribute field must only contain letters.",
+    "alpha_dash": "The :attribute field must only contain letters, numbers, dashes, and underscores.",
+    "alpha_num": "The :attribute field must only contain letters and numbers.",
+    "array": "The :attribute field must be an array.",
+    "ascii": "The :attribute field must only contain single-byte alphanumeric characters and symbols.",
+    "before": "The :attribute field must be a date before :date.",
+    "before_or_equal": "The :attribute field must be a date before or equal to :date.",
+    "between": {
+        "array": "The :attribute field must have between :min and :max items.",
+        "file": "The :attribute field must be between :min and :max kilobytes.",
+        "numeric": "The :attribute field must be between :min and :max.",
+        "string": "The :attribute field must be between :min and :max characters."
+    },
+    "boolean": "The :attribute field must be true or false.",
+    "can": "The :attribute field contains an unauthorized value.",
+    "confirmed": "The :attribute field confirmation does not match.",
+    "contains": "The :attribute field is missing a required value.",
+    "current_password": "The password is incorrect.",
+    "date": "The :attribute field must be a valid date.",
+    "date_equals": "The :attribute field must be a date equal to :date.",
+    "date_format": "The :attribute field must match the format :format.",
+    "decimal": "The :attribute field must have :decimal decimal places.",
+    "declined": "The :attribute field must be declined.",
+    "declined_if": "The :attribute field must be declined when :other is :value.",
+    "different": "The :attribute field and :other must be different.",
+    "digits": "The :attribute field must be :digits digits.",
+    "digits_between": "The :attribute field must be between :min and :max digits.",
+    "dimensions": "The :attribute field has invalid image dimensions.",
+    "distinct": "The :attribute field has a duplicate value.",
+    "doesnt_end_with": "The :attribute field must not end with one of the following: :values.",
+    "doesnt_start_with": "The :attribute field must not start with one of the following: :values.",
+    "email": "The :attribute field must be a valid email address.",
+    "ends_with": "The :attribute field must end with one of the following: :values.",
+    "enum": "The selected :attribute is invalid.",
+    "exists": "The selected :attribute is invalid.",
+    "extensions": "The :attribute field must have one of the following extensions: :values.",
+    "file": "The :attribute field must be a file.",
+    "filled": "The :attribute field must have a value.",
+    "gt": {
+        "array": "The :attribute field must have more than :value items.",
+        "file": "The :attribute field must be greater than :value kilobytes.",
+        "numeric": "The :attribute field must be greater than :value.",
+        "string": "The :attribute field must be greater than :value characters."
+    },
+    "gte": {
+        "array": "The :attribute field must have :value items or more.",
+        "file": "The :attribute field must be greater than or equal to :value kilobytes.",
+        "numeric": "The :attribute field must be greater than or equal to :value.",
+        "string": "The :attribute field must be greater than or equal to :value characters."
+    },
+    "hex_color": "The :attribute field must be a valid hexadecimal color.",
+    "image": "The :attribute field must be an image.",
+    "in": "The selected :attribute is invalid.",
+    "in_array": "The :attribute field must exist in :other.",
+    "integer": "The :attribute field must be an integer.",
+    "ip": "The :attribute field must be a valid IP address.",
+    "ipv4": "The :attribute field must be a valid IPv4 address.",
+    "ipv6": "The :attribute field must be a valid IPv6 address.",
+    "json": "The :attribute field must be a valid JSON string.",
+    "list": "The :attribute field must be a list.",
+    "lowercase": "The :attribute field must be lowercase.",
+    "lt": {
+        "array": "The :attribute field must have less than :value items.",
+        "file": "The :attribute field must be less than :value kilobytes.",
+        "numeric": "The :attribute field must be less than :value.",
+        "string": "The :attribute field must be less than :value characters."
+    },
+    "lte": {
+        "array": "The :attribute field must not have more than :value items.",
+        "file": "The :attribute field must be less than or equal to :value kilobytes.",
+        "numeric": "The :attribute field must be less than or equal to :value.",
+        "string": "The :attribute field must be less than or equal to :value characters."
+    },
+    "mac_address": "The :attribute field must be a valid MAC address.",
+    "max": {
+        "array": "The :attribute field must not have more than :max items.",
+        "file": "The :attribute field must not be greater than :max kilobytes.",
+        "numeric": "The :attribute field must not be greater than :max.",
+        "string": "The :attribute field must not be greater than :max characters."
+    },
+    "max_digits": "The :attribute field must not have more than :max digits.",
+    "mimes": "The :attribute field must be a file of type: :values.",
+    "mimetypes": "The :attribute field must be a file of type: :values.",
+    "min": {
+        "array": "The :attribute field must have at least :min items.",
+        "file": "The :attribute field must be at least :min kilobytes.",
+        "numeric": "The :attribute field must be at least :min.",
+        "string": "The :attribute field must be at least :min characters."
+    },
+    "min_digits": "The :attribute field must have at least :min digits.",
+    "missing": "The :attribute field must be missing.",
+    "missing_if": "The :attribute field must be missing when :other is :value.",
+    "missing_unless": "The :attribute field must be missing unless :other is :value.",
+    "missing_with": "The :attribute field must be missing when :values is present.",
+    "missing_with_all": "The :attribute field must be missing when :values are present.",
+    "multiple_of": "The :attribute field must be a multiple of :value.",
+    "not_in": "The selected :attribute is invalid.",
+    "not_regex": "The :attribute field format is invalid.",
+    "numeric": "The :attribute field must be a number.",
+    "password": {
+        "letters": "The :attribute field must contain at least one letter.",
+        "mixed": "The :attribute field must contain at least one uppercase and one lowercase letter.",
+        "numbers": "The :attribute field must contain at least one number.",
+        "symbols": "The :attribute field must contain at least one symbol.",
+        "uncompromised": "The given :attribute has appeared in a data leak. Please choose a different :attribute."
+    },
+    "present": "The :attribute field must be present.",
+    "present_if": "The :attribute field must be present when :other is :value.",
+    "present_unless": "The :attribute field must be present unless :other is :value.",
+    "present_with": "The :attribute field must be present when :values is present.",
+    "present_with_all": "The :attribute field must be present when :values are present.",
+    "prohibited": "The :attribute field is prohibited.",
+    "prohibited_if": "The :attribute field is prohibited when :other is :value.",
+    "prohibited_unless": "The :attribute field is prohibited unless :other is in :values.",
+    "prohibits": "The :attribute field prohibits :other from being present.",
+    "regex": "The :attribute field format is invalid.",
+    "required": "The :attribute field is required.",
+    "required_array_keys": "The :attribute field must contain entries for: :values.",
+    "required_if": "The :attribute field is required when :other is :value.",
+    "required_if_accepted": "The :attribute field is required when :other is accepted.",
+    "required_if_declined": "The :attribute field is required when :other is declined.",
+    "required_unless": "The :attribute field is required unless :other is in :values.",
+    "required_with": "The :attribute field is required when :values is present.",
+    "required_with_all": "The :attribute field is required when :values are present.",
+    "required_without": "The :attribute field is required when :values is not present.",
+    "required_without_all": "The :attribute field is required when none of :values are present.",
+    "same": "The :attribute field must match :other.",
+    "size": {
+        "array": "The :attribute field must contain :size items.",
+        "file": "The :attribute field must be :size kilobytes.",
+        "numeric": "The :attribute field must be :size.",
+        "string": "The :attribute field must be :size characters."
+    },
+    "starts_with": "The :attribute field must start with one of the following: :values.",
+    "string": "The :attribute field must be a string.",
+    "timezone": "The :attribute field must be a valid timezone.",
+    "unique": "The :attribute has already been taken.",
+    "uploaded": "The :attribute failed to upload.",
+    "uppercase": "The :attribute field must be uppercase.",
+    "url": "The :attribute field must be a valid URL.",
+    "ulid": "The :attribute field must be a valid ULID.",
+    "uuid": "The :attribute field must be a valid UUID.",
+    "custom":  {
+        "attribute-name":  {
+            "rule-name": "custom-message"
+        }
+    },
+    "attributes": {},
+    "exceptions": {
+        "not_found": ":Entity does not exist"
+    }
+}