Merge branch 'release/1.1.0'

.github/workflows/ci.yml

@@ -1,11 +1,59 @@
 name: "Continuous Integration"
 
-on: 
+on:
   push:
+    branches:
+      - "hotfix/**"
+      - "release/**"
+      - "develop"
+      - "master"
+  pull_request:
+    branches:
+      - "hotfix/**"
+      - "release/**"
+      - "develop"
+      - "master"
 
 jobs:
 
-  tests:
+  latest:
+    name: "Build & Verify"
+    runs-on: 'ubuntu-latest'
+    steps:
+      - uses: actions/checkout@v3
+      - uses: php-actions/composer@v6
+        with:
+          command: update
+            --with silverstripe/framework:^5.0
+          php_version: 8.1
+          php_extensions: xdebug intl
+      - name: Generate Code Coverage
+        run: |
+          XDEBUG_MODE=coverage \
+          ./vendor/bin/phpunit -c phpunit.xml.dist \
+          --coverage-clover ./coverage.xml
+      - name: Annotate with Metrics
+        run: |
+          find src -name "*.php" | xargs -n 1 ./vendor/bin/metrics annotate ./coverage.xml
+      - name: Refactor with Rector
+        run: |
+          ./vendor/bin/rector process src
+      - name: Tidy Source Code
+        run: |
+          find tests -name "*.php" | xargs -n 1 ./vendor/bin/phptidy.php replace
+          find src -name "*.php" | xargs -n 1 ./vendor/bin/phptidy.php replace
+      - name: Push Back Changes
+        run: |
+          git diff --exit-code src || ( \
+            git config user.name github-actions && \
+            git config user.email github-actions@github.com && \
+            git add src && \
+            git commit -m "tidy" && \
+            git fetch --unshallow origin ${{ github.head_ref || github.ref_name }} && \
+            git push origin HEAD:${{ github.head_ref || github.ref_name }} \
+          )
+
+  matrix:
     strategy:
       fail-fast: false
       matrix:
@@ -19,16 +67,32 @@ jobs:
           - operating-system: 'ubuntu-latest'
             silverstripe-version: '4.0'
             php-version: '7.4'
-
-    name: SS ${{ matrix.silverstripe-version }}, PHP ${{ matrix.php-version }}
+    name: "Matrix: SS ${{ matrix.silverstripe-version }}, PHP ${{ matrix.php-version }}"
     runs-on: ${{ matrix.operating-system }}
     steps:
       - uses: actions/checkout@v3
       - uses: php-actions/composer@v6
         with:
-          command: update --with silverstripe/framework:^${{ matrix.silverstripe-version }}
+          command: update
+            --with silverstripe/framework:^${{ matrix.silverstripe-version }}
           php_version: ${{ matrix.php-version }}
           php_extensions: intl
       - run: |
-          ./vendor/bin/phpunit -c phpunit.xml.dist \
-          --coverage-clover ./coverage.xml
+          ./vendor/bin/phpunit -c phpunit.xml.dist
+
+  merge:
+    name: "Merge Changes"
+    if: github.event_name == 'push'
+    needs: [latest,matrix]
+    runs-on: 'ubuntu-latest'
+    steps:
+      - uses: actions/checkout@v3
+      - run: |
+          false || ( \
+            git config user.name github-actions && \
+            git config user.email github-actions@github.com && \
+            git fetch --unshallow origin ${{ github.ref_name }} develop && \
+            git checkout develop && \
+            git merge origin/${{ github.ref_name }} && \
+            git push \
+          )

.gitignore

@@ -1,8 +1,8 @@
-/app
-/vendor
-/resources
-/assets
+resources
 composer.lock
-*.cache
-*.bak
+vendor
 *~
+coverage.xml
+public/assets
+.phpunit.result.cache
+app

.phptidy-config.php

@@ -1,9 +1,10 @@
 <?php
 
+$default_package = 'silverstripe-userform-utils';
 $add_operator_space = true;
 $fix_round_bracket_space = true;
-$add_file_docblock = true;
+$add_file_docblock = false;
 $add_function_docblocks = true;
-$add_doctags = true;
+$add_doctags = false;
 $fix_docblock_format = true;
 $fix_docblock_space = true;

composer.json

@@ -27,7 +27,8 @@
 		"phpunit/phpunit": "^9.5",
 		"silverstripe/sqlite3": "*",
 		"logicbrush/metrics": "*",
-		"cmrcx/phptidy": "*"
+		"cmrcx/phptidy": "*",
+		"rector/rector": "^1.2"
 	},
 	"autoload": {
 		"psr-4": {

public/_resources/.htaccess

@@ -0,0 +1,10 @@
+# Block .method file
+<Files .method>
+    Require all denied
+</Files>
+
+# Prevent file listings
+<IfModule mod_dir.c>
+    DirectoryIndex disabled
+    DirectorySlash On
+</IfModule>

public/_resources/.method

@@ -0,0 +1 @@
+auto

public/_resources/css

@@ -0,0 +1 @@
+../../css

public/_resources/images

@@ -0,0 +1 @@
+../../images

public/_resources/javascript

@@ -0,0 +1 @@
+../../javascript

rector.php

@@ -0,0 +1,32 @@
+<?php
+
+
+declare( strict_types = 1 );
+
+use Rector\CodeQuality\Rector\Class_\CompleteDynamicPropertiesRector;
+use Rector\CodeQuality\Rector\If_\ExplicitBoolCompareRector;
+use Rector\Config\RectorConfig;
+use Rector\DeadCode\Rector\Property\RemoveUnusedPrivatePropertyRector;
+use Rector\DeadCode\Rector\StaticCall\RemoveParentCallWithoutParentRector;
+use Rector\Set\ValueObject\LevelSetList;
+use Rector\Set\ValueObject\SetList;
+
+return static function ( RectorConfig $rectorConfig ): void {
+
+	$rectorConfig->sets( [
+			LevelSetList::UP_TO_PHP_74,
+			SetList::CODE_QUALITY,
+			SetList::DEAD_CODE,
+		] );
+
+	$rectorConfig->skip( [
+			CompleteDynamicPropertiesRector::class,
+			ExplicitBoolCompareRector::class,
+			RemoveParentCallWithoutParentRector::class,
+			RemoveUnusedPrivatePropertyRector::class,
+		] );
+
+	$rectorConfig->importShortClasses();
+	$rectorConfig->importNames();
+
+};

src/Controllers/RollupPageController.php

@@ -17,6 +17,7 @@ class RollupPageController extends PageController
 
 	/**
 	 *
+	 * @Metrics( crap = 3 )
 	 */
 	public function init() {
 		parent::init();
@@ -35,6 +36,7 @@ public function init() {
 
 	/**
 	 *
+	 * @Metrics( crap = 1 )
 	 * @return unknown
 	 */
 	public function index() {

src/Model/RollupPage.php

@@ -82,12 +82,10 @@ public function getCMSFields() {
 	 * @return unknown
 	 */
 	public function Children() {
-		if ( $this->ShowLinksOnly !== 1 ) {
+		if ( $this->ShowLinksOnly !== self::DISPLAY_LIST ) {
 			return ArrayList::create();
 		}
-		$children = parent::Children();
-
-		return parent::Children()->exclude( ['Content' => ''] );
+		return  parent::Children();
 	}
 
 

src/Model/WithRollupSupportExtension.php

@@ -22,7 +22,7 @@ class WithRollupSupportExtension extends DataExtension
 
 	/**
 	 *
-	 * @param FieldList $fields
+	 * @Metrics( crap = 1 )
 	 */
 	public function updateSettingsFields( FieldList $fields ) {
 		$fields->insertAfter( 'ShowInSearch', CheckboxField::create( 'NeverRollup', 'Never rollup this page?' ) );
@@ -31,19 +31,17 @@ public function updateSettingsFields( FieldList $fields ) {
 
 	/**
 	 *
+	 * @Metrics( crap = 7 )
 	 * @param unknown $link
 	 * @param unknown $action
 	 * @param unknown $relativeLink
 	 */
 	public function updateLink( &$link, &$action, &$relativeLink ) {
-		if ( $action === null ) {
-			if ( ! $this->owner->NeverRollup &&
+		if ( $action === null && ( ! $this->owner->NeverRollup &&
 				! ( Controller::has_curr() && Controller::curr() instanceof CMSPageEditController ) &&
 				$this->owner->Parent() instanceof RollupPage &&
-				$this->owner->Parent()->ShowLinksOnly !== 1
-			) {
-				$link = $this->owner->Parent()->Link() . '#' . $this->owner->URLSegment;
-			}
+				$this->owner->Parent()->ShowLinksOnly !== 1 ) ) {
+			$link = $this->owner->Parent()->Link() . '#' . $this->owner->URLSegment;
 		}
 	}
 

tests/unit/Model/RollupPageTest.php

@@ -40,52 +40,36 @@ public function testGetCMSFields() {
 
 
 	/**
-	 *
+	 * The list of children for the rollup page can vary depending on the value
+	 * of `ShowLinksOnly`.
 	 */
-	public function testChildren() {
+	public function testChildrenWithShowLinksOnlyOptions() {
+
 		$rollupPage = RollupPage::create();
-		$rollupPage->ShowLinksOnly = 1;
+		$rollupPage->ShowLinksOnly = RollupPage::DISPLAY_INLINE;
 		$rollupPage->write();
 		$rollupPage->publishSingle();
 
-		$this->assertEquals( 0, $rollupPage->Children()->count() );
-
-		$page1 = Page::create();
-		$page1->Content = '<p>Page 1</p>';
-		$page1->ParentID = $rollupPage->ID;
-		$page1->write();
-		$page1->publishSingle();
+		$childPage = Page::create();
+		$childPage->ParentID = $rollupPage->ID;
+		$childPage->write();
+		$childPage->publishSingle();
 
-		$page2 = Page::create();
-		$page2->Content = '';
-		$page2->ParentID = $rollupPage->ID;
-		$page2->write();
-		$page2->publishSingle();
+		// ShowLinksOnly == DISPLAY_INLINE -> should have no children.
+		$this->assertEquals( 0, $rollupPage->Children()->count() );
 
+		$rollupPage->ShowLinksOnly = RollupPage::DISPLAY_LIST;
 		$rollupPage->write();
 		$rollupPage->publishSingle();
 
+		// ShowLinksOnly == DISPLAY_LIST -> should have one child.
 		$this->assertEquals( 1, $rollupPage->Children()->count() );
 
-		$page2->Content = '<p>Page 2</p>';
-		$page2->write();
-		$page2->publishSingle();
-
-		$rollupPage->write();
-		$rollupPage->publishSingle();
-
-		$this->assertEquals( 2, $rollupPage->Children()->count() );
-
-		$rollupPage->ShowLinksOnly = 2;
-		$rollupPage->write();
-		$rollupPage->publishSingle();
-
-		$this->assertEquals( 0, $rollupPage->Children()->count() );
-
-		$rollupPage->ShowLinksOnly = 0;
+		$rollupPage->ShowLinksOnly = RollupPage::DISPLAY_TABS;
 		$rollupPage->write();
 		$rollupPage->publishSingle();
 
+		// ShowLinksOnly == DISPLAY_TABS -> should have no children.
 		$this->assertEquals( 0, $rollupPage->Children()->count() );
 	}