Fix empty string default not being parsed correctly (#70)

bennett-treptow · web-flow · commit b9ac034de603 · 2022-08-02T19:08:02.000-05:00
* Fix empty string default value not being correctly parsed

* CS fix
diff --git a/composer.json b/composer.json
@@ -35,7 +35,8 @@
     "post-autoload-dump": [
       "@php ./vendor/bin/testbench package:discover --ansi"
     ],
-    "test": ["vendor/bin/phpunit"]
+    "test": ["vendor/bin/phpunit"],
+    "lint": "vendor/bin/php-cs-fixer fix"
   },
   "extra": {
     "laravel": {
diff --git a/src/Definitions/ColumnDefinition.php b/src/Definitions/ColumnDefinition.php
@@ -123,7 +123,7 @@ public function getComment(): ?string
     {
         return $this->comment;
     }
-  
+
     /**
      * @return string|null
      */
@@ -411,7 +411,7 @@ public function setIsUUID(bool $isUUID): ColumnDefinition
 
     protected function isNullableMethod($methodName)
     {
-        return ! in_array($methodName, ['softDeletes', 'morphs', 'nullableMorphs', 'rememberToken', 'nullableUuidMorphs']) && !$this->isPrimaryKeyMethod($methodName);
+        return ! in_array($methodName, ['softDeletes', 'morphs', 'nullableMorphs', 'rememberToken', 'nullableUuidMorphs']) && ! $this->isPrimaryKeyMethod($methodName);
     }
 
     protected function isPrimaryKeyMethod($methodName)
@@ -514,8 +514,8 @@ public function render(): string
             $this->nullable = true;
         }
 
-        if($this->isNullableMethod($finalMethodName)){
-            if($this->nullable === true){
+        if ($this->isNullableMethod($finalMethodName)) {
+            if ($this->nullable === true) {
                 $initialString .= '->nullable()';
             }
         }
diff --git a/src/GeneratorManagers/BaseGeneratorManager.php b/src/GeneratorManagers/BaseGeneratorManager.php
@@ -2,14 +2,11 @@
 
 namespace LaravelMigrationGenerator\GeneratorManagers;
 
-use LaravelMigrationGenerator\Definitions\ViewDefinition;
-use LaravelMigrationGenerator\Helpers\Dependency;
 use LaravelMigrationGenerator\Helpers\ConfigResolver;
+use LaravelMigrationGenerator\Definitions\ViewDefinition;
 use LaravelMigrationGenerator\Helpers\DependencyResolver;
 use LaravelMigrationGenerator\Definitions\TableDefinition;
 use LaravelMigrationGenerator\GeneratorManagers\Interfaces\GeneratorManagerInterface;
-use LaravelMigrationGenerator\Helpers\DependencyResolverV2;
-use LaravelMigrationGenerator\Helpers\DependencyResolverV3;
 
 abstract class BaseGeneratorManager implements GeneratorManagerInterface
 {
diff --git a/src/GeneratorManagers/Interfaces/GeneratorManagerInterface.php b/src/GeneratorManagers/Interfaces/GeneratorManagerInterface.php
@@ -2,8 +2,8 @@
 
 namespace LaravelMigrationGenerator\GeneratorManagers\Interfaces;
 
-use LaravelMigrationGenerator\Definitions\TableDefinition;
 use LaravelMigrationGenerator\Definitions\ViewDefinition;
+use LaravelMigrationGenerator\Definitions\TableDefinition;
 
 interface GeneratorManagerInterface
 {
diff --git a/src/Generators/Concerns/CleansUpMorphColumns.php b/src/Generators/Concerns/CleansUpMorphColumns.php
@@ -5,7 +5,6 @@
 use Illuminate\Support\Str;
 use LaravelMigrationGenerator\Definitions\ColumnDefinition;
 use LaravelMigrationGenerator\Generators\BaseTableGenerator;
-use LaravelMigrationGenerator\Tokenizers\Interfaces\ColumnTokenizerInterface;
 
 /**
  * Trait CleansUpMorphColumns
diff --git a/src/Helpers/DependencyResolver.php b/src/Helpers/DependencyResolver.php
@@ -63,7 +63,7 @@ protected function build()
             foreach ($indicesForStart as $index) {
                 $startDefinition->removeIndexDefinition($index);
             }
-            if(!in_array($start, $sorted)) {
+            if (! in_array($start, $sorted)) {
                 $definitions[] = $startDefinition;
             }
 
@@ -76,7 +76,7 @@ protected function build()
             foreach ($indicesForEnd as $index) {
                 $endDefinition->removeIndexDefinition($index);
             }
-            if(!in_array($end, $sorted)) {
+            if (! in_array($end, $sorted)) {
                 $definitions[] = $endDefinition;
             }
 
diff --git a/src/Helpers/ValueToString.php b/src/Helpers/ValueToString.php
@@ -26,8 +26,8 @@ public static function parseCastedValue($value)
         if (Str::startsWith($value, 'float$:')) {
             return str_replace('float$:', '', $value);
         }
-        if(Str::startsWith($value, 'binary$:')) {
-            return 'b\''.str_replace('binary$:', '', $value).'\'';
+        if (Str::startsWith($value, 'binary$:')) {
+            return 'b\'' . str_replace('binary$:', '', $value) . '\'';
         }
 
         return $value;
diff --git a/src/Tokenizers/BaseTokenizer.php b/src/Tokenizers/BaseTokenizer.php
@@ -16,16 +16,18 @@ public function __construct(string $value)
         $this->value = $value;
         $prune = false;
         $pruneSingleQuotes = false;
-        //\(?\'(.+?)?\s(.+?)?\'\)?
 
         //first get rid of any single quoted stuff with '' around it
-        if(preg_match_all('/\'\'(.+?)\'\'/', $value, $matches)){
-            foreach($matches[0] as $key => $singleQuoted){
+        if (preg_match_all('/\'\'(.+?)\'\'/', $value, $matches)) {
+            foreach ($matches[0] as $key => $singleQuoted) {
                 $toReplace = $singleQuoted;
-                $value = str_replace($toReplace, self::SINGLE_QUOTE_REPLACER.$matches[1][$key].self::SINGLE_QUOTE_REPLACER, $value);
+                $value = str_replace($toReplace, self::SINGLE_QUOTE_REPLACER . $matches[1][$key] . self::SINGLE_QUOTE_REPLACER, $value);
                 $pruneSingleQuotes = true;
             }
         }
+        if (preg_match('/\'\'/', $value)) {
+            $value = str_replace('\'\'', '$$EMPTY_STRING', $value);
+        }
 
         if (preg_match_all("/'(.+?)'/", $value, $matches)) {
             foreach ($matches[0] as $quoteWithSpace) {
@@ -36,6 +38,7 @@ public function __construct(string $value)
                 $prune = true;
             }
         }
+        $value = str_replace('$$EMPTY_STRING', '\'\'', $value);
         $this->tokens = array_map(function ($item) {
             return trim($item, ', ');
         }, str_getcsv($value, ' ', "'"));
@@ -45,7 +48,7 @@ public function __construct(string $value)
                 return str_replace(self::SPACE_REPLACER, ' ', $item);
             }, $this->tokens);
         }
-        if($pruneSingleQuotes){
+        if ($pruneSingleQuotes) {
             $this->tokens = array_map(function ($item) {
                 return str_replace(self::SINGLE_QUOTE_REPLACER, '\'', $item);
             }, $this->tokens);
diff --git a/src/Tokenizers/MySQL/ColumnTokenizer.php b/src/Tokenizers/MySQL/ColumnTokenizer.php
@@ -112,9 +112,9 @@ protected function consumeNullable()
             $this->putBack($piece);
         }
 
-        if(Str::contains($this->columnDataType, 'text')){
+        if (Str::contains($this->columnDataType, 'text')) {
             //text column types are explicitly nullable unless set to NOT NULL
-            if($this->definition->isNullable() === null){
+            if ($this->definition->isNullable() === null) {
                 $this->definition->setNullable(true);
             }
         }
@@ -134,21 +134,21 @@ protected function consumeDefaultValue()
                 $this->definition
                     ->setDefaultValue(null)
                     ->setUseCurrent(true);
-            } elseif(preg_match("/b'([01]+)'/i", $this->definition->getDefaultValue(), $matches)){
+            } elseif (preg_match("/b'([01]+)'/i", $this->definition->getDefaultValue(), $matches)) {
                 // Binary digit, so let's convert to PHP's version
                 $this->definition->setDefaultValue(ValueToString::castBinary($matches[1]));
             }
             if ($this->definition->getDefaultValue() !== null) {
                 if ($this->isNumberType()) {
                     if (Str::contains(strtoupper($this->columnDataType), 'INT')) {
-                        $this->definition->setDefaultValue((int)$this->definition->getDefaultValue());
+                        $this->definition->setDefaultValue((int) $this->definition->getDefaultValue());
                     } else {
                         //floats get converted to strings improperly, gotta do a string cast
                         $this->definition->setDefaultValue(ValueToString::castFloat($this->definition->getDefaultValue()));
                     }
                 } else {
-                    if(!$this->isBinaryType()) {
-                        $this->definition->setDefaultValue((string)$this->definition->getDefaultValue());
+                    if (! $this->isBinaryType()) {
+                        $this->definition->setDefaultValue((string) $this->definition->getDefaultValue());
                     }
                 }
             }
@@ -164,10 +164,10 @@ protected function consumeComment()
             // next piece is the comment content
             $this->definition->setComment($this->consume());
         } else {
-          $this->putBack($piece);
+            $this->putBack($piece);
         }
     }
-  
+
     protected function consumeCharacterSet()
     {
         $piece = $this->consume();
@@ -370,7 +370,8 @@ protected function isArrayType()
         return Str::contains($this->columnDataType, ['enum', 'set']);
     }
 
-    protected function isBinaryType(){
+    protected function isBinaryType()
+    {
         return Str::contains($this->columnDataType, ['bit']);
     }
 
diff --git a/src/Tokenizers/MySQL/IndexTokenizer.php b/src/Tokenizers/MySQL/IndexTokenizer.php
@@ -59,11 +59,12 @@ private function consumeForeignKey()
             $columns = [];
             $token = $this->consume();
 
-            while(!is_null($token)) {
+            while (! is_null($token)) {
                 $columns = array_merge($columns, $this->columnsToArray($token));
                 $token = $this->consume();
-                if(strtoupper($token) === 'REFERENCES') {
+                if (strtoupper($token) === 'REFERENCES') {
                     $this->putBack($token);
+
                     break;
                 }
             }
@@ -76,11 +77,12 @@ private function consumeForeignKey()
 
             $referencedColumns = [];
             $token = $this->consume();
-            while(!is_null($token)){
+            while (! is_null($token)) {
                 $referencedColumns = array_merge($referencedColumns, $this->columnsToArray($token));
                 $token = $this->consume();
-                if(strtoupper($token) === 'ON'){
+                if (strtoupper($token) === 'ON') {
                     $this->putBack($token);
+
                     break;
                 }
             }
diff --git a/tests/Unit/Tokenizers/MySQL/ColumnTokenizerTest.php b/tests/Unit/Tokenizers/MySQL/ColumnTokenizerTest.php
@@ -133,14 +133,24 @@ public function test_it_tokenizes_a_null_varchar_default_value_null_column_with_
         $this->assertEquals('$table->string(\'favorite_color\')->nullable()->comment("favorite color is \"green\"")', $columnDefinition->render());
     }
 
-    public function test_it_tokenizes_varchar_with_default_and_comment(){
+    public function test_it_tokenizes_varchar_with_default_and_comment()
+    {
         $columnTokenizer = ColumnTokenizer::parse("`testing` varchar(255) DEFAULT 'this is ''it''' COMMENT 'this is the \"comment\"'");
         $columnDefinition = $columnTokenizer->definition();
         $this->assertEquals('this is \'it\'', $columnDefinition->getDefaultValue());
         $this->assertEquals('this is the "comment"', $columnDefinition->getComment());
     }
 
-    public function test_it_tokenizes_varchar_with_boolean_literal_default(){
+    public function test_it_tokenizes_varchar_with_default_empty_string_and_comment()
+    {
+        $columnTokenizer = ColumnTokenizer::parse("`testing` varchar(255) DEFAULT '' COMMENT 'this is the \"comment\"'");
+        $columnDefinition = $columnTokenizer->definition();
+        $this->assertEquals('', $columnDefinition->getDefaultValue());
+        $this->assertEquals('this is the "comment"', $columnDefinition->getComment());
+    }
+
+    public function test_it_tokenizes_varchar_with_boolean_literal_default()
+    {
         $columnTokenizer = ColumnTokenizer::parse("`testing` bit(2) DEFAULT b'10'");
         $columnDefinition = $columnTokenizer->definition();
         $this->assertEquals('bit', $columnDefinition->getMethodName());
@@ -724,6 +734,7 @@ public function test_it_tokenizes_a_null_default_value_now_and_on_update_datetim
         $this->assertNull($columnDefinition->getCollation());
         $this->assertEquals('$table->dateTime(\'sent_at\')->useCurrent()->useCurrentOnUpdate()', $columnDefinition->render());
     }
+
     //endregion
 
     //region TIMESTAMP
diff --git a/tests/Unit/Tokenizers/MySQL/IndexTokenizerTest.php b/tests/Unit/Tokenizers/MySQL/IndexTokenizerTest.php
@@ -194,7 +194,8 @@ public function test_it_tokenizes_foreign_key_with_update_and_delete()
         $this->assertEquals('$table->foreign(\'user_id\', \'fk_bank_accounts_user_id\')->references(\'id\')->on(\'users\')->onUpdate(\'cascade\')->onDelete(\'cascade\')', $indexDefinition->render());
     }
 
-    public function test_it_tokenizes_foreign_key_with_multiple_columns(){
+    public function test_it_tokenizes_foreign_key_with_multiple_columns()
+    {
         $indexTokenizer = IndexTokenizer::parse('CONSTRAINT `table2_ibfk_1` FOREIGN KEY (`table2-foreign1`, `table2-foreign2`) REFERENCES `table1` (`table1-field1`, `table1-field2`) ON DELETE CASCADE ON UPDATE CASCADE');
         $definition = $indexTokenizer->definition();
 

Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ public function getComment(): ?string`
`123`	`123`	`{`
`124`	`124`	`return $this->comment;`
`125`	`125`	`}`
`126`		`-`
	`126`	`+`
`127`	`127`	`/**`
`128`	`128`	`* @return string\|null`
`129`	`129`	`*/`
`@@ -411,7 +411,7 @@ public function setIsUUID(bool $isUUID): ColumnDefinition`
`411`	`411`
`412`	`412`	`protected function isNullableMethod($methodName)`
`413`	`413`	`{`
`414`		`- return ! in_array($methodName, ['softDeletes', 'morphs', 'nullableMorphs', 'rememberToken', 'nullableUuidMorphs']) && !$this->isPrimaryKeyMethod($methodName);`
	`414`	`+ return ! in_array($methodName, ['softDeletes', 'morphs', 'nullableMorphs', 'rememberToken', 'nullableUuidMorphs']) && ! $this->isPrimaryKeyMethod($methodName);`
`415`	`415`	`}`
`416`	`416`
`417`	`417`	`protected function isPrimaryKeyMethod($methodName)`
`@@ -514,8 +514,8 @@ public function render(): string`
`514`	`514`	`$this->nullable = true;`
`515`	`515`	`}`
`516`	`516`
`517`		`- if($this->isNullableMethod($finalMethodName)){`
`518`		`- if($this->nullable === true){`
	`517`	`+ if ($this->isNullableMethod($finalMethodName)) {`
	`518`	`+ if ($this->nullable === true) {`
`519`	`519`	`$initialString .= '->nullable()';`
`520`	`520`	`}`
`521`	`521`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,8 @@`
`2`	`2`
`3`	`3`	`namespace LaravelMigrationGenerator\GeneratorManagers\Interfaces;`
`4`	`4`
`5`		`-use LaravelMigrationGenerator\Definitions\TableDefinition;`
`6`	`5`	`use LaravelMigrationGenerator\Definitions\ViewDefinition;`
	`6`	`+use LaravelMigrationGenerator\Definitions\TableDefinition;`
`7`	`7`
`8`	`8`	`interface GeneratorManagerInterface`
`9`	`9`	`{`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ protected function build()`
`63`	`63`	`foreach ($indicesForStart as $index) {`
`64`	`64`	`$startDefinition->removeIndexDefinition($index);`
`65`	`65`	`}`
`66`		`- if(!in_array($start, $sorted)) {`
	`66`	`+ if (! in_array($start, $sorted)) {`
`67`	`67`	`$definitions[] = $startDefinition;`
`68`	`68`	`}`
`69`	`69`
`@@ -76,7 +76,7 @@ protected function build()`
`76`	`76`	`foreach ($indicesForEnd as $index) {`
`77`	`77`	`$endDefinition->removeIndexDefinition($index);`
`78`	`78`	`}`
`79`		`- if(!in_array($end, $sorted)) {`
	`79`	`+ if (! in_array($end, $sorted)) {`
`80`	`80`	`$definitions[] = $endDefinition;`
`81`	`81`	`}`
`82`	`82`
Original file line number	Diff line number	Diff line change
`@@ -26,8 +26,8 @@ public static function parseCastedValue($value)`
`26`	`26`	`if (Str::startsWith($value, 'float$:')) {`
`27`	`27`	`return str_replace('float$:', '', $value);`
`28`	`28`	`}`
`29`		`- if(Str::startsWith($value, 'binary$:')) {`
`30`		`- return 'b\''.str_replace('binary$:', '', $value).'\'';`
	`29`	`+ if (Str::startsWith($value, 'binary$:')) {`
	`30`	`+ return 'b\'' . str_replace('binary$:', '', $value) . '\'';`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`return $value;`
Original file line number	Diff line number	Diff line change
`@@ -112,9 +112,9 @@ protected function consumeNullable()`
`112`	`112`	`$this->putBack($piece);`
`113`	`113`	`}`
`114`	`114`
`115`		`- if(Str::contains($this->columnDataType, 'text')){`
	`115`	`+ if (Str::contains($this->columnDataType, 'text')) {`
`116`	`116`	`//text column types are explicitly nullable unless set to NOT NULL`
`117`		`- if($this->definition->isNullable() === null){`
	`117`	`+ if ($this->definition->isNullable() === null) {`
`118`	`118`	`$this->definition->setNullable(true);`
`119`	`119`	`}`
`120`	`120`	`}`
`@@ -134,21 +134,21 @@ protected function consumeDefaultValue()`
`134`	`134`	`$this->definition`
`135`	`135`	`->setDefaultValue(null)`
`136`	`136`	`->setUseCurrent(true);`
`137`		`- } elseif(preg_match("/b'([01]+)'/i", $this->definition->getDefaultValue(), $matches)){`
	`137`	`+ } elseif (preg_match("/b'([01]+)'/i", $this->definition->getDefaultValue(), $matches)) {`
`138`	`138`	`// Binary digit, so let's convert to PHP's version`
`139`	`139`	`$this->definition->setDefaultValue(ValueToString::castBinary($matches[1]));`
`140`	`140`	`}`
`141`	`141`	`if ($this->definition->getDefaultValue() !== null) {`
`142`	`142`	`if ($this->isNumberType()) {`
`143`	`143`	`if (Str::contains(strtoupper($this->columnDataType), 'INT')) {`
`144`		`- $this->definition->setDefaultValue((int)$this->definition->getDefaultValue());`
	`144`	`+ $this->definition->setDefaultValue((int) $this->definition->getDefaultValue());`
`145`	`145`	`} else {`
`146`	`146`	`//floats get converted to strings improperly, gotta do a string cast`
`147`	`147`	`$this->definition->setDefaultValue(ValueToString::castFloat($this->definition->getDefaultValue()));`
`148`	`148`	`}`
`149`	`149`	`} else {`
`150`		`- if(!$this->isBinaryType()) {`
`151`		`- $this->definition->setDefaultValue((string)$this->definition->getDefaultValue());`
	`150`	`+ if (! $this->isBinaryType()) {`
	`151`	`+ $this->definition->setDefaultValue((string) $this->definition->getDefaultValue());`
`152`	`152`	`}`
`153`	`153`	`}`
`154`	`154`	`}`
`@@ -164,10 +164,10 @@ protected function consumeComment()`
`164`	`164`	`// next piece is the comment content`
`165`	`165`	`$this->definition->setComment($this->consume());`
`166`	`166`	`} else {`
`167`		`- $this->putBack($piece);`
	`167`	`+ $this->putBack($piece);`
`168`	`168`	`}`
`169`	`169`	`}`
`170`		`-`
	`170`	`+`
`171`	`171`	`protected function consumeCharacterSet()`
`172`	`172`	`{`
`173`	`173`	`$piece = $this->consume();`
`@@ -370,7 +370,8 @@ protected function isArrayType()`
`370`	`370`	`return Str::contains($this->columnDataType, ['enum', 'set']);`
`371`	`371`	`}`
`372`	`372`
`373`		`- protected function isBinaryType(){`
	`373`	`+ protected function isBinaryType()`
	`374`	`+ {`
`374`	`375`	`return Str::contains($this->columnDataType, ['bit']);`
`375`	`376`	`}`
`376`	`377`