Squiz.ControlStructures.InlineIfDeclaration now supports the elvis operator (ref #1311)

Author: gsherwood

CodeSniffer/Standards/Squiz/Sniffs/ControlStructures/InlineIfDeclarationSniff.php

@@ -86,7 +86,6 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
         if ($tokens[$contentBefore]['code'] !== T_CLOSE_PARENTHESIS) {
             $error = 'Inline shorthand IF statement requires brackets around comparison';
             $phpcsFile->addError($error, $stackPtr, 'NoBrackets');
-            return;
         }
 
         $spaceBefore = ($tokens[$stackPtr]['column'] - ($tokens[$contentBefore]['column'] + $tokens[$contentBefore]['length']));
@@ -96,26 +95,38 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
             $phpcsFile->addError($error, $stackPtr, 'SpacingBeforeThen', $data);
         }
 
-        $spaceAfter = (($tokens[$contentAfter]['column']) - ($tokens[$stackPtr]['column'] + 1));
-        if ($spaceAfter !== 1) {
-            $error = 'Inline shorthand IF statement requires 1 space after THEN; %s found';
-            $data  = array($spaceAfter);
-            $phpcsFile->addError($error, $stackPtr, 'SpacingAfterThen', $data);
-        }
-
-        // Make sure the ELSE has the correct spacing.
-        $inlineElse    = $phpcsFile->findNext(T_INLINE_ELSE, ($stackPtr + 1), $statementEnd, false);
-        $contentBefore = $phpcsFile->findPrevious(T_WHITESPACE, ($inlineElse - 1), null, true);
-        $contentAfter  = $phpcsFile->findNext(T_WHITESPACE, ($inlineElse + 1), null, true);
-
-        $spaceBefore = ($tokens[$inlineElse]['column'] - ($tokens[$contentBefore]['column'] + $tokens[$contentBefore]['length']));
-        if ($spaceBefore !== 1) {
-            $error = 'Inline shorthand IF statement requires 1 space before ELSE; %s found';
-            $data  = array($spaceBefore);
-            $phpcsFile->addError($error, $inlineElse, 'SpacingBeforeElse', $data);
-        }
-
-        $spaceAfter = (($tokens[$contentAfter]['column']) - ($tokens[$inlineElse]['column'] + 1));
+        // If there is no content between the ? and the : operators, then they are
+        // trying to replicate an elvis operator, even though PHP doesn't have one.
+        // In this case, we want no spaces between the two operators so ?: looks like
+        // an operator itself.
+        $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
+        if ($tokens[$next]['code'] === T_INLINE_ELSE) {
+            $inlineElse = $next;
+            if ($inlineElse !== ($stackPtr + 1)) {
+                $error = 'Inline shorthand IF statement without THEN statement requires 0 spaces between THEN and ELSE';
+                $phpcsFile->addError($error, $stackPtr, 'ElvisSpacing');
+            }
+        } else {
+            $spaceAfter = (($tokens[$contentAfter]['column']) - ($tokens[$stackPtr]['column'] + 1));
+            if ($spaceAfter !== 1) {
+                $error = 'Inline shorthand IF statement requires 1 space after THEN; %s found';
+                $data  = array($spaceAfter);
+                $phpcsFile->addError($error, $stackPtr, 'SpacingAfterThen', $data);
+            }
+
+            // Make sure the ELSE has the correct spacing.
+            $inlineElse    = $phpcsFile->findNext(T_INLINE_ELSE, ($stackPtr + 1), $statementEnd, false);
+            $contentBefore = $phpcsFile->findPrevious(T_WHITESPACE, ($inlineElse - 1), null, true);
+            $spaceBefore   = ($tokens[$inlineElse]['column'] - ($tokens[$contentBefore]['column'] + $tokens[$contentBefore]['length']));
+            if ($spaceBefore !== 1) {
+                $error = 'Inline shorthand IF statement requires 1 space before ELSE; %s found';
+                $data  = array($spaceBefore);
+                $phpcsFile->addError($error, $inlineElse, 'SpacingBeforeElse', $data);
+            }
+        }//end if
+
+        $contentAfter = $phpcsFile->findNext(T_WHITESPACE, ($inlineElse + 1), null, true);
+        $spaceAfter   = (($tokens[$contentAfter]['column']) - ($tokens[$inlineElse]['column'] + 1));
         if ($spaceAfter !== 1) {
             $error = 'Inline shorthand IF statement requires 1 space after ELSE; %s found';
             $data  = array($spaceAfter);

CodeSniffer/Standards/Squiz/Tests/ControlStructures/InlineIfDeclarationUnitTest.inc

@@ -40,3 +40,6 @@ $config = function() {
 };
 
 rand(0, 1) ? 'ěščřžýáí' : NULL;
+
+$c = ($argv[1]) ? : "";
+$filepath = realpath($argv[1]) ?: $argv[1];

CodeSniffer/Standards/Squiz/Tests/ControlStructures/InlineIfDeclarationUnitTest.php

@@ -67,6 +67,7 @@ public function getErrorList()
                 13 => 1,
                 20 => 1,
                 24 => 4,
+                44 => 1,
                );
 
     }//end getErrorList()

package.xml

@@ -31,6 +31,8 @@ http://pear.php.net/dtd/package-2.0.xsd">
   - Squiz.Commenting.FunctionComment now properly fixes pipe-seperated param types
   - Squiz.Commenting.FunctionComment now works correctly when function return types also contain a comment
     -- Thanks to Juliette Reinders Folmer for the patch
+  - Squiz.ControlStructures.InlineIfDeclaration now supports the elvis operator
+    -- As this is not a real PHP operator, it enforces no spaces beteen ? and : when the THEN statement is empty
   - Fixed bug #1340 : STDIN file contents not being populated in some cases
     -- Thanks to David Biňovec for the patch
   - Fixed bug #1344 : PEAR.Functions.FunctionCallSignatureSniff throws error for blank comment lines