Tests added

Author: bhanwarpsrathore

composer.json

@@ -53,14 +53,14 @@
     },
     "require": {
         "php": "^8.2",
+        "illuminate/config": "*",
         "illuminate/console": "^11.0|^12.0",
         "illuminate/filesystem": "^11.0|^12.0",
-        "illuminate/support": "^11.0|^12.0",
-        "laravel/framework": "^11.0|^12.0",
         "tedivm/jshrink": "~1.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^11.0"
+        "pestphp/pest": "^3.7",
+        "orchestra/testbench": "^9.0|^10.0"
     },
     "autoload": {
         "psr-4": {
@@ -79,5 +79,10 @@
                 "Mariuzzo\\LaravelJsLocalization\\LaravelJsLocalizationServiceProvider"
             ]
         }
+    },
+    "config": {
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
     }
 }

src/config/localization-js.php config/localization-js.phpsrc/config/localization-js.php renamed to config/localization-js.php

@@ -11,9 +11,7 @@
      *     'forum/thread',
      * ],
      */
-    'messages' => [
-
-    ],
+    'messages' => [],
 
     /*
      * The default path to use for the generated javascript.

phpunit.xml

@@ -1,23 +1,17 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit
-    backupGlobals="false"
-    backupStaticAttributes="false"
-    bootstrap="vendor/autoload.php"
-    colors="true"
-    convertErrorsToExceptions="true"
-    convertNoticesToExceptions="true"
-    convertWarningsToExceptions="true"
-    processIsolation="false"
-    stopOnFailure="false"
-    verbose="true">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+>
     <testsuites>
-        <testsuite name="Package">
-            <directory suffix="Test.php">./tests/specs</directory>
+        <testsuite name="Test Suite">
+            <directory suffix="Test.php">./tests</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist>
+    <source>
+        <include>
             <directory suffix=".php">./src</directory>
-        </whitelist>
-    </filter>
+        </include>
+    </source>
 </phpunit>

src/LaravelJsLocalizationServiceProvider.php

@@ -35,7 +35,7 @@ public function boot() {
      */
     public function register() {
         $this->registerConfig();
-        $this->registerLangJsCommand();
+        $this->registerLangJsGenerator();
     }
 
     protected function registerConfig(): void {
@@ -54,17 +54,15 @@ protected function publishConfigs(): void {
         ], 'localization-js-config');
     }
 
-    protected function registerLangJsCommand(): void {
-        $this->app->singleton(LangJsCommand::class, function ($app) {
+    protected function registerLangJsGenerator(): void {
+        $this->app->singleton(LangJsGenerator::class, function ($app) {
             $app = $this->app;
 
             $files = $app['files'];
             $langs = $app['path.base'] . '/lang';
 
             $messages = $app['config']->get('localization-js.messages');
-            $generator = new LangJsGenerator($files, $langs, $messages);
-
-            return new LangJsCommand($generator);
+            return new LangJsGenerator($files, $langs, $messages);
         });
     }
 

tests/Feature/LangJsCommandTest.php

@@ -0,0 +1,47 @@
+<?php
+
+beforeEach(function () {
+    $this->testPath       = __DIR__ . '/..';
+    $this->rootPath       = __DIR__ . '/../..';
+    $this->outputFilePath = "$this->testPath/output/lang.js";
+    $this->langPath       = "$this->testPath/fixtures/lang";
+});
+
+test('it generates the JS language file successfully', function () {
+    $this->artisan('lang:js', ['target' => $this->outputFilePath])
+        ->expectsOutputToContain('Created:')
+        ->assertExitCode(0);
+
+    $this->assertFileExists($this->outputFilePath);
+
+    $template = "$this->rootPath/src/Generators/Templates/langjs_with_messages.js";
+    $this->assertFileExists($template);
+    $this->assertFileNotEquals($template, $this->outputFilePath);
+
+    $this->cleanupOutputDirectory($this->testPath);
+});
+
+test('template should have handlebars', function () {
+    $template = "$this->rootPath/src/Generators/Templates/langjs_with_messages.js";
+    $this->assertFileExists($template);
+
+    $contents = file_get_contents($template);
+    $this->assertNotEmpty($contents);
+    $this->assertHasHandlebars('messages', $contents);
+    $this->assertHasHandlebars('langjs', $contents);
+});
+
+test('output should not have handlebars', function () {
+    $this->artisan('lang:js', ['target' => $this->outputFilePath])
+        ->expectsOutputToContain('Created:')
+        ->assertExitCode(0);
+
+    $this->assertFileExists($this->outputFilePath);
+
+    $contents = file_get_contents($this->outputFilePath);
+    $this->assertNotEmpty($contents);
+    $this->assertHasNotHandlebars('messages', $contents);
+    $this->assertHasNotHandlebars('langjs', $contents);
+
+    $this->cleanupOutputDirectory($this->testPath);
+});

tests/Pest.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+|--------------------------------------------------------------------------
+| Test Case
+|--------------------------------------------------------------------------
+|
+| The closure you provide to your test functions is always bound to a specific PHPUnit test
+| case class. By default, that class is "PHPUnit\Framework\TestCase". Of course, you may
+| need to change it using the "pest()" function to bind a different classes or traits.
+|
+*/
+
+pest()->extend(Mariuzzo\LaravelJsLocalization\Tests\TestCase::class);
+
+/*
+|--------------------------------------------------------------------------
+| Functions
+|--------------------------------------------------------------------------
+|
+*/

tests/TestCase.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Mariuzzo\LaravelJsLocalization\Tests;
+
+use Illuminate\Support\Facades\File;
+use Mariuzzo\LaravelJsLocalization\LaravelJsLocalizationServiceProvider;
+use Orchestra\Testbench\TestCase as Orchestra;
+
+class TestCase extends Orchestra {
+
+    protected function getPackageProviders($app) {
+        return [
+            LaravelJsLocalizationServiceProvider::class,
+        ];
+    }
+
+    /**
+     * @param string $handle
+     * @param string $contents
+     */
+    protected function assertHasHandlebars($handle, $contents) {
+        $this->assertEquals(1, preg_match('/\'\{(\s)' . preg_quote($handle) . '(\s)\}\'/', $contents));
+    }
+
+    /**
+     * @param string $handle
+     * @param string $contents
+     */
+    protected function assertHasNotHandlebars($handle, $contents) {
+        $this->assertEquals(0, preg_match('/\'\{(\s)' . preg_quote($handle) . '(\s)\}\'/', $contents));
+    }
+
+    /**
+     * Cleanup output directory after tests.
+     */
+    protected function cleanupOutputDirectory($testpath) {
+        $files = File::files("{$testpath}/output");
+        foreach ($files as $file) {
+            File::delete($file);
+        }
+    }
+}

tests/Unit/LaravelJsLocalizationServiceProviderTest.php

@@ -0,0 +1,38 @@
+<?php
+
+use Illuminate\Support\Facades\Config;
+use Mariuzzo\LaravelJsLocalization\Commands\LangJsCommand;
+use Mariuzzo\LaravelJsLocalization\Generators\LangJsGenerator;
+use Mariuzzo\LaravelJsLocalization\LaravelJsLocalizationServiceProvider;
+
+it('merges configuration correctly', function () {
+    expect(Config::has('localization-js'))->toBeTrue();
+});
+
+it('registers the LangJsGenerator service', function () {
+    expect(app()->bound(LangJsGenerator::class))->toBeTrue()
+        ->and(app(LangJsGenerator::class))->toBeInstanceOf(LangJsGenerator::class);
+});
+
+it('registers the command', function () {
+    $this->app->singleton(LangJsCommand::class, function ($app) {
+        return new LangJsCommand();
+    });
+
+    expect(app()->bound(LangJsCommand::class))->toBeTrue()
+        ->and(app(LangJsCommand::class))->toBeInstanceOf(LangJsCommand::class);
+});
+
+it('provides correct services', function () {
+    $provider = app()->getProvider(LaravelJsLocalizationServiceProvider::class);
+
+    expect($provider->provides())->toContain(LangJsCommand::class);
+});
+
+it('publishes configuration file', function () {
+    $provider = new LaravelJsLocalizationServiceProvider(app());
+    $provider->boot();
+
+    expect(LaravelJsLocalizationServiceProvider::$publishGroups)
+        ->toHaveKey('localization-js-config');
+});