From e833403be6f42b0ebde1269882f7597fbfeb5b94 Mon Sep 17 00:00:00 2001
From: Travis Weston <anubisthejackle@users.noreply.github.com>
Date: Wed, 5 Jul 2023 10:21:11 -0400
Subject: [PATCH] Feature/dependencies test trait (#405)

* Add new Dependency_Assertions trait

* Fix linting
---
 .../concerns/trait-dependency-assertions.php  | 68 +++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 src/mantle/testing/concerns/trait-dependency-assertions.php

diff --git a/src/mantle/testing/concerns/trait-dependency-assertions.php b/src/mantle/testing/concerns/trait-dependency-assertions.php
new file mode 100644
index 000000000..3729fb9cd
--- /dev/null
+++ b/src/mantle/testing/concerns/trait-dependency-assertions.php
@@ -0,0 +1,68 @@
+<?php //phpcs:disable WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
+/**
+ * Dependency_Assertions trait file
+ *
+ * @package Mantle
+ */
+
+namespace Mantle\Testing\Concerns;
+
+use PHPUnit\Framework\Assert as PHPUnit;
+use Mantle\Support\Collection;
+
+trait Dependency_Assertions {
+
+	/**
+	 * Asserts that the contents of an array are loaded prior to testing.
+	 *
+	 * Array can be an array of strings or an array of arrays where the first value is a string -- for instance,
+	 * a data provider.
+	 *
+	 * @param array $dependencies Dependencies array.
+	 */
+	public static function assertDependenciesLoaded( array $dependencies ) {
+		if ( count( $dependencies ) === 0 ) {
+			PHPUnit::markTestIncomplete( 'Asserting an empty dependency array has been loaded does not assert that no dependencies have been loaded.' );
+		}
+
+		foreach ( $dependencies as $dependency ) {
+			if ( is_array( $dependency ) ) {
+				$dependency = array_shift( $dependency );
+			}
+
+			if ( ! is_string( $dependency ) ) {
+				PHPUnit::fail( 'Dependency type not string.' );
+				continue;
+			}
+
+			self::assertDependencyLoaded( $dependency );
+		}
+	}
+
+	/**
+	 * Asserts that a file is loaded.
+	 *
+	 * @param string $dependency The dependency file name.
+	 */
+	public static function assertDependencyLoaded( string $dependency ) {
+		static $includes;
+
+		if (
+			! is_array( $includes ) ||
+			empty( $includes )
+		) {
+			$includes = new Collection( get_included_files() );
+		}
+
+		PHPUnit::assertTrue(
+			$includes
+				->filter( fn( $file ) => strpos( $file, $dependency ) !== false )
+				->count() > 0,
+			sprintf(
+				'%s dependency not found in included files.',
+				(string) $dependency
+			)
+		);
+	}
+
+}