Merge pull request #6 in CFA/coding-guidelines from yoda to master

* commit 'fa7fad7be2a3dee4cf272d1f071d748fcbf5af8d':
  - Added YODA test cases
  - Added yoda sniff - Updated readme

Author: Daniel Müller

README.md

@@ -48,8 +48,10 @@ make test
 
 Use within PHPStorm
 -------------------
-- Open settings:
-`File` > `Default Settings...` > `Editor` > `Inspections` > `PHP`
+- Open settings: \
+Mac: `PhpStorm` > `Preferences` > `Editor` > `Inspections` > `PHP` \
+Windows: \<unknown>\
+Linux: \<unknown>
 - Activate Option `PHP Code Sniffer validation`
 - Choose "Custom" for „Coding standard:“ and click on `...` on the right hand side
 - Select Path to ruleset. This would be something like <YOUR_APP_ROOT>/vendor/flyeralarm/coding-guidelines/ruleset.xml

custom-standards/Flyeralarm/Sniffs/ControlStructures/YodaSniff.php

@@ -0,0 +1,114 @@
+<?php
+
+namespace flyeralarm\CodingGuidelines\Flyeralarm\Sniffs\ControlStructures;
+
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Files\File;
+
+class YodaSniff implements Sniff
+{
+    /**
+     * @return array
+     */
+    public function register()
+    {
+        return array(T_IF, T_ELSEIF, T_WHILE);
+    }
+
+    /**
+     * @param File $phpcsFile
+     * @param int $stackPtr
+     * @return void
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        $startOfConditionPtr = $stackPtr;
+        $endPtr = $tokens[$startOfConditionPtr]['scope_opener'] + 1;
+
+        $logicalOperatorTokenIds = [T_BOOLEAN_AND, T_BOOLEAN_OR, T_LOGICAL_AND, T_LOGICAL_OR, T_LOGICAL_XOR];
+        $scopeOpenerTokenIds = [T_OPEN_CURLY_BRACKET];
+        $tokenIdsToFindAllConditions = array_merge($logicalOperatorTokenIds, $scopeOpenerTokenIds);
+
+        while ($endOfConditionPtr = $phpcsFile->findNext($tokenIdsToFindAllConditions, $startOfConditionPtr, $endPtr)) {
+            $this->checkConditionalOrderForArithmeticExpression($phpcsFile, $startOfConditionPtr, $endOfConditionPtr);
+            $startOfConditionPtr = $endOfConditionPtr + 1;
+        }
+    }
+
+    /**
+     * @param File $phpcsFile
+     * @param $startOfConditionPtr
+     * @param $endOfConditionPtr
+     */
+    private function checkConditionalOrderForArithmeticExpression(
+        File $phpcsFile,
+        $startOfConditionPtr,
+        $endOfConditionPtr
+    ) {
+        $tokens = $phpcsFile->getTokens();
+        $logicalOperatorPtr = $phpcsFile->findNext(
+            [
+                T_IS_NOT_IDENTICAL,
+                T_IS_IDENTICAL,
+                T_IS_NOT_EQUAL,
+                T_IS_EQUAL,
+                T_IS_GREATER_OR_EQUAL,
+                T_IS_SMALLER_OR_EQUAL,
+                T_LESS_THAN,
+                T_GREATER_THAN,
+            ],
+            $startOfConditionPtr,
+            $endOfConditionPtr
+        );
+
+        // e.g. if ($foo)
+        if (!$logicalOperatorPtr) {
+            return;
+        }
+
+        $languageTypeTokenIds = [T_NULL, T_TRUE, T_FALSE, T_ARRAY, T_CONSTANT_ENCAPSED_STRING, T_LNUMBER];
+        $functionAndVariableTokenIds = [T_STRING, T_VARIABLE]; // T_STRING matches count() for example
+        $operandTokenIds = array_merge($languageTypeTokenIds, $functionAndVariableTokenIds);
+
+        $leftOperandPtr = $phpcsFile->findNext($operandTokenIds, $startOfConditionPtr, $logicalOperatorPtr);
+        if (!$leftOperandPtr) {
+            return;
+        }
+
+        $rightOperandPtr = $phpcsFile->findNext($operandTokenIds, $logicalOperatorPtr, $endOfConditionPtr);
+        if (!$rightOperandPtr) {
+            return;
+        }
+
+        $leftOperandTokenId = $tokens[$leftOperandPtr]['code'];
+        $rightOperandTokenId = $tokens[$rightOperandPtr]['code'];
+
+        // e.g. if ($foo = true)
+        // e.g. if ($foo = 'bar')
+        if (in_array($leftOperandTokenId, $functionAndVariableTokenIds)
+            && in_array($rightOperandTokenId, $languageTypeTokenIds)
+        ) {
+            return;
+        }
+        // e.g. if (count(..) > $test)
+        // e.g. if ($foo == $bar)
+        if (in_array($leftOperandTokenId, $functionAndVariableTokenIds)
+            && in_array($rightOperandTokenId, $functionAndVariableTokenIds)
+        ) {
+            return;
+        }
+        // e.g. if ('foo' == 'bar')
+        if (in_array($leftOperandTokenId, $languageTypeTokenIds)
+            && in_array($rightOperandTokenId, $languageTypeTokenIds)) {
+            return;
+        }
+
+        $phpcsFile->addError(
+            'YODA is discouraged',
+            $leftOperandPtr,
+            'ConditionalOrder'
+        );
+    }
+}

ruleset.xml

@@ -12,4 +12,5 @@
     <rule ref="./custom-standards/Flyeralarm/Sniffs/File/NoClassKindSuffixSniff.php"/>
     <rule ref="./custom-standards/Flyeralarm/Sniffs/Docblock/ReturnTypeSniff.php"/>
     <rule ref="./custom-standards/Flyeralarm/Sniffs/Docblock/ExpectedExceptionMessageSniff.php"/>
+    <rule ref="./custom-standards/Flyeralarm/Sniffs/ControlStructures/YodaSniff.php"/>
 </ruleset>

tests/rules/control-structures/yoda/allowed/ElseIfVariableEqualsString.php

@@ -0,0 +1,12 @@
+<?php
+
+// @expectedPass
+
+$foo = 'bar';
+$bar = 'foo';
+
+
+if (true) {
+} elseif ($foo == 'bar') {
+} elseif ($foo == 'bar' && $bar == 'foo') {
+}

tests/rules/control-structures/yoda/allowed/IfCountGreaterVariable.php

@@ -0,0 +1,9 @@
+<?php
+
+// @expectedPass
+
+$foo = [];
+$bar = 0;
+
+if (count($foo) > $bar) {
+}

tests/rules/control-structures/yoda/allowed/IfNotVariable.php

@@ -0,0 +1,8 @@
+<?php
+
+// @expectedPass
+
+$foo = true;
+
+if (!$foo) {
+}

tests/rules/control-structures/yoda/allowed/IfThisIsTrueEqualsTrue.php

@@ -0,0 +1,16 @@
+<?php
+
+// @expectedPass
+
+namespace flyeralarm\CodingGuidelines;
+
+class IfThisIsTrueEqualsTrue
+{
+    private $isTrue;
+
+    public function foo()
+    {
+        if ($this->isTrue == true) {
+        }
+    }
+}

tests/rules/control-structures/yoda/allowed/IfTrue.php

@@ -0,0 +1,6 @@
+<?php
+
+// @expectedPass
+
+if (true) {
+}

tests/rules/control-structures/yoda/allowed/IfVariableEqualsString.php

@@ -0,0 +1,8 @@
+<?php
+
+// @expectedPass
+
+$foo = 'bar';
+
+if ($foo == 'bar') {
+}

tests/rules/control-structures/yoda/allowed/IfVariableEqualsVariable.php

@@ -0,0 +1,9 @@
+<?php
+
+// @expectedPass
+
+$foo = 'bar';
+$bar = 'foo';
+
+if ($foo == $bar) {
+}