Merge pull request #59 from moufmouf/not_in_issue

NOT IN parameters are not adding parenthesis automatically

Author: moufmouf

.travis.yml

@@ -35,3 +35,10 @@ jobs:
      - *composerupdate
     script:
      - *phpunit
+  - stage: test
+    php: 7.3
+    env: PREFER_LOWEST=""
+    before_script:
+      - *composerupdate
+    script:
+      - *phpunit

src/SQLParser/Node/AbstractInListOperator.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace SQLParser\Node;
+use Doctrine\DBAL\Connection;
+use Mouf\Database\MagicQueryException;
+
+/**
+ * This class represents an In operation in an SQL expression.
+ *
+ * @author David Négrier <[email protected]>
+ */
+abstract class AbstractInListOperator extends AbstractTwoOperandsOperator
+{
+    protected function getSql(array $parameters = array(), Connection $dbConnection = null, $indent = 0, $conditionsMode = self::CONDITION_APPLY, bool $extrapolateParameters = true)
+    {
+        $rightOperand = $this->getRightOperand();
+
+        $rightOperand = $this->refactorParameterToExpression($rightOperand);
+
+        $this->setRightOperand($rightOperand);
+
+        $parameterNode = $this->getParameter($rightOperand);
+
+        if ($parameterNode !== null) {
+            if (!isset($parameters[$parameterNode->getName()])) {
+                throw new MagicQueryException("Missing parameter '" . $parameterNode->getName() . "' for 'IN' operand.");
+            }
+            if ($parameters[$parameterNode->getName()] === []) {
+                return "FALSE";
+            }
+        }
+
+        return parent::getSql($parameters, $dbConnection, $indent, $conditionsMode, $extrapolateParameters);
+    }
+
+    protected function refactorParameterToExpression(NodeInterface $rightOperand): NodeInterface
+    {
+        if ($rightOperand instanceof Parameter) {
+            $expression = new Expression();
+            $expression->setSubTree([$rightOperand]);
+            $expression->setBrackets(true);
+            return $expression;
+        }
+        return $rightOperand;
+    }
+
+    protected function getParameter(NodeInterface $operand): ?Parameter
+    {
+        if (!$operand instanceof Expression) {
+            return null;
+        }
+        $subtree = $operand->getSubTree();
+        if (!isset($subtree[0])) {
+            return null;
+        }
+        if ($subtree[0] instanceof Parameter) {
+            return $subtree[0];
+        }
+        return null;
+    }
+}

src/SQLParser/Node/In.php

@@ -9,7 +9,7 @@
  *
  * @author David Négrier <[email protected]>
  */
-class In extends AbstractTwoOperandsOperator
+class In extends AbstractInListOperator
 {
     /**
      * Returns the symbol for this operator.
@@ -20,52 +20,4 @@ protected function getOperatorSymbol()
     {
         return 'IN';
     }
-
-    protected function getSql(array $parameters = array(), Connection $dbConnection = null, $indent = 0, $conditionsMode = self::CONDITION_APPLY, bool $extrapolateParameters = true)
-    {
-        $rightOperand = $this->getRightOperand();
-
-        $rightOperand = $this->refactorParameterToExpression($rightOperand);
-
-        $this->setRightOperand($rightOperand);
-
-        $parameterNode = $this->getParameter($rightOperand);
-
-        if ($parameterNode !== null) {
-            if (!isset($parameters[$parameterNode->getName()])) {
-                throw new MagicQueryException("Missing parameter '" . $parameterNode->getName() . "' for 'IN' operand.");
-            }
-            if ($parameters[$parameterNode->getName()] === []) {
-                return "FALSE";
-            }
-        }
-
-        return parent::getSql($parameters, $dbConnection, $indent, $conditionsMode, $extrapolateParameters);
-    }
-
-    protected function refactorParameterToExpression(NodeInterface $rightOperand): NodeInterface
-    {
-        if ($rightOperand instanceof Parameter) {
-            $expression = new Expression();
-            $expression->setSubTree([$rightOperand]);
-            $expression->setBrackets(true);
-            return $expression;
-        }
-        return $rightOperand;
-    }
-
-    protected function getParameter(NodeInterface $operand): ?Parameter
-    {
-        if (!$operand instanceof Expression) {
-            return null;
-        }
-        $subtree = $operand->getSubTree();
-        if (!isset($subtree[0])) {
-            return null;
-        }
-        if ($subtree[0] instanceof Parameter) {
-            return $subtree[0];
-        }
-        return null;
-    }
 }

src/SQLParser/Node/NotIn.php

@@ -7,7 +7,7 @@
  *
  * @author David Négrier <[email protected]>
  */
-class NotIn extends AbstractTwoOperandsOperator
+class NotIn extends AbstractInListOperator
 {
     /**
      * Returns the symbol for this operator.

tests/Mouf/Database/MagicQueryTest.php

@@ -78,6 +78,12 @@ public function testStandardSelect()
         $sql = 'SELECT * FROM users WHERE status IN :statuses';
         $this->assertEquals('SELECT * FROM users WHERE status IN (\'1\',\'2\')', self::simplifySql($magicQuery->build($sql, ['statuses' => [1, 2]])));
 
+        $sql = 'SELECT * FROM users WHERE status not in :status';
+        $this->assertEquals("SELECT * FROM users WHERE status NOT IN ('2','4')", self::simplifySql($magicQuery->build($sql, ['status' => [2, 4]])));
+
+        $sql = 'SELECT * FROM users WHERE status not in (:status)';
+        $this->assertEquals("SELECT * FROM users WHERE status NOT IN ('2','4')", self::simplifySql($magicQuery->build($sql, ['status' => [2, 4]])));
+
         $sql = 'SELECT * FROM myTable where someField BETWEEN :value1 AND :value2';
         $this->assertEquals("SELECT * FROM myTable WHERE someField BETWEEN '2' AND '4'", self::simplifySql($magicQuery->build($sql, ['value1' => 2, 'value2' => 4])));
         $this->assertEquals("SELECT * FROM myTable WHERE someField >= '2'", self::simplifySql($magicQuery->build($sql, ['value1' => 2])));
@@ -433,5 +439,9 @@ public function testBuildPreparedStatement()
         // Let's check that MagicQuery is cleverly adding parenthesis if the user forgot those in the "IN" statement.
         $sql = 'SELECT id FROM users WHERE status IN :status';
         $this->assertEquals("SELECT id FROM users WHERE status IN (:status)", self::simplifySql($magicQuery->buildPreparedStatement($sql, ['status' => [1,2]])));
+
+        // Let's check that MagicQuery is cleverly adding parenthesis if the user forgot those in the "NOT IN" statement.
+        $sql = 'SELECT id FROM users WHERE status NOT IN :status';
+        $this->assertEquals("SELECT id FROM users WHERE status NOT IN (:status)", self::simplifySql($magicQuery->buildPreparedStatement($sql, ['status' => [1,2]])));
     }
 }