Merge branch 'release/1.3.0'

Author: jflearn

.github/workflows/ci.yml

@@ -16,39 +16,8 @@ on:
 
 jobs:
 
-  test:
-
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - operating-system: 'ubuntu-latest'
-            silverstripe-version: '5.0'
-            php-version: '8.1'
-          - operating-system: 'ubuntu-latest'
-            silverstripe-version: '4.0'
-            php-version: '8.0'
-          - operating-system: 'ubuntu-latest'
-            silverstripe-version: '4.0'
-            php-version: '7.4'
-
-    name: 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 }}
-          php_version: ${{ matrix.php-version }}
-          php_extensions: intl
-      - run: |
-          ./vendor/bin/phpunit -c phpunit.xml.dist
-
-  tidy:
-
-    name: "Annotate & Tidy"
-    needs: [test]
+  latest:
+    name: "Build & Verify"
     runs-on: 'ubuntu-latest'
     steps:
       - uses: actions/checkout@v3
@@ -65,30 +34,56 @@ jobs:
           --coverage-clover ./coverage.xml
       - name: Annotate with Metrics
         run: |
-          find src -name "*.php" | xargs ./vendor/bin/metrics annotate ./coverage.xml
+          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 ./vendor/bin/phptidy.php replace
-          find src -name "*.php" | xargs ./vendor/bin/phptidy.php replace
+          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 add . && \
             git commit -m "tidy" && \
             git fetch --unshallow origin ${{ github.head_ref || github.ref_name }} && \
             git push origin HEAD:${{ github.head_ref || github.ref_name }} \
           )
 
-  merge:
+  matrix:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - operating-system: 'ubuntu-latest'
+            silverstripe-version: '5.0'
+            php-version: '8.1'
+          - operating-system: 'ubuntu-latest'
+            silverstripe-version: '4.0'
+            php-version: '8.0'
+          - operating-system: 'ubuntu-latest'
+            silverstripe-version: '4.0'
+            php-version: '7.4'
+    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 }}
+          php_version: ${{ matrix.php-version }}
+          php_extensions: intl
+      - run: |
+          ./vendor/bin/phpunit -c phpunit.xml.dist
 
+  merge:
     name: "Merge Changes"
     if: github.event_name == 'push'
-    needs: [test]
+    needs: [latest,matrix]
     runs-on: 'ubuntu-latest'
     steps:
       - uses: actions/checkout@v3

.gitignore

@@ -1,4 +1,11 @@
-resources
+.phptidy-cache
+.phpunit.result.cache
+*.log
+*~
+app
 composer.lock
+coverage.xml
+DOCKER_ENV
+docker_tag
+resources
 vendor
-*~

README.md

@@ -8,7 +8,8 @@ These include:
   - a *shortcode* with which to insert a user form into any content area;
   - a *form widget* that presents a user form (requires
     [silverstripe/widgets](https://github.com/silverstripe/silverstripe-widgets));
-  - various new *form fields*.
+  - various *additional validations* for existing form fields;
+  - various *new form fields*.
 
 ## Installation
 
@@ -43,7 +44,14 @@ You have the ability to customize display with the following options:
  - **Show form content?** - Chose whether to display the content of the form
    page.
 
-## Form Fields
+## Additional Field Validations
+
+### Maximum File Size
+
+The maximum file size for a form fields will now be checked prior to submission.
+This is much more responsive for the user.
+
+## New Form Fields
 
 This module provides a selection of new field types to use with your user forms.
 

_config/config.yml

@@ -1,3 +1,4 @@
 ---
 Name: userforms-utils
----
+After: 'userforms/*'
+---

phpunit.xml.dist

@@ -1,20 +1,29 @@
-<?xml version="1.0"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/silverstripe/cms/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>
-    <report>
-      <clover outputFile="clover.xml"/>
-    </report>
-  </coverage>
-  <testsuite name="Default">
-    <directory>tests/</directory>
-  </testsuite>
-  <logging/>
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+         bootstrap="vendor/silverstripe/cms/tests/bootstrap.php"
+         executionOrder="depends,defects"
+         forceCoversAnnotation="false"
+         beStrictAboutCoversAnnotation="true"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutTodoAnnotatedTests="true"
+         failOnRisky="true"
+         failOnWarning="true"
+         verbose="true">
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+        <exclude>
+            <file>src/bootstrap.php</file>
+        </exclude>
+    </coverage>
   <php>
     <includePath>app/code</includePath>
     <env name="SS_DATABASE_CLASS" value="SQLite3Database"/>

rector.php

@@ -1,15 +1,13 @@
 <?php
-/**
- *
- * @package default
- */
 
 
 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;
 
@@ -22,8 +20,10 @@
 		] );
 
 	$rectorConfig->skip( [
-			RemoveUnusedPrivatePropertyRector::class,
+			CompleteDynamicPropertiesRector::class,
 			ExplicitBoolCompareRector::class,
+			RemoveParentCallWithoutParentRector::class,
+			RemoveUnusedPrivatePropertyRector::class,
 		] );
 
 	$rectorConfig->importShortClasses();

src/FormFields/EditableHTML5DateField.php

@@ -1,9 +1,4 @@
 <?php
-/**
- * src/FormFields/EditableHTML5DateField.php
- *
- * @package default
- */
 
 
 namespace Logicbrush\UserFormsUtils\FormFields;
@@ -15,8 +10,9 @@
 /**
  * An HTML5 date field.
  *
- * @package userform-utils
  */
+
+
 class EditableHTML5DateField extends EditableFormField {
 
 	private static $singular_name = 'HTML5 Date Field';
@@ -25,6 +21,7 @@ class EditableHTML5DateField extends EditableFormField {
 
 	/**
 	 *
+	 * @Metrics( crap = 6, uncovered = true )
 	 * @return unknown
 	 */
 	public function getFormField() {

src/FormFields/EditableSignatureField.php

@@ -1,9 +1,4 @@
 <?php
-/**
- * src/FormFields/EditableSignatureField.php
- *
- * @package default
- */
 
 
 namespace Logicbrush\UserFormsUtils\FormFields;
@@ -22,8 +17,11 @@ class EditableSignatureField extends EditableFormField {
 
 	/**
 	 *
+	 * @Metrics( crap = 6, uncovered = true )
 	 * @return unknown
 	 */
+
+
 	public function getFormField() {
 		$field = TextField::create( $this->Name, $this->Title ?: false )
 		->setFieldHolderTemplate( EditableFormField::class . '_holder' )
@@ -38,6 +36,8 @@ public function getFormField() {
 	 * Returns an image field, so the signature can be viewed in the CMS and in
 	 * reports.
 	 *
+	 *
+	 * @Metrics( crap = 2, uncovered = true )
 	 * @return unknown
 	 */
 	public function getSubmittedFormField() : SubmittedFormField

src/FormFields/EditableUSStateDropdownField.php

@@ -1,9 +1,4 @@
 <?php
-/**
- * src/FormFields/EditableUSStateDropdownField.php
- *
- * @package default
- */
 
 
 namespace Logicbrush\UserFormsUtils\FormFields;
@@ -23,8 +18,9 @@
  *
  * @property bool $UseEmptyString
  * @property string $EmptyString
- * @package userform-utils
  */
+
+
 class EditableUSStateDropdownField extends EditableFormField {
 
 	private static $singular_name = 'US State Dropdown';
@@ -90,6 +86,7 @@ class EditableUSStateDropdownField extends EditableFormField {
 
 	/**
 	 *
+	 * @Metrics( crap = 2, uncovered = true )
 	 * @return FieldList
 	 */
 	public function getCMSFields() {
@@ -120,6 +117,7 @@ public function getCMSFields() {
 
 	/**
 	 *
+	 * @Metrics( crap = 30, uncovered = true )
 	 * @return unknown
 	 */
 	public function getFormField() {
@@ -147,6 +145,7 @@ public function getFormField() {
 
 	/**
 	 *
+	 * @Metrics( crap = 6, uncovered = true )
 	 * @param unknown $data
 	 * @return unknown
 	 */
@@ -161,6 +160,7 @@ public function getValueFromData( $data ) {
 
 	/**
 	 *
+	 * @Metrics( crap = 6, uncovered = true )
 	 * @return unknown
 	 */
 	public function getIcon() {
@@ -176,6 +176,7 @@ public function getIcon() {
 
 	/**
 	 *
+	 * @Metrics( crap = 2, uncovered = true )
 	 * @param unknown $forOnLoad (optional)
 	 * @return unknown
 	 */

src/FormFields/Impl/HTML5DateField.php

@@ -1,9 +1,4 @@
 <?php
-/**
- * src/FormFields/Impl/HTML5DateField.php
- *
- * @package default
- */
 
 
 namespace Logicbrush\UserFormsUtils\FormFields\Impl;
@@ -14,10 +9,13 @@ class HTML5DateField extends DateField {
 
 	/**
 	 *
+	 * @Metrics( crap = 2, uncovered = true )
 	 * @param unknown $name
 	 * @param unknown $title (optional)
 	 * @param unknown $value (optional)
 	 */
+
+
 	public function __construct( $name, $title = null, $value = "" ) {
 		parent::__construct( $name, $title, $value );
 		$this->setHTML5( true );
@@ -26,6 +24,7 @@ public function __construct( $name, $title = null, $value = "" ) {
 
 	/**
 	 *
+	 * @Metrics( crap = 2, uncovered = true )
 	 * @return unknown
 	 */
 	public function getAttributes() {