Added coverage for everything but the variable types

Author: harm-less

src/PE/Encoder.php

@@ -202,9 +202,6 @@ protected function _decodeNode($nodeName, $nodeData, EncoderOptions $options, En
 
 					$objectSetter = $objectSetterVariable->getObjectSetter();
 					$processedRequiredValue = $objectSetter->processValue($requiredValue);
-					if ($processedRequiredValue === null) {
-						throw new EncoderException(sprintf('Variable "%s" for "%s" cannot process its value (%s). Presumably because the NodeType does not recognize the variable', $processedVariable, $nodeClassName, $requiredValue));
-					}
 
 					$requiredVariableValues[$processedVariable] = $processedRequiredValue;
 					unset($nodeDataItem[$processedVariable]);
@@ -276,7 +273,7 @@ protected function _decodeNode($nodeName, $nodeData, EncoderOptions $options, En
 
 			$nodeIndex++;
 		}
-		$proxyNode->variablesAreValid($decodedChildren, true);
+		$variableCollection->objectVariablesAreValidWithData($decodedChildren, true);
 
 		if ($isSingleNode) {
 			return $objects[0];
@@ -344,14 +341,7 @@ protected function _encode($object, EncoderNode $node, EncoderOptions $options,
 
         $optionNodeIndex = $node->getNodeName() . '[' . $childObjectIterationIndex . ']';
 
-		// get all the variables values from the object
 		$attributesRaw = array();
-		foreach ($objectGetterVariables as $objectGetterVariable) {
-			$variableId = $objectGetterVariable->getId();
-
-			$objectGetter = $objectGetterVariable->getObjectGetter();
-			$attributesRaw[$variableId] = $objectGetter->apply($object);
-		}
 
 		$postNodeStaticOptions = array(
 			NodeAccessor::VARIABLE_NODE => $node,
@@ -361,6 +351,30 @@ protected function _encode($object, EncoderNode $node, EncoderOptions $options,
 			NodeAccessor::VARIABLE_NODE_ITERATION_INDEX => $nodeIterationIndex,
 			NodeAccessor::VARIABLE_CHILD_OBJECT_ITERATION_INDEX => $childObjectIterationIndex,
 		);
+
+		$preNodeGetterVariables = $variableCollection->getPreNodeGetterVariables();
+		foreach ($preNodeGetterVariables as $preNodeGetterVariable) {
+			$variableId = $preNodeGetterVariable->getId();
+			$postNodeGetter = $preNodeGetterVariable->getPreNodeGetter();
+			$actionOptions = array_merge($postNodeStaticOptions, array(
+				NodeAccessor::VARIABLE_NODE_DATA => $attributesRaw,
+				NodeAccessor::VARIABLE_NAME => $variableId,
+			));
+			if ($newAttributeData = $postNodeGetter->apply($actionOptions)) {
+				if (is_array($newAttributeData)) {
+					$attributesRaw = $newAttributeData;
+				}
+			}
+		}
+
+		// get all the variables values from the object
+		foreach ($objectGetterVariables as $objectGetterVariable) {
+			$variableId = $objectGetterVariable->getId();
+
+			$objectGetter = $objectGetterVariable->getObjectGetter();
+			$attributesRaw[$variableId] = $objectGetter->apply($object);
+		}
+
 		$postNodeGetterVariables = $variableCollection->getPostNodeGetterVariables();
 		foreach ($postNodeGetterVariables as $postNodeGetterVariable) {
 			$variableId = $postNodeGetterVariable->getId();

src/PE/Nodes/EncoderNode.php

@@ -498,29 +498,6 @@ public function getVariableCollection() {
 		return $this->variables;
 	}
 
-	/**
-	 * @param array $nodeDataArray
-	 * @param bool $throwErrorIfFails Set to true if you want it to throw an error if it fails
-	 * @return bool Returns true if all requirements are met
-	 *
-	 * @see EncoderNodeVariable::variablesAreValidWithData()
-	 */
-	public function variablesAreValid($nodeDataArray, $throwErrorIfFails = false) {
-		return $this->variables->objectVariablesAreValidWithData($nodeDataArray, $throwErrorIfFails);
-	}
-
-	/**
-	 * @param NodeAccessor $nodeAccessor NodeAccessor you want to apply to
-	 * @param array $parameters Array of all the information required for the several methods needing it
-	 * @return bool|mixed
-	 *
-	 * @see EncoderNodeVariable::applyToSetter()
-	 */
-	public function applyToNode(NodeAccessor $nodeAccessor, $parameters) {
-		$parameters[NodeAccessor::VARIABLE_NODE] = $this;
-		return $nodeAccessor->apply($parameters);
-	}
-
 
 
 

src/PE/Nodes/EncoderNodeChild.php

@@ -23,6 +23,9 @@ class EncoderNodeChild {
 	 */
 	private $getter;
 
+	/**
+	 * @var bool
+	 */
 	private $isArray = true;
 
 	function __construct($nodeName, NodeChildSetter $setter = null, NodeChildGetter $getter = null) {
@@ -68,10 +71,13 @@ public function getGetter() {
 		return $this->getter;
 	}
 
-	// @todo Figure out if this feature is still necessary. Because if you use a single node, can't we simply assume it isn't an array?
+	/**
+	 * @param null $bool
+	 * @return bool
+	 */
 	public function isArray($bool = null) {
 		if ($bool !== null) {
-			$this->isArray = $bool;
+			$this->isArray = (bool) $bool;
 		}
 		return $this->isArray;
 	}

src/PE/Nodes/EncoderNodeVariable.php

@@ -277,66 +277,4 @@ public function hasObjectGetter() {
 	public function getObjectGetter() {
 		return $this->objectGetter;
 	}
-
-
-
-	/**
-	 * Call the setter action of the node. The setter action type must be set to "node", otherwise it will not execute.
-	 *
-	 * @param EncoderNode $node The EncoderNode of which you wish to call the setter action from
-	 * @param array $options All the available options
-	 * @return mixed|null Returns null if setter action type is not "node". Returns an array with the possibly altered node data
-	 */
-	/*public function callNodeSetterAction(EncoderNode $node, $options) {
-		if ($this->getSetterActionType() != self::ACTION_TYPE_NODE) {
-			return null;
-		}
-		$required = array(
-			self::ACTION_VARIABLE_SETTER_NODE_DATA
-		);
-		$variables = $this->_setupNodeActionVariables($this->getSetterAction(), $required, $options);
-		return $this->_callNodeAction($node, $this->getSetterActionMethod(), $variables);
-	}*/
-
-	/**
-	 * Call the getter action of the node. The getter action type must be set to "node", otherwise it will not execute.
-	 *
-	 * @param EncoderNode $node The EncoderNode of which you wish to call the getter action from
-	 * @param array $options All the available options
-	 * @return mixed|null Returns null if getter action type is not "node". Returns an array with the possibly altered node data
-	 */
-	/*public function callNodeGetterAction(EncoderNode $node, $options) {
-		if ($this->getGetterActionType() != self::ACTION_TYPE_NODE) {
-			return null;
-		}
-		$required = array(
-			self::ACTION_VARIABLE_GETTER_NODE_DATA
-		);
-		$variables = $this->_setupNodeActionVariables($this->getGetterAction(), $required, $options);
-		return $this->_callNodeAction($node, $this->getGetterActionMethod(), $variables);
-	}*/
-
-	/**
-	 * Prepares the variables so they can be used
-	 *
-	 * @param array $action Action object
-	 * @param array $required Will be used to determine if options are missing or not
-	 * @param array $options All available options. If options are missing an error will be thrown
-	 * @return array The prepared array of variables
-	 */
-	/*protected function _setupNodeActionVariables($action, $required, $options) {
-
-		$variablesNames = array_merge($required, isset($action['variables']) ? $action['variables'] : array());
-
-		$variables = array();
-		foreach ($variablesNames as $variableName) {
-			if (array_key_exists($variableName, $options)) {
-				$variables[] = $options[$variableName];
-			}
-			else {
-				throw new EncoderNodeVariableException(sprintf('Action variable "%s" is not known', $variableName));
-			}
-		}
-		return $variables;
-	}*/
 }

src/PE/Nodes/EncoderNodeVariableCollection.php

@@ -3,7 +3,6 @@
 namespace PE\Nodes;
 
 use PE\Exceptions\EncoderNodeVariableCollectionException;
-use PE\Exceptions\EncoderNodeVariableException;
 use PE\Variables\Types\NodeAccessor;
 use PE\Variables\Types\ObjectAccessor;
 
@@ -28,10 +27,10 @@ function __construct() {
 	 */
 	public function addVariable(EncoderNodeVariable $variable) {
 		$id = $variable->getId();
-		if (!$this->variableExists($id)) {
-			$this->variables[$id] = $variable;
+		if ($this->variableExists($id)) {
+			throw new EncoderNodeVariableCollectionException(sprintf('Trying to add a EncoderNodeVariable but a variable with id "%s" already exists', $id));
 		}
-		$this->_cacheHardReset();
+		$this->variables[$id] = $variable;
 		return $variable;
 	}
 
@@ -208,22 +207,6 @@ protected function _cache($method, $parameters = null, $value = false) {
 		return $this->_cache[$method][$parameters];
 	}
 
-	/**
-	 * @param string $method
-	 * @return bool
-	 */
-	protected function _cacheReset($method) {
-		if (array_key_exists($method, $this->_cache)) {
-			unset($this->_cache[$method]);
-			return true;
-		}
-		return false;
-	}
-
-	protected function _cacheHardReset() {
-		$this->_cache = array();
-	}
-
 
 	/**
 	 * @param $dataArray
@@ -244,7 +227,7 @@ public function objectVariablesAreValidWithData($dataArray, $throwErrorIfFails =
 						$variableValue = $data[$variableId];
 						if (array_search($variableValue, $unique[$variableId]) !== false) {
 							if ($throwErrorIfFails) {
-								throw new EncoderNodeVariableException(sprintf('Variable "%s" must be unique but value "%s" is given at least twice', $variableId, $variableValue));
+								throw new EncoderNodeVariableCollectionException(sprintf('Variable "%s" must be unique but value "%s" is given at least twice', $variableId, $variableValue));
 							}
 							else {
 								return false;

tests/PE/Nodes/Specials/VariableTypesNode.php

@@ -8,6 +8,7 @@
 use PE\Variables\Types\NodeAccessor;
 use PE\Variables\Types\PostNodeGetter;
 use PE\Variables\Types\PostNodeSetter;
+use PE\Variables\Types\PreNodeGetter;
 use PE\Variables\Types\PreNodeSetter;
 
 class VariableTypesNode extends EncoderNode {
@@ -30,6 +31,13 @@ function __construct() {
 			NodeAccessor::VARIABLE_OBJECT,
 			NodeAccessor::VARIABLE_PARENT
 		)));
+
+		$required->preNodeGetter(new PreNodeGetter('preNodeRequiredGetter', array(
+			NodeAccessor::VARIABLE_NODE,
+			NodeAccessor::VARIABLE_NAME,
+			NodeAccessor::VARIABLE_OBJECT,
+			NodeAccessor::VARIABLE_PARENT
+		)));
 		$required->postNodeGetter(new PostNodeGetter('postNodeRequiredGetter', array(
 			NodeAccessor::VARIABLE_NODE,
 			NodeAccessor::VARIABLE_NAME,
@@ -38,6 +46,7 @@ function __construct() {
 			NodeAccessor::VARIABLE_PARENT
 		)));
 
+
 		$optional = $this->addVariable(new EncoderNodeVariable('optional'));
 		$optional->preNodeSetter(new PreNodeSetter('preNodeOptionalSetter', array(
 			NodeAccessor::VARIABLE_NODE,
@@ -52,6 +61,13 @@ function __construct() {
 			NodeAccessor::VARIABLE_OBJECT,
 			NodeAccessor::VARIABLE_PARENT
 		)));
+
+		$optional->preNodeGetter(new PreNodeGetter('preNodeOptionalGetter', array(
+			NodeAccessor::VARIABLE_NODE,
+			NodeAccessor::VARIABLE_NAME,
+			NodeAccessor::VARIABLE_OBJECT,
+			NodeAccessor::VARIABLE_PARENT
+		)));
 		$optional->postNodeGetter(new PostNodeGetter('postNodeOptionalGetter', array(
 			NodeAccessor::VARIABLE_NODE,
 			NodeAccessor::VARIABLE_NAME,
@@ -69,18 +85,30 @@ public function postNodeRequiredSetter($nodeData, VariableTypesNode $variableTyp
 		$nodeData['required'] = $nodeData['required'] . ' | setter post';
 		return $nodeData;
 	}
+
+	public function preNodeRequiredGetter($nodeData, VariableTypesNode $variableTypesNode, $name, VariableTypes $variableTypes, $parent) {
+		$variableTypes->setOptional($variableTypes->getOptional() . ' | required pre');
+		$nodeData['pre-required'] = 'getter pre';
+		return $nodeData;
+	}
 	public function postNodeRequiredGetter($nodeData, VariableTypesNode $variableTypesNode, $name, $value, VariableTypes $variableTypes, $parent) {
 		$nodeData['required'] = $nodeData['required'] . ' | getter post';
 		return $nodeData;
 	}
 
 
 	public function preNodeOptionalSetter($nodeData, VariableTypesNode $variableTypesNode, $name, $value, $parent) {
-		$nodeData['optional'] = $nodeData['optional'] . ' | setter  pre';
+		$nodeData['optional'] = $nodeData['optional'] . ' | setter pre';
 		return $nodeData;
 	}
 	public function postNodeOptionalSetter($nodeData, VariableTypesNode $variableTypesNode, $name, $value, VariableTypes $variableTypes, $parent) {
-		$nodeData['optional'] = $nodeData['optional'] . ' | setter  post';
+		$nodeData['optional'] = $nodeData['optional'] . ' | setter post';
+		return $nodeData;
+	}
+
+	public function preNodeOptionalGetter($nodeData, VariableTypesNode $variableTypesNode, $name, VariableTypes $variableTypes, $parent) {
+		$variableTypes->setOptional($variableTypes->getOptional() . ' | optional pre');
+		$nodeData['pre-optional'] = 'getter pre';
 		return $nodeData;
 	}
 	public function postNodeOptionalGetter($nodeData, VariableTypesNode $variableTypesNode, $name, $value, VariableTypes $variableTypes, $parent) {

tests/PE/Tests/EncoderTest.php

@@ -251,12 +251,14 @@ public function testDecodeObjectAllVariableTypes() {
 		/** @var VariableTypes $obj */
 		$obj = $decoded['variable-type'];
 		$this->assertEquals('Hello world | setter pre', $obj->getRequired());
-		$this->assertEquals('Hello other world | setter  pre | setter  post', $obj->getOptional());
+		$this->assertEquals('Hello other world | setter pre | setter post', $obj->getOptional());
 
 		$encoded = $this->encoder()->encode($obj);
 		$encodedProcessed = $encoded['processed'];
 		$this->assertEquals('Hello world | setter pre | getter post', $encodedProcessed['variable-type']['required']);
-		$this->assertEquals('Hello other world | setter  pre | setter  post | getter post', $encodedProcessed['variable-type']['optional']);
+		$this->assertEquals('getter pre', $encodedProcessed['variable-type']['pre-required']);
+		$this->assertEquals('Hello other world | setter pre | setter post | required pre | optional pre | getter post', $encodedProcessed['variable-type']['optional']);
+		$this->assertEquals('getter pre', $encodedProcessed['variable-type']['pre-optional']);
 	}
 
 	public function testDecodeWithSetAfterChildrenFalse() {

tests/PE/Tests/Nodes/Children/NodeChildGetterTest.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace PE\Tests\Nodes\Children;
+
+use PE\Nodes\Children\NodeChildGetter;
+use PE\Tests\Samples;
+
+class NodeChildGetterTest extends Samples
+{
+
+	protected function setUp()
+	{
+		parent::setUp();
+		$this->_peApp = new NodeChildGetter('method');
+	}
+
+	/**
+	 * @return NodeChildGetter
+	 */
+	protected function nodeChildSetter()
+	{
+		return $this->_peApp;
+	}
+
+	public function testConstructor()
+	{
+		$setter = new NodeChildGetter('test');
+		$this->assertNotNull($setter);
+		$this->assertTrue($setter instanceof NodeChildGetter);
+	}
+
+	public function testGetMethod() {
+		$childSetter = $this->nodeChildSetter();
+		$this->assertEquals('method', $childSetter->getMethod());
+	}
+}
+?>

tests/PE/Tests/Nodes/Children/NodeChildSetterTest.php

@@ -29,6 +29,11 @@ public function testConstructor()
 		$this->assertTrue($setter instanceof NodeChildSetter);
 	}
 
+	public function testGetMethod() {
+		$childSetter = $this->nodeChildSetter();
+		$this->assertEquals('method', $childSetter->getMethod());
+	}
+
 	public function testSetAfterChildren() {
 		$nodeChildSetter = $this->nodeChildSetter();