Update README and refactor import/export classes

Author: jeroenpf

README.md

@@ -0,0 +1,42 @@
+automattic/wp-cli-sqlite-command
+================================
+
+Imports and exports SQLite databases using WP-CLI.
+
+## Using
+
+### wp sqlite import
+
+Imports a MySQL compatible file into an SQLite database.
+
+```
+$ wp sqlite import <file>
+```
+
+**OPTIONS**
+
+	<file>
+		The path to the MySQL compatible dump file to import. When passing `-` as the file argument, the SQL commands are read from standard input.
+
+### wp sqlite export
+
+Exports an SQLite database to a MySQL compatible file.
+
+```
+$ wp sqlite export [<file>] [--tables=<tables>] [--exclude-tables] [--porcelain]
+```
+
+**OPTIONS**
+
+	[<file>]
+		Path to the file to write the MySQL compatible dump to. If not provided, the SQL commands are written to standard output.
+
+	[--tables=<tables>]
+		List of tables to export. Use commas to separate multiple table names.
+
+	[--exclude-tables]
+		Exclude certain tables from the export. Use commas to separate multiple table names.
+
+	[--porcelain]
+		Output just the SQL commands, without any comments.
+

command.php

@@ -13,7 +13,6 @@
 	'\Automattic\WP_CLI\SQLite\SQLite_Command',
 	array(
 		'before_invoke' => function () {
-			// Load the SQLite driver
 			$min_version = '7.4';
 			if ( version_compare( PHP_VERSION, $min_version, '<' ) ) {
 				WP_CLI::error( "The `wp server` command requires PHP {$min_version} or newer." );

src/Base.php

@@ -5,8 +5,6 @@
 
 class Base {
 
-	protected $unsupported_arguments = [];
-
 	/**
 	 * Get the version of the SQLite integration plugin if it is installed
 	 * and activated.
@@ -85,31 +83,11 @@ protected function load_dependencies() {
 		}
 
 		// We also need to selectively load the necessary classes from the plugin.
-		require_once $plugin_directory . '/php-polyfills.php';
 		require_once $plugin_directory . '/constants.php';
 		require_once $plugin_directory . '/wp-includes/sqlite/class-wp-sqlite-lexer.php';
 		require_once $plugin_directory . '/wp-includes/sqlite/class-wp-sqlite-query-rewriter.php';
 		require_once $plugin_directory . '/wp-includes/sqlite/class-wp-sqlite-translator.php';
 		require_once $plugin_directory . '/wp-includes/sqlite/class-wp-sqlite-token.php';
 		require_once $plugin_directory . '/wp-includes/sqlite/class-wp-sqlite-pdo-user-defined-functions.php';
 	}
-
-	/**
-	 * Check if the arguments passed to the command are supported.
-	 *
-	 * @param $args
-	 *
-	 * @return void
-	 * @throws WP_CLI\ExitException
-	 */
-	protected function check_arguments( $args ) {
-		if ( array_intersect_key( $args, array_flip( $this->unsupported_arguments ) ) ) {
-			WP_CLI::error(
-				sprintf(
-					'The following arguments are not supported by SQLite exports: %s',
-					implode( ', ', $this->unsupported_arguments )
-				)
-			);
-		}
-	}
 }

src/Export.php

@@ -8,18 +8,6 @@
 
 class Export extends Base {
 
-	/**
-	 * List of arguments that are not supported by the export command.
-	 * @var string[]
-	 */
-	protected $unsupported_arguments = [
-		'fields',
-		'include-tablespaces',
-		'defaults',
-		'dbuser',
-		'dbpass',
-	];
-
 	protected $translator;
 	protected $args      = array();
 	protected $is_stdout = false;
@@ -40,7 +28,6 @@ public function __construct() {
 	 */
 	public function run( $result_file, $args ) {
 		$this->args = $args;
-		$this->check_arguments( $args );
 
 		$handle = $this->open_output_stream( $result_file );
 

src/Import.php

@@ -8,14 +8,6 @@
 
 class Import extends Base {
 
-	protected $unsupported_arguments = [
-		'skip-optimization',
-		'defaults',
-		'fields',
-		'dbuser',
-		'dbpass',
-	];
-
 	protected $translator;
 	protected $args;
 
@@ -34,7 +26,6 @@ public function __construct() {
 	 */
 	public function run( $sql_file_path, $args ) {
 		$this->args = $args;
-		$this->check_arguments( $args );
 
 		$is_stdin    = '-' === $sql_file_path;
 		$import_file = $is_stdin ? 'php://stdin' : $sql_file_path;

src/SQLite_Command.php

@@ -9,32 +9,84 @@ class SQLite_Command extends WP_CLI_Command {
 
 
 	/**
-	 * Imports the database to SQLite.
+	 * Imports the database to SQLite from an MySQL dump file or from STDIN.
 	 *
 	 * ## OPTIONS
 	 *
 	 * <file>
-	 * : The file to import or - for stdin.
+	 * : The name of the SQL file to import. If '-', then reads from STDIN. If omitted, it will look for '{dbname}.sql'.
+	 *
+	 * ## EXAMPLES
+	 *      # Import the database from a file
+	 *      $ wp sqlite import wordpress_dbase.sql
+	 *      Success: Imported from 'import wordpress_dbase.sql'.
 	 */
 	public function import( $args, $assoc_args ) {
-		WP_CLI::success( 'Importing database...' );
+
+		if ( empty( $args[0] ) ) {
+			WP_CLI::error( 'Please provide a file to import.' );
+		}
+
+		if ( ! Import::get_sqlite_plugin_version() ) {
+			WP_CLI::error( 'The SQLite integration plugin is not installed or activated.' );
+		}
+
 		$import = new Import();
-		$file   = $args[0];
-		$import->run( $file, $assoc_args );
+		$import->run( $args[0], $assoc_args );
 	}
 
 
 	/**
-	 * Exports the database from SQLite
+	 * Exports the database from SQLite to a file or to STDOUT.
 	 *
 	 * ## OPTIONS
 	 *
-	 * <file>
-	 * : The file to export to or - for stdout.
+	 * [<file>]
+	 * : The name of the SQL file to export. If '-', then outputs to STDOUT. If
+	 *  omitted, it will be '{dbname}-{Y-m-d}-{random-hash}.sql'.
+	 *
+	 * [--tables=<tables>]
+	 * : The tables to export. Separate multiple tables with a comma. If omitted, all tables will be exported.
+	 *
+	 * [--exclude_tables=<tables>]
+	 * : The comma separated list of specific tables that should be skipped from exporting. Excluding this parameter will export all tables in the database.
+	 *
+	 * [--porcelain]
+	 * : Output filename for the exported database.
+	 *
+	 * ## EXAMPLES
+	 *  # Export the database to a file
+	 *  $ wp sqlite export wordpress_dbase.sql
+	 *  Success: Exported to 'wordpress_dbase.sql'.
+	 *
+	 *  # Export the database to STDOUT
+	 *  $ wp sqlite export -
+	 *  -- Table structure for table wp_users
+	 *  DROP TABLE IF EXISTS wp_users;
+	 *  CREATE TABLE wp_users (
+	 *  ...
+	 *
+	 *  # Export only specific tables
+	 *  $ wp sqlite export --tables=wp_posts,wp_users
+	 *  Success: Exported to 'wordpress_dbase.sql'.
+	 *
+	 *  # Export all tables except specific tables
+	 *  $ wp sqlite export --exclude_tables=wp_posts,wp_users
+	 *  Success: Exported to 'wordpress_dbase.sql'.
 	 */
 	public function export( $args, $assoc_args ) {
 		WP_CLI::success( 'Exporting database...' );
 		$export = new Export();
-		$export->run( $args[0], $assoc_args );
+
+		if ( ! empty( $args[0] ) ) {
+			$result_file = $args[0];
+		} else {
+			// phpcs:ignore WordPress.WP.AlternativeFunctions.rand_mt_rand -- WordPress is not loaded.
+			$hash        = substr( md5( mt_rand() ), 0, 7 );
+			$result_file = sprintf( '%s-%s.sql', date( 'Y-m-d' ), $hash ); // phpcs:ignore WordPress.DateTime.RestrictedFunctions.date_date
+
+		}
+
+		$export->run( $result_file, $assoc_args );
 	}
 }