Merge pull request #4 from nswdpc/feat-ci-files

JamesDPC · web-flow · commit 55d53cb3d7a1 · 2025-11-14T18:53:48.000+11:00
Automated updates / review
diff --git a/.gitattributes b/.gitattributes
@@ -10,3 +10,4 @@
 /code-of-conduct.md         export-ignore
 /CONTRIBUTING.md            export-ignore
 /README.md                  export-ignore
+/.github                    export-ignore
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,13 @@
+name: CI
+
+on:
+  pull_request: null
+
+jobs:
+  Silverstripe:
+    name: 'Silverstripe (bundle)'
+    uses: nswdpc/ci-files/.github/workflows/silverstripe_53_83.yml@v-4
+  PHPStan:
+    name: 'PHPStan (analyse)'
+    uses: nswdpc/ci-files/.github/workflows/phpstan.silverstripe_83.yml@v-4
+    needs: Silverstripe
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,5 @@
 /vendor/
 .DS_Store
 /.php-cs-fixer.cache
+/public/
+/composer.lock
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ Developers, see [config.yml](./_config/config.yml) for module configuration valu
 
 ## Maintainers
 
-+ [dpcdigital@NSWDPC:~$](https://dpc.nsw.gov.au)
++ PD Web Team
 
 
 ## Bugtracker
diff --git a/composer.json b/composer.json
@@ -13,20 +13,48 @@
     "authors": [
         {
             "name": "James Ellis",
-            "homepage": "https://dpc.nsw.gov.au",
             "role": "Developer"
         }
     ],
+    "autoload": {
+        "psr-4": {
+            "NSWDPC\\Elemental\\Models\\Curator\\": [
+                "src/Models/",
+                "src/Models/Elements/"
+            ],
+            "NSWDPC\\Elemental\\Extensions\\Curator\\": "src/Extensions/",
+            "NSWDPC\\Elemental\\Controllers\\Curator\\": "src/Controllers/"
+        }
+    },
     "require": {
         "dnadesign/silverstripe-elemental": "^5"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",
-        "friendsofphp/php-cs-fixer": "^3"
+        "friendsofphp/php-cs-fixer": "^3",
+        "cambis/silverstan": "^2",
+        "cambis/silverstripe-rector": "^2",
+        "nswdpc/ci-files": "dev-v-4",
+        "phpstan/phpstan": "^2",
+        "rector/rector": "^2"
     },
     "extra": {
         "expose": [
             "client/static"
         ]
+    },
+    "scripts": {
+        "phpstan-analyse": "./vendor/bin/phpstan analyse --ansi --no-progress --no-interaction --configuration vendor/nswdpc/ci-files/phpstan/.phpstan.silverstripe.neon src/ tests/",
+        "rector-dryrun": "./vendor/bin/rector process --dry-run --ansi --config vendor/nswdpc/ci-files/rector/.rector.silverstripe_53_83.php src/ tests/",
+        "rector-process": "./vendor/bin/rector process --no-diffs --ansi --config vendor/nswdpc/ci-files/rector/.rector.silverstripe_53_83.php src/ tests/",
+        "phpcsfixer-fix": "./vendor/bin/php-cs-fixer fix --ansi --no-interaction --config vendor/nswdpc/ci-files/php-cs-fixer/.php-cs-fixer.php src/ tests/"
+    },
+    "config": {
+        "allow-plugins": {
+            "composer/installers": true,
+            "silverstripe/vendor-plugin": true,
+            "silverstripe/recipe-plugin": true,
+            "phpstan/extension-installer": true
+        }
     }
 }
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,13 +1,14 @@
-<phpunit bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true">
-    <testsuite name="nswdpc/silverstripe-curatorio">
-        <directory>tests/</directory>
-    </testsuite>
-    <filter>
-        <whitelist addUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">src/</directory>
-            <exclude>
-                <directory suffix=".php">tests/</directory>
-            </exclude>
-        </whitelist>
-    </filter>
+<?xml version="1.0"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage includeUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+    <exclude>
+      <directory suffix=".php">tests/</directory>
+    </exclude>
+  </coverage>
+  <testsuite name="nswdpc/silverstripe-curatorio">
+    <directory>tests/</directory>
+  </testsuite>
 </phpunit>
diff --git a/src/Controllers/CuratorFeedAdmin.php b/src/Controllers/CuratorFeedAdmin.php
@@ -8,29 +8,29 @@
 /**
  * Curator Feed Admin, for editing/creating/deleting feeds
  *
- * @author james.ellis@dpc.nsw.gov.au
+ * @author James
  */
 class CuratorFeedAdmin extends ModelAdmin
 {
     /**
      * @inheritdoc
      */
-    private static $managed_models = [
+    private static array $managed_models = [
         CuratorFeed::class
     ];
 
     /**
      * @inheritdoc
      */
-    private static $menu_title = 'Curator.io';
+    private static string $menu_title = 'Curator.io';
 
     /**
      * @inheritdoc
      */
-    private static $menu_icon_class = 'font-icon-block-carousel';
+    private static string $menu_icon_class = 'font-icon-block-carousel';
 
     /**
      * @inheritdoc
      */
-    private static $url_segment = 'curatorio';
+    private static string $url_segment = 'curatorio';
 }
diff --git a/src/Extensions/SiteConfigExtension.php b/src/Extensions/SiteConfigExtension.php
@@ -3,22 +3,24 @@
 namespace NSWDPC\Elemental\Extensions\Curator;
 
 use NSWDPC\Elemental\Models\Curator\CuratorFeed;
-use Silverstripe\ORM\DataExtension;
-use Silverstripe\Forms\FieldList;
-use Silverstripe\Forms\DropdownField;
+use SilverStripe\ORM\DataExtension;
+use SilverStripe\Forms\FieldList;
+use SilverStripe\Forms\DropdownField;
 
 /**
  * Provide content administrators the ability to select a global site social feed
  * from a list of configured feeds
  * @author James
+ * @property int $CuratorFeedRecordID
+ * @method \NSWDPC\Elemental\Models\Curator\CuratorFeed CuratorFeedRecord()
+ * @extends \SilverStripe\ORM\DataExtension<(\SilverStripe\SiteConfig\SiteConfig & static)>
  */
 class SiteConfigExtension extends DataExtension
 {
-
     /**
      * @inheritdoc
      */
-    private static $has_one = [
+    private static array $has_one = [
         'CuratorFeedRecord' => CuratorFeed::class
     ];
 
@@ -32,7 +34,7 @@ public function updateCmsFields(FieldList $fields)
             [
                 DropdownField::create(
                     'CuratorFeedRecordID',
-                    _t(__CLASS__. '.SELECT_CURATOR_FEED', 'Select a global Curator.io feed'),
+                    _t(self::class. '.SELECT_CURATOR_FEED', 'Select a global Curator.io feed'),
                     CuratorFeed::get()->map('ID', 'Title')
                 )->setEmptyString('')
             ]
@@ -42,22 +44,22 @@ public function updateCmsFields(FieldList $fields)
     /**
      * To add the field to your own SiteConfig extension, call this method
      * e.g $this->owner->getSocialFeedSelector()
-     * @return DropdownField
      */
-    public function getSocialFeedSelector() : DropdownField {
-        $field = DropdownField::create(
+    public function getSocialFeedSelector(): DropdownField
+    {
+        return DropdownField::create(
             'CuratorFeedRecordID',
-            _t(__CLASS__. '.SELECT_CURATOR_FEED', 'Select a global Curator.io feed'),
+            _t(self::class. '.SELECT_CURATOR_FEED', 'Select a global Curator.io feed'),
             CuratorFeed::get()->map('ID', 'Title')
         )->setEmptyString('');
-        return $field;
     }
 
     /**
      * @return CuratorFeed|null
      */
-    public function getSocialFeedRecord() {
-        return $this->owner->CuratorFeedRecord();
+    public function getSocialFeedRecord()
+    {
+        return $this->getOwner()->CuratorFeedRecord();
     }
 
 }
diff --git a/src/Models/CuratorFeed.php b/src/Models/CuratorFeed.php
diff --git a/src/Models/Elements/ElementCuratorFeedWidget.php b/src/Models/Elements/ElementCuratorFeedWidget.php
diff --git a/tests/CuratorWidgetTest.php b/tests/CuratorWidgetTest.php
