- Handle special characters ";" and "'" inside column comments.

- Handle table options in different order.

Author: Carlos Cima

src/Model/Column.php

@@ -437,7 +437,7 @@ public function generateCreationScript()
         }
 
         if (!empty($this->comment)) {
-            $columnOptions[] = sprintf('COMMENT \'%s\'', $this->comment);
+            $columnOptions[] = sprintf('COMMENT \'%s\'', str_replace('\'','\'\'', $this->comment));
         }
 
         return trim(sprintf('`%s` %s %s', $this->name, $this->columnType, implode(' ', $columnOptions)));

src/Model/Table.php

@@ -350,7 +350,7 @@ public function generatePrimaryKeyCreationScript()
             } else {
                 $primaryKey = sprintf('`%s`', $primaryKeyColumn->getName());
             }
-            
+
             $primaryKeys[] = $primaryKey;
         }
 
@@ -359,6 +359,7 @@ public function generatePrimaryKeyCreationScript()
 
     /**
      * @param bool $ignoreAutoIncrement
+     * @param bool $sortKeys
      *
      * @return string
      */

src/Parser.php

@@ -139,7 +139,7 @@ public function parseColumns(Table $table)
             }
 
             if (!empty($comment)) {
-                $column->setComment($comment);
+                $column->setComment(str_replace('\'\'','\'', $comment));
             }
 
             if (!empty($characterSet)) {

src/RegExpPattern.php

@@ -32,12 +32,17 @@ class RegExpPattern
     public static function tables()
     {
         $pattern = '/(?<creationScript>CREATE\s+TABLE\s+(?<ifNotExists>IF NOT EXISTS)?\s*`(?<tableName>\S+)`\s+';
-        $pattern .= '\((?<tableDefinition>[^;\/]+)\)';
+        $pattern .= '\((?<tableDefinition>[^\/]+)\)';
+        $pattern .= '(';
         $pattern .= '(?:\s+ENGINE=(?<engine>[^;\s]+))?\s*';
+        $pattern .= '|';
         $pattern .= '(?:AUTO_INCREMENT=(?<autoIncrement>\d+))?\s*';
-        $pattern .= '(?:DEFAULT CHARSET=(?<defaultCharset>[^;\s]+))?\s*)';
+        $pattern .= '|';
+        $pattern .= '(?:DEFAULT CHARSET=(?<defaultCharset>[^;\s]+))?\s*';
+        $pattern .= '|';
         $pattern .= '(?:COLLATE=.+?)?\s*';
-        $pattern .= '(?:\/\*.+?\*\/)?\s*';
+        $pattern .= ')*';
+        $pattern .= ')(?:\/\*.+?\*\/)?\s*';
         $pattern .= ';/';
         $pattern .= 's'; // modifier
 
@@ -58,7 +63,7 @@ public static function column()
         $pattern .= '(?<autoIncrement>AUTO_INCREMENT)?\s*';
         $pattern .= '(?:DEFAULT (?<defaultValue>\S+|\'[^\']+\'))?\s*';
         $pattern .= '(?:ON UPDATE (?<onUpdateValue>\S+))?\s*';
-        $pattern .= '(?:COMMENT \'(?<comment>[^\']+)\')?\s*';
+        $pattern .= '(?:COMMENT \'(?<comment>([^\']|\'\')+)\')?\s*';
         $pattern .= '(?:,|$)/';
 
         return $pattern;

tests/ParserTest.php

@@ -302,4 +302,25 @@ public function testIsParsingPrimaryKeyLength()
 
         $this->assertEquals($creationScript, $database->getTableByName('jos_extwebdav_properties')->generateCreationScript());
     }
+
+    public function testIsParsingCommentsWithSpecialCharacters()
+    {
+        $creationScript = $this->getDatabaseFixture('jos_ucm_history.sql');
+
+        $parser = new Parser();
+
+        $database = $parser->parseDatabase($creationScript);
+
+        $this->assertInstanceOf(Database::class, $database);
+        $this->assertCount(1, $database->getTables());
+        $this->assertCount(10, $database->getTableByName('jos_ucm_history')->getColumns());
+        $this->assertCount(1, $database->getTableByName('jos_ucm_history')->getPrimaryKeys());
+        $this->assertCount(2, $database->getTableByName('jos_ucm_history')->getIndexes());
+        $this->assertEquals(1, $database->getTableByName('jos_ucm_history')->getAutoIncrement());
+        $this->assertEquals('utf8', $database->getTableByName('jos_ucm_history')->getDefaultCharset());
+        $this->assertEquals('InnoDB', $database->getTableByName('jos_ucm_history')->getEngine());
+        $this->assertEquals('SHA1 hash of the version\'s data column.', $database->getTableByName('jos_ucm_history')->getColumnByName('sha1_hash')->getComment());
+        $this->assertEquals('`sha1_hash` varchar(50) NOT NULL DEFAULT \'\' COMMENT \'SHA1 hash of the version\'\'s data column.\'', $database->getTableByName('jos_ucm_history')->getColumnByName('sha1_hash')->generateCreationScript());
+        $this->assertEquals('0=auto delete; 1=keep', $database->getTableByName('jos_ucm_history')->getColumnByName('keep_forever')->getComment());
+    }
 }

tests/fixtures/jos_ucm_history.sql

@@ -0,0 +1,15 @@
+CREATE TABLE IF NOT EXISTS `jos_ucm_history` (
+  `version_id` int(10) unsigned NOT NULL AUTO_INCREMENT,
+  `ucm_item_id` int(10) unsigned NOT NULL,
+  `ucm_type_id` int(10) unsigned NOT NULL,
+  `version_note` varchar(255) NOT NULL DEFAULT '' COMMENT 'Optional version name',
+  `save_date` datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `editor_user_id` int(10) unsigned NOT NULL DEFAULT '0',
+  `character_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'Number of characters in this version.',
+  `sha1_hash` varchar(50) NOT NULL DEFAULT '' COMMENT 'SHA1 hash of the version''s data column.',
+  `version_data` mediumtext NOT NULL COMMENT 'json-encoded string of version data',
+  `keep_forever` tinyint(4) NOT NULL DEFAULT '0' COMMENT '0=auto delete; 1=keep',
+  PRIMARY KEY (`version_id`),
+  KEY `idx_ucm_item_id` (`ucm_type_id`,`ucm_item_id`),
+  KEY `idx_save_date` (`save_date`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 AUTO_INCREMENT=1;