Adding support for folder and a filter for registering custom repositories via filter

Author: david-binda

backends/class-phpcs-diff-svn.php

@@ -36,10 +36,15 @@ function __construct( $repo, $options = array() ) {
 			# Add new repos here. See details at the top of this file.
 		}
 
+		$repositories = apply_filters( 'phpcs_diff_svn_repositories', array() );
+		if ( true === is_array( $repositories ) && true === array_key_exists( $repo, $repositories ) ) {
+			$this->repo_url = $repositories[$repo];
+		}
+
 		$this->repo = $repo;
 	}
 
-	public function get_diff( $end_revision, $start_revision = null, $options = array() ) {
+	public function get_diff( $folder, $end_revision, $start_revision = null, $options = array() ) {
 		$summarize			 = false;
 		$xml 				 = false;
 		$ignore_space_change = false;
@@ -66,7 +71,7 @@ public function get_diff( $end_revision, $start_revision = null, $options = arra
 			$start_revision = 1;
 		}
 
-		$repo_url = esc_url_raw( trailingslashit( $this->repo_url ) );
+		$repo_url = esc_url_raw( trailingslashit( $this->repo_url ) . urlencode( sanitize_title( $folder ) ) );
 
 		$diff = shell_exec(
 			sprintf( 'svn diff %s --non-interactive --no-auth-cache --username %s --password %s -r %d:%d %s %s %s',

inc/class-phpcs-diff.php

@@ -61,12 +61,13 @@ public function set_excluded_extensions( $excluded_exts ) {
 		$this->excluded_extensions = $excluded_exts;
 	}
 
-	public function run( $oldest_rev, $newest_rev ) {
+	public function run( $oldest_rev, $newest_rev, $folder = '' ) {
 
 		$oldest_rev = absint( $oldest_rev );
 		$newest_rev = absint( $newest_rev );
+		$folder		= sanitize_title( $folder );
 
-		$cache_key	  = md5( 'phpcs_' . $this->version_control->repo . $oldest_rev . $newest_rev );
+		$cache_key	  = md5( 'phpcs_' . $this->version_control->repo . $folder . $oldest_rev . $newest_rev );
 		$cache_group  = 'vip-phpcs';
 
 		if ( true !== $this->nocache ) {
@@ -76,7 +77,7 @@ public function run( $oldest_rev, $newest_rev ) {
 			}
 		}
 
-		$diff  = trim( $this->version_control->get_diff( $newest_rev, $oldest_rev, array( 'ignore-space-change' => true ) ) );
+		$diff  = trim( $this->version_control->get_diff( $folder, $newest_rev, $oldest_rev, array( 'ignore-space-change' => true ) ) );
 
 		$this->stop_the_insanity();
 
@@ -109,7 +110,7 @@ public function run( $oldest_rev, $newest_rev ) {
 				} else {
 					$is_new_file = false;
 				}
-				$processed_file = $this->process_file( $repo . '/' . $filename, $oldest_rev, $newest_rev, $is_new_file );
+				$processed_file = $this->process_file( $folder . '/' . $filename, $oldest_rev, $newest_rev, $is_new_file );
 				if ( false === $processed_file || true === empty( $processed_file ) ) {
 					continue;
 				}

wp-cli-command.php

@@ -37,11 +37,14 @@ class PHPCS_Diff_CLI_Command extends WP_CLI_Command {
 	 * [--excluded-exts=<excluded-exts>]
 	 * : Ignore specified extensions. Use comma for separating multiple extensions
 	 *
+	 * [--folder=<folder>]
+	 * : Process files in specific folder
+	 *
 	 * ## EXAMPLES
 	 * wp phpcs-diff --repo="hello-dolly" --start_revision=99998 --end_revision=100000
 	 *
 	 * @subcommand phpcs-diff
-	 * @synopsis --repo=<repo> --start_revision=<start-revision> --end_revision=<end-revision> [--standard=<standard>] [--format=<format>] [--nocache] [--ignore-diff-too-big] [--excluded-exts=<excluded-exts>]
+	 * @synopsis --repo=<repo> --start_revision=<start-revision> --end_revision=<end-revision> [--standard=<standard>] [--format=<format>] [--nocache] [--ignore-diff-too-big] [--excluded-exts=<excluded-exts>] [--folder=<folder>]
 	 */
 	public function __invoke( $args, $assoc_args ) {
 
@@ -58,6 +61,11 @@ public function __invoke( $args, $assoc_args ) {
 		if ( true === array_key_exists( 'excluded-exts', $assoc_args ) && false === empty( $assoc_args['excluded-exts'] ) ) {
 			$excluded_exts = array_map( 'sanitize_text_field', explode( ',', $assoc_args['excluded-exts'] ) );
 		}
+		if ( true === array_key_exists( 'folder', $assoc_args ) ) {
+			$folder = sanitize_title( $assoc_args['folder'] );
+		} else {
+			$folder = '';
+		}
 
 		// @todo: replace SVN version control backend with any other parser you might want to use - eg.: git
 		require_once( PHPCS_DIFF_PLUGIN_DIR . 'backends/class-phpcs-diff-svn.php' );
@@ -77,7 +85,7 @@ public function __invoke( $args, $assoc_args ) {
 		if ( true === isset( $excluded_exts ) && false === empty( $excluded_exts ) && true === is_array( $excluded_exts ) ) {
 			$phpcs->set_excluded_extensions( $excluded_exts );
 		}
-		$found_issues = $phpcs->run( $start_revision, $end_revision );
+		$found_issues = $phpcs->run( $start_revision, $end_revision, $folder );
 
 		if ( is_wp_error( $found_issues ) ) {
 			WP_CLI::error( $found_issues->get_error_message(), true );