Merge pull request #16 from jack-nzl/master

Silverstripe 6 compatibility upgrade

Author: benmanu

composer.json

@@ -3,7 +3,10 @@
 	"description": "Provides a kitchen sink template useful for theme development.",
 	"type": "silverstripe-vendormodule",
 	"homepage": "https://github.com/benmanu/silverstripe-simple-styleguide",
-	"keywords": ["silverstripe", "styleguide"],
+	"keywords": [
+		"silverstripe",
+		"styleguide"
+	],
 	"license": "BSD-3-Clause",
 	"authors": [
 		{
@@ -15,25 +18,46 @@
 		"issues": "https://github.com/benmanu/silverstripe-simple-styleguide/issues"
 	},
 	"require": {
-		"silverstripe/cms": "^5.0"
+		"silverstripe/recipe-cms": "^6",
+		"silverstripe/subsites": "^4.0"
 	},
 	"require-dev": {
-		"phpunit/phpunit": "^9.6"
+		"phpunit/phpunit": "^11"
 	},
 	"extra": {
 		"installer-name": "simple-styleguide",
-        "expose": [
-            "css",
-            "js",
-            "images"
-        ]
-    },
-    "autoload": {
-        "psr-4": {
-            "BenManu\\SimpleStyleguide\\": "src/",
-            "BenManu\\SimpleStyleguide\\Tests\\": "tests/"
-        }
-    },
-    "prefer-stable": true,
-    "minimum-stability": "dev"
+		"expose": [
+			"css",
+			"js",
+			"images"
+		],
+		"project-files-installed": [
+			".htaccess",
+			"app/.htaccess",
+			"app/_config/mimevalidator.yml",
+			"app/_config/mysite.yml",
+			"app/src/Page.php",
+			"app/src/PageController.php"
+		],
+		"public-files-installed": [
+			".htaccess",
+			"index.php",
+			"web.config"
+		]
+	},
+	"autoload": {
+		"psr-4": {
+			"BenManu\\SimpleStyleguide\\": "src/",
+			"BenManu\\SimpleStyleguide\\Tests\\": "tests/"
+		}
+	},
+	"prefer-stable": true,
+	"minimum-stability": "dev",
+	"config": {
+		"allow-plugins": {
+			"composer/installers": true,
+			"silverstripe/recipe-plugin": true,
+			"silverstripe/vendor-plugin": true
+		}
+	}
 }

src/SimpleStyleguideController.php

@@ -6,14 +6,14 @@
 use SilverStripe\Control\Director;
 use SilverStripe\Core\Manifest\ModuleResourceLoader;
 use SilverStripe\Core\Injector\Injector;
+use SilverStripe\Model\List\ArrayList;
 use SilverStripe\Security\Permission;
 use SilverStripe\Security\Security;
 use SilverStripe\CMS\Model\SiteTree;
 use SilverStripe\CMS\Controllers\ModelAsController;
 use SilverStripe\View\Requirements;
-use SilverStripe\View\ArrayData;
+use SilverStripe\Model\ArrayData;
 use SilverStripe\ORM\FieldType\DBField;
-use SilverStripe\ORM\ArrayList;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\TextField;
 use SilverStripe\Forms\NumericField;
@@ -23,10 +23,12 @@
 use SilverStripe\Forms\CheckboxSetField;
 use SilverStripe\Forms\OptionsetField;
 use SilverStripe\Forms\FormAction;
-use SilverStripe\Forms\RequiredFields;
 use SilverStripe\Forms\Form;
 use SilverStripe\Assets\File;
+use SilverStripe\Core\Config\Config;
+use SilverStripe\Forms\Validation\RequiredFieldsValidator;
 use SilverStripe\Subsites\Model\Subsite;
+use SilverStripe\View\SSViewer;
 
 /**
  * @package simple-styleguide
@@ -65,7 +67,14 @@ public function index()
 
         // If the subsite module is installed then set the theme based on the current subsite
         if (class_exists(Subsite::class) && Subsite::currentSubsite()) {
-            Config::inst()->update('SSViewer', 'theme', Subsite::currentSubsite()->Theme);
+            Config::modify()->set(
+                SSViewer::class,
+                'theme',
+                [
+                    Subsite::currentSubsite()->Theme,
+                    '$default'
+                ]
+            );
         }
 
         $page = Injector::inst()->create(SiteTree::class);
@@ -83,11 +92,10 @@ public function index()
 
     /**
      * Provides access to any custom function on the controller for use on the template output.
-     * @return ArrayData
      */
-    public function getStyleguideData()
+    public function getStyleguideData(): ArrayData
     {
-        $data = new ArrayData([
+        $data = ArrayData::create([
             'Title' => 'Styleguide',
             'Message' => DBField::create_field(
                 'HTMLText',
@@ -107,9 +115,8 @@ public function getStyleguideData()
 
     /**
      * Return a form with fields to match rendering through controller/template output.
-     * @return Form
      */
-    public function getTestForm()
+    public function getTestForm(): Form
     {
         $fields = FieldList::create(
             TextField::create('SimpleText', 'Simple Text Field'),
@@ -144,14 +151,14 @@ public function getTestForm()
             FormAction::create('doForm', 'Submit')
         );
 
-        $required = new RequiredFields(
+        $required = RequiredFieldsValidator::create(
             'SimpleText',
             'Email',
             'Checkbox',
             'Dropdown'
         );
 
-        $form = new Form($this, 'TestForm', $fields, $actions, $required);
+        $form = Form::create($this, 'TestForm', $fields, $actions, $required);
         $form->setMessage('This is a form wide message. See the alerts component for site wide messages.', 'warning');
 
         $this->extend('updateForm', $form);
@@ -161,9 +168,8 @@ public function getTestForm()
 
     /**
      * Emulate an HTMLEditorField output useful for testing shortcodes and output extensions etc.
-     * @return HTMLText
      */
-    public function getContent()
+    public function getContent(): DBField
     {
         $content = '';
 
@@ -181,10 +187,7 @@ public function getContent()
         return DBField::create_field('HTMLText', $content);
     }
 
-    /**
-     * @return ArrayList
-     */
-    public function getColorSwatches()
+    public function getColorSwatches(): ArrayList
     {
         $list = ArrayList::create();
         $colors = $this->config()->color_swatches;
@@ -200,10 +203,7 @@ public function getColorSwatches()
         return $list;
     }
 
-    /**
-     * @return string
-     */
-    public function getPlaceholderImageURL()
+    public function getPlaceholderImageURL(): ?string
     {
         $url = $this->config()->placeholder_image_url;
         $url = ModuleResourceLoader::singleton()->resolveURL($url);

tests/SimpleStyleguideControllerTest.php

@@ -4,7 +4,6 @@
 
 use BenManu\SimpleStyleguide\SimpleStyleguideController;
 use SilverStripe\Dev\SapphireTest;
-use SilverStripe\Core\Config\Config;
 
 /**
  * @package simple-styleguide
@@ -84,7 +83,7 @@ public function testGetColorSwatches()
         ];
 
         SimpleStyleguideController::config()->remove('color_swatches');
-        SimpleStyleguideController::config()->update('color_swatches', $swatchesFixture);
+        SimpleStyleguideController::config()->color_swatches = $swatchesFixture;
 
         $swatches = $controller->getColorSwatches();
 

tests/SimpleStyleguideControllerTest_data.php

@@ -2,10 +2,10 @@
 
 namespace BenManu\SimpleStyleguide;
 
-use SilverStripe\ORM\DataExtension;
+use SilverStripe\Core\Extension;
 use SilverStripe\Dev\TestOnly;
 
-class SimpleStyleguideControllerTest_data extends DataExtension implements TestOnly {
+class SimpleStyleguideControllerTest_data extends Extension implements TestOnly {
     public function updateStyleguideData($data)
     {
         $data->setField('CustomData', 'Test');