More verbose error reporting for shortcodes, and dependency updates

.travis.yml

@@ -14,10 +14,11 @@ php:
     - "7.0"
 
 # WordPress versions to be tested against.
+# Include the highest patch versions of the last 3 versions (including the current one), as well as master.
 env:
-    - WP_VERSION=4.3.5
-    - WP_VERSION=4.4.4
-    - WP_VERSION=4.5.3
+    - WP_VERSION=4.4.5
+    - WP_VERSION=4.5.4
+    - WP_VERSION=4.6.1
     - WP_VERSION=master
 
 # Clones WordPress and configures our testing environment.

assets/style.css

@@ -71,3 +71,6 @@ form.tabulate-schema td.primary-key,
 form.tabulate-schema td.unique { text-align:center }
 form.tabulate-schema td.reorder { font-size:smaller; white-space:nowrap }
 form.tabulate-schema td.reorder a.move {  }
+
+.tabulate.shortcode-error { border:1px solid #ccc; padding:0.5em }
+.tabulate.shortcode-error .message { color:red }

docs/conf.py

@@ -12,7 +12,7 @@
 project = u'Tabulate for WordPress'
 copyright = u'2016, Sam Wilson'
 version = '2.7'
-release = '2.7.13'
+release = '2.7.14'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

src/Controllers/ShortcodeController.php

@@ -42,19 +42,24 @@ public function __construct( $wpdb ) {
 	/**
 	 * Substitute the Shortcode with the relevant formatted output.
 	 *
-	 * @param string[] $atts The shortcode attributes.
+	 * @param string[] $raw_attrs The shortcode attributes.
 	 * @return string
 	 */
-	public function run( $atts ) {
+	public function run( $raw_attrs ) {
 		$defaults = array(
 			'format' => 'table',
 			'table' => null,
 			'ident' => null,
 			'search' => null,
 		);
-		$attrs = shortcode_atts( $defaults, $atts );
+		$attrs = shortcode_atts( $defaults, $raw_attrs );
 		if ( ! isset( $attrs['table'] ) ) {
-			return $this->error( "The 'table' attribute must be set." );
+			$msg = "The 'table' attribute must be set. Attributes found: [";
+			foreach ( $raw_attrs as $k => $v ) {
+				$msg .= ' ' . htmlentities2( $k ) .' = "' . htmlentities2( $v ) . '" ';
+			}
+			$msg .= "]";
+			return $this->error( $msg );
 		}
 		$table = $this->db->get_table( $attrs['table'] );
 		if ( ! $table ) {
@@ -73,13 +78,19 @@ public function run( $atts ) {
 	}
 
 	/**
-	 * Get an error message, and dequeue scripts.
-	 * It's too late now to dequeue styles.
+	 * Get a formatted error message.
 	 *
 	 * @param string $message The error message to display.
+	 * @return string The error HTML.
 	 */
 	protected function error( $message = '' ) {
-		return "<div class='tabulate shortcode-error'>$message</div>";
+		$url = "http://tabulate.readthedocs.io/en/latest/shortcode.html";
+		return "<div class='tabulate shortcode-error'>"
+			. "<h3>Tabulate shortcode error:</h3> "
+			. "<p class='message'>$message</p>"
+			. "<p>For more information, please "
+			. "<a href='$url' target='_blank' title='Opens in new tab'>read the docs</a>."
+			. "</p></div>";
 	}
 
 	/**

src/DB/Grants.php

@@ -27,6 +27,11 @@ class Grants {
 	 */
 	const ANON_ROLE = 'anon';
 
+	/**
+	 * The name of the option under which grants are saved. Is always 'tabulate_grants'.
+	 *
+	 * @var string
+	 */
 	private $option_name;
 
 	/**

src/DB/Reports.php

@@ -67,8 +67,12 @@ public static function report_sources_table_name() {
 	public function get_template( $report_id ) {
 		// Find the report.
 		$reports = $this->db->get_table( self::reports_table_name() );
+		if ( false === $reports ) {
+			$msg = "Reports table not found. Please re-activate Tabulate to create it.";
+			throw new Exception( $msg );
+		}
 		$report = $reports->get_record( $report_id );
-		if ( ! $report ) {
+		if ( false === $report ) {
 			throw new Exception( "Report $report_id not found." );
 		}
 		$template = new \WordPress\Tabulate\Template( false, $report->template() );

src/DB/Table.php

@@ -297,22 +297,22 @@ public function apply_filters( &$sql ) {
 				$f_column = "`" . $this->get_name() . "`.`$f_column`";
 			}
 
-			// LIKE or NOT LIKE.
 			if ( 'like' === $filter['operator'] || 'not like' === $filter['operator'] ) {
+				// LIKE or NOT LIKE.
 				$where_clause .= " AND CONVERT($f_column, CHAR) " . strtoupper( $filter['operator'] ) . " %s ";
 				$params[ $param_name ] = '%' . trim( $filter['value'] ) . '%';
-			} // Equals or does-not-equal
-			elseif ( '=' === $filter['operator'] || '!=' === $filter['operator'] ) {
+			} elseif ( '=' === $filter['operator'] || '!=' === $filter['operator'] ) {
+				// Equals or does-not-equal.
 				$where_clause .= " AND $f_column " . $filter['operator'] . " %s ";
 				$params[ $param_name ] = trim( $filter['value'] );
-			} // IS EMPTY
-			elseif ( 'empty' === $filter['operator'] ) {
+			} elseif ( 'empty' === $filter['operator'] ) {
+				// IS EMPTY.
 				$where_clause .= " AND ($f_column IS NULL OR $f_column = '')";
-			} // IS NOT EMPTY
-			elseif ( 'not empty' === $filter['operator'] ) {
+			} elseif ( 'not empty' === $filter['operator'] ) {
+				// IS NOT EMPTY.
 				$where_clause .= " AND ($f_column IS NOT NULL AND $f_column != '')";
-			} // IN or NOT IN
-			elseif ( 'in' === $filter['operator'] || 'not in' === $filter['operator'] ) {
+			} elseif ( 'in' === $filter['operator'] || 'not in' === $filter['operator'] ) {
+				// IN or NOT IN.
 				$placeholders = array();
 				foreach ( Util::split_newline( $filter['value'] ) as $vid => $val ) {
 					$placeholders[] = "%s";
@@ -322,14 +322,14 @@ public function apply_filters( &$sql ) {
 				}
 				$negate = ( 'not in' === $filter['operator'] ) ? 'NOT' : '';
 				$where_clause .= " AND ($f_column $negate IN (" . join( ", ", $placeholders ) . "))";
-			} // Other operators. They're already validated in self::addFilter().
-			else {
+			} else {
+				// Other operators. They're already validated in self::addFilter().
 				$where_clause .= " AND ($f_column " . $filter['operator'] . " %s)";
 				$params[ $param_name ] = trim( $filter['value'] );
-			}
+			} // End if().
 
 			$param_num++;
-		} // end foreach filter.
+		} // End foreach().
 
 		// Add clauses into SQL.
 		if ( ! empty( $where_clause ) ) {
@@ -1175,8 +1175,8 @@ public function save_record( $data, $pk_value = null ) {
 				// Everything else.
 				$sql_values[ $field ] = "'" . esc_sql( $value ) . "'";
 
-			}
-		}
+			} // End if().
+		} // End foreach().
 
 		// Find the PK, and hide errors (for now).
 		$pk_name = $this->get_pk_column()->get_name();

tabulate.php

@@ -10,7 +10,7 @@
  * Version: 2.7.13
  */
 
-define( 'TABULATE_VERSION', '2.7.13' );
+define( 'TABULATE_VERSION', '2.7.14' );
 define( 'TABULATE_SLUG', 'tabulate' );
 
 // Load textdomain.