chore: write new tests and add a new example

wdes · Mar 31, 2021 · 3ee642a · 3ee642a
1 parent b988af5
commit 3ee642a
Show file tree

Hide file tree

Showing 4 changed files with 338 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -27,25 +27,65 @@ composer require wdes/php-i18n-l10n
 
 Have a look at example file [example/simple.php](example/simple.php)
 
-### Example
+### Example without a MO file
 
 ```php
 <?php
+
 declare(strict_types = 1);
+
 // Can be removed :)
 
 require_once __DIR__ . '/../vendor/autoload.php';
 
-use \Wdes\phpI18nL10n\plugins\MoReader;
-use \Wdes\phpI18nL10n\Launcher;
-use \Wdes\phpI18nL10n\Twig\Extension\I18n as ExtensionI18n;
-use \Twig\Environment as TwigEnvironment;
-use \Twig\Loader\FilesystemLoader as TwigLoaderFilesystem;
+use Wdes\phpI18nL10n\plugins\MoReader;
+use Wdes\phpI18nL10n\Launcher;
+use Wdes\phpI18nL10n\Twig\Extension\I18n as ExtensionI18n;
+use Twig\Environment as TwigEnvironment;
+use Twig\Loader\ArrayLoader as TwigLoader;
 
-$dataDir  = __DIR__ . '/locale/';
-$moReader = new MoReader(
-    ['localeDir' => $dataDir]
+$moReader = new MoReader();
+$moReader->setTranslations(
+    [
+        'Homepage' => 'Page d\'accueil',
+    ]
 );
+// Load the translation plugin
+Launcher::setPlugin($moReader);
+
+$twig = new TwigEnvironment(new TwigLoader());
+$twig->addExtension(new ExtensionI18n());
+// You can use a file instead, see the example using a mo file
+$templateContents = <<<HTML
+<html>
+    <title>{% trans %}Homepage{% endtrans %}</title>
+    <body>
+        {% trans %}Homepage{% endtrans %}
+    </body>
+</html>
+HTML;
+echo $twig->createTemplate($templateContents)->render([]);
+```
+
+### Example with a MO file
+
+```php
+<?php
+
+declare(strict_types = 1);
+
+// Can be removed :)
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+use Wdes\phpI18nL10n\plugins\MoReader;
+use Wdes\phpI18nL10n\Launcher;
+use Wdes\phpI18nL10n\Twig\Extension\I18n as ExtensionI18n;
+use Twig\Environment as TwigEnvironment;
+use Twig\Loader\FilesystemLoader as TwigLoaderFilesystem;
+
+$dataDir  = __DIR__ . '/locale/';
+$moReader = new MoReader();
 $moReader->readFile($dataDir . 'fr.mo'); // Load the file you want (a specific language for example)
 // Load the translation plugin
 Launcher::setPlugin($moReader);
@@ -61,6 +101,7 @@ echo $twig->render(
         'say' => 'Hello world'
     ]
 );
+
 ```
 
 ### Scripts

diff --git a/example/no-data-file.php b/example/no-data-file.php
@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types = 1);
+
+// Can be removed :)
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+use Wdes\phpI18nL10n\plugins\MoReader;
+use Wdes\phpI18nL10n\Launcher;
+use Wdes\phpI18nL10n\Twig\Extension\I18n as ExtensionI18n;
+use Twig\Environment as TwigEnvironment;
+use Twig\Loader\ArrayLoader as TwigLoader;
+
+$moReader = new MoReader();
+$moReader->setTranslations(
+    [
+        'Homepage' => 'Page d\'accueil',
+    ]
+);
+// Load the translation plugin
+Launcher::setPlugin($moReader);
+
+$twig = new TwigEnvironment(new TwigLoader());
+$twig->addExtension(new ExtensionI18n());
+// You can use a file instead, see the example using a mo file
+$templateContents = <<<HTML
+<html>
+    <title>{% trans %}Homepage{% endtrans %}</title>
+    <body>
+        {% trans %}Homepage{% endtrans %}
+    </body>
+</html>
+HTML;
+echo $twig->createTemplate($templateContents)->render([]);
diff --git a/example/simple.php b/example/simple.php
@@ -13,9 +13,7 @@
 use Twig\Loader\FilesystemLoader as TwigLoaderFilesystem;
 
 $dataDir  = __DIR__ . '/locale/';
-$moReader = new MoReader(
-    ['localeDir' => $dataDir]
-);
+$moReader = new MoReader();
 $moReader->readFile($dataDir . 'fr.mo'); // Load the file you want (a specific language for example)
 // Load the translation plugin
 Launcher::setPlugin($moReader);

diff --git a/tests/I18nTestNoData.php b/tests/I18nTestNoData.php
@@ -0,0 +1,252 @@
+<?php
+
+declare(strict_types = 1);
+
+/* The contents of this file is free and unencumbered software released into the
+ * public domain.
+ * For more information, please refer to <http://unlicense.org/>
+ */
+namespace Wdes\phpI18nL10n\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Wdes\phpI18nL10n\Twig\Extension\I18n as ExtensionI18n;
+use Twig\Environment as TwigEnv;
+use Twig\Loader\FilesystemLoader as TwigLoaderFilesystem;
+use Wdes\phpI18nL10n\plugins\MoReader;
+use Wdes\phpI18nL10n\Launcher;
+
+/**
+ * @author William Desportes <[email protected]>
+ * @license Unlicense
+ */
+class I18nTestNoData extends TestCase
+{
+
+    /**
+     * The TwigEnv object
+     *
+     * @var TwigEnv
+     */
+    private $twig = null;
+
+    /**
+     * The MoReader object
+     *
+     * @var MoReader
+     */
+    private $moReader = null;
+
+    /**
+     * Set up the instance
+     *
+     * @return void
+     */
+    public function setUp(): void
+    {
+        $this->moReader = new MoReader();
+        Launcher::setPlugin($this->moReader);
+
+        $loader     = new TwigLoaderFilesystem();
+        $this->twig = new TwigEnv(
+            $loader
+        );
+
+        $this->twig->addExtension(new ExtensionI18n());
+    }
+
+    /**
+     * Test simple translation using get and set
+     * @return void
+     */
+    public function testSimpleTranslationGetSetTranslations(): void
+    {
+        $template = $this->twig->createTemplate(
+            '{% trans "Translate this" %}',
+            'testSimpleTranslationGetSetTranslations'
+        );
+        $html     = $template->render([]);
+        $this->assertNotEmpty($html);
+        $this->assertEquals('Translate this', $html);
+        $this->moReader->setTranslations([]);
+        $this->assertSame($this->moReader->getTranslations(), []);
+        $html = $template->render([]);
+        $this->assertNotEmpty($html);
+        $this->assertEquals('Translate this', $html);
+        $this->moReader->setTranslations(
+            [
+            'Translate this' => 'blob blob blob',
+            ]
+        );
+        $this->assertSame(
+            $this->moReader->getTranslations(),
+            [
+            'Translate this' => 'blob blob blob',
+            ]
+        );
+        $html = $template->render([]);
+        $this->assertNotEmpty($html);
+        $this->assertEquals('blob blob blob', $html);
+    }
+
+    /**
+     * Test simple translation
+     * @return void
+     */
+    public function testSimpleTranslation(): void
+    {
+        $template = $this->twig->createTemplate(
+            '{% trans "Translate this" %}'
+        );
+        $html     = $template->render([]);
+        $this->assertEquals('Translate this', $html);
+        $this->assertNotEmpty($html);
+    }
+
+    /**
+     * Test simple translation with a comment
+     * @return void
+     */
+    public function testSimpleTranslationWithComment(): void
+    {
+        $template = $this->twig->createTemplate(
+            '{% trans %}Translate this{% notes %}And note{% endtrans %}'
+        );
+        $html     = $template->render([]);
+        $this->assertEquals('Translate this', $html);
+        $this->assertNotEmpty($html);
+    }
+
+    /**
+     * Test simple translation with context
+     * @return void
+     */
+    public function testSimpleTranslationWithContext(): void
+    {
+        $template = $this->twig->createTemplate(
+            '{% trans %}Translate this{% context %}NayanCat{% endtrans %}'
+        );
+        $html     = $template->render([]);
+        $this->assertEquals('Translate this', $html);
+        $this->assertNotEmpty($html);
+    }
+
+    /**
+     * Test simple translation with context and a variable
+     * @return void
+     */
+    public function testSimpleTranslationWithContextAndVariable(): void
+    {
+        $template = $this->twig->createTemplate(
+            '{% trans %}Translate this {{name}} {% context %}The user name{% endtrans %}'
+        );
+        $html     = $template->render(
+            [
+            'name' => 'williamdes',
+            ]
+        );
+        $this->assertEquals('Translate this williamdes', $html);
+        $this->assertNotEmpty($html);
+    }
+
+    /**
+     * Test simple translation with context and some variables
+     * @return void
+     */
+    public function testSimpleTranslationWithContextAndVariables(): void
+    {
+        $template = $this->twig->createTemplate(
+            '{% trans %}Translate this {{key}}: {{value}} {% context %}The user name{% endtrans %}'
+        );
+        $html     = $template->render(
+            [
+            'key' => 'user',
+            'value' => 'williamdes',
+            ]
+        );
+        $this->assertEquals('Translate this user: williamdes', $html);
+        $this->assertNotEmpty($html);
+    }
+
+    /**
+     * Test plural translation
+     * @return void
+     */
+    public function testPluralTranslation(): void
+    {
+        $template = $this->twig->createTemplate(
+            '{% trans %}One person{% plural nbr_persons %}{{ nbr }} persons{% endtrans %}'
+        );
+        $html     = $template->render(['nbr' => 5]);
+        $this->assertEquals('One person', $html);
+        $this->assertNotEmpty($html);
+    }
+
+    /**
+     * Test plural translation with comment
+     * @return void
+     */
+    public function testPluralTranslationWithComment(): void
+    {
+        $template = $this->twig->createTemplate(
+            '{% trans %}one user likes this.{% plural nbr_persons %}{{ nbr }} users likes this.{% notes %}Number of users{% endtrans %}'
+        );
+        $html     = $template->render(['nbr' => 5]);
+        $this->assertEquals('one user likes this.', $html);
+        $this->assertNotEmpty($html);
+    }
+
+    /**
+     * Test simple plural translation
+     * @return void
+     */
+    public function testSimplePluralTranslation(): void
+    {
+        $template = $this->twig->createTemplate(
+            '{% trans %}One person{% plural a %}persons{% endtrans %}'
+        );
+        $html     = $template->render(['nbr' => 5]);
+        $this->assertEquals('One person', $html);
+        $this->assertNotEmpty($html);
+    }
+
+    /**
+      * Test simple plural translation using count
+
+
+      * @return void
+      */
+    public function testSimplePluralTranslationCount(): void
+    {
+        $template = $this->twig->createTemplate(
+            '{% trans %}One person{% plural a.count %}persons{% endtrans %}'
+        );
+        $html     = $template->render(['a' => ['1', '2']]);
+        $this->assertEquals('One person', $html);
+        $this->assertNotEmpty($html);
+    }
+
+    /**
+     * Test simple plural translation using count and vars
+     * @return void
+     */
+    public function testSimplePluralTranslationCountAndVars(): void
+    {
+        $template = $this->twig->createTemplate(
+            '{% trans %}One person{% plural a.count %}persons and {{ count }} dogs{% endtrans %}'
+        );
+        $html     = $template->render(['a' => ['1', '2'], 'nbrdogs' => 3]);
+        $this->assertEquals('One person', $html);
+        $this->assertNotEmpty($html);
+    }
+
+    /**
+     * Test simple plural translation using count and vars
+     * @return void
+     */
+    public function testExtensionI18nGetName(): void
+    {
+        $extension = new ExtensionI18n();
+        $this->assertSame('i18n', $extension->getName());
+    }
+
+}