Add Universal.CodeAnalysis.MixedBooleanOperator

README.md

@@ -229,6 +229,10 @@ Detects `foreach` control structures which use the same variable for both the ke
 
 Note: The fixer will maintain the existing behaviour of the code. This may not be the _intended_ behaviour.
 
+#### `Universal.CodeAnalysis.MixedBooleanOperator` :books:
+
+Forbids mixing different binary boolean operators within a single expression without making precedence clear using parentheses.
+
 #### `Universal.CodeAnalysis.NoEchoSprintf` :wrench: :books:
 
 Detects use of the inefficient `echo [v]sprintf(...);` combi. Use `[v]printf()` instead.

Universal/Docs/CodeAnalysis/MixedBooleanOperatorStandard.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0"?>
+<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
+    title="Mixed Boolean Operator"
+    >
+    <standard>
+    <![CDATA[
+    Forbids mixing different binary boolean operators within a single expression without making precedence clear using parentheses.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: Making precedence clear with parentheses.">
+        <![CDATA[
+$one = false;
+$two = false;
+$three = true;
+
+$result = <em>($one && $two) || $three</em>;
+$result2 = <em>$one && ($two || $three)</em>;
+$result3 = <em>($one && !$two) xor $three;</em>;
+$result4 = <em>$one && (!$two xor $three);</em>;
+
+if (<em>($result && !$result3) || (!$result && $result3)</em>) {}
+        ]]>
+        </code>
+        <code title="Invalid: Not using parentheses.">
+        <![CDATA[
+$one = false;
+$two = false;
+$three = true;
+
+$result = <em>$one && $two || $three</em>;
+$result3 = <em>$one && !$two xor $three;</em>;
+
+if (<em>$result && !$result3 || !$result && $result3</em>) {}
+        ]]>
+        </code>
+    </code_comparison>
+</documentation>

Universal/Sniffs/CodeAnalysis/MixedBooleanOperatorSniff.php

@@ -0,0 +1,98 @@
+<?php
+/**
+ * PHPCSExtra, a collection of sniffs and standards for use with PHP_CodeSniffer.
+ *
+ * @package   PHPCSExtra
+ * @copyright 2021 WoltLab GmbH, 2023 PHPCSExtra Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSExtra
+ */
+
+namespace PHPCSExtra\Universal\Sniffs\CodeAnalysis;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Util\Tokens;
+use PHPCSUtils\BackCompat\BCFile;
+
+/**
+ * Forbid mixing different binary boolean operators within a single expression without making precedence
+ * clear using parentheses.
+ *
+ * @link https://github.com/squizlabs/PHP_CodeSniffer/pull/3205
+ * @link https://github.com/php-fig/per-coding-style/issues/22
+ *
+ * @since 1.2.0
+ */
+final class MixedBooleanOperatorSniff implements Sniff
+{
+
+    /**
+     * Array of tokens this test searches for to find either a boolean
+     * operator or the start of the current (sub-)expression. Used for
+     * performance optimization purposes.
+     *
+     * @since 1.2.0
+     *
+     * @var array<int|string>
+     */
+    private $searchTargets = [];
+
+    /**
+     * Returns an array of tokens this test wants to listen for.
+     *
+     * @since 1.2.0
+     *
+     * @return array<int|string>
+     */
+    public function register()
+    {
+        $this->searchTargets                 = Tokens::$booleanOperators;
+        $this->searchTargets[\T_INLINE_THEN] = \T_INLINE_THEN;
+        $this->searchTargets[\T_INLINE_ELSE] = \T_INLINE_ELSE;
+
+        return Tokens::$booleanOperators;
+    }
+
+    /**
+     * Processes this test, when one of its tokens is encountered.
+     *
+     * @since 1.2.0
+     *
+     * @param \PHP_CodeSniffer\Files\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)
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        $start = BCFile::findStartOfStatement($phpcsFile, $stackPtr);
+
+        $previous = $phpcsFile->findPrevious(
+            $this->searchTargets,
+            $stackPtr - 1,
+            $start,
+            false,
+            null,
+            true
+        );
+
+        if (
+            // No token found.
+            $previous === false
+            // Identical operator found.
+            || $tokens[$previous]['code'] === $tokens[$stackPtr]['code']
+            // Beginning of the expression found for the ternary conditional operator.
+            || \in_array($tokens[$previous]['code'], [\T_INLINE_THEN, \T_INLINE_ELSE], true)
+        ) {
+            return;
+        }
+
+        // We found a mismatching operator, thus we must report the error.
+        $error = 'Mixing different binary boolean operators within an expression without using parentheses to clarify precedence is not allowed.';
+        $phpcsFile->addError($error, $stackPtr, 'MissingParentheses');
+    }
+}

Universal/Tests/CodeAnalysis/MixedBooleanOperatorUnitTest.inc

@@ -0,0 +1,83 @@
+<?php
+
+if (true && true || true); // Not OK.
+if ((true && true) || true);
+if (true && (true || true));
+
+$var = true && true || true; // Not OK.
+$var = (true && true) || true;
+$var = true && (true || true);
+
+$complex = true && (true || true) && true;
+$complex = true && (true || true) || true; // Not OK.
+
+if (
+    true
+    && true
+    || true // Not OK.
+);
+
+if (
+    true
+    && (
+        true
+        || true
+    )
+);
+
+if (true && foo(true || true));
+if (true && foo(true && true || true)); // Not OK.
+if (true && $foo[true || true]);
+if (true && $foo[true && true || true]); // Not OK.
+
+if (true && foo(true) || true); // Not OK.
+if (true && $foo[true] || true); // Not OK.
+if (true && foo($foo[true]) || true); // Not OK.
+
+$foo[] = true && true || false; // Not OK.
+
+foo([true && true || false]); // Not OK.
+
+if (true && true || true && true); // Not OK.
+
+$foo = false || true && (#[\Attr(true && true || true)] function (#[\SensitiveParameter] $p) { // Not OK.
+    echo true || true && true; // Not OK.
+
+    return true;
+})('dummy') || false; // Not OK.
+
+$foo = false || (true && (#[\Attr((true && true) || true)] function (#[\SensitiveParameter] $p) {
+    echo (true || true) && true;
+
+    return true;
+})('dummy')) || false;
+
+$foo = true || true || (#[\Attr(true && true && true)] function (#[\SensitiveParameter] $p) {
+    echo true && true && true;
+
+    return true;
+})('dummy') || false;
+
+if (true && [true, callMe(), ${true || true}] || true); // Not OK.
+if (true && [true, callMe(), ${true || true}] && true);
+
+for (true || true || true; true && true && true; true || true || true);
+for (true || true && true; true && true || true; true || true && true); // Not OK.
+
+for ($a = true || true || true, $b = true && true && true; $a; $b);
+for ($a = true || true && true, $b = true || true && true; $a; $b); // Not OK.
+
+$foo = true || true || true ? true && true && true : true || true || true;
+$foo = true && true || true // Not OK.
+    ? true || true && true // Not OK.
+    : true || true && true; // Not OK.
+
+for(true || true || true, true && true && true);
+for(true && true || true, true && true || true); // Not OK.
+
+(true && true and true); // Not OK.
+(true && true or true); // Not OK.
+(true and true or true); // Not OK.
+(true and true xor true and true); // Not OK.
+
+if (true || true && true && true && true); // Not OK.

Universal/Tests/CodeAnalysis/MixedBooleanOperatorUnitTest.php

@@ -0,0 +1,72 @@
+<?php
+/**
+ * PHPCSExtra, a collection of sniffs and standards for use with PHP_CodeSniffer.
+ *
+ * @package   PHPCSExtra
+ * @copyright 2021 WoltLab GmbH, 2023 PHPCSExtra Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSExtra
+ */
+
+namespace PHPCSExtra\Universal\Tests\CodeAnalysis;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+/**
+ * Unit test class for the MixedBooleanOperator sniff.
+ *
+ * @covers PHPCSExtra\Universal\Sniffs\CodeAnalysis\MixedBooleanOperatorSniff
+ *
+ * @since 1.2.0
+ */
+final class MixedBooleanOperatorUnitTest extends AbstractSniffUnitTest
+{
+
+    /**
+     * Returns the lines where errors should occur.
+     *
+     * @return array<int, int> Key is the line number, value is the number of expected errors.
+     */
+    public function getErrorList()
+    {
+        return [
+            3  => 1,
+            7  => 1,
+            12 => 1,
+            17 => 1,
+            29 => 1,
+            31 => 1,
+            33 => 1,
+            34 => 1,
+            35 => 1,
+            37 => 1,
+            39 => 1,
+            41 => 2,
+            43 => 2,
+            44 => 1,
+            47 => 1,
+            61 => 1,
+            65 => 3,
+            68 => 2,
+            71 => 1,
+            72 => 1,
+            73 => 1,
+            76 => 2,
+            78 => 1,
+            79 => 1,
+            80 => 1,
+            81 => 2,
+            83 => 1,
+        ];
+    }
+
+    /**
+     * Returns the lines where warnings should occur.
+     *
+     * @return array<int, int> Key is the line number, value is the number of expected warnings.
+     */
+    public function getWarningList()
+    {
+        return [];
+    }
+}