Fixed minor style issues in generated queries.

udan11 · udan11 · commit 1b2988f29661 · 2015-08-20T22:33:08.000+03:00
Introduced options for builders. Data types are lower case in CREATE TABLE statements, but in any other case they continue to be upper case. Formatter uses 2 spaces instead of 4 for indentation as specified in the MySQL Coding Guidelines. https://dev.mysql.com/doc/internals/en/indentation-spacing.html.
diff --git a/src/Component.php b/src/Component.php
@@ -70,12 +70,13 @@ public static function parse(
          * `static::parse`.
          *
          * @param mixed $component The component to be built.
+         * @param array $options   Parameters for building.
          *
          * @throws \Exception Not implemented yet.
          *
          * @return string
          */
-        public static function build($component)
+        public static function build($component, array $options = array())
         {
             // This method should be abstract, but it can't be both static and
             // abstract.
diff --git a/src/Components/AlterOperation.php b/src/Components/AlterOperation.php
@@ -210,10 +210,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param AlterOperation $component The component to be built.
+     * @param array          $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         $ret = $component->options . ' ';
         if ((isset($component->field)) && ($component->field !== '')) {
diff --git a/src/Components/Array2d.php b/src/Components/Array2d.php
@@ -124,10 +124,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param ArrayObj[] $component The component to be built.
+     * @param array      $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         return ArrayObj::build($component);
     }
diff --git a/src/Components/ArrayObj.php b/src/Components/ArrayObj.php
@@ -143,10 +143,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param ArrayObj|ArrayObj[] $component The component to be built.
+     * @param array               $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         if (is_array($component)) {
             return implode(', ', $component);
diff --git a/src/Components/Condition.php b/src/Components/Condition.php
@@ -197,10 +197,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param Condition[] $component The component to be built.
+     * @param array       $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         if (is_array($component)) {
             return implode(' ', $component);
diff --git a/src/Components/CreateDefinition.php b/src/Components/CreateDefinition.php
@@ -272,13 +272,14 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param CreateDefinition|CreateDefinition[] $component The component to be built.
+     * @param array                               $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         if (is_array($component)) {
-            return "(\n" . implode(",\n", $component) . "\n)";
+            return "(\n  " . implode(",\n  ", $component) . "\n)";
         } else {
             $tmp = '';
 
@@ -291,7 +292,10 @@ public static function build($component)
             }
 
             if (!empty($component->type)) {
-                $tmp .= $component->type . ' ';
+                $tmp .= DataType::build(
+                    $component->type,
+                    array('lowercase' => true)
+                ) . ' ';
             }
 
             if (!empty($component->key)) {
diff --git a/src/Components/DataType.php b/src/Components/DataType.php
@@ -151,16 +151,20 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param DataType $component The component to be built.
+     * @param array    $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
-        $tmp = '';
+        $name = (empty($options['lowercase'])) ?
+            $component->name : strtolower($component->name);
+
+        $parameters = '';
         if (!empty($component->parameters)) {
-            $tmp = '(' . implode(', ', $component->parameters) . ')';
+            $parameters = '(' . implode(',', $component->parameters) . ')';
         }
 
-        return trim($component->name . $tmp . ' ' . $component->options);
+        return trim($name . $parameters . ' ' . $component->options);
     }
 }
diff --git a/src/Components/Expression.php b/src/Components/Expression.php
@@ -351,10 +351,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param Expression|Expression[] $component The component to be built.
+     * @param array                   $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         if (is_array($component)) {
             return implode($component, ', ');
diff --git a/src/Components/ExpressionArray.php b/src/Components/ExpressionArray.php
@@ -106,10 +106,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param Expression[] $component The component to be built.
+     * @param array        $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         $ret = array();
         foreach ($component as $frag) {
diff --git a/src/Components/FunctionCall.php b/src/Components/FunctionCall.php
@@ -115,10 +115,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param FunctionCall $component The component to be built.
+     * @param array        $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         return $component->name . $component->parameters;
     }
diff --git a/src/Components/IntoKeyword.php b/src/Components/IntoKeyword.php
@@ -133,10 +133,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param IntoKeyword $component The component to be built.
+     * @param array       $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         if ($component->dest instanceof Expression) {
             $columns = !empty($component->columns) ?
diff --git a/src/Components/JoinKeyword.php b/src/Components/JoinKeyword.php
@@ -151,10 +151,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param JoinKeyword[] $component The component to be built.
+     * @param array         $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         $ret = array();
         foreach ($component as $c) {
diff --git a/src/Components/Key.php b/src/Components/Key.php
@@ -152,17 +152,18 @@ public static function parse(Parser $parser, TokensList $list, array $options =
     }
 
     /**
-     * @param Key $component The component to be built.
+     * @param Key   $component The component to be built.
+     * @param array $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         $ret = $component->type . ' ';
         if (!empty($component->name)) {
             $ret .= Context::escape($component->name) . ' ';
         }
-        $ret .= '(' . implode(', ', Context::escape($component->columns)) . ') '
+        $ret .= '(' . implode(',', Context::escape($component->columns)) . ') '
             . $component->options;
         return trim($ret);
     }
diff --git a/src/Components/Limit.php b/src/Components/Limit.php
@@ -122,10 +122,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param Limit $component The component to be built.
+     * @param array $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         if (empty($component->offset)) {
             return $component->rowCount;
diff --git a/src/Components/OptionsArray.php b/src/Components/OptionsArray.php
@@ -251,10 +251,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param OptionsArray $component The component to be built.
+     * @param array        $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         if (empty($component->options)) {
             return '';
diff --git a/src/Components/OrderKeyword.php b/src/Components/OrderKeyword.php
@@ -127,10 +127,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param OrderKeyword|OrderKeyword[] $component The component to be built.
+     * @param array                       $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         if (is_array($component)) {
             return implode(', ', $component);
diff --git a/src/Components/ParameterDefinition.php b/src/Components/ParameterDefinition.php
@@ -140,10 +140,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param ParameterDefinition[] $component The component to be built.
+     * @param array                 $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         if (is_array($component)) {
             return '(' . implode(', ', $component) . ')';
diff --git a/src/Components/PartitionDefinition.php b/src/Components/PartitionDefinition.php
@@ -192,10 +192,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param PartitionDefinition|PartitionDefinition[] $component The component to be built.
+     * @param array                                     $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         if (is_array($component)) {
             return "(\n" . implode(",\n", $component) . "\n)";
diff --git a/src/Components/Reference.php b/src/Components/Reference.php
@@ -137,10 +137,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param Reference $component The component to be built.
+     * @param array     $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         return trim(
             Context::escape($component->table)
diff --git a/src/Components/RenameOperation.php b/src/Components/RenameOperation.php
@@ -162,10 +162,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param RenameOperation $component The component to be built.
+     * @param array           $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         if (is_array($component)) {
             return implode(', ', $component);
diff --git a/src/Components/SetOperation.php b/src/Components/SetOperation.php
@@ -122,10 +122,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =
 
     /**
      * @param SetOperation|SetOperation[] $component The component to be built.
+     * @param array                       $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         if (is_array($component)) {
             return implode(', ', $component);
diff --git a/src/Components/UnionKeyword.php b/src/Components/UnionKeyword.php
@@ -25,10 +25,11 @@ class UnionKeyword extends Component
 
     /**
      * @param SelectStatement[] $component The component to be built.
+     * @param array             $options   Parameters for building.
      *
      * @return string
      */
-    public static function build($component)
+    public static function build($component, array $options = array())
     {
         return implode(' UNION ', $component);
     }
diff --git a/src/Utils/Formatter.php b/src/Utils/Formatter.php
@@ -80,7 +80,7 @@ public function __construct(array $options = array())
                  *
                  * @var string
                  */
-                'indentation' => "    ",
+                'indentation' => "  ",
 
                 /**
                  * Whether comments should be removed or not.
diff --git a/tests/Builder/CreateStatementTest.php b/tests/Builder/CreateStatementTest.php
@@ -58,8 +58,8 @@ public function testBuilderTable()
 
         $this->assertEquals(
             "CREATE TABLE `test` (\n" .
-            "`id` INT(11) UNSIGNED NOT NULL AUTO_INCREMENT,\n" .
-            "PRIMARY KEY (`id`)\n" .
+            "  `id` int(11) UNSIGNED NOT NULL AUTO_INCREMENT,\n" .
+            "  PRIMARY KEY (`id`)\n" .
             ") ",
             $stmt->build()
         );
@@ -68,8 +68,8 @@ public function testBuilderTable()
     public function testBuilderPartitions()
     {
         $query = 'CREATE TABLE ts (' . "\n"
-            . '`id` INT,' . "\n"
-            . '`purchased` DATE' . "\n"
+            . '  `id` int,' . "\n"
+            . '  `purchased` date' . "\n"
             . ') ' . "\n"
             . 'PARTITION BY RANGE(YEAR(purchased))' . "\n"
             . 'PARTITIONS 3' . "\n"

Original file line number	Diff line number	Diff line change
`@@ -70,12 +70,13 @@ public static function parse(`
`70`	`70`	* `static::parse`.
`71`	`71`	`*`
`72`	`72`	`* @param mixed $component The component to be built.`
	`73`	`+ * @param array $options Parameters for building.`
`73`	`74`	`*`
`74`	`75`	`* @throws \Exception Not implemented yet.`
`75`	`76`	`*`
`76`	`77`	`* @return string`
`77`	`78`	`*/`
`78`		`- public static function build($component)`
	`79`	`+ public static function build($component, array $options = array())`
`79`	`80`	`{`
`80`	`81`	`// This method should be abstract, but it can't be both static and`
`81`	`82`	`// abstract.`
Original file line number	Diff line number	Diff line change
`@@ -210,10 +210,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =`
`210`	`210`
`211`	`211`	`/**`
`212`	`212`	`* @param AlterOperation $component The component to be built.`
	`213`	`+ * @param array $options Parameters for building.`
`213`	`214`	`*`
`214`	`215`	`* @return string`
`215`	`216`	`*/`
`216`		`- public static function build($component)`
	`217`	`+ public static function build($component, array $options = array())`
`217`	`218`	`{`
`218`	`219`	`$ret = $component->options . ' ';`
`219`	`220`	`if ((isset($component->field)) && ($component->field !== '')) {`
Original file line number	Diff line number	Diff line change
`@@ -124,10 +124,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =`
`124`	`124`
`125`	`125`	`/**`
`126`	`126`	`* @param ArrayObj[] $component The component to be built.`
	`127`	`+ * @param array $options Parameters for building.`
`127`	`128`	`*`
`128`	`129`	`* @return string`
`129`	`130`	`*/`
`130`		`- public static function build($component)`
	`131`	`+ public static function build($component, array $options = array())`
`131`	`132`	`{`
`132`	`133`	`return ArrayObj::build($component);`
`133`	`134`	`}`
Original file line number	Diff line number	Diff line change
`@@ -143,10 +143,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =`
`143`	`143`
`144`	`144`	`/**`
`145`	`145`	`* @param ArrayObj\|ArrayObj[] $component The component to be built.`
	`146`	`+ * @param array $options Parameters for building.`
`146`	`147`	`*`
`147`	`148`	`* @return string`
`148`	`149`	`*/`
`149`		`- public static function build($component)`
	`150`	`+ public static function build($component, array $options = array())`
`150`	`151`	`{`
`151`	`152`	`if (is_array($component)) {`
`152`	`153`	`return implode(', ', $component);`
Original file line number	Diff line number	Diff line change
`@@ -197,10 +197,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =`
`197`	`197`
`198`	`198`	`/**`
`199`	`199`	`* @param Condition[] $component The component to be built.`
	`200`	`+ * @param array $options Parameters for building.`
`200`	`201`	`*`
`201`	`202`	`* @return string`
`202`	`203`	`*/`
`203`		`- public static function build($component)`
	`204`	`+ public static function build($component, array $options = array())`
`204`	`205`	`{`
`205`	`206`	`if (is_array($component)) {`
`206`	`207`	`return implode(' ', $component);`
Original file line number	Diff line number	Diff line change
`@@ -272,13 +272,14 @@ public static function parse(Parser $parser, TokensList $list, array $options =`
`272`	`272`
`273`	`273`	`/**`
`274`	`274`	`* @param CreateDefinition\|CreateDefinition[] $component The component to be built.`
	`275`	`+ * @param array $options Parameters for building.`
`275`	`276`	`*`
`276`	`277`	`* @return string`
`277`	`278`	`*/`
`278`		`- public static function build($component)`
	`279`	`+ public static function build($component, array $options = array())`
`279`	`280`	`{`
`280`	`281`	`if (is_array($component)) {`
`281`		`- return "(\n" . implode(",\n", $component) . "\n)";`
	`282`	`+ return "(\n " . implode(",\n ", $component) . "\n)";`
`282`	`283`	`} else {`
`283`	`284`	`$tmp = '';`
`284`	`285`
`@@ -291,7 +292,10 @@ public static function build($component)`
`291`	`292`	`}`
`292`	`293`
`293`	`294`	`if (!empty($component->type)) {`
`294`		`- $tmp .= $component->type . ' ';`
	`295`	`+ $tmp .= DataType::build(`
	`296`	`+ $component->type,`
	`297`	`+ array('lowercase' => true)`
	`298`	`+ ) . ' ';`
`295`	`299`	`}`
`296`	`300`
`297`	`301`	`if (!empty($component->key)) {`
Original file line number	Diff line number	Diff line change
`@@ -151,16 +151,20 @@ public static function parse(Parser $parser, TokensList $list, array $options =`
`151`	`151`
`152`	`152`	`/**`
`153`	`153`	`* @param DataType $component The component to be built.`
	`154`	`+ * @param array $options Parameters for building.`
`154`	`155`	`*`
`155`	`156`	`* @return string`
`156`	`157`	`*/`
`157`		`- public static function build($component)`
	`158`	`+ public static function build($component, array $options = array())`
`158`	`159`	`{`
`159`		`- $tmp = '';`
	`160`	`+ $name = (empty($options['lowercase'])) ?`
	`161`	`+ $component->name : strtolower($component->name);`
	`162`	`+`
	`163`	`+ $parameters = '';`
`160`	`164`	`if (!empty($component->parameters)) {`
`161`		`- $tmp = '(' . implode(', ', $component->parameters) . ')';`
	`165`	`+ $parameters = '(' . implode(',', $component->parameters) . ')';`
`162`	`166`	`}`
`163`	`167`
`164`		`- return trim($component->name . $tmp . ' ' . $component->options);`
	`168`	`+ return trim($name . $parameters . ' ' . $component->options);`
`165`	`169`	`}`
`166`	`170`	`}`
Original file line number	Diff line number	Diff line change
`@@ -351,10 +351,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =`
`351`	`351`
`352`	`352`	`/**`
`353`	`353`	`* @param Expression\|Expression[] $component The component to be built.`
	`354`	`+ * @param array $options Parameters for building.`
`354`	`355`	`*`
`355`	`356`	`* @return string`
`356`	`357`	`*/`
`357`		`- public static function build($component)`
	`358`	`+ public static function build($component, array $options = array())`
`358`	`359`	`{`
`359`	`360`	`if (is_array($component)) {`
`360`	`361`	`return implode($component, ', ');`
Original file line number	Diff line number	Diff line change
`@@ -106,10 +106,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =`
`106`	`106`
`107`	`107`	`/**`
`108`	`108`	`* @param Expression[] $component The component to be built.`
	`109`	`+ * @param array $options Parameters for building.`
`109`	`110`	`*`
`110`	`111`	`* @return string`
`111`	`112`	`*/`
`112`		`- public static function build($component)`
	`113`	`+ public static function build($component, array $options = array())`
`113`	`114`	`{`
`114`	`115`	`$ret = array();`
`115`	`116`	`foreach ($component as $frag) {`
Original file line number	Diff line number	Diff line change
`@@ -115,10 +115,11 @@ public static function parse(Parser $parser, TokensList $list, array $options =`
`115`	`115`
`116`	`116`	`/**`
`117`	`117`	`* @param FunctionCall $component The component to be built.`
	`118`	`+ * @param array $options Parameters for building.`
`118`	`119`	`*`
`119`	`120`	`* @return string`
`120`	`121`	`*/`
`121`		`- public static function build($component)`
	`122`	`+ public static function build($component, array $options = array())`
`122`	`123`	`{`
`123`	`124`	`return $component->name . $component->parameters;`
`124`	`125`	`}`