Merge pull request #779 from creative-commoners/pulls/master/cms5-com…

…patibility

DEP Silverstripe CMS 5 compatibility

.nvmrc

@@ -1 +1 @@
-10
+18

.scrutinizer.yml

@@ -2,7 +2,7 @@ inherit: true
 
 build:
   environment:
-    php: 8.0
+    php: 8.1
   nodes:
     analysis:
       tests:

babel.config.json

@@ -0,0 +1,6 @@
+{
+  "presets": [
+    "@babel/preset-env",
+    "@babel/preset-react"
+  ]
+}

composer.json

@@ -30,19 +30,19 @@
         "issues": "http://github.com/tractorcow-farm/silverstripe-fluent/issues"
     },
     "require": {
-        "php": "^7.1 || ^8",
-        "silverstripe/vendor-plugin": "^1.6",
-        "silverstripe/framework": "^4.7",
-        "silverstripe/admin": "^1",
-        "silverstripe/versioned": "^1.7",
-        "symbiote/silverstripe-gridfieldextensions": "^3.1",
+        "php": "^8.1",
+        "silverstripe/vendor-plugin": "^2",
+        "silverstripe/framework": "^5",
+        "silverstripe/admin": "^2",
+        "silverstripe/versioned": "^2",
+        "symbiote/silverstripe-gridfieldextensions": "^4",
         "ext-json": "*"
     },
     "suggest": {
         "silverstripe/cms": "Localise pages"
     },
     "require-dev": {
-        "silverstripe/recipe-testing": "^2"
+        "silverstripe/recipe-testing": "^3"
     },
     "extra": {
         "branch-alias": {

package.json

@@ -1,12 +1,12 @@
 {
   "name": "tractorcow-fluent",
-  "version": "4.0.0",
   "description": "Fluent localisation module for SilverStrip CMS",
   "engines": {
-    "node": "^10.x"
+    "node": "^18.x"
   },
   "scripts": {
-    "build": "NODE_ENV=production webpack -p --bail --progress",
+    "build": "yarn && yarn lint && rm -rf client/dist/* && NODE_ENV=production webpack --mode production --bail --progress",
+    "dev": "NODE_ENV=development webpack --progress",
     "watch": "NODE_ENV=development webpack --watch --progress",
     "css": "WEBPACK_CHILD=css npm run build",
     "lint": "eslint client/src && sass-lint -v"
@@ -27,12 +27,19 @@
   },
   "homepage": "https://github.com/tractorcow-farm/silverstripe-fluent",
   "devDependencies": {
-    "@silverstripe/eslint-config": "^0.0.5",
-    "@silverstripe/webpack-config": "^0.4.1"
+    "@silverstripe/eslint-config": "^1.0.0-alpha6",
+    "@silverstripe/webpack-config": "^2.0.0-alpha6",
+    "webpack": "^5.74.0",
+    "webpack-cli": "^5.0.0"
   },
   "dependencies": {
-    "jquery": "^3.5.0",
-    "query-string": "^5.0.0",
+    "query-string": "^8.1.0",
     "url": "^0.11.0"
-  }
+  },
+  "resolutions": {
+    "colors": "1.4.0"
+  },
+  "browserslist": [
+    "defaults"
+  ]
 }

src/Extension/FluentExtension.php

@@ -7,7 +7,6 @@
 use SilverStripe\Core\Config\Config;
 use SilverStripe\Core\Convert;
 use SilverStripe\Core\Extension;
-use SilverStripe\Dev\Deprecation;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\FormField;
 use SilverStripe\Forms\GridField\GridField_ActionMenuItem;
@@ -1045,19 +1044,6 @@ public function getLocaleInstances(): array
         return $locales;
     }
 
-    /**
-     * Return the linking mode for the current locale and object
-     *
-     * @param string $locale
-     * @return string
-     * @deprecated 5.0 use LocaleInformation() instead
-     */
-    public function getLinkingMode($locale)
-    {
-        Deprecation::notice('5.0', 'Use LocaleInformation instead');
-        return $this->LocaleInformation($locale)->getLinkingMode();
-    }
-
     /**
      * Determine the baseurl within a specified $locale.
      *
@@ -1073,17 +1059,6 @@ public function BaseURLForLocale($locale)
         return $localeObject->getBaseURL();
     }
 
-    /**
-     * @param string $locale
-     * @return string
-     * @deprecated Use LocaleInformation instead
-     */
-    public function LocaleLink($locale)
-    {
-        Deprecation::notice('5.0', 'Use LocaleInformation instead');
-        return $this->LocaleInformation($locale)->getLink();
-    }
-
     /**
      * Ensure has_one cache is segmented by locale
      *

src/Extension/FluentVersionedExtension.php

@@ -949,7 +949,7 @@ protected function getCurrentVersionNumbers(string $class, string $stage, ?array
         $results = DB::prepared_query($query, $params);
         $versions = [];
 
-        while ($result = $results->next()) {
+        foreach ($results as $result) {
             $id = (int) $result['LatestID'];
             $version = (int) $result['LatestVersion'];
 

src/Forms/LocaleToggleColumn.php

@@ -18,9 +18,6 @@ class LocaleToggleColumn implements GridField_SaveHandler, GridField_ColumnProvi
 {
     use Injectable;
 
-    /**
-     * @skipUpgrade
-     */
     const COLUMN_NAME = 'VisibleToggle';
 
     /**

src/Model/CachableModel.php

@@ -37,7 +37,7 @@ public static function getCached()
         $dataList = DataObject::get(static::class);
         $sort = Config::inst()->get(static::class, 'default_sort');
         if ($sort) {
-            $dataList = $dataList->sort($sort);
+            $dataList = $dataList->orderBy($sort);
         }
 
         // If DB isn't ready, silently return empty array to prevent bootstrapping issues

tests/php/Extension/FluentExtensionTest.php

@@ -176,7 +176,7 @@ public function testLocalisedMixSorting()
 
             // Sort by the NonLocalisedSort field first then the LocalisedField second both in ascending order
             // so the result will be opposite if the order of the columns is not maintained
-            $objects=MixedLocalisedSortObject::get()->sort(
+            $objects=MixedLocalisedSortObject::get()->orderBy(
                 '"FluentExtensionTest_MixedLocalisedSortObject"."LocalizedSort", '.
                 '"FluentExtensionTest_MixedLocalisedSortObject"."NonLocalizedSort", '.
                 '"FluentExtensionTest_MixedLocalisedSortObject"."Title"'
@@ -289,12 +289,16 @@ public function testLocalisedCopyClassNameChange(): void
      * @param string[] $expected
      * @group exclude-from-travis
      */
-    public function testLocalisedFieldsCanBeSorted($locale, array $sortArgs, $expected)
+    public function testLocalisedFieldsCanBeSorted($locale, array $sortArgs, $expected, $useOrderBy = false)
     {
-        FluentState::singleton()->withState(function (FluentState $newState) use ($locale, $sortArgs, $expected) {
+        FluentState::singleton()->withState(function (FluentState $newState) use ($locale, $sortArgs, $expected, $useOrderBy) {
             $newState->setLocale($locale);
 
-            $records = LocalisedParent::get()->sort(...$sortArgs);
+            if ($useOrderBy) {
+                $records = LocalisedParent::get()->orderBy(...$sortArgs);
+            } else {
+                $records = LocalisedParent::get()->sort(...$sortArgs);
+            }
             $titles = $records->column('Title');
             $this->assertEquals($expected, $titles);
         });
@@ -411,6 +415,7 @@ public function sortRecordProvider()
                 'en_US',
                 ['CONCAT((SELECT COUNT(*) FROM "FluentExtensionTest_LocalisedParent_Localised"), "FluentExtensionTest_LocalisedParent"."ID")'],
                 ['A record', 'Read about things', 'Go for a run'],
+                true,
             ]
         ];
     }
@@ -431,7 +436,7 @@ protected function hasLocalisedRecord(DataObject $record, $locale)
                 '"Locale"' => $locale,
             ])
             ->execute()
-            ->first();
+            ->record();
 
         return !empty($result);
     }

tests/php/Extension/FluentSiteTreeExtensionTest.php

@@ -5,6 +5,7 @@
 use Page;
 use SilverStripe\CMS\Forms\SiteTreeURLSegmentField;
 use SilverStripe\CMS\Model\SiteTree;
+use SilverStripe\Control\Controller;
 use SilverStripe\Control\Director;
 use SilverStripe\Core\Config\Config;
 use SilverStripe\Dev\SapphireTest;
@@ -74,8 +75,8 @@ public function testGetLocaleInformation()
             $this->assertEquals('English (New Zealand)', $result->getTitle());
             $this->assertEquals('English', $result->getLanguageNative());
             $this->assertEquals('en', $result->getLanguage());
-            $this->assertEquals('/newzealand/a-page/', $result->getLink());
-            $this->assertEquals('http://mocked/newzealand/a-page/', $result->getAbsoluteLink());
+            $this->assertEquals(Controller::normaliseTrailingSlash('/newzealand/a-page/'), $result->getLink());
+            $this->assertEquals(Controller::normaliseTrailingSlash('http://mocked/newzealand/a-page/'), $result->getAbsoluteLink());
             $this->assertEquals('link', $result->getLinkingMode());
             $this->assertEquals('newzealand', $result->getURLSegment());
         });
@@ -179,7 +180,7 @@ function (FluentState $newState) use ($domain, $locale, $prefixDisabled, $pageNa
 
                 /** @var Page|FluentSiteTreeExtension $page */
                 $page = $this->objFromFixture(Page::class, $pageName);
-                $this->assertEquals($url, $page->Link());
+                $this->assertEquals(Controller::normaliseTrailingSlash($url), $page->Link());
             }
         );
     }