Fixed minor style issues in generated queries.

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.
phpmyadmin · Aug 20, 2015 · 1b2988f · 1b2988f
1 parent 14c54da
commit 1b2988f
Show file tree

Hide file tree

Showing 24 changed files with 62 additions and 34 deletions.
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"