Merge branch 'develop' into fix/woocommerce-bootstrapping

Author: stevegrunwell

.travis.yml

@@ -26,8 +26,8 @@ matrix:
       env: WP_VERSION=latest
     - php: 5.6
       env: WP_VERSION=trunk
-    - php: 5.6
-      env: WP_TRAVISCI=phpcs
+    #- php: 5.6
+    #  env: WP_TRAVISCI=phpcs
     - php: 5.3
       env: WP_VERSION=latest
       dist: precise

includes/class-wc-custom-order-table-cli.php

@@ -6,6 +6,9 @@
  * @author  Liquid Web
  */
 
+/**
+ * Manages the contents of the WooCommerce order table.
+ */
 class WC_Custom_Order_Table_CLI extends WP_CLI_Command {
 
 	/**

includes/class-wc-custom-order-table-install.php

@@ -6,6 +6,13 @@
  * @author  Liquid Web
  */
 
+/**
+ * Installer for WooCommerce Custom Order Tables.
+ *
+ * Usage:
+ *
+ *     WC_Custom_Order_Table_Install::activate();
+ */
 class WC_Custom_Order_Table_Install {
 
 	/**
@@ -18,14 +25,14 @@ class WC_Custom_Order_Table_Install {
 	 *
 	 * @var int
 	 */
-	protected static $table_version = 1;
+	protected static $table_version = 2;
 
 	/**
 	 * Actions to perform on plugin activation.
 	 */
 	public static function activate() {
 		// We're already on the latest schema version.
-		if ( (int) self::$table_version === (int) get_option( self::SCHEMA_VERSION_KEY ) ) {
+		if ( (int) get_option( self::SCHEMA_VERSION_KEY ) === (int) self::$table_version ) {
 			return false;
 		}
 
@@ -88,7 +95,10 @@ protected static function install_tables() {
 				date_completed datetime DEFAULT NULL,
 				date_paid datetime DEFAULT NULL,
 				cart_hash varchar(32) NOT NULL,
-			PRIMARY KEY  (order_id)
+			PRIMARY KEY  (order_id),
+			UNIQUE KEY `order_key` (`order_key`),
+			KEY `customer_id` (`customer_id`),
+			KEY `order_total` (`total`)
 			) $collate;
 		";
 

includes/class-wc-custom-order-table.php

@@ -6,6 +6,9 @@
  * @author  Liquid Web
  */
 
+/**
+ * Core functionality for WooCommerce Custom Order Tables.
+ */
 class WC_Custom_Order_Table {
 
 	/**

includes/class-wc-order-data-store-custom-table.php

@@ -2,12 +2,16 @@
 /**
  * WooCommerce order data store.
  *
- * Orders are still treated as posts within WordPress, but the data is stored in a separate table.
- *
  * @package WooCommerce_Custom_Order_Tables
  * @author  Liquid Web
  */
 
+/**
+ * Extension of the Abstract_WC_Order_Data_Store_CPT class, designed to map data between
+ * WooCommerce and the custom database table.
+ *
+ * Orders are still treated as posts within WordPress, but the data is stored in a separate table.
+ */
 class WC_Order_Data_Store_Custom_Table extends Abstract_WC_Order_Data_Store_CPT implements WC_Object_Data_Store_Interface, WC_Order_Data_Store_Interface {
 
 	/**
@@ -403,12 +407,12 @@ public function get_orders( $args = array() ) {
 		$wc_customer_query = array();
 
 		if ( ! empty( $args['customer'] ) ) {
-			$values = is_array( $args['customer'] ) ? $args['customer'] : array( $args['customer'] );
+			$values            = is_array( $args['customer'] ) ? $args['customer'] : array( $args['customer'] );
 			$wc_customer_query = array_merge( $wc_customer_query, $values );
 		}
 
 		if ( ! empty( $args['email'] ) ) {
-			$values = is_array( $args['email'] ) ? $args['email'] : array( $args['email'] );
+			$values            = is_array( $args['email'] ) ? $args['email'] : array( $args['email'] );
 			$wc_customer_query = array_merge( $wc_customer_query, $values );
 		}
 
@@ -482,13 +486,13 @@ public function get_orders( $args = array() ) {
 	 */
 	private function get_orders_generate_customer_meta_query( $values, $relation = 'or' ) {
 		$meta_query = array(
-			'relation' => strtoupper( $relation ),
+			'relation'        => strtoupper( $relation ),
 			'customer_emails' => array(
 				'key'     => '_billing_email',
 				'value'   => array(),
 				'compare' => 'IN',
 			),
-			'customer_ids' => array(
+			'customer_ids'    => array(
 				'key'     => '_customer_user',
 				'value'   => array(),
 				'compare' => 'IN',
@@ -713,7 +717,7 @@ public function populate_from_meta( &$order, $save = true, $delete = false ) {
 
 		if ( is_null( $table_data ) ) {
 			$original_creating = $this->creating;
-			$this->creating = true;
+			$this->creating    = true;
 		}
 
 		foreach ( $this->get_postmeta_mapping() as $column => $meta_key ) {
@@ -777,8 +781,8 @@ public function query( $query_vars ) {
 
 		if ( ! empty( $args['errors'] ) ) {
 			$query = (object) array(
-				'posts' => array(),
-				'found_posts' => 0,
+				'posts'         => array(),
+				'found_posts'   => 0,
 				'max_num_pages' => 0,
 			);
 		} else {

phpcs.xml.dist

@@ -14,4 +14,5 @@
 
 	<exclude-pattern>*/node_modules/*</exclude-pattern>
 	<exclude-pattern>*/vendor/*</exclude-pattern>
+	<exclude-pattern>*/tests/*</exclude-pattern>
 </ruleset>

tests/test-installation.php

@@ -76,7 +76,7 @@ public function test_can_upgrade_table() {
 		// Get the current schema version, then increment it.
 		$property = new ReflectionProperty( 'WC_Custom_Order_Table_Install', 'table_version' );
 		$property->setAccessible( true );
-		$version  = $property->getValue();
+		$version = $property->getValue();
 		$property->setValue( $version + 1 );
 
 		// Run the activation script again.
@@ -103,4 +103,60 @@ public function test_current_schema_version_is_not_autoloaded() {
 			'The schema version should not be autoloaded.'
 		);
 	}
+
+	/**
+	 * Test that the generated database schema contains the expected indexes.
+	 *
+	 * @dataProvider table_index_provider()
+	 */
+	public function test_database_indexes( $non_unique, $key_name, $column_name ) {
+		global $wpdb;
+
+		WC_Custom_Order_Table_Install::activate();
+
+		$table   = wc_custom_order_table()->get_table_name();
+		$indexes = $wpdb->get_results( "SHOW INDEX FROM $table", ARRAY_A );
+		$search  = array(
+			'Non_unique'  => $non_unique,
+			'Key_name'    => $key_name,
+			'Column_name' => $column_name,
+		);
+
+		// Find the index by name.
+		foreach ( $indexes as $index ) {
+			if ( $index['Key_name'] !== $key_name ) {
+				continue;
+			}
+
+			$this->assertEquals(
+				$non_unique,
+				$index['Non_unique'],
+				sprintf(
+					'Did not match expected non-uniqueness (Received %d, expected %d',
+					$non_unique,
+					$index['Non_unique']
+				)
+			);
+
+			$this->assertEquals(
+				$column_name,
+				$index['Column_name'],
+				sprintf( 'Expected index "%s" on column %s.', $key_name, $column_name )
+			);
+
+			// We've checked the index we've come to check, return early.
+			return;
+		}
+
+		$this->fail( sprintf( 'Could not find an index with name "%s".', $key_name ) );
+	}
+
+	public function table_index_provider() {
+		return array(
+			'Primary key' => array( 0, 'PRIMARY', 'order_id' ),
+			'Order key'   => array( 0, 'order_key', 'order_key' ),
+			'Customer ID' => array( 1, 'customer_id', 'customer_id' ),
+			'Order total' => array( 1, 'order_total', 'total' ),
+		);
+	}
 }