Tests added for requirements

A few tests have been added and some logic has been resived

Author: harm-less

samples/FQ/Samples/Simple.php

@@ -4,9 +4,7 @@
 
 use FQ\Dirs\ChildDir;
 use FQ\Dirs\RootDir;
-use FQ\Query\FilesQuery;
 use FQ\Query\FilesQueryBuilder;
-use FQ\Query\Selection\ChildSelection;
 
 class Simple extends SampleBootstrapper {
 
@@ -24,13 +22,10 @@ public function queryFile1FromChild1() {
 
 
 		$builder = new FilesQueryBuilder($this);
-		$builder->includeChildDirs('child1')->fileName('File1');
-
+		$builder->excludeRootDirs('root1')->includeChildDirs('child1')->fileName('File1');
 
 		$query = $builder->run();
 
-		//pr($builder);
-
 		return $query->listPaths();
 	}
 

samples/FQ/Samples/simple/root1/child1/File2.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace FQ\Exceptions;
+
+class FileQueryRequirementsException extends FileQueryException
+{
+}

src/FQ/exceptions/FileQueryRequirementsException.php

@@ -36,6 +36,11 @@ class FilesQuery {
 	 */
 	private $_currentQueryChildren;
 
+	/**
+	 * @var RootDir[]
+	 */
+	private $_cachedQueryRootDirs;
+
 	/**
 	 * @var bool Indicator if the query has run or not
 	 */
@@ -78,6 +83,7 @@ function __construct(Files $files) {
 	}
 
 	public function reset() {
+		$this->_cachedQueryRootDirs = null;
 		$this->_currentQueryChildren = array();
 
 		$this->requirements()->removeAll();
@@ -185,10 +191,11 @@ protected function _hasRun() {
 	 */
 	public function run($fileName) {
 		$this->_queriedFileName = $fileName;
+		$rootDirsSelection = $this->_getCachedRootDirSelection();
+
 		$this->_currentQueryChildren = array();
 		foreach ($this->getCurrentChildDirSelection() as $childDir) {
-			pr($childDir);
-			$this->_currentQueryChildren[$childDir->id()] = $this->processQueryChild($childDir);
+			$this->_currentQueryChildren[$childDir->id()] = $this->processQueryChild($childDir, $rootDirsSelection);
 		}
 		$this->_hasRun = true;
 		return $this->listPaths();
@@ -198,19 +205,27 @@ public function run($fileName) {
 	 * @return RootDir[]
 	 */
 	public function getCurrentRootDirSelection() {
-		return $this->_rootDirSelection->getSelection($this->files()->rootDirs());
+		return $this->getRootDirSelection()->getSelection($this->files()->rootDirs());
 	}
 
 	/**
 	 * @return ChildDir[]
 	 */
 	public function getCurrentChildDirSelection() {
-		return $this->_childDirSelection->getSelection($this->files()->childDirs());
+		return $this->getChildDirSelection()->getSelection($this->files()->childDirs());
+	}
+
+	protected function _getCachedRootDirSelection() {
+		if ($this->_cachedQueryRootDirs === null) {
+			$this->_cachedQueryRootDirs = $this->getCurrentRootDirSelection();
+		}
+		return $this->_cachedQueryRootDirs;
 	}
 
-	protected function processQueryChild(ChildDir $childDir) {
+	protected function processQueryChild(ChildDir $childDir, $rootSelection) {
 		$queryChild = $this->_getQueryChild($childDir);
 		$queryChild->reset();
+		$queryChild->setRootDirs($rootSelection);
 		if (!$this->requirements()->meetsRequirements($queryChild)) {
 			return false;
 		}

src/FQ/query/FilesQuery.php

@@ -3,6 +3,7 @@
 namespace FQ\Query;
 
 use FQ\Dirs\ChildDir;
+use FQ\Dirs\RootDir;
 use FQ\Exceptions\FileQueryException;
 use FQ\Files;
 use FQ\Query\Selection\RootSelection;
@@ -14,6 +15,11 @@ class FilesQueryChild {
 	 */
 	private $_filesQuery;
 
+	/**
+	 * @var RootDir[]
+	 */
+	private $_rootDirs;
+
 	/**
 	 * @var ChildDir
 	 */
@@ -59,6 +65,16 @@ function __construct(FilesQuery $filesQuery, ChildDir $childDir) {
 		$this->_childDir = $childDir;
 	}
 
+	public function setRootDirs($dirs) {
+		$this->_rootDirs = $dirs;
+	}
+	public function getRootDirs() {
+		if ($this->_rootDirs === null) {
+			return array();
+		}
+		return $this->_rootDirs;
+	}
+
 	/**
 	 * Resets the FilesQueryChild so it can be reused
 	 */
@@ -67,6 +83,8 @@ public function reset() {
 		$this->_rawAbsolutePaths = null;
 		$this->_rawBasePaths = null;
 
+		$this->_rootDirs = null;
+
 		$this->_pathsExist = null;
 
 		$this->_filteredPathsCashed = null;
@@ -150,7 +168,8 @@ public function rawBasePaths() {
 	private function _generatePaths($dirMethod) {
 		$paths = array();
 		$methodExists = null;
-		foreach ($this->files()->rootDirs() as $rootDir) {
+
+		foreach ($this->getRootDirs() as $rootDir) {
 			if ($methodExists === null) {
 				$methodExists = method_exists($rootDir, $dirMethod);
 				if (!$methodExists) {
@@ -228,7 +247,7 @@ private function _cachedFilterPaths() {
 		if (empty($this->_filteredPathsCashed)) {
 			$filters = $this->query()->filters();
 
-			$rootDirs = $this->files()->rootDirs();
+			$rootDirs = $this->getRootDirs();
 			$pathsExist = $this->pathsExist();
 
 			$filteredPaths = array();

src/FQ/query/FilesQueryChild.php

@@ -2,7 +2,6 @@
 
 namespace FQ\Query;
 
-use FQ\Exceptions\FileQueryException;
 use FQ\Exceptions\FileQueryRequirementsException;
 
 class FilesQueryRequirements {
@@ -25,6 +24,8 @@ class FilesQueryRequirements {
 	const LEVELS_ALL = 'levels_all';
 
 	function __construct() {
+		$this->_requirements = array();
+
 		$this->registerRequirement(self::LEVELS_ONE, array($this, 'requirementAtLeastOne'));
 		$this->registerRequirement(self::LEVELS_LAST, array($this, 'requirementLast'));
 		$this->registerRequirement(self::LEVELS_ALL, array($this, 'requirementAll'));
@@ -49,15 +50,15 @@ public function addRequirements($requirements) {
 
 	/**
 	 * @param string|int $requirement
-	 * @throws FileQueryException Thrown when there provided requirement is neither a string or an integer
+	 * @throws FileQueryRequirementsException Thrown when there provided requirement is neither a string or an integer
 	 * @return bool Return true when added. Returns false when it was already part of the requirements
 	 */
 	public function addRequirement($requirement) {
-		if (!is_string($requirement) || !is_int($requirement)) {
-			throw new FileQueryException(sprintf('A requirement van only be of type integer or string. Provided requirement is of type "%s"', gettype($requirement)));
+		if (!(is_string($requirement) || is_int($requirement))) {
+			throw new FileQueryRequirementsException(sprintf('A requirement van only be of type integer or string. Provided requirement is of type "%s"', gettype($requirement)));
 		}
 		if (!$this->requirementIsRegistered($requirement)) {
-			throw new FileQueryException(sprintf('Trying to add a requirement, but it isn\'t registered. Provided requirement "%s"', $requirement));
+			throw new FileQueryRequirementsException(sprintf('Trying to add a requirement, but it isn\'t registered. Provided requirement "%s"', $requirement));
 		}
 		if (!$this->hasRequirement($requirement)) {
 			$this->_requirements[] = $requirement;
@@ -101,8 +102,17 @@ public function hasRequirement($requirement) {
 	 * @return bool Returns true if there is at least one requirement, otherwise it will return false
 	 */
 	public function hasRequirements() {
+		return $this->countRequirements() !== 0;
+	}
+
+	/**
+	 * Count all configured requirements.
+	 *
+	 * @return int Returns the total number of requirements
+	 */
+	public function countRequirements() {
 		$requirements = $this->requirements();
-		return count($requirements) !== 0;
+		return count($requirements);
 	}
 
 	/**
@@ -120,56 +130,91 @@ public function requirementIsRegistered($requirement) {
 	 * @throws FileQueryRequirementsException
 	 */
 	public function registerRequirement($id, $callable) {
-		if (!is_callable($callable, true)) {
-			throw new FileQueryRequirementsException(sprintf('Trying to register a requirement but the requirement isn\'t callable. Info "%s"', implode(', ', (array) $callable)));
+		if (is_string($callable) && !method_exists($this, $callable)) {
+			throw new FileQueryRequirementsException(sprintf('Trying to register a requirement via a string but the requirement isn\'t callable. Method name "%s"', $callable));
+		}
+		else if (is_array($callable)) {
+			$class = new \ReflectionClass($callable[0]);
+			if (!$class->hasMethod($callable[1])) {
+				throw new FileQueryRequirementsException(sprintf('Trying to register a requirement but the requirement isn\'t callable. Class name "%s", method name "%s"', get_class($callable[0]), $callable[1]));
+			}
+		}
+		else {
+			throw new FileQueryRequirementsException(sprintf('Trying to register a requirement but the requirement\'s callable isn\'t a known data-type. Must be a string or an array. Type given "%s"', gettype($callable)));
+		}
+
+		if (isset($this->_registeredRequirements[$id])) {
+			return false;
 		}
 		$this->_registeredRequirements[$id] = $callable;
 		return true;
 	}
 
+	/**
+	 * Count all registered requirements.
+	 *
+	 * @return int Returns the total number of registered requirements
+	 */
+	public function countRegisteredRequirements() {
+		return count($this->_registeredRequirements);
+	}
+
+	/**
+	 * Check whether a requirements has already been registered
+	 * @param string $id ID of the requirement
+	 * @return bool Return true if the requirement is already registered
+	 */
+	public function isRegisteredRequirement($id) {
+		return isset($this->_registeredRequirements[$id]);
+	}
+
 	/**
 	 * @param string $id
 	 * @param FilesQueryChild $child
-	 * @throws FileQueryException
+	 * @throws FileQueryRequirementsException
 	 * @return mixed
 	 */
 	public function tryRequirement($id, FilesQueryChild $child) {
-		if ($this->requirementIsRegistered($id)) {
-			throw new FileQueryException(sprintf('Trying to call a requirement, but it isn\'t registered. Provided requirement "%s"', $id), 10);
+		if (!$this->requirementIsRegistered($id)) {
+			throw new FileQueryRequirementsException(sprintf('Trying to call a requirement, but it isn\'t registered. Provided requirement "%s"', $id), 10);
 		}
 		return call_user_func($this->_registeredRequirements[$id], $child);
 	}
 
 	/**
 	 * @param FilesQueryChild $child
-	 * @return bool|FileQueryException
+	 * @return bool|FileQueryRequirementsException
 	 */
 	protected function requirementAtLeastOne(FilesQueryChild $child) {
-		if ($child->totalExistingPaths() === 0) {
+		if (!$child->totalExistingPaths() >= 1) {
 			return new FileQueryRequirementsException(sprintf('At least 1 file must be available for file "%s" in child with an id of "%s". Please create the file in any of these locations: %s', $child->relativePath(), $child->childDir()->id(), implode($child->rawAbsolutePaths())));
 		}
 		return true;
 	}
 
 	/**
 	 * @param FilesQueryChild $child
-	 * @return bool|FileQueryException
+	 * @return bool|FileQueryRequirementsException
 	 */
 	protected function requirementLast(FilesQueryChild $child) {
-		$pathsExist = $child->pathsExist();
-		if ($child->totalExistingPaths() === 0 || $pathsExist[0] == null) {
-			return new FileQueryException(sprintf('Last file "%s" not found in child "%s" but it is required', $child->relativePath(), $child->childDir()->id()));
+		$pathsExist = array_reverse($child->pathsExist());
+		foreach ($pathsExist as $rootDir) {
+			if ($rootDir === false) {
+				return new FileQueryRequirementsException(sprintf('Last file "%s" not found in child "%s" but it is required', $child->relativePath(), $child->childDir()->id()));
+			}
+			// just check the first root dir (which is the last one because it was reversed)
+			break;
 		}
 		return true;
 	}
 
 	/**
 	 * @param FilesQueryChild $child
-	 * @return bool|FileQueryException
+	 * @return bool|FileQueryRequirementsException
 	 */
 	protected function requirementAll(FilesQueryChild $child) {
-		if ($child->totalExistingPaths() != $child->files()->totalRootDirs()) {
-			return new FileQueryException(sprintf('All "%s" children must contain a file called "%s".', $child->childDir()->id(), $child->relativePath()));
+		if ($child->totalExistingPaths() != count($child->getRootDirs())) {
+			return new FileQueryRequirementsException(sprintf('All "%s" children must contain a file called "%s".', $child->childDir()->id(), $child->relativePath()));
 		}
 		return true;
 	}
@@ -179,8 +224,10 @@ protected function requirementAll(FilesQueryChild $child) {
 	 *
 	 * @param FilesQueryChild $queryChild
 	 * @param bool $throwExceptionOnFail
-	 * @throws \Exception
-	 * @return mixed Returns true if all requirements are met. Otherwise returns an un-thrown exception if 'throwExceptionOnFail' is set to false or the response from the requirement
+	 * @throws \Exception When $throwExceptionOnFail is set to true and one of the requirements fails, it will throw
+	 * the exception from that fail. Otherwise this exception will be returned
+	 * @return mixed Returns true if all requirements are met. Otherwise returns an un-thrown exception
+	 * if 'throwExceptionOnFail' is set to false or the response from the requirement
 	 */
 	public function meetsRequirements(FilesQueryChild $queryChild, $throwExceptionOnFail = true) {
 		// if there are no requirements it certainly is valid and it can be returned immediately

src/FQ/query/FilesQueryRequirements.php

@@ -26,9 +26,14 @@ abstract class AbstractFQTest extends PHPUnit_Framework_TestCase
 
 	const DIR_ABSOLUTE_DEFAULT = __DIR__;
 	const DIR_CUSTOM_ID = 'custom_id';
-	const ROOT_DIR_ABSOLUTE_DEFAULT = __DIR__;
+
+	const ROOT_DIR_DEFAULT_ID = ACTUAL_ROOT_DIR_FIRST_ID;
+	const ROOT_DIR_DEFAULT_ABSOLUTE_PATH = ACTUAL_ROOT_DIR_FIRST_ABSOLUTE_PATH;
+	const ROOT_DIR_SECOND_ID = ACTUAL_ROOT_DIR_SECOND_ID;
+	const ROOT_DIR_SECOND_ABSOLUTE_PATH = ACTUAL_ROOT_DIR_SECOND_ABSOLUTE_PATH;
+
 	const ROOT_DIR_ID_CUSTOM = 'rootDir';
-	const CHILD_DIR_DEFAULT = 'child';
+	const CHILD_DIR_DEFAULT = ACTUAL_CHILD_DIR;
 
 
 	/**
@@ -60,7 +65,11 @@ protected function callObjectWithNonPublicMethod($obj, $name, $args) {
 		$method->setAccessible(true);
 
 		$args = is_array($args) ? $args : (array) $args;
-		return $method->invokeArgs($obj, $args);
+		$result = $method->invokeArgs($obj, $args);
+		if (is_a($result, 'Exception')) {
+			throw $result;
+		}
+		return $result;
 	}
 
 	protected function __newDir($id = self::DIR_CUSTOM_ID, $dir = self::DIR_ABSOLUTE_DEFAULT, $required = false) {
@@ -73,11 +82,14 @@ protected function _newFictitiousDir($required = true) {
 		return $this->__newDir('does_not_exist', $required);
 	}
 
-	protected function __newRootDir($id = self::ROOT_DIR_ID_CUSTOM, $absoluteDir = self::ROOT_DIR_ABSOLUTE_DEFAULT, $basePath = null, $required = false) {
+	protected function __newRootDir($id = self::ROOT_DIR_ID_CUSTOM, $absoluteDir = self::ROOT_DIR_DEFAULT_ABSOLUTE_PATH, $basePath = null, $required = false) {
 		return new RootDir($id, $absoluteDir, $basePath, $required);
 	}
 	protected function _newActualRootDir($basePath = null, $required = false) {
-		return $this->__newRootDir(self::ROOT_DIR_ID_CUSTOM, self::ROOT_DIR_ABSOLUTE_DEFAULT, $basePath, $required);
+		return $this->__newRootDir(self::ROOT_DIR_DEFAULT_ID, self::ROOT_DIR_DEFAULT_ABSOLUTE_PATH, $basePath, $required);
+	}
+	protected function _newActualRootDirSecond($basePath = null, $required = false) {
+		return $this->__newRootDir(self::ROOT_DIR_SECOND_ID, self::ROOT_DIR_SECOND_ABSOLUTE_PATH, $basePath, $required);
 	}
 	protected function _newFictitiousRootDir($required = true) {
 		return $this->__newRootDir('does_not_exist', 'does_not_exist', $required);