Add support for --order, --orderby flags in wp db size command (#226)

Co-authored-by: Daniel Bachhuber <[email protected]>

Author: kjohnson

features/db-size.feature

@@ -202,3 +202,38 @@ Feature: Display database size
       """
       KB
       """
+
+  @broken
+  Scenario: Display ordered table names for a WordPress install
+    Given a WP install
+    And I run `wp site empty --yes`
+
+    When I run `wp db size --tables --order=asc --format=json`
+    Then STDOUT should contain:
+      """
+      [{"Name":"wp_commentmeta",
+      """
+
+    When I run `wp db size --tables --order=desc --format=json`
+    Then STDOUT should contain:
+      """
+      [{"Name":"wp_users",
+      """
+
+  @broken
+  Scenario: Display ordered table sizes for a WordPress install
+    Given a WP install
+    And I run `wp site empty --yes`
+    And I run `wp post generate --post_type=page --post_status=draft --count=300`
+
+    When I run `wp db size --tables --order=desc --orderby=size --format=json`
+    Then STDOUT should contain:
+      """
+      [{"Name":"wp_posts",
+      """
+
+    When I run `wp db size --tables --order=asc --orderby=size --format=json`
+    Then STDOUT should not contain:
+      """
+      [{"Name":"wp_posts",
+      """

src/DB_Command.php

@@ -904,6 +904,24 @@ public function tables( $args, $assoc_args ) {
 	 * [--all-tables]
 	 * : List all tables in the database, regardless of the prefix, and even if not registered on $wpdb. Overrides --all-tables-with-prefix.
 	 *
+	 * [--order=<order>]
+	 * : Ascending or Descending order.
+	 * ---
+	 * default: asc
+	 * options:
+	 *   - asc
+	 *   - desc
+	 * ---
+	 *
+	 * [--orderby=<orderby>]
+	 * : Order by fields.
+	 * ---
+	 * default: name
+	 * options:
+	 *   - name
+	 *   - size
+	 * ---
+	 *
 	 * ## EXAMPLES
 	 *
 	 *     $ wp db size
@@ -943,7 +961,6 @@ public function tables( $args, $assoc_args ) {
 	 * @when after_wp_load
 	 */
 	public function size( $args, $assoc_args ) {
-
 		global $wpdb;
 
 		$format                 = Utils\get_flag_value( $assoc_args, 'format' );
@@ -953,6 +970,8 @@ public function size( $args, $assoc_args ) {
 		$tables                 = ! empty( $tables );
 		$all_tables             = Utils\get_flag_value( $assoc_args, 'all-tables' );
 		$all_tables_with_prefix = Utils\get_flag_value( $assoc_args, 'all-tables-with-prefix' );
+		$order                  = Utils\get_flag_value( $assoc_args, 'order', 'asc' );
+		$orderby                = Utils\get_flag_value( $assoc_args, 'orderby', null );
 
 		if ( ! is_null( $size_format ) && $human_readable ) {
 			WP_CLI::error( 'Cannot use --size_format and --human-readable arguments at the same time.' );
@@ -989,8 +1008,9 @@ public function size( $args, $assoc_args ) {
 
 				// Add the table size to the list.
 				$rows[] = [
-					'Name' => $table_name,
-					'Size' => strtoupper( $table_bytes ) . $default_unit,
+					'Name'  => $table_name,
+					'Size'  => strtoupper( $table_bytes ) . $default_unit,
+					'Bytes' => strtoupper( $table_bytes ),
 				];
 			}
 		} else {
@@ -1005,8 +1025,9 @@ public function size( $args, $assoc_args ) {
 
 			// Add the database size to the list.
 			$rows[] = [
-				'Name' => DB_NAME,
-				'Size' => strtoupper( $db_bytes ) . $default_unit,
+				'Name'  => DB_NAME,
+				'Size'  => strtoupper( $db_bytes ) . $default_unit,
+				'Bytes' => strtoupper( $db_bytes ),
 			];
 		}
 
@@ -1088,6 +1109,25 @@ public function size( $args, $assoc_args ) {
 		if ( ! empty( $size_format ) && ! $tables && ! $format && ! $human_readable && true !== $all_tables && true !== $all_tables_with_prefix ) {
 			WP_CLI::line( str_replace( " {$size_format_display}", '', $rows[0]['Size'] ) );
 		} else {
+
+			// Sort the rows by user input
+			if ( $orderby ) {
+				usort(
+					$rows,
+					function( $a, $b ) use ( $order, $orderby ) {
+
+						$orderby_array          = 'asc' === $order ? array( $a, $b ) : array( $b, $a );
+						list( $first, $second ) = $orderby_array;
+
+						if ( 'size' === $orderby ) {
+							return $first['Bytes'] > $second['Bytes'];
+						}
+
+						return strcmp( $first['Name'], $second['Name'] );
+					}
+				);
+			}
+
 			// Display the rows.
 			$args = [
 				'format' => $format,