improve testing of AlphabeticalUseStatementsSniff

fixes GH-65

Author: xalopp

MO4/Sniffs/Formatting/AlphabeticalUseStatementsSniff.php

@@ -86,12 +86,15 @@ class AlphabeticalUseStatementsSniff extends UseDeclarationSniff
 
 
     /**
-     * Returns an array of tokens this test wants to listen for.
+     * Processes this test, when one of its tokens is encountered.
+     *
+     * @param File $phpcsFile The file being scanned.
+     * @param int  $stackPtr  The position of the current token in
+     *                        the stack passed in $tokens.
      *
-     * @return array
-     * @throws \PHP_CodeSniffer\Exceptions\RuntimeException
+     * @return void
      */
-    public function register()
+    public function process(File $phpcsFile, $stackPtr)
     {
         if (in_array($this->order, $this->supportedOrderingMethods, true) === false) {
             $error = sprintf(
@@ -101,25 +104,11 @@ public function register()
                 implode(', ', $this->supportedOrderingMethods)
             );
 
-            throw new RuntimeException($error);
-        }
-
-        return parent::register();
-
-    }//end register()
+            $phpcsFile->addError($error, $stackPtr, 'InvalidOrder');
 
+            return;
+        }
 
-    /**
-     * Processes this test, when one of its tokens is encountered.
-     *
-     * @param File $phpcsFile The file being scanned.
-     * @param int  $stackPtr  The position of the current token in
-     *                        the stack passed in $tokens.
-     *
-     * @return void
-     */
-    public function process(File $phpcsFile, $stackPtr)
-    {
         parent::process($phpcsFile, $stackPtr);
 
         if ($this->currentFile !== $phpcsFile->getFilename()) {

MO4/Tests/Formatting/AlphabeticalUseStatementsUnitTest.fail.6.inc

@@ -0,0 +1,13 @@
+<?php
+
+// phpcs:set MO4.Formatting.AlphabeticalUseStatements order dictionary-typo
+
+use A1\B;
+
+// reset it
+// phpcs:set MO4.Formatting.AlphabeticalUseStatements order dictionary
+
+class Foo
+{
+
+}

MO4/Tests/Formatting/AlphabeticalUseStatementsUnitTest.pass.inc

@@ -16,6 +16,27 @@ use A\B;
 use A\B\C;
 use A\BD;
 
+// phpcs:set MO4.Formatting.AlphabeticalUseStatements order string
+
+use Doctrine\ORM\Query;
+use Doctrine\ORM\QueryBuilder;
+use Doctrine\ORM\Query\Expr;
+
+use ExampleSub;
+use Examples;
+
+// phpcs:set MO4.Formatting.AlphabeticalUseStatements order string-case-insensitive
+
+use E2xamples;
+use E2xampleSub;
+
+// phpcs:set MO4.Formatting.AlphabeticalUseStatements order string-locale
+
+use E3xampleSub;
+use E3xamples;
+
+// phpcs:set MO4.Formatting.AlphabeticalUseStatements order dictionary
+
 class Foo {
     $bar = 'foo';
 

MO4/Tests/Formatting/AlphabeticalUseStatementsUnitTest.php

@@ -83,6 +83,8 @@ protected function getErrorList($testFile='')
             ];
         case 'AlphabeticalUseStatementsUnitTest.fail.5.inc':
             return [12 => 1];
+        case 'AlphabeticalUseStatementsUnitTest.fail.6.inc':
+            return [5 => 1];
         }//end switch
 
         throw new RuntimeException("Testfile {$testFile} in ".__DIR__." is not handled by ".__CLASS__);

README.md

@@ -136,7 +136,7 @@ Possible values for order:
   use Examples;
   ```
 * `string-locale`: locale based string comparison using [strcoll](http://php.net/strcoll)
-* `string-case-insenstive`: binary safe case-insensitive string comparison [strcasecmp](http://php.net/strcasecmp)
+* `string-case-insensitive`: binary safe case-insensitive string comparison [strcasecmp](http://php.net/strcasecmp)
    ```php
    use Examples;
    use ExampleSub;
@@ -159,7 +159,7 @@ If `phpcs` complains that MO4 is not installed, please check the installed codin
 
 ## Dependencies
 
-* [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer)
+* [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) version 3.2.0 or later
 * [David Joos's Symfony Coding Standard](https://github.com/djoos/Symfony-coding-standard) ruleset for PHP CodeSniffer
 * [Composer installer for PHP_CodeSniffer coding standards](https://github.com/DealerDirect/phpcodesniffer-composer-installer)