Merge pull request #4 from codem/maint-module-requirements

Module requirements - general maintenance and requirements updates

Author: MrJamesEllis

.gitattributes

@@ -1,9 +1,9 @@
-/tests  export-ignore
-/docs export-ignore
-/client/src export-ignore
-/.gitattributes export-ignore
-/.gitignore export-ignore
-/.php_cs.dist
-/.phpcs.xml.dist
-/.phpunit.xml.dist
-/README.md export-ignore
+/tests                      export-ignore
+/docs                       export-ignore
+/.editorconfig              export-ignore
+/.gitattributes             export-ignore
+/.gitignore                 export-ignore
+/.php-cs-fixer.dist.php     export-ignore
+/code-of-conduct.md         export-ignore
+/CONTRIBUTING.md            export-ignore
+/README.md                  export-ignore

.php-cs-fixer.dist.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ * Configuration file for https://github.com/FriendsOfPHP/PHP-CS-Fixer
+ * Install with composer: $ composer global require friendsofphp/php-cs-fixer
+ * Usage (in this directory) :  ~/.composer/vendor/bin/php-cs-fixer fix .
+ */
+$finder = PhpCsFixer\Finder::create()
+            ->in(__DIR__);
+
+$config = new PhpCsFixer\Config();
+return $config->setRules([
+            '@PSR2' => true,
+            'array_indentation' => true,
+            'array_syntax' => ['syntax' => 'short'],
+            'blank_line_after_namespace' => true,
+            'blank_line_after_opening_tag' => true,
+            'full_opening_tag' => true,
+            'no_closing_tag' => true,
+        ])
+        ->setIndent("    ")
+        ->setFinder($finder);

composer.json

@@ -25,11 +25,11 @@
         }
     },
     "require": {
-        "silverstripe/framework" : "^4"
+        "silverstripe/framework" : "^4.10.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^5.7 | ^9.5",
-        "squizlabs/php_codesniffer": "^3.0",
+        "phpunit/phpunit": "^9.5",
+        "friendsofphp/php-cs-fixer": "^3",
         "ext-dom" : "*"
     }
 }

phpcs.xml.dist

@@ -11,7 +11,8 @@
  * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/color
  * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/color#Value wrt value
  */
-class ColorField extends TextField {
+class ColorField extends TextField
+{
 
     use Core;
     use Datalist;
@@ -24,7 +25,8 @@ class ColorField extends TextField {
      * Returns the value saved as a 6 chr RGB colour with # prefixed
      * @return string
      */
-    public function dataValue() {
+    public function dataValue()
+    {
         $value = $this->getValidRGB($this->value);
         return $value;
     }
@@ -42,7 +44,8 @@ public function Value()
      * @param string $value an RGB colour value as a 'valid simple colour'
      * @return void
      */
-    public function setValue($value, $data = null) {
+    public function setValue($value, $data = null)
+    {
         $this->value = $this->getValidRGB($value);
     }
 
@@ -61,7 +64,8 @@ public function setValue($value, $data = null) {
      *    representing the red component, the middle two digits representing the green component,
      *  and the last two digits representing the blue component, in hexadecimal.</blockquote>
      */
-    public function getValidRGB($value, Validator $validator = null) {
+    public function getValidRGB($value, Validator $validator = null)
+    {
 
         // empty values default to the empty value value
         if(!$value) {
@@ -71,7 +75,7 @@ public function getValidRGB($value, Validator $validator = null) {
         $value = strtolower($value);
 
         // If input is not exactly seven characters long, then return an error.
-        if(mb_strlen( $value ) != 7) {
+        if(mb_strlen($value) != 7) {
             if($validator) {
                 $validator->validationError(
                     $this->name,

src/Forms/ColorField.php

@@ -5,7 +5,8 @@
 /**
  * Provides a class for those of us not using en_US
  */
-class ColourField extends ColorField {
+class ColourField extends ColorField
+{
 
     protected $template = "Codem/Utilities/HTML5/ColorField";
 

src/Forms/ColourField.php

@@ -8,7 +8,8 @@
  * Provides a date field
  * @author James
  */
-class DateField extends TextField {
+class DateField extends TextField
+{
 
     use Core;
     use Datalist;
@@ -21,15 +22,18 @@ class DateField extends TextField {
 
     protected $example = "2020-12-31";
 
-    protected function formatDate(\Datetime $datetime) {
-        return $datetime->format( $this->datetime_format );
+    protected function formatDate(\Datetime $datetime)
+    {
+        return $datetime->format($this->datetime_format);
     }
 
-    public function setMin(\DateTime $min) {
+    public function setMin(\DateTime $min)
+    {
         return $this->setAttribute('min', $this->formatDate($min));
     }
 
-    public function setMax(\DateTime $max) {
+    public function setMax(\DateTime $max)
+    {
         return $this->setAttribute('max', $this->formatDate($max));
     }
 

src/Forms/DateField.php

@@ -7,7 +7,8 @@
  * but with hour and minute selection
  * @author James
  */
-class DatetimeField extends DateField {
+class DatetimeField extends DateField
+{
 
     protected $inputType = 'datetime-local';
 

src/Forms/DatetimeField.php

@@ -8,7 +8,8 @@
  * Text input field with validation for correct email format according to RFC 2822.
  * @author james
  */
-class EmailField extends CoreEmailField {
+class EmailField extends CoreEmailField
+{
 
     use Core;
     use Datalist;

src/Forms/EmailField.php

@@ -7,7 +7,8 @@
  * but with month and year selection
  * @author James
  */
-class MonthField extends DateField {
+class MonthField extends DateField
+{
 
     protected $inputType = 'month';
 

src/Forms/MonthField.php

@@ -8,7 +8,8 @@
  * Number input field
  * @author James
  */
-class NumberField extends TextField {
+class NumberField extends TextField
+{
 
     use Core;
     use Datalist;

src/Forms/NumberField.php

@@ -7,7 +7,8 @@
 /**
  * Range input field
  */
-class RangeField extends TextField {
+class RangeField extends TextField
+{
 
     use Core;
     use Datalist;

src/Forms/RangeField.php

@@ -8,7 +8,8 @@
  * Search input field
  * @author James
  */
-class SearchField extends TextField {
+class SearchField extends TextField
+{
 
     use Core;
     use Datalist;

src/Forms/SearchField.php

@@ -8,7 +8,8 @@
  * From <input> elements of type tel are used to let the user enter and edit a telephone number.
  * @author James
  */
-class TelField extends TextField {
+class TelField extends TextField
+{
 
     use Core;
     use Datalist;
@@ -20,7 +21,8 @@ class TelField extends TextField {
     /**
      * @inheritdoc
      */
-    public function Type() {
+    public function Type()
+    {
         return 'tel text';
     }
 

src/Forms/TelField.php

@@ -6,7 +6,8 @@
  * Provides a time field, limited to hour and minute selection only
  * @author James
  */
-class TimeField extends DateField {
+class TimeField extends DateField
+{
 
     protected $inputType = 'time';
 

src/Forms/TimeField.php

@@ -8,7 +8,8 @@
 /**
  * Provides a URL input field
  */
-class UrlField extends TextField {
+class UrlField extends TextField
+{
 
     use Core;
     use Datalist;
@@ -28,7 +29,8 @@ class UrlField extends TextField {
     /**
      * @inheritdoc
      */
-    public function Type() {
+    public function Type()
+    {
         return 'url text';
     }
 
@@ -86,7 +88,8 @@ public function validate($validator)
         return true;
     }
 
-    public function setRequiredParts(array $requiredParts) {
+    public function setRequiredParts(array $requiredParts)
+    {
         $this->requiredParts = $requiredParts;
         return $this;
     }
@@ -95,7 +98,8 @@ public function setRequiredParts(array $requiredParts) {
      * Parse a possible URL string
      * If the second parameter is provided, the URL must have those parts
      */
-    public function parseURL(string $url) : bool {
+    public function parseURL(string $url) : bool
+    {
         if($url == '') {
             // an empty URL is a valid URL
             return true;
@@ -104,7 +108,7 @@ public function parseURL(string $url) : bool {
         $parts = parse_url($url);
         if(empty($this->requiredParts)) {
             return !empty($parts);
-        }  else {
+        } else {
             // ensure all of the required parts are present in all of the keys
             $result = array_intersect($this->requiredParts, array_keys($parts));
             sort($result);
@@ -116,19 +120,22 @@ public function parseURL(string $url) : bool {
     /**
      * Schemes are set by calling restrictToSchemes
      */
-    protected function setSchemes(array $schemes) {
+    protected function setSchemes(array $schemes)
+    {
         $this->schemes = $schemes;
         return $this;
     }
 
-    public function getSchemes() {
+    public function getSchemes()
+    {
         return $this->schemes;
     }
 
     /**
      * Restrict to http (and https) protocols
      */
-    public function restrictToHttp() {
+    public function restrictToHttp()
+    {
         $this->restrictToSchemes(["https","http"]);
         $this->setAttribute(
             'placeholder',
@@ -143,14 +150,16 @@ public function restrictToHttp() {
     /**
      * Restrict to URLs beginning with https://
      */
-    public function restrictToHttps() {
+    public function restrictToHttps()
+    {
         return $this->restrictToSchemes(["https"]);
     }
 
     /**
      * Restrict to URLs beginning with the provided scheme
      */
-    public function restrictToSchemes(array $schemes) {
+    public function restrictToSchemes(array $schemes)
+    {
         $this->setSchemes($schemes);
         $schemesString = implode("://, ", $schemes)  . "://";
         $this->setAttribute(

src/Forms/UrlField.php

@@ -8,7 +8,8 @@
  * year plus the ISO 8601 week number during that year (i.e., week 1 to 52 or 53).
  * @author James
  */
-class WeekField extends DateField {
+class WeekField extends DateField
+{
 
     protected $inputType = 'week';
 

src/Forms/WeekField.php

@@ -6,17 +6,21 @@
  * Core common attribute methods
  * @author James
  */
-trait Core {
+trait Core
+{
 
-    protected function bool2str($value) {
+    protected function bool2str($value)
+    {
         return $value ? 'true' : 'false';
     }
 
-    public function setSpellcheck($spellcheck) {
+    public function setSpellcheck($spellcheck)
+    {
         return $this->setAttribute('spellcheck', $this->bool2str($spellcheck));
     }
 
-    public function getSpellcheck() {
+    public function getSpellcheck()
+    {
         return $this->getAttribute('spellcheck');
     }