Merge pull request #703 from godaddy-wordpress/chore/add-convert-to-a…

…rray-trait [WIP] Add `CanConvertToArrayTrait` and `ArrayHelper` classes
godaddy-wordpress · Aug 26, 2024 · 021bdb8 · 021bdb8
2 parents 7145b7e + 332b89a
commit 021bdb8
Show file tree

Hide file tree

Showing 7 changed files with 855 additions and 5 deletions.
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -10,7 +10,9 @@
 require_once PLUGIN_ROOT_DIR.'/woocommerce/Enums/Traits/EnumTrait.php';
 require_once PLUGIN_ROOT_DIR.'/woocommerce/Enums/PaymentFormContext.php';
 require_once PLUGIN_ROOT_DIR.'/woocommerce/Traits/CanGetNewInstanceTrait.php';
+require_once PLUGIN_ROOT_DIR.'/woocommerce/Traits/CanConvertToArrayTrait.php';
 require_once PLUGIN_ROOT_DIR.'/woocommerce/Traits/IsSingletonTrait.php';
+require_once PLUGIN_ROOT_DIR.'/woocommerce/Helpers/ArrayHelper.php';
 
 WP_Mock::setUsePatchwork(true);
 WP_Mock::bootstrap();

diff --git a/tests/unit/Helpers/ArrayHelperTest.php b/tests/unit/Helpers/ArrayHelperTest.php
@@ -0,0 +1,280 @@
+<?php
+
+namespace SkyVerge\WooCommerce\PluginFramework\v5_13_1\Tests\Unit\Helpers;
+
+use ArrayAccess;
+use Generator;
+use SkyVerge\WooCommerce\PluginFramework\v5_13_1\Helpers\ArrayHelper;
+use SkyVerge\WooCommerce\PluginFramework\v5_13_1\Tests\TestCase;
+
+/**
+ * @coversDefaultClass \SkyVerge\WooCommerce\PluginFramework\v5_13_1\Helpers\ArrayHelper
+ */
+final class ArrayHelperTest extends TestCase
+{
+	/**
+	 * @covers ::accessible()
+	 * @dataProvider providerCanDetermineIsAccessible
+	 *
+	 * @param mixed $item
+	 * @param bool $expected
+	 * @return void
+	 */
+	public function testCanDetermineIsAccessible($item, bool $expected): void
+	{
+		$this->assertSame($expected, ArrayHelper::accessible($item));
+	}
+
+	/** @see testCanDetermineIsAccessible */
+	public function providerCanDetermineIsAccessible(): Generator
+	{
+		yield 'array is accessible' => [
+			'item' => ['foo' => 'bar'],
+			'expected' => true,
+		];
+
+		yield 'ArrayAccess is accessible' => [
+			'item' => $this->getArrayAccessObject(),
+			'expected' => true,
+		];
+
+		yield 'object without ArrayAccess is not accessible' => [
+			'item' => new \stdClass(),
+			'expected' => false,
+		];
+
+		yield 'integer is not accessible' => [
+			'item' => 10,
+			'expected' => false,
+		];
+
+		yield 'string is not accessible' => [
+			'item' => 'string',
+			'expected' => false,
+		];
+	}
+
+	/**
+	 * @covers ::except()
+	 * @dataProvider providerExcept
+	 *
+	 * @param array $inputArray
+	 * @param array|string $keysToExclude
+	 * @param array $expectedOutputArray
+	 * @return void
+	 */
+	public function testExcept(array $inputArray, $keysToExclude, array $expectedOutputArray): void
+	{
+		$this->assertSame(
+			$expectedOutputArray,
+			ArrayHelper::except($inputArray, $keysToExclude)
+		);
+	}
+
+	/** @see testExcept */
+	public function providerExcept(): Generator
+	{
+		yield 'array of keys' => [
+			'inputArray' => [
+				'apple' => 'red',
+				'banana' => 'yellow',
+				'cucumber' => 'green',
+			],
+			'keysToExclude' => ['apple', 'cucumber'],
+			'expectedOutputArray' => [
+				'banana' => 'yellow',
+			],
+		];
+
+		yield 'key as a string' => [
+			'inputArray' => [
+				'apple' => 'red',
+				'banana' => 'yellow',
+				'cucumber' => 'green',
+			],
+			'keysToExclude' => 'banana',
+			'expectedOutputArray' => [
+				'apple' => 'red',
+				'cucumber' => 'green',
+			],
+		];
+
+		yield 'keys to exclude do not exist' => [
+			'inputArray' => [
+				'apple' => 'red',
+				'banana' => 'yellow',
+				'cucumber' => 'green',
+			],
+			'keysToExclude' => ['invalid'],
+			'expectedOutputArray' => [
+				'apple' => 'red',
+				'banana' => 'yellow',
+				'cucumber' => 'green',
+			],
+		];
+	}
+
+	/**
+	 * Tests that can remove items from an array.
+	 *
+	 * @covers ::remove()
+	 * @dataProvider providerCanRemove
+	 *
+	 * @param array<string, mixed> $input
+	 * @param string|string[] $keysToRemove
+	 * @param array $expected
+	 */
+	public function testCanRemoveItemsFromArray(array $input, $keysToRemove, array $expected) : void
+	{
+		ArrayHelper::remove($input, $keysToRemove);
+		$this->assertEquals($expected, $input);
+	}
+
+	/** @see testCanRemoveItemsFromArray */
+	public function providerCanRemove() : Generator
+	{
+		yield 'remove 1 key from one item array' => [
+			'input'        => ['test' => 1],
+			'keysToRemove' => 'test',
+			'expected'     => [],
+		];
+
+		yield 'remove 1 key from two item array' => [
+			'input'        => ['test' => 2, 'second' => ['nested' => 3]],
+			'keysToRemove' => 'second',
+			'expected'     => ['test' => 2],
+		];
+
+		yield 'remove 2 keys' => [
+			'input'        => ['test' => 2, 'second' => ['nested' => 3], 'third' => 4],
+			'keysToRemove' => ['second', 'third'],
+			'expected'     => ['test' => 2],
+		];
+
+		yield 'remove 2 keys that are one level deep' => [
+			'input' => [
+				'resource' => [
+					'first'  => 1,
+					'second' => 2,
+				],
+			],
+			'keysToRemove' => ['resource.first', 'resource.second'],
+			'expected'     => ['resource' => []],
+		];
+	}
+
+	/**
+	 * @covers ::wrap()
+	 * @dataProvider providerCanWrap
+	 *
+	 * @param mixed $item
+	 * @param array $expectedOutput
+	 * @return void
+	 */
+	public function testCanWrap($item, array $expectedOutput): void
+	{
+		$this->assertEquals($expectedOutput, ArrayHelper::wrap($item));
+	}
+
+	/** @see testCanWrap */
+	public function providerCanWrap(): Generator
+	{
+		yield 'already an array' => [
+			'item' => ['foo' => 'bar'],
+			'expectedOutput' => ['foo' => 'bar'],
+		];
+
+		yield 'integer' => [
+			'item' => 50,
+			'expectedOutput' => [50],
+		];
+
+		yield 'null item' => [
+			'item' => null,
+			'expectedOutput' => [],
+		];
+
+		yield 'empty string' => [
+			'item' => '',
+			'expectedOutput' => [],
+		];
+	}
+
+	/**
+	 * @covers ::exists()
+	 * @dataProvider providerCanDetermineKeyExists
+	 *
+	 * @param array|ArrayAccess $input
+	 * @param string|int $key
+	 * @param bool $expected
+	 * @return void
+	 */
+	public function testCanDetermineKeyExists($input, $key, bool $expected): void
+	{
+		$this->assertSame(
+			$expected,
+			ArrayHelper::exists($input, $key)
+		);
+	}
+
+	/** @see testCanDetermineKeyExists */
+	public function providerCanDetermineKeyExists(): Generator
+	{
+		yield 'ArrayAccess' => [
+			'input' => $this->getArrayAccessObject(),
+			'key' => 'key',
+			'expected' => true,
+		];
+
+		yield 'array with string key that exists' => [
+			'input' => ['foo' => 'bar'],
+			'key' => 'foo',
+			'expected' => true,
+		];
+
+		yield 'array with string key that does not exist' => [
+			'input' => ['foo' => 'bar'],
+			'key' => 'invalid',
+			'expected' => false,
+		];
+
+		yield 'array with integer key that exists' => [
+			'input' => ['chocolate', 'vanilla'],
+			'key' => 1,
+			'expected' => true,
+		];
+
+		yield 'array with integer key that does not exist' => [
+			'input' => ['chocolate', 'vanilla'],
+			'key' => 5,
+			'expected' => false,
+		];
+	}
+
+	protected function getArrayAccessObject(): ArrayAccess
+	{
+		return new class implements ArrayAccess
+		{
+
+			public function offsetExists($offset) : bool
+			{
+				return true;
+			}
+
+			public function offsetGet($offset) : int
+			{
+				return 1;
+			}
+
+			public function offsetSet($offset, $value) : void
+			{
+				// TODO: Implement offsetSet() method.
+			}
+
+			public function offsetUnset($offset) : void
+			{
+				// TODO: Implement offsetUnset() method.
+			}
+		};
+	}
+}