Include Generic.Arrays.DisallowLongArraySyntax

- as warning in the moodle standard.
- as error in the moodle-extra standard.
- to become error in both standards in 1y (#58)

Author: andrewnicols

moodle-extra/ruleset.xml

@@ -9,6 +9,11 @@
     <!-- Extend the standard Moodle coding style -->
     <rule ref="moodle"/>
 
+    <!-- This is an error in moodle-extra. TODO: Remove as part of #58 -->
+    <rule ref="Generic.Arrays.DisallowLongArraySyntax">
+        <type>error</type>
+    </rule>
+
     <!-- Include the PSR-12 ruleset with relevant Moodle exclusions -->
     <rule ref="PSR12">
 

moodle/Tests/MoodleStandardTest.php

@@ -223,6 +223,33 @@ public function test_moodle_files_linelength() {
         $this->verify_cs_results();
     }
 
+    /**
+     * Test the Generic.Arrays.DisallowLongArraySyntax sniff.
+     *
+     * @covers \PHP_CodeSniffer\Standards\Generic\Sniffs\Arrays\DisallowLongArraySyntaxSniff
+     */
+    public function test_generic_array_disallowlongarraysyntax(): void {
+        // Define the standard, sniff and fixture to use.
+        $this->set_standard('moodle');
+        $this->set_sniff('Generic.Arrays.DisallowLongArraySyntax');
+        $this->set_fixture(__DIR__ . '/fixtures/generic_array_longarraysyntax.php');
+
+        // Define expected results (errors and warnings). Format, array of:
+        // - line => number of problems,  or
+        // - line => array of contents for message / source problem matching.
+        // - line => string of contents for message / source problem matching (only 1).
+        $this->set_errors([
+            3 => 'Short array syntax must be used to define arrays @Source: Generic.Arrays.DisallowLongArraySyntax.Found',
+            5 => 'Short array syntax must be used to define arrays @Source: Generic.Arrays.DisallowLongArraySyntax.Found',
+            9 => 'Short array syntax must be used to define arrays @Source: Generic.Arrays.DisallowLongArraySyntax.Found',
+        ]);
+
+        $this->set_warnings(array());
+
+        // Let's do all the hard work!
+        $this->verify_cs_results();
+    }
+
     /**
      * Test the Generic.Files.LineEndings sniff.
      *

moodle/Tests/fixtures/generic_array_longarraysyntax.php

@@ -0,0 +1,14 @@
+<?php
+
+$a = array();
+$b = [];
+$c = array(
+);
+$d = [
+];
+$e = array (
+    'alphabet'
+);
+$f = [
+    'numbers'
+];

moodle/Tests/fixtures/generic_array_longarraysyntax.php.fixed

@@ -0,0 +1,14 @@
+<?php
+
+$a = [];
+$b = [];
+$c = [
+];
+$d = [
+];
+$e =  [
+    'alphabet'
+];
+$f = [
+    'numbers'
+];

moodle/ruleset.xml

@@ -9,6 +9,10 @@
     <arg name="extensions" value="php" />
     <arg name="encoding" value="utf-8" />
 
+    <rule ref="Generic.Arrays.DisallowLongArraySyntax">
+        <type>warning</type>
+    </rule>
+
     <rule ref="Generic.Classes.DuplicateClassName"/>
     <rule ref="Generic.Classes.OpeningBraceSameLine"/>