Merge branch 'master' of github.com:wpengine/phpcompat into PHP-160

Author: stevenkword

.travis.yml

@@ -0,0 +1,22 @@
+language: php
+
+php:
+  - 5.3
+  - 5.5
+  - 5.6
+  - 7.0
+
+env:
+  - WP_VERSION=latest WP_MULTISITE=0
+  - WP_VERSION=4.5 WP_MULTISITE=0
+
+matrix:
+  include:
+    - php: 5.6
+      env: WP_VERSION=latest WP_MULTISITE=1
+
+before_script:
+  - composer install
+  - bash tests/bin/install-wp-tests.sh wordpress_test root '' localhost $WP_VERSION
+
+script: phpunit

Gruntfile.js

@@ -3,7 +3,8 @@ module.exports = function(grunt) {
 	grunt.initConfig({
 		wp_readme_to_markdown: {
 			options: {
-				screenshot_url: 'assets/{screenshot}.png'
+				screenshot_url: 'assets/{screenshot}.png',
+				post_convert: addBuildStatus,
 			},
 			your_target: {
 				files: {
@@ -19,3 +20,10 @@ module.exports = function(grunt) {
 		'wp_readme_to_markdown'
 	]); 
 };
+
+// Add build status image to GitHub readme.
+function addBuildStatus(readme) {
+	var buildImage = '<a href="https://travis-ci.org/wpengine/phpcompat"><img src="https://travis-ci.org/wpengine/phpcompat.svg?branch=master"></a>';
+	
+	return readme.replace(/# PHP Compatibility Checker #/, '# PHP Compatibility Checker ' + buildImage);
+}

readme.md

@@ -1,4 +1,4 @@
-# PHP Compatibility Checker #
+# PHP Compatibility Checker <a href="https://travis-ci.org/wpengine/phpcompat"><img src="https://travis-ci.org/wpengine/phpcompat.svg?branch=master"></a>
 **Contributors:** [wpengine](https://profiles.wordpress.org/wpengine), [octalmage](https://profiles.wordpress.org/octalmage), [stevenkword](https://profiles.wordpress.org/stevenkword), [taylor4484](https://profiles.wordpress.org/taylor4484)  
 **Tags:** php 7, php 5.5, php, version, compatibility, checker, wp engine, wpe, wpengine  
 **Requires at least:** 3.0.1  
@@ -85,7 +85,11 @@ Example: `wp phpcompat 5.5 --scan=active`
 
 5. Why was my plugin/theme skipped?
 
-    Some servers have timeouts to prevent long running queries, this is commonly 60 seconds. This can prevent the checker from being able to process large themes or plugins. You should check with your host to see if this timeout can be temporarily removed. The best way around this timeout issues is to run this plugin on a [local copy](https://make.wordpress.org/core/handbook/tutorials/installing-a-local-server/) of your site. 
+    Some servers have timeouts to prevent long running queries, this is commonly 60 seconds. This can prevent the checker from being able to process large themes or plugins. You should check with your host to see if this timeout can be temporarily removed. The best way around this timeout issue is to run this plugin on a [local copy](https://make.wordpress.org/core/handbook/tutorials/installing-a-local-server/) of your site, or you can use the WP-CLI command. 
+    
+    You can use the filter `wpephpcompat_scan_timeout` to customize the scan timeout. See [this](https://gist.github.com/octalmage/07f26e0d1f25cea9a8ca92ebc67a3a14) for an example.
+    
+    Setting the timeout to 0 disables the cron/timeout.
 
 6. I found a bug, or have a suggestion, can I contribute back? 
 

readme.txt

@@ -85,7 +85,11 @@ Example: `wp phpcompat 5.5 --scan=active`
 
 5. Why was my plugin/theme skipped?
 
-    Some servers have timeouts to prevent long running queries, this is commonly 60 seconds. This can prevent the checker from being able to process large themes or plugins. You should check with your host to see if this timeout can be temporarily removed. The best way around this timeout issues is to run this plugin on a [local copy](https://make.wordpress.org/core/handbook/tutorials/installing-a-local-server/) of your site. 
+    Some servers have timeouts to prevent long running queries, this is commonly 60 seconds. This can prevent the checker from being able to process large themes or plugins. You should check with your host to see if this timeout can be temporarily removed. The best way around this timeout issue is to run this plugin on a [local copy](https://make.wordpress.org/core/handbook/tutorials/installing-a-local-server/) of your site, or you can use the WP-CLI command. 
+    
+    You can use the filter `wpephpcompat_scan_timeout` to customize the scan timeout. See [this](https://gist.github.com/octalmage/07f26e0d1f25cea9a8ca92ebc67a3a14) for an example.
+    
+    Setting the timeout to 0 disables the cron/timeout.
 
 6. I found a bug, or have a suggestion, can I contribute back? 
 

src/js/run.js

@@ -90,7 +90,7 @@ function checkStatus() {
 			jQuery( '#runButton' ).val( 'Re-run' );
 		}
 
-		if ( '1' == obj.status ) {
+		if ( '1' === obj.status ) {
 			jQuery( '#runButton' ).addClass( 'button-primary-disabled' );
 			jQuery( '.spinner' ).show();
 		} else {
@@ -163,21 +163,29 @@ 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 );
+
 	$( '#testResults' ).text( response );
 	$( '#footer' ).show();
 
 	// 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 ) {
-		if ( '' === plugins[x].trim() ) {
-			continue;
-		}
 		var updateVersion;
 		var updateAvailable = 0;
 		var passed = 1;
@@ -197,6 +205,7 @@ function displayReport( response ) {
 		if ( parseInt( errors ) > 0 ) {
 			compatible = 0;
 			passed = 0;
+			failedCount++;
 		}
 		// Trim whitespace and newlines from report.
 		log = log.replace( /^\s+|\s+$/g, '' );
@@ -205,8 +214,6 @@ function displayReport( response ) {
 			skipped = 1;
 		}
 		// Use handlebars to build our template.
-		var source = $( '#result-template' ).html();
-		var template = Handlebars.compile( source );
 		var context = {
 			plugin_name: name,
 			warnings: warnings,
@@ -220,11 +227,14 @@ function displayReport( response ) {
 		var html = template( context );
 		$('#standardMode').append( html );
 	}
+
 	// Display global compatibility status.
 	if ( compatible ) {
 		$( '#standardMode' ).prepend( '<h3>Your WordPress install is PHP ' + test_version + ' compatible.</h3>' );
 	} 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,27 +88,45 @@ function __construct( $dir ) {
 	public function start_test() {
 
 		$this->debug_log( 'startScan: ' . isset( $_POST['startScan'] ) );
-		// 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() - MINUTE_IN_SECONDS ) ) ) {
-				$this->debug_log( 'Process already running (locked), returning.' );
-
-				$timestamp = wp_next_scheduled( 'wpephpcompat_start_test_cron' );
-
-				if ( $timestamp == false ) {
-					wp_schedule_single_event( time() + ( MINUTE_IN_SECONDS ), 'wpephpcompat_start_test_cron' );
+		/**
+		* 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
+		* 0 to disable the timeout and the cron.
+		*
+		* @since 1.0.4
+		*
+		* @param int $timeout The timeout in seconds.
+		*/
+		$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' );
+					}
+					return;
 				}
-				return;
 			}
+			update_option( 'wpephpcompat.lock', time(), false );
 		}
-		update_option( 'wpephpcompat.lock', time(), false );
 
 		// Check to see if scan has already started.
 		$scan_status = get_option( 'wpephpcompat.status' );
@@ -148,15 +166,16 @@ public function start_test() {
 
 			return;
 		}
-
-		wp_schedule_single_event( time() + ( MINUTE_IN_SECONDS ), 'wpephpcompat_start_test_cron' );
+		if ( 0 !== $timeout ) {
+			wp_schedule_single_event( time() + $timeout, 'wpephpcompat_start_test_cron' );
+		}
 
 		if ( ! $this->is_command_line() ) {
 			// Close the connection to the browser.
 			$this->close_connection("started");
 
-			// Kill cron after a minute.
-			set_time_limit( 55 );
+			// Kill cron after a configurable timeout.
+			set_time_limit( ( $timeout > 5 ? $timeout - 5 : $timeout ) );
 		}
 
 		$scan_results = get_option( 'wpephpcompat.scan_results' );
@@ -377,8 +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' );
 

tests/qunit/test-run.js

@@ -63,6 +63,7 @@ QUnit.test( 'Render test pass', function( assert ) {
 	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.' );
+	assert.ok( ! $( '#standardMode' ).text().includes( '0 out of 2' ), 'No scan stats are shown.' );
 });
 
 QUnit.test( 'Render test fail', function( assert ) {
@@ -83,6 +84,7 @@ QUnit.test( 'Render test fail', function( assert ) {
 	assert.ok( $('#footer').is(':visible'), 'Footer is visible' );
 	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' );
 });
 
 QUnit.test( 'Render test skip', function( assert ) {