Issue #59 Add more tests and rename to keepUppercaseLanguageCode

Author: mikehaertl

README.md

@@ -154,7 +154,9 @@ codes before the similar looking generic ones (i.e. 'en-US' before 'en'):
 > **Note:** If you use country codes, they should always be configured in upper case letters
 > as shown above. The URLs will still always use lowercase codes. If a URL with an uppercase
 > code like `en-US` is used, the user will be redirected to the lowercase `en-us` variant.
-> The application language will always use the correct `en-US` code.
+> The application language will always use the correct `en-US` code. If you don't want to
+> redirect URLs with uppercase country code, you can set the `keepUppercaseLanguageCode`
+> option to `true`.
 
 If you want your URL to optionally contain *any* country variant you can also use a wildcard pattern:
 

UrlManager.php

@@ -59,7 +59,7 @@ class UrlManager extends BaseUrlManager
      * @var bool whether to keep upper case language codes in URL. Default is `false` wich will e.g.
      * redirect `de-AT` to `de-at`.
      */
-    public $keepUpperCaseLanguageCode = false;
+    public $keepUppercaseLanguageCode = false;
 
     /**
      * @var string the name of the session key that is used to store the language. Default is '_language'.
@@ -215,7 +215,7 @@ public function createUrl($params)
                 if (is_string($key)) {
                     $language = $key;
                 }
-                if (!$this->keepUpperCaseLanguageCode) {
+                if (!$this->keepUppercaseLanguageCode) {
                     $language = strtolower($language);
                 }
                 // Remove any trailing slashes unless one is configured as suffix
@@ -266,7 +266,7 @@ protected function processLocaleUrl($request)
                 // lowercase language, uppercase country
                 list($language,$country) = $this->matchCode($code);
                 if ($country!==null) {
-                    if ($code==="$language-$country" && !$this->keepUpperCaseLanguageCode) {
+                    if ($code==="$language-$country" && !$this->keepUppercaseLanguageCode) {
                         $this->redirectToLanguage(strtolower($code));
                     } else {
                         $language = "$language-$country";

tests/RedirectTest.php

@@ -51,7 +51,7 @@ public function testRedirectsIfDefaultLanguageInUrl()
         $this->mockRequest('/en');
     }
 
-    public function testRedirectsIfLanguageWithUpperCaseCountryInUrl()
+    public function testRedirectsIfLanguageWithUppercaseCountryInUrl()
     {
         $this->expectRedirect('/es-bo/site/page');
         $this->mockUrlManager([
@@ -60,16 +60,16 @@ public function testRedirectsIfLanguageWithUpperCaseCountryInUrl()
         $this->mockRequest('/es-BO/site/page');
     }
 
-    public function testNoRedirectIfLanguageWithUpperCaseCountryInUrlAndUppercaseEnabled()
+    public function testNoRedirectIfLanguageWithUppercaseCountryInUrlAndUppercaseEnabled()
     {
         $this->mockUrlManager([
             'languages' => ['en-US', 'deutsch' => 'de', 'es-BO'],
-            'keepUpperCaseLanguageCode' => true,
+            'keepUppercaseLanguageCode' => true,
         ]);
         $this->mockRequest('/es-BO/site/page');
     }
 
-    public function testRedirectsIfLanguageWithUpperCaseWildcardCountryInUrl()
+    public function testRedirectsIfLanguageWithUppercaseWildcardCountryInUrl()
     {
         $this->expectRedirect('/es-bo/site/page');
         $this->mockUrlManager([

tests/UrlCreationTest.php

@@ -61,6 +61,22 @@ public function testCreateUrlWithLanguageFromUrl()
         $this->assertEquals($this->prepareUrl('/de/foo/baz/bar?x=y'), Url::to(['/slug/action', 'x' => 'y', 'term' => 'baz']));
     }
 
+    public function testCreateUrlWithLanguageFromUrlIfUppercaseEnabled()
+    {
+        $this->mockUrlManager([
+            'languages' => ['en-US', 'en', 'de'],
+            'keepUppercaseLanguageCode' => true,
+            'rules' => [
+                '/foo/<term:.+>/bar' => 'slug/action',
+            ],
+        ]);
+        $this->mockRequest('/en-US/site/page');
+        $this->assertEquals($this->prepareUrl('/en-US/demo/action'), Url::to(['/demo/action']));
+        $this->assertEquals($this->prepareUrl('/en-US/demo/action?x=y'), Url::to(['/demo/action', 'x' => 'y']));
+        $this->assertEquals($this->prepareUrl('/en-US/foo/baz/bar'), Url::to(['/slug/action', 'term' => 'baz']));
+        $this->assertEquals($this->prepareUrl('/en-US/foo/baz/bar?x=y'), Url::to(['/slug/action', 'x' => 'y', 'term' => 'baz']));
+    }
+
     public function testCreateHomeUrlWithLanguageFromUrl()
     {
         $this->mockUrlManager([
@@ -192,7 +208,7 @@ public function testCreateUrlUppercaseLanguageIfEnabled()
     {
         $this->mockUrlManager([
             'languages' => ['en-US', 'en', 'de'],
-            'keepUpperCaseLanguageCode' => true,
+            'keepUppercaseLanguageCode' => true,
             'rules' => [
                 '/foo/<term:.+>/bar' => 'slug/action',
             ],

tests/UrlManagerTest.php

@@ -33,6 +33,22 @@ public function testSetsLanguageFromUrl()
         $this->assertEquals('site/page', $request->pathInfo);
     }
 
+    public function testSetsLanguageFromUrlIfUppercaseEnabled()
+    {
+        $this->mockUrlManager([
+            'languages' => ['en-US', 'en', 'de'],
+            'keepUppercaseLanguageCode' => true,
+        ]);
+        $this->mockRequest('/en-US/site/page');
+        $this->assertEquals('en-US', Yii::$app->language);
+        $this->assertEquals('en-US', Yii::$app->session->get('_language'));
+        $cookie = Yii::$app->response->cookies->get('_language');
+        $this->assertNotNull($cookie);
+        $this->assertEquals('en-US', $cookie->value);
+        $request = Yii::$app->request;
+        $this->assertEquals('site/page', $request->pathInfo);
+    }
+
     public function testSetsLanguageFromUrlIfItMatchesWildcard()
     {
         $this->mockUrlManager([