Refactor/cleanup tests

Author: ivanvermeyen

tests/TestCase.php

@@ -5,16 +5,29 @@
 use CodeZero\LocalizedRoutes\LocalizedRoutesServiceProvider;
 use CodeZero\Localizer\LocalizerServiceProvider;
 use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Route;
 use Orchestra\Testbench\TestCase as BaseTestCase;
 
 abstract class TestCase extends  BaseTestCase
 {
+    /**
+     * Set the app locale.
+     *
+     * @param string $locale
+     *
+     * @return void
+     */
+    protected function setAppLocale($locale)
+    {
+        App::setLocale($locale);
+    }
+
     /**
      * Set the supported locales config option.
      *
-     * @param $locales
+     * @param array $locales
      *
      * @return void
      */

tests/Unit/Macros/UriTranslationMacroTest.php

@@ -3,23 +3,10 @@
 namespace CodeZero\LocalizedRoutes\Tests\Unit\Macros;
 
 use CodeZero\LocalizedRoutes\Tests\TestCase;
-use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Lang;
 
 class UriTranslationMacroTest extends TestCase
 {
-    protected function setTranslations($translations)
-    {
-        // Fake that we created a routes.php file in
-        // 'resources/lang/' for each language
-        // with the given translations.
-        Lang::setLoaded([
-            '*' => [
-                'routes' => $translations
-            ]
-        ]);
-    }
-
     /** @test */
     public function it_translates_every_segment_in_a_uri_to_the_current_locale()
     {
@@ -31,10 +18,10 @@ public function it_translates_every_segment_in_a_uri_to_the_current_locale()
             ]
         ]);
 
-        App::setLocale('en');
+        $this->setAppLocale('en');
         $this->assertEquals('my/new/page', Lang::uri('my/new/page'));
 
-        App::setLocale('nl');
+        $this->setAppLocale('nl');
         $this->assertEquals('mijn/nieuwe/pagina', Lang::uri('my/new/page'));
     }
 
@@ -91,4 +78,21 @@ public function it_skips_placeholders_in_a_uri()
 
         $this->assertEquals('artikels/{article}', Lang::uri('articles/{article}', 'nl'));
     }
+
+    /**
+     * Fake that we created a routes.php file in 'resources/lang/'
+     * for each language with the given translations.
+     *
+     * @param $translations
+     *
+     * @return void
+     */
+    protected function setTranslations($translations)
+    {
+        Lang::setLoaded([
+            '*' => [
+                'routes' => $translations
+            ]
+        ]);
+    }
 }

tests/Unit/Middleware/SetLocaleTest.php

@@ -167,8 +167,7 @@ public function it_still_sets_the_app_locale_for_localized_routes_if_localizer_i
     {
         $this->setSupportedLocales(['en']);
         $this->setUseLocalizer(false);
-
-        App::setLocale('fr');
+        $this->setAppLocale('fr');
 
         Route::localized(function () {
             Route::get('localized-route', function () {
@@ -186,8 +185,7 @@ public function it_does_not_set_the_app_locale_for_non_localized_routes_if_local
     {
         $this->setSupportedLocales(['en', 'nl']);
         $this->setUseLocalizer(false);
-
-        App::setLocale('fr');
+        $this->setAppLocale('fr');
 
         Route::get('non-localized-route', function () {
             return App::getLocale();

tests/Unit/UrlGeneratorTest.php

@@ -6,39 +6,26 @@
 use CodeZero\LocalizedRoutes\Tests\TestCase;
 use CodeZero\LocalizedRoutes\UrlGenerator;
 use Illuminate\Support\Facades\App;
-use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\Request;
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\Facades\URL;
 use InvalidArgumentException;
 
 class UrlGeneratorTest extends TestCase
 {
-    protected function setUp(): void
-    {
-        parent::setUp();
-
-        Config::set('localized-routes.supported-locales', ['en', 'nl']);
-
-        App::setLocale('en');
-    }
-
-    protected function registerRoute($url, $name, $callback = null)
-    {
-        Route::getRoutes()->add(
-            Route::name($name)->get($url, $callback ?: function () {})
-        );
-    }
-
     /** @test */
     public function it_binds_our_custom_url_generator_class()
     {
-        $this->assertInstanceOf(UrlGenerator::class, app('url'));
-        $this->assertInstanceOf(UrlGenerator::class, redirect()->getUrlGenerator());
+        $this->assertInstanceOf(UrlGenerator::class, App::make('url'));
+        $this->assertInstanceOf(UrlGenerator::class, App::make('redirect')->getUrlGenerator());
     }
 
     /** @test */
-    public function it_gets_the_url_of_a_named_route()
+    public function it_gets_the_url_of_a_named_route_as_usual()
     {
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setAppLocale('en');
+
         $this->registerRoute('weirdly-named-route', 'en');
         $this->registerRoute('route', 'route');
         $this->registerRoute('en/route', 'en.route');
@@ -59,15 +46,20 @@ public function it_gets_the_url_of_a_named_route()
     /** @test */
     public function it_gets_the_url_of_a_route_in_the_current_locale_if_the_given_route_name_does_not_exist()
     {
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setAppLocale('en');
+
         $this->registerRoute('en/route', 'en.route.name');
 
-        $this->assertEquals('en', App::getLocale());
         $this->assertEquals(url('en/route'), route('route.name'));
     }
 
     /** @test */
     public function it_throws_if_no_valid_route_can_be_found()
     {
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setAppLocale('en');
+
         $this->registerRoute('wrong-route', 'wrong-route');
 
         $this->expectException(InvalidArgumentException::class);
@@ -78,9 +70,11 @@ public function it_throws_if_no_valid_route_can_be_found()
     /** @test */
     public function it_throws_if_no_valid_localized_route_can_be_found()
     {
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setAppLocale('en');
+
         $this->registerRoute('nl/route', 'nl.route.name');
 
-        $this->assertEquals('en', App::getLocale());
         $this->expectException(InvalidArgumentException::class);
 
         route('route.name');
@@ -89,10 +83,12 @@ public function it_throws_if_no_valid_localized_route_can_be_found()
     /** @test */
     public function it_gets_the_url_of_a_route_in_the_given_locale()
     {
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setAppLocale('en');
+
         $this->registerRoute('en/route', 'en.route.name');
         $this->registerRoute('nl/route', 'nl.route.name');
 
-        $this->assertEquals('en', App::getLocale());
         $this->assertEquals(url('nl/route'), route('route.name', [], true, 'nl'));
         $this->assertEquals(url('nl/route'), route('en.route.name', [], true, 'nl'));
         $this->assertEquals(url('nl/route'), route('nl.route.name', [], true, 'nl'));
@@ -101,6 +97,9 @@ public function it_gets_the_url_of_a_route_in_the_given_locale()
     /** @test */
     public function it_always_gets_the_url_of_a_localized_route_if_a_locale_is_specified()
     {
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setAppLocale('en');
+
         $this->registerRoute('route', 'route.name');
         $this->registerRoute('nl/route', 'nl.route.name');
 
@@ -110,9 +109,11 @@ public function it_always_gets_the_url_of_a_localized_route_if_a_locale_is_speci
     /** @test */
     public function it_throws_if_no_valid_route_can_be_found_for_the_given_locale()
     {
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setAppLocale('en');
+
         $this->registerRoute('en/route', 'en.route.name');
 
-        $this->assertEquals('en', App::getLocale());
         $this->expectException(InvalidArgumentException::class);
 
         route('en.route.name', [], true, 'nl');
@@ -121,11 +122,12 @@ public function it_throws_if_no_valid_route_can_be_found_for_the_given_locale()
     /** @test */
     public function it_temporarily_changes_the_app_locale_when_generating_a_route_url()
     {
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setAppLocale('en');
+
         $this->registerRoute('en/route/{slug}', 'en.route.name');
         $this->registerRoute('nl/route/{slug}', 'nl.route.name');
 
-        App::setLocale('en');
-
         $this->assertEquals(url('en/route/en-slug'), route('route.name', [new Model]));
         $this->assertEquals(url('en/route/en-slug'), route('route.name', [new Model], true, 'en'));
         $this->assertEquals(url('nl/route/nl-slug'), route('route.name', [new Model], true, 'nl'));
@@ -134,8 +136,11 @@ public function it_temporarily_changes_the_app_locale_when_generating_a_route_ur
     /** @test */
     public function it_generates_a_signed_route_url_for_the_current_locale()
     {
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setAppLocale('en');
+
         $callback = function () {
-            return request()->hasValidSignature()
+            return Request::hasValidSignature()
                 ? 'Valid Signature'
                 : 'Invalid Signature';
         };
@@ -153,8 +158,11 @@ public function it_generates_a_signed_route_url_for_the_current_locale()
     /** @test */
     public function it_generates_a_signed_route_url_for_a_specific_locale()
     {
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setAppLocale('en');
+
         $callback = function () {
-            return request()->hasValidSignature()
+            return Request::hasValidSignature()
                 ? 'Valid Signature'
                 : 'Invalid Signature';
         };
@@ -168,4 +176,18 @@ public function it_generates_a_signed_route_url_for_a_specific_locale()
         $this->get($validUrl)->assertSee('Valid Signature');
         $this->get($tamperedUrl)->assertSee('Invalid Signature');
     }
+
+    /**
+     * Register a route.
+     *
+     * @param string $url
+     * @param string $name
+     * @param \Closure|null $callback
+     *
+     * @return void
+     */
+    protected function registerRoute($url, $name, $callback = null)
+    {
+        Route::name($name)->get($url, $callback ?: function () {});
+    }
 }