Add support for Silverstripe 5 (#70)

* Update min requirements. Add support for Silverstripe 5
* Update coding standards from 6 to 8. Add new exclusions. Update linting

Author: chrispenny

README.md

@@ -30,7 +30,6 @@ The overall aim of this module is twofold:
     * [Queued jobs](#queued-jobs)
 * [Case Studies](docs/en/case-studies.md)
 * [Fluent support](docs/en/fluent.md)
-* [GridField Orderable support](docs/en/gridfield-orderable.md)
 * [License](license.md)
 * [Maintainers](#maintainers)
 * [Development and contribution](#development-and-contribution)
@@ -41,6 +40,13 @@ The overall aim of this module is twofold:
 composer require silverstripe-terraformers/keys-for-cache
 ```
 
+## Requirements
+
+* PHP `^8.1`
+* Silverstripe Framework `^5`
+
+Support for Silverstripe 4 is provided though our `^1` tagged releases.
+
 ## Why cache keys are difficult
 
 The goal of any cache key is to have as low a cost as possible to calculate (as this must happen with every request),
@@ -289,9 +295,6 @@ See: [Case studies](docs/en/case-studies.md)
 
 See: [Fluent support](docs/en/fluent.md)
 
-## GridField Orderable support
-
-See: [GridField Orderable support](docs/en/gridfield-orderable.md)
 
 ## License
 

composer.json

@@ -19,13 +19,13 @@
         }
     ],
     "require": {
-        "php": "^7.4 || ^8.0",
-        "silverstripe/framework": "^4.6"
+        "php": "^8.1",
+        "silverstripe/framework": "^5"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",
-        "tractorcow/silverstripe-fluent": ">=4.0.0",
-        "slevomat/coding-standard": "~6.0"
+        "tractorcow/silverstripe-fluent": "^7",
+        "slevomat/coding-standard": "~8.8.0"
     },
     "autoload": {
         "psr-4": {

docs/en/gridfield-orderable.md

@@ -5,6 +5,11 @@
 	<file>src</file>
 	<file>tests</file>
 
+    <!-- Show progress and output sniff names on violation, and add colours -->
+    <arg value="p" />
+    <arg name="colors" />
+    <arg value="s" />
+
     <rule ref="PSR2">
         <!-- Allow non camel cased method names - some base SS method names are PascalCase or snake_case -->
         <exclude name="PSR1.Methods.CamelCapsMethodName.NotCamelCaps"/>
@@ -75,6 +80,26 @@
         <exclude name="SlevomatCodingStandard.ControlStructures.DisallowShortTernaryOperator.DisallowedShortTernaryOperator"/>
         <!-- You are not making me go \PHP_EOL -->
         <exclude name="SlevomatCodingStandard.Namespaces.FullyQualifiedGlobalConstants.NonFullyQualified"/>
+        <!-- We can't declare classes as abstract/final because that would remove the ability for devs to extend our -->
+        <!-- classes as they see fit -->
+        <exclude name="SlevomatCodingStandard.Classes.RequireAbstractOrFinal.ClassNeitherAbstractNorFinal"/>
+        <!-- We do not require trailing commas on multiline methods. Both rules disabled, as we'll allow folks to -->
+        <!-- add them if they want them, but we don't enforce either way -->
+        <exclude name="SlevomatCodingStandard.Functions.RequireTrailingCommaInCall.MissingTrailingComma"/>
+        <exclude name="SlevomatCodingStandard.Functions.DisallowTrailingCommaInCall.DisallowedTrailingComma"/>
+        <exclude name="SlevomatCodingStandard.Functions.RequireTrailingCommaInDeclaration.MissingTrailingComma"/>
+        <exclude name="SlevomatCodingStandard.Functions.DisallowTrailingCommaInDeclaration.DisallowedTrailingComma"/>
+        <exclude name="SlevomatCodingStandard.Functions.RequireTrailingCommaInClosureUse.MissingTrailingComma"/>
+        <exclude name="SlevomatCodingStandard.Functions.DisallowTrailingCommaInClosureUse.DisallowedTrailingComma"/>
+        <!-- Length does not determine complexity. We do not care if methods or files are long -->
+        <exclude name="SlevomatCodingStandard.Functions.FunctionLength.FunctionLength"/>
+        <exclude name="SlevomatCodingStandard.Files.FunctionLength.FunctionLength"/>
+        <exclude name="SlevomatCodingStandard.Files.FileLength.FileTooLong"/>
+        <exclude name="SlevomatCodingStandard.Classes.ClassLength.ClassTooLong"/>
+        <!-- We'll decide what is complex -->
+        <exclude name="SlevomatCodingStandard.Complexity.Cognitive.ComplexityTooHigh"/>
+        <!-- We require property promotion -->
+        <exclude name="SlevomatCodingStandard.Classes.DisallowConstructorPropertyPromotion.DisallowedConstructorPropertyPromotion"/>
     </rule>
 
     <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">

phpcs.xml.dist

@@ -1,9 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
 <phpunit bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true">
-    <testsuite name="Default">
-        <directory>tests/</directory>
-    </testsuite>
+    <testsuites>
+        <testsuite name="Default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
     <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
+        <whitelist addUncoveredFilesFromWhitelist="true">
             <directory suffix=".php">src/</directory>
             <exclude>
                 <directory suffix=".php">tests/</directory>

phpunit.xml.dist

@@ -4,11 +4,8 @@
 
 class CacheKeyDto
 {
-    private ?string $key;
-
-    public function __construct(?string $key)
+    public function __construct(private ?string $key)
     {
-        $this->key = $key;
     }
 
     public function getKey(): ?string

src/DataTransferObjects/CacheKeyDto.php

@@ -7,13 +7,9 @@
 
 class EdgeUpdateDto
 {
-    private Edge $edge;
-    private DataObject $instance;
 
-    public function __construct(Edge $edge, DataObject $instance)
+    public function __construct(private readonly Edge $edge, private readonly DataObject $instance)
     {
-        $this->edge = $edge;
-        $this->instance = $instance;
     }
 
     public function getEdge(): Edge

src/DataTransferObjects/EdgeUpdateDto.php

@@ -4,16 +4,10 @@
 
 class ProcessedUpdateDto
 {
-    private string $className;
-
-    private int $id;
-
     private bool $published = false;
 
-    public function __construct(string $className, int $id)
+    public function __construct(private readonly string $className, private readonly int $id)
     {
-        $this->className = $className;
-        $this->id = $id;
     }
 
     public function getClassName(): string

src/DataTransferObjects/ProcessedUpdateDto.php

@@ -4,17 +4,12 @@
 
 class Edge
 {
-    private Node $from;
-    private Node $to;
-    private string $relation;
-    private string $relationType;
-
-    public function __construct(Node $from, Node $to, string $relation, string $relationType)
-    {
-        $this->from = $from;
-        $this->to = $to;
-        $this->relation = $relation;
-        $this->relationType = $relationType;
+    public function __construct(
+        private readonly Node $from,
+        private readonly Node $to,
+        private readonly string $relation,
+        private readonly string $relationType
+    ) {
     }
 
     public function getFromClassName(): string