Merge pull request #18 from ARCANEDEV/develop

Adding Regional to locales
ARCANEDEV · Nov 29, 2015 · 8ed06ff · 8ed06ff
2 parents 66c5e10 + cf16be2
commit 8ed06ff
Show file tree

Hide file tree

Showing 15 changed files with 2,144 additions and 1,784 deletions.
diff --git a/config/localization.php b/config/localization.php
diff --git a/src/Contracts/LocalizationInterface.php b/src/Contracts/LocalizationInterface.php
@@ -93,6 +93,13 @@ public function getCurrentLocaleDirection();
      */
     public function getCurrentLocaleNative();
 
+    /**
+     * Returns current locale regional.
+     *
+     * @return string
+     */
+    public function getCurrentLocaleRegional();
+
     /**
      * Set and return current locale.
      *

diff --git a/src/Entities/Locale.php b/src/Entities/Locale.php
@@ -51,6 +51,13 @@ class Locale implements Arrayable, Jsonable, JsonSerializable
      */
     private $native;
 
+    /**
+     * Locale regional.
+     *
+     * @var string
+     */
+    private $regional;
+
     /**
      * Default locale.
      *
@@ -75,6 +82,7 @@ public function __construct($key, array $data)
         $this->setScript($data['script']);
         $this->setDirection($data['dir']);
         $this->setNative($data['native']);
+        $this->setRegional(isset($data['regional']) ? $data['regional'] : '');
     }
 
     /* ------------------------------------------------------------------------------------------------
@@ -210,6 +218,30 @@ private function setNative($native)
         return $this;
     }
 
+    /**
+     * Get locale regional.
+     *
+     * @return string
+     */
+    public function regional()
+    {
+        return $this->regional;
+    }
+
+    /**
+     * Set Regional.
+     *
+     * @param  string  $regional
+     *
+     * @return self
+     */
+    private function setRegional($regional)
+    {
+        $this->regional = $regional;
+
+        return $this;
+    }
+
     /**
      * Check if it is a default locale.
      *
@@ -232,6 +264,23 @@ private function setDefault()
         return $this;
     }
 
+    /* ------------------------------------------------------------------------------------------------
+     |  Main Functions
+     | ------------------------------------------------------------------------------------------------
+     */
+    /**
+     * Create Locale instance.
+     *
+     * @param  string  $key
+     * @param  array   $data
+     *
+     * @return self
+     */
+    public static function make($key, array $data)
+    {
+        return new self($key, $data);
+    }
+
     /* ------------------------------------------------------------------------------------------------
      |  Other Functions
      | ------------------------------------------------------------------------------------------------
@@ -244,11 +293,12 @@ private function setDefault()
     public function toArray()
     {
         return [
-            'key'    => $this->key(),
-            'name'   => $this->name(),
-            'script' => $this->script(),
-            'dir'    => $this->direction(),
-            'native' => $this->native(),
+            'key'      => $this->key(),
+            'name'     => $this->name(),
+            'script'   => $this->script(),
+            'dir'      => $this->direction(),
+            'native'   => $this->native(),
+            'regional' => $this->regional(),
         ];
     }
 

diff --git a/src/Entities/LocaleCollection.php b/src/Entities/LocaleCollection.php
@@ -103,7 +103,7 @@ public function loadFromArray(array $locales)
         $this->reset();
 
         foreach ($locales as $key => $locale) {
-            $this->put($key, new Locale($key, $locale));
+            $this->put($key, Locale::make($key, $locale));
         }
 
         return $this;

diff --git a/src/Localization.php b/src/Localization.php
@@ -199,6 +199,16 @@ public function getCurrentLocaleNative()
         return $this->getCurrentLocaleEntity()->native();
     }
 
+    /**
+     * Returns current locale regional.
+     *
+     * @return string
+     */
+    public function getCurrentLocaleRegional()
+    {
+        return $this->getCurrentLocaleEntity()->regional();
+    }
+
     /**
      * Get all locales.
      *

diff --git a/src/Utilities/LocalesManager.php b/src/Utilities/LocalesManager.php
@@ -113,6 +113,7 @@ public function setLocale($locale = null)
         }
 
         $this->app->setLocale($this->getCurrentLocale());
+        $this->updateRegional();
 
         return $locale;
     }
@@ -371,4 +372,16 @@ private function filterLocales(array $supportedLocales)
             return in_array($locale->key(), $supportedLocales);
         });
     }
+
+    /**
+     * Update locale regional.
+     */
+    private function updateRegional()
+    {
+        $currentLocale = $this->getCurrentLocaleEntity();
+
+        if ( ! empty($regional = $currentLocale->regional())) {
+            setlocale(LC_TIME, $regional . '.utf8');
+        }
+    }
 }
diff --git a/tests/Entities/LocaleCollectionTest.php b/tests/Entities/LocaleCollectionTest.php
@@ -32,9 +32,9 @@ public function setUp()
 
     public function tearDown()
     {
-        parent::tearDown();
+        unset($this->locales);
 
-        unset($locales);
+        parent::tearDown();
     }
 
     /* ------------------------------------------------------------------------------------------------

diff --git a/tests/Entities/LocaleTest.php b/tests/Entities/LocaleTest.php
@@ -29,9 +29,9 @@ public function setUp()
 
     public function tearDown()
     {
-        parent::tearDown();
-
         unset($this->locale);
+
+        parent::tearDown();
     }
 
     /* ------------------------------------------------------------------------------------------------
@@ -50,6 +50,8 @@ public function it_can_be_instantiated()
         $this->assertEquals('Latin',   $this->locale->script());
         $this->assertEquals('ltr',     $this->locale->direction());
         $this->assertEquals('English', $this->locale->native());
+        $this->assertEquals('en_GB',   $this->locale->regional());
+
         $this->assertTrue($this->locale->isDefault());
     }
 
@@ -96,33 +98,48 @@ public function it_can_convert_entity_to_json()
      |  Other Functions
      | ------------------------------------------------------------------------------------------------
      */
+    /**
+     * Make a locale.
+     *
+     * @param  string  $key
+     *
+     * @return Locale
+     */
     private function makeLocale($key)
     {
-        $data = $this->getLocale($key);
-
-        return new Locale($key, $data);
+        return Locale::make($key, $this->getLocale($key));
     }
 
+    /**
+     * Get locale data.
+     *
+     * @param  string  $key
+     *
+     * @return array
+     */
     private function getLocale($key)
     {
         return array_get([
-            'ar'         => [
-                'name'   => 'Arabic',
-                'script' => 'Arab',
-                'dir'    => 'rtl',
-                'native' => 'العربية',
+            'ar' => [
+                'name'     => 'Arabic',
+                'script'   => 'Arab',
+                'dir'      => 'rtl',
+                'native'   => 'العربية',
+                'regional' => 'ar_AE',
             ],
-            'en'         => [
-                'name'   => 'English',
-                'script' => 'Latin',
-                'dir'    => 'ltr',
-                'native' => 'English',
+            'en' => [
+                'name'     => 'English',
+                'script'   => 'Latin',
+                'dir'      => 'ltr',
+                'native'   => 'English',
+                'regional' => 'en_GB',
             ],
-            'fr'         => [
-                'name'   => 'French',
-                'script' => 'Latin',
-                'dir'    => 'ltr',
-                'native' => 'Français',
+            'fr' => [
+                'name'     => 'French',
+                'script'   => 'Latin',
+                'dir'      => 'ltr',
+                'native'   => 'Français',
+                'regional' => 'fr_FR',
             ],
         ], $key);
     }

diff --git a/tests/LocalizationTest.php b/tests/LocalizationTest.php
@@ -428,6 +428,22 @@ public function it_can_get_current_locale_native()
         }
     }
 
+    /** @test */
+    public function testGetCurrentLocaleRegional()
+    {
+        $locales = [
+            'en' => 'en_GB',
+            'es' => 'es_ES',
+            'fr' => 'fr_FR',
+        ];
+
+        foreach ($locales as $locale => $regional) {
+            $this->refreshApplication($locale);
+
+            $this->assertEquals($regional, localization()->getCurrentLocaleRegional());
+        }
+    }
+
     /** @test */
     public function it_can_create_url_from_uri()
     {

diff --git a/tests/Middleware/LocaleCookieRedirectTest.php b/tests/Middleware/LocaleCookieRedirectTest.php
@@ -12,20 +12,6 @@
  */
 class LocaleCookieRedirectTest extends TestCase
 {
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
-     */
-    public function setUp()
-    {
-        parent::setUp();
-    }
-
-    public function tearDown()
-    {
-        parent::tearDown();
-    }
-
     /* ------------------------------------------------------------------------------------------------
      |  Test Functions
      | ------------------------------------------------------------------------------------------------

diff --git a/tests/Middleware/LocaleSessionRedirectTest.php b/tests/Middleware/LocaleSessionRedirectTest.php
@@ -12,20 +12,6 @@
  */
 class LocaleSessionRedirectTest extends TestCase
 {
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
-     */
-    public function setUp()
-    {
-        parent::setUp();
-    }
-
-    public function tearDown()
-    {
-        parent::tearDown();
-    }
-
     /* ------------------------------------------------------------------------------------------------
      |  Test Functions
      | ------------------------------------------------------------------------------------------------

diff --git a/tests/Routing/RouterTest.php b/tests/Routing/RouterTest.php
@@ -31,9 +31,9 @@ public function setUp()
 
     public function tearDown()
     {
-        parent::tearDown();
-
         unset($this->router);
+
+        parent::tearDown();
     }
 
     /* ------------------------------------------------------------------------------------------------

diff --git a/tests/Utilities/LocalesManagerTest.php b/tests/Utilities/LocalesManagerTest.php
@@ -34,9 +34,9 @@ public function setUp()
 
     public function tearDown()
     {
-        parent::tearDown();
-
         unset($this->localesManager);
+
+        parent::tearDown();
     }
 
     /* ------------------------------------------------------------------------------------------------

diff --git a/tests/Utilities/NegotiatorTest.php b/tests/Utilities/NegotiatorTest.php
@@ -33,9 +33,9 @@ public function setUp()
 
     public function tearDown()
     {
-        parent::tearDown();
-
         unset($this->negotiator);
+
+        parent::tearDown();
     }
 
     /* ------------------------------------------------------------------------------------------------

diff --git a/tests/Utilities/UrlTest.php b/tests/Utilities/UrlTest.php
@@ -11,20 +11,6 @@
  */
 class UrlTest extends TestCase
 {
-    /* ------------------------------------------------------------------------------------------------
-     |  Main Functions
-     | ------------------------------------------------------------------------------------------------
-     */
-    public function setUp()
-    {
-        parent::setUp();
-    }
-
-    public function tearDown()
-    {
-        parent::tearDown();
-    }
-
     /* ------------------------------------------------------------------------------------------------
      |  Test Functions
      | ------------------------------------------------------------------------------------------------