Skip to content

refactor: split CLI command classes into separate files #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rbcorrales merged 1 commit into from
May 27, 2026
+144 −126
Merged

refactor: split CLI command classes into separate files #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 1 addition & 125 deletions includes/cli/class-wpvdb-cli.php → includes/cli/class-embeddings-command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* WP CLI embedding and re-embed job commands for WPVDB.
* WP-CLI `wpvdb embeddings` command.
*
* @package WPVDB
*/
Expand Down Expand Up @@ -142,128 +142,4 @@ private static function scope_args_from_assoc( $assoc_args ) {
}
}

/**
* Manage wpvdb embedding jobs (status, resume, cancel, list).
*/
class Jobs_Command extends \WP_CLI_Command {

/**
* List recent jobs (newest first).
*
* ## OPTIONS
*
* [--limit=<n>]
* : Number of jobs to list. Default 20.
*
* [--format=<format>]
* : Output format. Default: table.
* ---
* default: table
* options:
* - table
* - csv
* - json
* - yaml
* ---
*
* @param array $args Positional arguments.
* @param array $assoc_args Associative arguments.
* @return void
*/
public function list( $args, $assoc_args ) {
$limit = isset( $assoc_args['limit'] ) ? (int) $assoc_args['limit'] : 20;
$format = isset( $assoc_args['format'] ) ? $assoc_args['format'] : 'table';
$rows = Embedding_Enqueuer::list_jobs( $limit );
if ( empty( $rows ) ) {
\WP_CLI::log( 'No jobs found.' );
return;
}
$fields = array( 'job_id', 'status', 'provider', 'model', 'queued_count', 'scanned_count', 'skipped_count', 'last_seen_id', 'upper_bound_id', 'updated_at' );
\WP_CLI\Utils\format_items( $format, $rows, $fields );
}

/**
* Print a job's current state.
*
* ## OPTIONS
*
* <job_id>
* : The job ID.
*
* @param array $args Positional arguments.
* @param array $assoc_args Associative arguments.
* @return void
*/
public function status( $args, $assoc_args ) {
$job_id = isset( $args[0] ) ? (int) $args[0] : 0;
if ( $job_id <= 0 ) {
\WP_CLI::error( 'Missing job_id argument.' );
}
$job = Embedding_Enqueuer::get_job( $job_id );
if ( ! $job ) {
\WP_CLI::error( "Job {$job_id} not found." );
}
foreach ( $job as $key => $value ) {
if ( 'scope_args' === $key && is_string( $value ) ) {
$decoded = json_decode( $value, true );
$value = wp_json_encode( $decoded );
}
\WP_CLI::log( str_pad( (string) $key, 18 ) . ' : ' . (string) $value );
}
}

/**
* Cancel a job. Already-scheduled AS pages will exit early on their next firing.
*
* ## OPTIONS
*
* <job_id>
* : The job ID.
*
* @param array $args Positional arguments.
* @param array $assoc_args Associative arguments.
* @return void
*/
public function cancel( $args, $assoc_args ) {
$job_id = isset( $args[0] ) ? (int) $args[0] : 0;
if ( $job_id <= 0 ) {
\WP_CLI::error( 'Missing job_id argument.' );
}
if ( Embedding_Enqueuer::cancel_job( $job_id ) ) {
\WP_CLI::success( "Job {$job_id} canceled." );
} else {
\WP_CLI::error( "Failed to cancel job {$job_id}." );
}
}

/**
* Resume a paused job.
*
* ## OPTIONS
*
* <job_id>
* : The job ID.
*
* @param array $args Positional arguments.
* @param array $assoc_args Associative arguments.
* @return void
*/
public function resume( $args, $assoc_args ) {
$job_id = isset( $args[0] ) ? (int) $args[0] : 0;
if ( $job_id <= 0 ) {
\WP_CLI::error( 'Missing job_id argument.' );
}
$result = Embedding_Enqueuer::resume_job( $job_id );
if ( is_wp_error( $result ) ) {
\WP_CLI::error( $result->get_error_message() );
}
if ( $result ) {
\WP_CLI::success( "Job {$job_id} resumed." );
} else {
\WP_CLI::error( "Job {$job_id} is not in a paused state." );
}
}
}

\WP_CLI::add_command( 'wpvdb embeddings', __NAMESPACE__ . '\\Embeddings_Command' );
\WP_CLI::add_command( 'wpvdb embeddings job', __NAMESPACE__ . '\\Jobs_Command' );
141 changes: 141 additions & 0 deletions includes/cli/class-jobs-command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
<?php
/**
* WP-CLI `wpvdb embeddings job` command.
*
* @package WPVDB
*/

namespace WPVDB\CLI;

use WPVDB\Embedding_Enqueuer;

defined( 'ABSPATH' ) || exit;

if ( ! defined( 'WP_CLI' ) || ! WP_CLI ) {
return;
}

/**
* Manage wpvdb embedding jobs (status, resume, cancel, list).
*/
class Jobs_Command extends \WP_CLI_Command {

/**
* List recent jobs (newest first).
*
* ## OPTIONS
*
* [--limit=<n>]
* : Number of jobs to list. Default 20.
*
* [--format=<format>]
* : Output format. Default: table.
* ---
* default: table
* options:
* - table
* - csv
* - json
* - yaml
* ---
*
* @param array $args Positional arguments.
* @param array $assoc_args Associative arguments.
* @return void
*/
public function list( $args, $assoc_args ) {
$limit = isset( $assoc_args['limit'] ) ? (int) $assoc_args['limit'] : 20;
$format = isset( $assoc_args['format'] ) ? $assoc_args['format'] : 'table';
$rows = Embedding_Enqueuer::list_jobs( $limit );
if ( empty( $rows ) ) {
\WP_CLI::log( 'No jobs found.' );
return;
}
$fields = array( 'job_id', 'status', 'provider', 'model', 'queued_count', 'scanned_count', 'skipped_count', 'last_seen_id', 'upper_bound_id', 'updated_at' );
\WP_CLI\Utils\format_items( $format, $rows, $fields );
}

/**
* Print a job's current state.
*
* ## OPTIONS
*
* <job_id>
* : The job ID.
*
* @param array $args Positional arguments.
* @param array $assoc_args Associative arguments.
* @return void
*/
public function status( $args, $assoc_args ) {
$job_id = isset( $args[0] ) ? (int) $args[0] : 0;
if ( $job_id <= 0 ) {
\WP_CLI::error( 'Missing job_id argument.' );
}
$job = Embedding_Enqueuer::get_job( $job_id );
if ( ! $job ) {
\WP_CLI::error( "Job {$job_id} not found." );
}
foreach ( $job as $key => $value ) {
if ( 'scope_args' === $key && is_string( $value ) ) {
$decoded = json_decode( $value, true );
$value = wp_json_encode( $decoded );
}
\WP_CLI::log( str_pad( (string) $key, 18 ) . ' : ' . (string) $value );
}
}

/**
* Cancel a job. Already-scheduled AS pages will exit early on their next firing.
*
* ## OPTIONS
*
* <job_id>
* : The job ID.
*
* @param array $args Positional arguments.
* @param array $assoc_args Associative arguments.
* @return void
*/
public function cancel( $args, $assoc_args ) {
$job_id = isset( $args[0] ) ? (int) $args[0] : 0;
if ( $job_id <= 0 ) {
\WP_CLI::error( 'Missing job_id argument.' );
}
if ( Embedding_Enqueuer::cancel_job( $job_id ) ) {
\WP_CLI::success( "Job {$job_id} canceled." );
} else {
\WP_CLI::error( "Failed to cancel job {$job_id}." );
}
}

/**
* Resume a paused job.
*
* ## OPTIONS
*
* <job_id>
* : The job ID.
*
* @param array $args Positional arguments.
* @param array $assoc_args Associative arguments.
* @return void
*/
public function resume( $args, $assoc_args ) {
$job_id = isset( $args[0] ) ? (int) $args[0] : 0;
if ( $job_id <= 0 ) {
\WP_CLI::error( 'Missing job_id argument.' );
}
$result = Embedding_Enqueuer::resume_job( $job_id );
if ( is_wp_error( $result ) ) {
\WP_CLI::error( $result->get_error_message() );
}
if ( $result ) {
\WP_CLI::success( "Job {$job_id} resumed." );
} else {
\WP_CLI::error( "Job {$job_id} is not in a paused state." );
}
}
}

\WP_CLI::add_command( 'wpvdb embeddings job', __NAMESPACE__ . '\\Jobs_Command' );
3 changes: 2 additions & 1 deletion wpvdb.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@
require_once WPVDB_PLUGIN_DIR . 'includes/class-wpvdb-embedding-enqueuer.php';
require_once WPVDB_PLUGIN_DIR . 'includes/class-wpvdb-plugin.php';
if ( defined( 'WP_CLI' ) && WP_CLI ) {
require_once WPVDB_PLUGIN_DIR . 'includes/cli/class-wpvdb-cli.php';
require_once WPVDB_PLUGIN_DIR . 'includes/cli/class-embeddings-command.php';
require_once WPVDB_PLUGIN_DIR . 'includes/cli/class-jobs-command.php';
}

if ( ! function_exists( 'wpvdb_has_action_scheduler' ) ) {
Expand Down