Fixed parsing SQL comment at the end of query.

Fixes #156

Signed-off-by: Michal Čihař <michal@cihar.com>

Author: nijel

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## [Unreleased]
 
+* Fixed parsing SQL comment at the end of query.
+
 ## [4.1.7] - 2017-06-06
 
 * Fixed setting combination SQL Modes.

src/Context.php

@@ -307,7 +307,7 @@ public static function isWhitespace($str)
      *
      * @return int the appropriate flag for the comment type
      */
-    public static function isComment($str)
+    public static function isComment($str, $end=false)
     {
         $len = strlen($str);
         if ($str[0] === '#') {
@@ -321,6 +321,8 @@ public static function isComment($str)
             && ($str[1] === '-') && (static::isWhitespace($str[2]))
         ) {
             return Token::FLAG_COMMENT_SQL;
+        } elseif (($len == 2) && $end && ($str[0] === '-') && ($str[1] === '-')) {
+            return Token::FLAG_COMMENT_SQL;
         }
 
         return null;

src/Lexer.php

@@ -602,23 +602,27 @@ public function parseComment()
         // SQL style comments. (-- comment\n)
         if (++$this->last < $this->len) {
             $token .= $this->str[$this->last];
-            if (Context::isComment($token)) {
-                // Checking if this comment did not end already (```--\n```).
-                if ($this->str[$this->last] !== "\n") {
-                    while (
-                        ++$this->last < $this->len
-                        && $this->str[$this->last] !== "\n"
-                    ) {
-                        $token .= $this->str[$this->last];
-                    }
-                }
-                // Include trailing \n as whitespace token
-                if ($this->last < $this->len) {
-                    --$this->last;
+            $end = false;
+        } else {
+            --$this->last;
+            $end = true;
+        }
+        if (Context::isComment($token, $end)) {
+            // Checking if this comment did not end already (```--\n```).
+            if ($this->str[$this->last] !== "\n") {
+                while (
+                    ++$this->last < $this->len
+                    && $this->str[$this->last] !== "\n"
+                ) {
+                    $token .= $this->str[$this->last];
                 }
-
-                return new Token($token, Token::TYPE_COMMENT, Token::FLAG_COMMENT_SQL);
             }
+            // Include trailing \n as whitespace token
+            if ($this->last < $this->len) {
+                --$this->last;
+            }
+
+            return new Token($token, Token::TYPE_COMMENT, Token::FLAG_COMMENT_SQL);
         }
 
         $this->last = $iBak;

tests/Lexer/LexerTest.php

@@ -63,6 +63,7 @@ public function testLexProvider()
             array('lexer/lexUtf8'),
             array('lexer/lexBool'),
             array('lexer/lexComment'),
+            array('lexer/lexCommentEnd'),
             array('lexer/lexDelimiter'),
             array('lexer/lexDelimiter2'),
             array('lexer/lexDelimiterErr1'),

tests/data/lexer/lexCommentEnd.in

@@ -0,0 +1,3 @@
+SELECT 1
+-- comment
+--

tests/data/lexer/lexCommentEnd.out

@@ -0,0 +1,7 @@
+a:4:{s:5:"query";s:22:"SELECT 1
+-- comment
+--";s:5:"lexer";O:26:"PhpMyAdmin\SqlParser\Lexer":8:{s:3:"str";s:22:"SELECT 1
+-- comment
+--";s:3:"len";i:22;s:4:"last";i:23;s:4:"list";O:31:"PhpMyAdmin\SqlParser\TokensList":3:{s:6:"tokens";a:8:{i:0;O:26:"PhpMyAdmin\SqlParser\Token":6:{s:5:"token";s:6:"SELECT";s:5:"value";s:6:"SELECT";s:7:"keyword";s:6:"SELECT";s:4:"type";i:1;s:5:"flags";i:3;s:8:"position";i:0;}i:1;O:26:"PhpMyAdmin\SqlParser\Token":6:{s:5:"token";s:1:" ";s:5:"value";s:1:" ";s:7:"keyword";N;s:4:"type";i:3;s:5:"flags";i:0;s:8:"position";i:6;}i:2;O:26:"PhpMyAdmin\SqlParser\Token":6:{s:5:"token";s:1:"1";s:5:"value";i:1;s:7:"keyword";N;s:4:"type";i:6;s:5:"flags";i:0;s:8:"position";i:7;}i:3;O:26:"PhpMyAdmin\SqlParser\Token":6:{s:5:"token";s:1:"
+";s:5:"value";s:1:" ";s:7:"keyword";N;s:4:"type";i:3;s:5:"flags";i:0;s:8:"position";i:8;}i:4;O:26:"PhpMyAdmin\SqlParser\Token":6:{s:5:"token";s:10:"-- comment";s:5:"value";s:10:"-- comment";s:7:"keyword";N;s:4:"type";i:4;s:5:"flags";i:4;s:8:"position";i:9;}i:5;O:26:"PhpMyAdmin\SqlParser\Token":6:{s:5:"token";s:1:"
+";s:5:"value";s:1:" ";s:7:"keyword";N;s:4:"type";i:3;s:5:"flags";i:0;s:8:"position";i:19;}i:6;O:26:"PhpMyAdmin\SqlParser\Token":6:{s:5:"token";s:2:"--";s:5:"value";s:2:"--";s:7:"keyword";N;s:4:"type";i:4;s:5:"flags";i:4;s:8:"position";i:20;}i:7;O:26:"PhpMyAdmin\SqlParser\Token":6:{s:5:"token";N;s:5:"value";N;s:7:"keyword";N;s:4:"type";i:9;s:5:"flags";i:0;s:8:"position";N;}}s:5:"count";i:8;s:3:"idx";i:0;}s:9:"delimiter";s:1:";";s:12:"delimiterLen";i:1;s:6:"strict";b:0;s:6:"errors";a:0:{}}s:6:"parser";N;s:6:"errors";a:2:{s:5:"lexer";a:0:{}s:6:"parser";a:0:{}}}