Improve Package Handling in CartShippingRateSchema (#3680)

* Generate package names when geting them from the cart

* Split package formatting methods

* Fix variable name

Author: mikejolley

src/StoreApi/Schemas/CartShippingRateSchema.php

@@ -224,7 +224,41 @@ protected function get_rate_properties() {
 	 * @return array
 	 */
 	public function get_item_response( $package ) {
-		// Add product names and quantities.
+		return [
+			'package_id'     => $package['package_id'],
+			'name'           => $package['package_name'],
+			'destination'    => $this->prepare_package_destination_response( $package ),
+			'items'          => $this->prepare_package_items_response( $package ),
+			'shipping_rates' => $this->prepare_package_shipping_rates_response( $package ),
+		];
+	}
+
+	/**
+	 * Gets and formats the destination address of a package.
+	 *
+	 * @param array $package Shipping package complete with rates from WooCommerce.
+	 * @return object
+	 */
+	protected function prepare_package_destination_response( $package ) {
+		return (object) $this->prepare_html_response(
+			[
+				'address_1' => $package['destination']['address_1'],
+				'address_2' => $package['destination']['address_2'],
+				'city'      => $package['destination']['city'],
+				'state'     => $package['destination']['state'],
+				'postcode'  => $package['destination']['postcode'],
+				'country'   => $package['destination']['country'],
+			]
+		);
+	}
+
+	/**
+	 * Gets items from a package and creates an array of strings containing product names and quantities.
+	 *
+	 * @param array $package Shipping package complete with rates from WooCommerce.
+	 * @return array
+	 */
+	protected function prepare_package_items_response( $package ) {
 		$items = array();
 		foreach ( $package['contents'] as $item_id => $values ) {
 			$items[] = [
@@ -233,38 +267,7 @@ public function get_item_response( $package ) {
 				'quantity' => $values['quantity'],
 			];
 		}
-
-		// Generate package name.
-		$package_number       = absint( $package['package_id'] ) + 1;
-		$package_display_name = apply_filters(
-			'woocommerce_shipping_package_name',
-			$package_number > 1 ?
-				sprintf(
-					/* translators: %d: shipping package number */
-					_x( 'Shipping %d', 'shipping packages', 'woo-gutenberg-products-block' ),
-					$package_number
-				) :
-				_x( 'Shipping', 'shipping packages', 'woo-gutenberg-products-block' ),
-			$package['package_id'],
-			$package
-		);
-
-		return [
-			'package_id'     => $package['package_id'],
-			'name'           => $package_display_name,
-			'destination'    => (object) $this->prepare_html_response(
-				[
-					'address_1' => $package['destination']['address_1'],
-					'address_2' => $package['destination']['address_2'],
-					'city'      => $package['destination']['city'],
-					'state'     => $package['destination']['state'],
-					'postcode'  => $package['destination']['postcode'],
-					'country'   => $package['destination']['country'],
-				]
-			),
-			'items'          => $items,
-			'shipping_rates' => $this->prepare_rates_response( $package ),
-		];
+		return $items;
 	}
 
 	/**
@@ -273,10 +276,10 @@ public function get_item_response( $package ) {
 	 * @param array $package Shipping package complete with rates from WooCommerce.
 	 * @return array
 	 */
-	protected function prepare_rates_response( $package ) {
+	protected function prepare_package_shipping_rates_response( $package ) {
 		$rates          = $package['rates'];
 		$selected_rates = wc()->session->get( 'chosen_shipping_methods', array() );
-		$selected_rate  = isset( $chosen_shipping_methods[ $package['package_id'] ] ) ? $chosen_shipping_methods[ $package['package_id'] ] : '';
+		$selected_rate  = isset( $selected_rates[ $package['package_id'] ] ) ? $selected_rates[ $package['package_id'] ] : '';
 
 		if ( empty( $selected_rate ) && ! empty( $package['rates'] ) ) {
 			$selected_rate = wc_get_chosen_shipping_method_for_package( $package['package_id'], $package );

src/StoreApi/Utilities/CartController.php

@@ -473,16 +473,45 @@ public function get_shipping_packages( $calculate_rates = true ) {
 
 		$packages = $cart->get_shipping_packages();
 
-		// Add package ID to array.
-		foreach ( $packages as $key => $package ) {
-			if ( ! isset( $packages[ $key ]['package_id'] ) ) {
-				$packages[ $key ]['package_id'] = $key;
-			}
+		// Add extra package data to array.
+		if ( count( $packages ) ) {
+			$packages = array_map(
+				function( $key, $package, $index ) {
+					$package['package_id']   = isset( $package['package_id'] ) ? $package['package_id'] : $key;
+					$package['package_name'] = isset( $package['package_name'] ) ? $package['package_name'] : $this->get_package_name( $package, $index );
+					return $package;
+				},
+				array_keys( $packages ),
+				$packages,
+				range( 1, count( $packages ) )
+			);
 		}
 
 		return $calculate_rates ? wc()->shipping()->calculate_shipping( $packages ) : $packages;
 	}
 
+	/**
+	 * Creates a name for a package.
+	 *
+	 * @param array $package Shipping package from WooCommerce.
+	 * @param int   $index Package number.
+	 * @return string
+	 */
+	protected function get_package_name( $package, $index ) {
+		return apply_filters(
+			'woocommerce_shipping_package_name',
+			$index > 1 ?
+				sprintf(
+					/* translators: %d: shipping package number */
+					_x( 'Shipping %d', 'shipping packages', 'woo-gutenberg-products-block' ),
+					$index
+				) :
+				_x( 'Shipping', 'shipping packages', 'woo-gutenberg-products-block' ),
+			$package['package_id'],
+			$package
+		);
+	}
+
 	/**
 	 * Selects a shipping rate.
 	 *