Make plugin ready for Laravel 6 update (#600)

Make slug parameters optional in routes

.github/workflows/tests.yml

@@ -0,0 +1,82 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  phpUnitTests:
+    runs-on: ubuntu-latest
+    name: Unit Tests / PHP ${{ matrix.phpVersions }}
+    strategy:
+      max-parallel: 6
+      matrix:
+        phpVersions: ['7.2', '7.3', '7.4']
+      fail-fast: false
+    env:
+      phpExtensions: mbstring, intl, gd, xml, sqlite
+      cacheKey: ext-cache-v1
+      octoberCmsRelease: develop
+    steps:
+      - name: Checkout changes
+        uses: actions/checkout@v2
+        with:
+          path: translate-plugin
+
+      - name: Setup cache environment
+        id: extcache
+        uses: shivammathur/cache-extensions@v1
+        with:
+          php-version: ${{ matrix.phpVersions }}
+          extensions: ${{ env.phpExtensions }}
+          key: ${{ env.cacheKey }}
+
+      - name: Cache extensions
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.extcache.outputs.dir }}
+          key: ${{ steps.extcache.outputs.key }}
+          restore-keys: ${{ steps.extcache.outputs.key }}
+
+      - name: Install PHP and extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.phpVersions }}
+          extensions: ${{ env.phpExtensions }}
+          tools: composer
+          coverage: none
+
+      - name: Install October CMS
+        run: |
+          wget https://github.com/octobercms/october/archive/${{ env.octoberCmsRelease }}.zip
+          unzip ${{ env.octoberCmsRelease }}.zip
+          shopt -s dotglob
+          mv october-${{ env.octoberCmsRelease }}/* ./
+          shopt -u dotglob
+          cp config/cms.php config/testing/cms.php
+          mkdir -p plugins/rainlab
+          mv translate-plugin plugins/rainlab/translate
+
+      - name: Get Composer cache directory
+        id: composercache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composercache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install Composer dependencies
+        run: composer install --no-interaction --no-progress --no-suggest
+
+      - name: Run linting
+        run: ./vendor/bin/parallel-lint plugins/rainlab/translate
+
+      - name: Run unit tests
+        run: |
+          cd plugins/rainlab/translate
+          ../../../vendor/bin/phpunit

.gitignore

@@ -1,3 +1,4 @@
 /vendor
 composer.lock
 .DS_Store
+.phpunit.result.cache

phpunit.xml

@@ -1,14 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit backupGlobals="false"
-         backupStaticAttributes="false"
-         bootstrap="../../../tests/bootstrap.php"
-         colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false"
-         syntaxCheck="false"
+<phpunit
+    backupGlobals="false"
+    backupStaticAttributes="false"
+    bootstrap="../../../tests/bootstrap.php"
+    colors="true"
+    convertErrorsToExceptions="true"
+    convertNoticesToExceptions="true"
+    convertWarningsToExceptions="true"
+    processIsolation="false"
+    stopOnFailure="false"
 >
     <testsuites>
         <testsuite name="Plugin Unit Test Suite">

routes.php

@@ -6,8 +6,7 @@
 /*
  * Adds a custom route to check for the locale prefix.
  */
-App::before(function($request) {
-
+App::before(function ($request) {
     if (Config::get('rainlab.translate::disableLocalePrefixRoutes', false)) {
         return;
     }
@@ -29,8 +28,8 @@
     /*
      * Register routes
      */
-    Route::group(['prefix' => $locale, 'middleware' => 'web'], function() {
-        Route::any('{slug}', 'Cms\Classes\CmsController@run')->where('slug', '(.*)?');
+    Route::group(['prefix' => $locale, 'middleware' => 'web'], function () {
+        Route::any('{slug?}', 'Cms\Classes\CmsController@run')->where('slug', '(.*)?');
     });
 
     Route::any($locale, 'Cms\Classes\CmsController@run')->middleware('web');
@@ -39,17 +38,17 @@
      * Ensure Url::action() retains the localized URL
      * by re-registering the route after the CMS.
      */
-    Event::listen('cms.route', function() use ($locale) {
-        Route::group(['prefix' => $locale, 'middleware' => 'web'], function() {
-            Route::any('{slug}', 'Cms\Classes\CmsController@run')->where('slug', '(.*)?');
+    Event::listen('cms.route', function () use ($locale) {
+        Route::group(['prefix' => $locale, 'middleware' => 'web'], function () {
+            Route::any('{slug?}', 'Cms\Classes\CmsController@run')->where('slug', '(.*)?');
         });
     });
 });
 
 /*
  * Save any used messages to the contextual cache.
  */
-App::after(function($request) {
+App::after(function ($request) {
     if (class_exists('RainLab\Translate\Models\Message')) {
         Message::saveToCache();
     }

tests/unit/behaviors/TranslatableCmsObjectTest.php

@@ -1,19 +1,19 @@
 <?php namespace RainLab\Translate\Tests\Unit\Behaviors;
 
 use File;
+use PluginTestCase;
 use October\Rain\Halcyon\Model;
 use October\Rain\Filesystem\Filesystem;
 use October\Rain\Halcyon\Datasource\FileDatasource;
 use October\Rain\Halcyon\Datasource\Resolver;
 use RainLab\Translate\Tests\Fixtures\Classes\Feature as FeatureModel;
 use RainLab\Translate\Models\Locale as LocaleModel;
-use PluginTestCase;
 
 class TranslatableCmsObjectTest extends PluginTestCase
 {
     public $themePath;
 
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 
@@ -22,7 +22,7 @@ public function setUp()
         $this->seedSampleSourceAndData();
     }
 
-    public function tearDown()
+    public function tearDown(): void
     {
         $this->cleanUp();
     }

tests/unit/behaviors/TranslatableModelTest.php

@@ -1,16 +1,16 @@
 <?php namespace RainLab\Translate\Tests\Unit\Behaviors;
 
+use Model;
 use Schema;
 use PluginTestCase;
-use Model;
 use RainLab\Translate\Classes\Translator;
 use RainLab\Translate\Tests\Fixtures\Models\Country as CountryModel;
 use RainLab\Translate\Models\Locale as LocaleModel;
 use October\Rain\Database\Relations\Relation;
 
 class TranslatableModelTest extends PluginTestCase
 {
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 
@@ -172,7 +172,7 @@ public function testTranslateOrderBy()
 
         Translator::instance()->setLocale('en');
     }
-  
+
     public function testGetTranslationValueEagerLoadingWithMorphMap()
     {
         Relation::morphMap([

tests/unit/behaviors/TranslatablePageTest.php

@@ -1,18 +1,18 @@
 <?php namespace RainLab\Translate\Tests\Unit\Behaviors;
 
 use File;
+use PluginTestCase;
 use October\Rain\Halcyon\Model;
 use October\Rain\Filesystem\Filesystem;
 use October\Rain\Halcyon\Datasource\FileDatasource;
 use October\Rain\Halcyon\Datasource\Resolver;
 use RainLab\Translate\Tests\Fixtures\Classes\TranslatablePage;
-use PluginTestCase;
 
 class TranslatablePageTest extends PluginTestCase
 {
     public $themePath;
 
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 
@@ -31,7 +31,7 @@ public function setUp()
         });
     }
 
-    public function tearDown()
+    public function tearDown(): void
     {
         File::deleteDirectory($this->themePath.'/pages');
     }