Merge pull request #37 from stevenkword/PHP-160

[PHP-160] Allow leaving the test page during the scan.

Author: stevenkword

src/css/style.css

@@ -2,23 +2,23 @@
 .wpe-results-card
 {
 	background-color: #fff;
-	border-bottom-color: rgb(221, 221, 221); 
-	border-bottom-style: solid; 
-	border-bottom-width: 1px; 
-	border-left-style: solid; 
-	border-left-width: 6px; 
-	width: 812px; 
-	padding-bottom: 14px; 
-	padding-left: 16px; 
-	padding-right: 16px; 
-	padding-top: 14px; 
+	border-bottom-color: rgb(221, 221, 221);
+	border-bottom-style: solid;
+	border-bottom-width: 1px;
+	border-left-style: solid;
+	border-left-width: 6px;
+	width: 812px;
+	padding-bottom: 14px;
+	padding-left: 16px;
+	padding-right: 16px;
+	padding-top: 14px;
 	margin-bottom: 10px;
 	/*box-shadow: 0px 2px 5px 0px rgba(0, 0, 0, 0.12);*/
 }
 
 .wpe-results-card .inner-left
 {
-	display: inline-block; 
+	display: inline-block;
 	letter-spacing: normal;
 	text-rendering: auto;
 	vertical-align: top;
@@ -29,7 +29,7 @@
 {
 	color: rgb(51, 51, 51);
 	display: inline-block;
-	font-family: sans-serif; 
+	font-family: sans-serif;
 	letter-spacing: normal;
 	text-rendering: auto;
 	vertical-align: top;
@@ -44,24 +44,24 @@
 
 .wpe-results-card textarea
 {
-	white-space: nowrap; 
-	width: 100%; 
+	white-space: nowrap;
+	width: 100%;
 	height: 400px;
 }
 
 .wpe-results-card .view-details
 {
-	font-size: 12px; 
+	font-size: 12px;
 	color: #c0c0c0;
 	cursor: pointer;
 }
 
 .wpe-results-card .badge
 {
-	display: inline-block;  
-	color: #fff; 
-	text-align: center; 
-	padding: 2px 10px; 
+	display: inline-block;
+	color: #fff;
+	text-align: center;
+	padding: 2px 10px;
 }
 
 .wpe-update a:link, .wpe-update a:visited, .wpe-update a:hover, .wpe-update a:active { color:#ffffff; cursor: pointer; text-decoration: none; }
@@ -91,4 +91,9 @@
 #progressbar .ui-progressbar-value
 {
 	background: #0085ba;
-}
+}
+
+#wpe-progress-count, #wpe-progress-active
+{
+	display: inline;
+}

src/js/run.js

@@ -3,6 +3,9 @@ var test_version, only_active, timer;
 
 jQuery( document ).ready(function($) {
 
+	// Check the status immediately to reflect if tests are running.
+	checkStatus();
+
 	$( '#developermode' ).change(function() {
 		if ( $(this).is( ':checked' ) ) {
 			$( '#developerMode' ).show();
@@ -75,16 +78,44 @@ function checkStatus() {
 			alert(e);
 			return;
 		}
+
+		/*
+		 * Status false: the test is not running and has not been run yet
+		 * Status 1: the test is currently running
+		 * Status 0: the test as completed but is not currently running
+		 */
+		if ( false === obj.results ) {
+			jQuery( '#runButton' ).val( 'Run' );
+		} else {
+			jQuery( '#runButton' ).val( 'Re-run' );
+		}
+
+		if ( '1' === obj.status ) {
+			jQuery( '#runButton' ).addClass( 'button-primary-disabled' );
+			jQuery( '.spinner' ).show();
+		} else {
+			jQuery( '#runButton' ).removeClass( 'button-primary-disabled' );
+			jQuery( '.spinner' ).hide();
+		}
+
 		if ( '0' !== obj.results ) {
-			displayReport( obj.results );
+			if( false !== obj.results ) {
+				test_version = obj.version;
+				displayReport( obj.results );
+			}
 			jQuery( '#wpe-progress' ).hide();
 		} else {
 			jQuery( '#progressbar' ).progressbar({
 				value: obj.progress
 			});
+			jQuery( '#wpe-progress' ).show();
 
 			// Display the current plugin count.
-			jQuery( '#wpe-progress-count' ).text( ( obj.total - obj.count ) + '/' + obj.total );
+			jQuery( '#wpe-progress-count' ).text( ( obj.total - obj.count + 1 ) + '/' + obj.total );
+
+			// Display the object being scanned.
+			jQuery( '#wpe-progress-active' ).text( obj.activeJob );
+
 			// Requeue the checkStatus call.
 			timer = setTimeout(function() {
 				checkStatus();
@@ -102,6 +133,7 @@ function resetDisplay() {
 	jQuery( '#testResults' ).text('');
 	jQuery( '#standardMode' ).html('');
 	jQuery( '#wpe-progress-count' ).text('');
+	jQuery( '#wpe-progress-active' ).text('');
 }
 /**
  * Loop through a string and count the total matches.
@@ -131,26 +163,27 @@ function displayReport( response ) {
 	resetDisplay();
 	var $ = jQuery;
 	var compatible = 1;
+
 	// Keep track of the number of failed plugins/themes.
 	var failedCount = 0;
 	var errorsRegex = /(\d*) ERRORS?/g;
 	var warningRegex = /(\d*) WARNINGS?/g;
 	var updateVersionRegex = /e: (.*?);/g;
 	var currentVersionRegex = /n: (.*?);/g;
+
 	// Grab and compile our template.
 	var source = $( '#result-template' ).html();
 	var template = Handlebars.compile( source );
-	$( '#runButton' ).removeClass( 'button-primary-disabled' );
-	$( '.spinner' ).hide();
+
 	$( '#testResults' ).text( response );
 	$( '#footer' ).show();
-	$( '#runButton' ).val( 'Re-run' );
+
 	// Separate plugins/themes.
 	var plugins = response.replace( /^\s+|\s+$/g, '' ).split( 'Name: ' );
-	
+
 	// Remove the first item, it's empty.
 	plugins.shift();
-	
+
 	// Loop through them.
 	for ( var x in plugins ) {
 		var updateVersion;
@@ -176,7 +209,7 @@ function displayReport( response ) {
 		}
 		// Trim whitespace and newlines from report.
 		log = log.replace( /^\s+|\s+$/g, '' );
-		
+
 		if ( log.search('skipped') !== -1 ) {
 			skipped = 1;
 		}
@@ -201,7 +234,7 @@ function displayReport( response ) {
 	} else {
 		// Display scan stats.
 		$( '#standardMode' ).prepend( '<p>' + failedCount + ' out of ' + plugins.length + ' plugins/themes are not compatible.</p>' );
-		
+
 		$( '#standardMode' ).prepend( '<h3>Your WordPress install is not PHP ' + test_version + ' compatible.</h3>' );
 	}
 }

src/wpephpcompat.php

@@ -88,12 +88,12 @@ function __construct( $dir ) {
 	public function start_test() {
 
 		$this->debug_log( 'startScan: ' . isset( $_POST['startScan'] ) );
-		
+
 		/**
 		* Filters the scan timeout.
 		*
-		* Lets you change the timeout of the scan. The value is how long the scan 
-		* runs before dying and picking back up on a cron. You can set $timeout to 
+		* Lets you change the timeout of the scan. The value is how long the scan
+		* runs before dying and picking back up on a cron. You can set $timeout to
 		* 0 to disable the timeout and the cron.
 		*
 		* @since 1.0.4
@@ -102,23 +102,23 @@ public function start_test() {
 		*/
 		$timeout = apply_filters( 'wpephpcompat_scan_timeout', MINUTE_IN_SECONDS );
 		$this->debug_log( 'timeout: ' . $timeout );
-		
+
 		// No reason to lock if there's no timeout.
 		if ( 0 !== $timeout ) {
 			// Try to lock.
 			$lock_result = add_option( 'wpephpcompat.lock', time(), '', 'no' );
-			
+
 			$this->debug_log( 'lock: ' . $lock_result );
-			
+
 			if ( ! $lock_result ) {
 				$lock_result = get_option( 'wpephpcompat.lock' );
-				
+
 				// Bail if we were unable to create a lock, or if the existing lock is still valid.
 				if ( ! $lock_result || ( $lock_result > ( time() - $timeout ) ) ) {
 					$this->debug_log( 'Process already running (locked), returning.' );
-					
+
 					$timestamp = wp_next_scheduled( 'wpephpcompat_start_test_cron' );
-					
+
 					if ( $timestamp == false ) {
 						wp_schedule_single_event( time() + $timeout, 'wpephpcompat_start_test_cron' );
 					}
@@ -133,6 +133,9 @@ public function start_test() {
 		$this->debug_log( 'scan status: ' . $scan_status );
 		if ( ! $scan_status ) {
 
+			// Clear the previous results.
+			delete_option( 'wpephpcompat.scan_results' );
+
 			update_option( 'wpephpcompat.status', '1', false );
 			update_option( 'wpephpcompat.test_version', $this->test_version, false );
 			update_option( 'wpephpcompat.only_active', $this->only_active, false );
@@ -182,7 +185,7 @@ public function start_test() {
 
 			// Add the plugin/theme name to the results.
 			$scan_results .= 'Name: ' . $directory->post_title . "\n\n";
-			
+
 			// Keep track of the number of times we've attempted to scan the plugin.
 			$count = get_post_meta( $directory->ID, 'count', true ) ?: 1;
 			$this->debug_log( 'Attempted scan count: ' . $count );
@@ -196,7 +199,7 @@ public function start_test() {
 				continue;
 			}
 
-			// Increment and save the count. 
+			// Increment and save the count.
 			$count++;
 			update_post_meta( $directory->ID, 'count', $count );
 
@@ -256,7 +259,7 @@ public function process_file( $dir ) {
 
 		return $this->clean_report( $report );
 	}
-	
+
 	/**
 	 * Generate a list of ignored files and directories.
 	 *
@@ -270,14 +273,14 @@ public function generate_ignored_list() {
 			'*/node_modules/*', // Commonly used for development but not in production.
 			'*/tmp/*', // Temporary files.
 		);
-		
+
 		foreach ( $this->whitelist as $plugin => $version ) {
 			// Check to see if the plugin is compatible with the tested version.
 			if ( version_compare( $this->test_version, $version, '<=' ) ) {
 				array_push( $ignored, $plugin );
 			}
 		}
-		
+
 		return $ignored;
 	}
 
@@ -356,13 +359,13 @@ public function generate_directory_list() {
 
 			$this->add_directory( $all_themes[$k]->Name, $theme_path );
 		}
-		
+
 		// Add parent theme if the current theme is a child theme.
 		if ( 'yes' === $this->only_active && is_child_theme() ) {
 			$parent_theme_path = get_template_directory();
 			$theme_data        = wp_get_theme();
 			$parent_theme_name = $theme_data->parent()->Name;
-		
+
 			$this->add_directory( $parent_theme_name, $parent_theme_path );
 		}
 	}
@@ -393,9 +396,6 @@ public function clean_after_scan() {
 		// Delete options created during the scan.
 		delete_option( 'wpephpcompat.lock' );
 		delete_option( 'wpephpcompat.status' );
-		delete_option( 'wpephpcompat.scan_results' );
-		delete_option( 'wpephpcompat.test_version' );
-		delete_option( 'wpephpcompat.only_active' );
 		delete_option( 'wpephpcompat.numdirs' );
 
 		// Clear scheduled cron.

tests/qunit/test-run.js

@@ -1,4 +1,8 @@
 /* jshint esversion: 6 */
+
+// No document.ready event.
+$.holdReady( true );
+
 QUnit.module( 'findAll' );
 
 QUnit.test( 'no matches', function( assert ) {
@@ -52,10 +56,7 @@ QUnit.test( 'Render test pass', function( assert ) {
 	var displayedResults = $('#testResults').text();
 
 	assert.ok( helpers.passResults === displayedResults, 'Text results are correct' );
-	assert.ok( ! $('.spinner').is(':visible'), 'Spinner is hidden' );
-	assert.ok( 'Re-run' === $('#runButton').val(), 'Run button text is Re-run' );
 	assert.ok( $('#footer').is(':visible'), 'Footer is visible' );
-	assert.ok( ! $('#runButton').hasClass('button-primary-disabled'), "Run button isn't disabled" );
 	assert.ok( $('.wpe-results-card').length == 2, 'There are 2 results.' );
 	assert.ok( $('#standardMode').text().includes( 'Your WordPress install is PHP 5.5 compatible.' ), 'Test did pass.' );
 	assert.ok( '#038103' === helpers.rgb2hex( $( ".wpe-results-card" ).eq( 0 ).css( 'border-left-color' ) ), 'First plugin marked as passed.' );
@@ -74,10 +75,7 @@ QUnit.test( 'Render test fail', function( assert ) {
 	var displayedResults = $('#testResults').text();
 
 	assert.ok( helpers.failResults === displayedResults, 'Text results are correct' );
-	assert.ok( ! $('.spinner').is(':visible'), 'Spinner is hidden' );
-	assert.ok( 'Re-run' === $('#runButton').val(), 'Run button text is Re-run' );
 	assert.ok( $('#footer').is(':visible'), 'Footer is visible' );
-	assert.ok( ! $('#runButton').hasClass('button-primary-disabled'), "Run button isn't disabled" );
 	assert.ok( $('.wpe-results-card').length == 7, 'There are 7 results.' );
 	assert.ok( $('#standardMode').text().includes( 'Your WordPress install is not PHP 5.5 compatible.' ), 'Test did not pass.' );
 	assert.ok( $( '#standardMode' ).text().includes( '1 out of 7' ), 'Scan stats are correct' );
@@ -120,7 +118,7 @@ QUnit.test( 'Test checkStatus progress', function( assert ) {
 			return true;
 		},
 		onAfterComplete: function() { // Check the results of checkStatus();
-			assert.ok( $( '#wpe-progress-count' ).text() === '16/17', 'Progress count is correct.' );
+			assert.ok( $( '#wpe-progress-count' ).text() === '17/17', 'Progress count is correct.' );
 			assert.ok( $( '#progressbar' ).progressbar( 'value' ) === 94.1176470588 , 'Progress bar is correct.' );
 
 			// Clear the next queued checkStatus call.