Skip to content

Commit

Permalink
Fixed incorrect pluralisation for de_informal
Browse files Browse the repository at this point in the history
Updated language system to only use initial part of locale for
translation pluralisation to better match the hard-coded logic of the
built-in MessageSelector. Extends and overrides Laravel's default for
this system.

Added test to cover.
Related to #3976.
  • Loading branch information
ssddanbrown committed Jan 16, 2023
1 parent 5393465 commit 6070d80
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 1 deletion.
31 changes: 31 additions & 0 deletions app/Providers/TranslationServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,41 @@
namespace BookStack\Providers;

use BookStack\Translation\FileLoader;
use BookStack\Translation\MessageSelector;
use Illuminate\Translation\TranslationServiceProvider as BaseProvider;
use Illuminate\Translation\Translator;

class TranslationServiceProvider extends BaseProvider
{
/**
* Register the service provider.
*
* @return void
*/
public function register()
{
$this->registerLoader();

// This is a tweak upon Laravel's based translation service registration to allow
// usage of a custom MessageSelector class
$this->app->singleton('translator', function ($app) {
$loader = $app['translation.loader'];

// When registering the translator component, we'll need to set the default
// locale as well as the fallback locale. So, we'll grab the application
// configuration so we can easily get both of these values from there.
$locale = $app['config']['app.locale'];

$trans = new Translator($loader, $locale);
$trans->setFallback($app['config']['app.fallback_locale']);
$trans->setSelector(new MessageSelector());

return $trans;
});
}



/**
* Register the translation line loader.
* Overrides the default register action from Laravel so a custom loader can be used.
Expand Down
19 changes: 19 additions & 0 deletions app/Translation/MessageSelector.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?php

namespace BookStack\Translation;

use Illuminate\Translation\MessageSelector as BaseClass;

/**
* This is a customization of the default Laravel MessageSelector class to tweak pluralization,
* so that is uses just the first part of the locale string to provide support with
* non-standard locales such as "de_informal".
*/
class MessageSelector extends BaseClass
{
public function getPluralIndex($locale, $number)
{
$locale = explode('_', $locale)[0];
return parent::getPluralIndex($locale, $number);
}
}
14 changes: 13 additions & 1 deletion tests/LanguageTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

class LanguageTest extends TestCase
{
protected $langs;
protected array $langs;

/**
* LanguageTest constructor.
Expand Down Expand Up @@ -81,4 +81,16 @@ public function test_rtl_config_set_if_lang_is_rtl()
$this->get('/');
$this->assertTrue(config('app.rtl'), 'App RTL config should have been set to true by middleware');
}

public function test_pluralisation_for_non_standard_locales()
{
$text = trans_choice('entities.x_pages', 1, [], 'de_informal');
$this->assertEquals('1 Seite', $text);

$text = trans_choice('entities.x_pages', 2, [], 'de_informal');
$this->assertEquals('2 Seiten', $text);

$text = trans_choice('entities.x_pages', 0, [], 'de_informal');
$this->assertEquals('0 Seiten', $text);
}
}

0 comments on commit 6070d80

Please sign in to comment.