Merge pull request #23 from moufmouf/fix_null_equals

Transforms automatically '= null' into 'IS NULL'.

Author: moufmouf

src/Mouf/Database/MagicQuery.php

@@ -34,9 +34,9 @@ class MagicQuery
     private $enableTwig = false;
 
     /**
-     * @param \Doctrine\DBAL\Connection $connection
+     * @param \Doctrine\DBAL\Connection    $connection
      * @param \Doctrine\Common\Cache\Cache $cache
-     * @param SchemaAnalyzer $schemaAnalyzer (optional). If not set, it is initialized from the connection.
+     * @param SchemaAnalyzer               $schemaAnalyzer (optional). If not set, it is initialized from the connection.
      */
     public function __construct($connection = null, $cache = null, SchemaAnalyzer $schemaAnalyzer = null)
     {
@@ -54,11 +54,15 @@ public function __construct($connection = null, $cache = null, SchemaAnalyzer $s
     /**
      * Whether Twig parsing should be enabled or not.
      * Defaults to false.
+     *
      * @param bool $enableTwig
+     *
      * @return $this
      */
-    public function setEnableTwig($enableTwig = true) {
+    public function setEnableTwig($enableTwig = true)
+    {
         $this->enableTwig = $enableTwig;
+
         return $this;
     }
 
@@ -79,6 +83,7 @@ public function build($sql, array $parameters = array())
             $sql = $this->getTwigEnvironment()->render($sql, $parameters);
         }
         $select = $this->parse($sql);
+
         return $this->toSql($select, $parameters);
     }
 
@@ -87,13 +92,16 @@ public function build($sql, array $parameters = array())
      * This tree representation can be used to manipulate the SQL.
      *
      * @param string $sql
+     *
      * @return NodeInterface
+     *
      * @throws MagicQueryMissingConnectionException
      * @throws MagicQueryParserException
      */
-    public function parse($sql) {
+    public function parse($sql)
+    {
         // We choose md4 because it is fast.
-        $cacheKey = "request_".hash("md4", $sql);
+        $cacheKey = 'request_'.hash('md4', $sql);
         $select = $this->cache->fetch($cacheKey);
 
         if ($select === false) {
@@ -111,27 +119,32 @@ public function parse($sql) {
             // Let's store the tree
             $this->cache->save($cacheKey, $select);
         }
+
         return $select;
     }
 
     /**
      * Transforms back a tree of SQL node into a SQL string.
      *
      * @param NodeInterface $sqlNode
-     * @param array $parameters
+     * @param array         $parameters
+     *
      * @return string
      */
-    public function toSql(NodeInterface $sqlNode, array $parameters = array()) {
+    public function toSql(NodeInterface $sqlNode, array $parameters = array())
+    {
         return $sqlNode->toSql($parameters, $this->connection, 0, SqlRenderInterface::CONDITION_GUESS);
     }
 
     /**
      * Scans the SQL statement and replaces the "magicjoin" part with the correct joins.
      *
      * @param NodeInterface $select
+     *
      * @throws MagicQueryMissingConnectionException
      */
-    private function magicJoin(NodeInterface $select) {
+    private function magicJoin(NodeInterface $select)
+    {
         // Let's find if this is a MagicJoin query.
         $magicJoinDetector = new DetectMagicJoinSelectVisitor();
         $nodeTraverser = new NodeTraverser();
@@ -147,11 +160,14 @@ private function magicJoin(NodeInterface $select) {
     }
 
     /**
-     * For one given MagicJoin select, let's apply MagicJoin
+     * For one given MagicJoin select, let's apply MagicJoin.
+     *
      * @param MagicJoinSelect $magicJoinSelect
+     *
      * @return Select
      */
-    private function magicJoinOnOneQuery(MagicJoinSelect $magicJoinSelect) {
+    private function magicJoinOnOneQuery(MagicJoinSelect $magicJoinSelect)
+    {
         $tableSearchNodeTraverser = new NodeTraverser();
         $detectTableVisitor = new DetectTablesVisitor($magicJoinSelect->getMainTable());
         $tableSearchNodeTraverser->addVisitor($detectTableVisitor);
@@ -183,7 +199,7 @@ private function magicJoinOnOneQuery(MagicJoinSelect $magicJoinSelect) {
         $tableNode = new Table();
         $tableNode->setTable($mainTable);
         $tables = [
-            $mainTable => $tableNode
+            $mainTable => $tableNode,
         ];
 
         foreach ($completePath as $foreignKey) {
@@ -202,7 +218,7 @@ private function magicJoinOnOneQuery(MagicJoinSelect $magicJoinSelect) {
             $onNode->setRightOperand($rightCol);
 
             $tableNode = new Table();
-            $tableNode->setJoinType("LEFT JOIN");
+            $tableNode->setJoinType('LEFT JOIN');
             $tableNode->setRefClause($onNode);
 
             if (isset($tables[$foreignKey->getLocalTableName()])) {
@@ -215,34 +231,38 @@ private function magicJoinOnOneQuery(MagicJoinSelect $magicJoinSelect) {
         }
 
         $select->setFrom($tables);
-
     }
 
     /**
      * @return SchemaAnalyzer
      */
-    private function getSchemaAnalyzer() {
+    private function getSchemaAnalyzer()
+    {
         if ($this->schemaAnalyzer === null) {
             if (!$this->connection) {
                 throw new MagicQueryMissingConnectionException('In order to use MagicJoin, you need to configure a DBAL connection.');
             }
 
             $this->schemaAnalyzer = new SchemaAnalyzer($this->connection->getSchemaManager(), $this->cache, $this->getConnectionUniqueId());
         }
+
         return $this->schemaAnalyzer;
     }
 
-    private function getConnectionUniqueId() {
-        return hash('md4', $this->connection->getHost()."-".$this->connection->getPort()."-".$this->connection->getDatabase()."-".$this->connection->getDriver()->getName());
+    private function getConnectionUniqueId()
+    {
+        return hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName());
     }
 
     /**
      * @return \Twig_Environment
      */
-    private function getTwigEnvironment() {
+    private function getTwigEnvironment()
+    {
         if ($this->twigEnvironment === null) {
             $this->twigEnvironment = SqlTwigEnvironmentFactory::getTwigEnvironment();
         }
+
         return $this->twigEnvironment;
     }
 }

src/Mouf/Database/MagicQuery/Twig/ForbiddenTwigParameterInSqlException.php

@@ -1,9 +1,9 @@
 <?php
+
 namespace Mouf\Database\MagicQuery\Twig;
 
 use Mouf\Database\MagicQueryException;
 
 class ForbiddenTwigParameterInSqlException extends MagicQueryException
 {
-
-}
+}

src/Mouf/Database/MagicQuery/Twig/SqlTwigEnvironmentFactory.php

@@ -1,16 +1,16 @@
 <?php
-namespace Mouf\Database\MagicQuery\Twig;
 
-use Doctrine\DBAL\Connection;
+namespace Mouf\Database\MagicQuery\Twig;
 
 /**
- * Class in charge of creating the Twig environment
+ * Class in charge of creating the Twig environment.
  */
 class SqlTwigEnvironmentFactory
 {
     private static $twig;
 
-    public static function getTwigEnvironment() {
+    public static function getTwigEnvironment()
+    {
         if (self::$twig) {
             return self::$twig;
         }
@@ -20,14 +20,14 @@ public static function getTwigEnvironment() {
         $options = array(
             // The cache directory is in the temporary directory and reproduces the path to the directory (to avoid cache conflict between apps).
             'cache' => self::getCacheDirectory(),
-            'strict_variables' => true
+            'strict_variables' => true,
         );
 
         $twig = new \Twig_Environment($stringLoader, $options);
 
         // Default escaper will throw an exception. This is because we want to use SQL parameters instead of Twig.
         // This ahs a number of advantages, especially in terms of caching.
-        $twig->getExtension('core')->setEscaper('sql', function() {
+        $twig->getExtension('core')->setEscaper('sql', function () {
             throw new ForbiddenTwigParameterInSqlException('You cannot use Twig expressions (like "{{ id }}"). Instead, you should use SQL parameters (like ":id"). Twig integration is limited to Twig statements (like "{% for .... %}"');
         });
 
@@ -39,7 +39,8 @@ public static function getTwigEnvironment() {
         return $twig;
     }
 
-    private static function getCacheDirectory() {
+    private static function getCacheDirectory()
+    {
         // If we are running on a Unix environment, let's prepend the cache with the user id of the PHP process.
         // This way, we can avoid rights conflicts.
 
@@ -50,7 +51,7 @@ private static function getCacheDirectory() {
             $posixGetuid = '';
         }
         // @codeCoverageIgnoreEnd
-        $cacheDirectory = rtrim(sys_get_temp_dir(), '/\\').'/magicquerysqltwigtemplate'.$posixGetuid.str_replace(":", "", __DIR__);
+        $cacheDirectory = rtrim(sys_get_temp_dir(), '/\\').'/magicquerysqltwigtemplate'.$posixGetuid.str_replace(':', '', __DIR__);
 
         return $cacheDirectory;
     }

src/Mouf/Database/MagicQuery/Twig/StringLoader.php

@@ -1,6 +1,6 @@
 <?php
-namespace Mouf\Database\MagicQuery\Twig;
 
+namespace Mouf\Database\MagicQuery\Twig;
 
 /**
  * This loader completely bypasses the loader mechanism, by directly passing the key as a template.

src/Mouf/Database/MagicQueryMissingConnectionException.php

@@ -1,8 +1,7 @@
 <?php
-namespace Mouf\Database;
 
+namespace Mouf\Database;
 
 class MagicQueryMissingConnectionException extends MagicQueryException
 {
-
-}
+}

src/SQLParser/ExpressionType.php

@@ -31,7 +31,6 @@
  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  * DAMAGE.
  */
-
 namespace SQLParser;
 
 class ExpressionType

src/SQLParser/InvalidParameterException.php

@@ -31,7 +31,6 @@
  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  * DAMAGE.
  */
-
 namespace SQLParser;
 
 class InvalidParameterException extends \InvalidArgumentException

src/SQLParser/LexerSplitter.php

@@ -31,7 +31,6 @@
  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  * DAMAGE.
  */
-
 namespace SQLParser;
 
 class LexerSplitter

src/SQLParser/Node/AbstractManyInstancesOperator.php

@@ -81,7 +81,8 @@ public function toSql(array $parameters = array(), Connection $dbConnection = nu
      *
      * @param VisitorInterface $visitor
      */
-    public function walk(VisitorInterface $visitor) {
+    public function walk(VisitorInterface $visitor)
+    {
         $node = $this;
         $result = $visitor->enterNode($node);
         if ($result instanceof NodeInterface) {
@@ -97,6 +98,7 @@ public function walk(VisitorInterface $visitor) {
                 }
             }
         }
+
         return $visitor->leaveNode($node);
     }
 

src/SQLParser/Node/AbstractTwoOperandsOperator.php

@@ -117,22 +117,30 @@ public function toSql(array $parameters = array(), Connection $dbConnection = nu
             }
         }
         if ($conditionsMode == self::CONDITION_IGNORE || !$this->condition || $this->condition->isOk($parameters)) {
-            $sql = NodeFactory::toSql($this->leftOperand, $dbConnection, $parameters, ' ', false, $indent, $conditionsMode);
-            $sql .= ' '.$this->getOperatorSymbol().' ';
-            $sql .= NodeFactory::toSql($this->rightOperand, $dbConnection, $parameters, ' ', false, $indent, $conditionsMode);
+            $sql = $this->getSql($parameters, $dbConnection, $indent, $conditionsMode);
         } else {
             $sql = null;
         }
 
         return $sql;
     }
 
+    protected function getSql(array $parameters = array(), Connection $dbConnection = null, $indent = 0, $conditionsMode = self::CONDITION_APPLY)
+    {
+        $sql = NodeFactory::toSql($this->leftOperand, $dbConnection, $parameters, ' ', false, $indent, $conditionsMode);
+        $sql .= ' '.$this->getOperatorSymbol().' ';
+        $sql .= NodeFactory::toSql($this->rightOperand, $dbConnection, $parameters, ' ', false, $indent, $conditionsMode);
+
+        return $sql;
+    }
+
     /**
      * Walks the tree of nodes, calling the visitor passed in parameter.
      *
      * @param VisitorInterface $visitor
      */
-    public function walk(VisitorInterface $visitor) {
+    public function walk(VisitorInterface $visitor)
+    {
         $node = $this;
         $result = $visitor->enterNode($node);
         if ($result instanceof NodeInterface) {
@@ -153,10 +161,10 @@ public function walk(VisitorInterface $visitor) {
                 $this->rightOperand = $result2;
             }
         }
+
         return $visitor->leaveNode($node);
     }
 
-
     /**
      * Returns the symbol for this operator.
      */