Merge pull request #113 from woocommerce/add/product-type-arg

Add a "type" argument to the generate products command

Author: rrennick

README.md

@@ -17,6 +17,9 @@ WooCommerce Smooth Generator requires Composer and WP-CLI to function.
 Generate products based on the number of products parameter.
 - `wp wc generate products <nr of products>`
 
+Generate products of the specified type. `simple` or `variable`.
+- `wp wc generate products <nr of products> --type=simple`
+
 ### Orders
 
 Generate orders from existing products based on the number of orders parameter, customers will also be generated to mimic guest checkout.

includes/CLI.php

@@ -43,7 +43,7 @@ public static function products( $args, $assoc_args ) {
 		$progress = \WP_CLI\Utils\make_progress_bar( 'Generating products', $amount );
 
 		for ( $i = 1; $i <= $amount; $i++ ) {
-			Generator\Product::generate();
+			Generator\Product::generate( true, $assoc_args );
 			$progress->tick();
 		}
 
@@ -198,7 +198,27 @@ public static function coupons( $args, $assoc_args ) {
 	}
 }
 
-WP_CLI::add_command( 'wc generate products', array( 'WC\SmoothGenerator\CLI', 'products' ) );
+WP_CLI::add_command( 'wc generate products', array( 'WC\SmoothGenerator\CLI', 'products' ), array(
+	'shortdesc' => 'Generate products.',
+	'synopsis' => array(
+		array(
+			'name'        => 'amount',
+			'type'        => 'positional',
+			'description' => 'The number of products to generate.',
+			'optional'    => true,
+			'default'     => 10,
+		),
+		array(
+			'name'        => 'type',
+			'type'        => 'assoc',
+			'description' => 'Specify one type of product to generate. Otherwise defaults to a mix.',
+			'optional'    => true,
+			'options'     => array( 'simple', 'variable' ),
+		),
+	),
+	'longdesc' => "## EXAMPLES\n\nwc generate products 10\n\nwc generate products 20 --type=variable",
+) );
+
 WP_CLI::add_command( 'wc generate orders', array( 'WC\SmoothGenerator\CLI', 'orders' ), array(
 	'synopsis' => array(
 		array(
@@ -229,6 +249,7 @@ public static function coupons( $args, $assoc_args ) {
 		),
 	),
 ) );
+
 WP_CLI::add_command( 'wc generate customers', array( 'WC\SmoothGenerator\CLI', 'customers' ) );
 
 WP_CLI::add_command( 'wc generate coupons', array( 'WC\SmoothGenerator\CLI', 'coupons' ), array(

includes/Generator/Product.php

@@ -76,19 +76,22 @@ protected static function init_faker() {
 	/**
 	 * Return a new product.
 	 *
-	 * @param bool $save Save the object before returning or not.
+	 * @param bool  $save Save the object before returning or not.
+	 * @param array $assoc_args Arguments passed via the CLI for additional customization.
 	 * @return \WC_Product The product object consisting of random data.
 	 */
-	public static function generate( $save = true ) {
+	public static function generate( $save = true, $assoc_args = array() ) {
 		self::init_faker();
 
-		// 20% chance of a variable product.
-		$is_variable = self::$faker->boolean( 20 );
-
-		if ( $is_variable ) {
-			$product = self::generate_variable_product();
-		} else {
-			$product = self::generate_simple_product();
+		$type = self::get_product_type( $assoc_args );
+		switch ( $type ) {
+			case 'simple':
+			default:
+				$product = self::generate_simple_product();
+				break;
+			case 'variable':
+				$product = self::generate_variable_product();
+				break;
 		}
 
 		if ( $product ) {
@@ -222,6 +225,30 @@ protected static function generate_attributes( $qty = 1, $maximum_terms = 10 ) {
 		return $attributes;
 	}
 
+	/**
+	 * Returns a product type to generate. If no type is specified, or an invalid type is specified,
+	 * a weighted random type is returned.
+	 *
+	 * @param array $assoc_args CLI arguments.
+	 * @return string A product type.
+	 */
+	protected static function get_product_type( array $assoc_args ) {
+		$type  = $assoc_args['type'] ?? null;
+		$types = array(
+			'simple',
+			'variable',
+		);
+
+		if ( ! is_null( $type ) && in_array( $type, $types, true ) ) {
+			return $type;
+		} else {
+			return self::random_weighted_element( array(
+				'simple'   => 80,
+				'variable' => 20,
+			) );
+		}
+	}
+
 	/**
 	 * Generate a variable product and return it.
 	 *