Expectation.php

<?php

class EcomDev_PHPUnit_Model_Expectation
    implements EcomDev_PHPUnit_Model_ExpectationInterface
{
    /**
     * List of created data object ids by path format
     *
     * @var array
     */
    protected $_dataObjectIds = array();

    /**
     * Loaded data from Yaml files
     *
     * @var Varien_Object
     */
    protected $_loadedData = null;

    /**
     * Data object used for managing
     * expectation data
     *
     * @var string
     */
    protected $_dataObjectClassAlias = 'ecomdev_phpunit/expectation_object';

    /**
     * Returns class alias for fixture data object
     *
     * @return string
     */
    public function getDataObjectClassAlias()
    {
        return $this->_dataObjectClassAlias;
    }

    /**
     * Retrieves data object for a particular path format
     *
     * @see EcomDev_PHPUnit_Model_ExpectationInterface::getDataObject()
     */
    public function getDataObject($pathFormat = null, $args = array())
    {
        if ($pathFormat === null) {
            return $this->_loadedData;
        }

        $argsHash = $pathFormat . '_' . md5(serialize($args));

        // Check already created objects by path
        if (!isset($this->_dataObjectIds[$argsHash])) {
            if ($args) {
               array_unshift($args, $pathFormat);
               $dataPath = call_user_func_array('sprintf', $args);
            } else {
               $dataPath = $pathFormat;
            }

            $data = $this->_loadedData->getData($dataPath);

            if (!is_array($data)) {
               throw new InvalidArgumentException(
                   'Argument values for specifying special scope of expectations should be presented '
                   . ' in expectation file and should be an associative list (path: "' . $dataPath . '")'
               );
            }

            $this->_dataObjectIds[$argsHash] = Mage::objects()->save(
                Mage::getModel($this->getDataObjectClassAlias(), $data)
            );
        }

        return Mage::objects($this->_dataObjectIds[$argsHash]);
    }

    /**
     * Applies loaded data
     *
     * @see EcomDev_PHPUnit_Model_Test_LoadableInterface::apply()
     */
    public function apply()
    {
        // For now it does nothing :(
        return $this;
    }

    /**
     * Removes objects created in object cache
     * Clears loaded data property
     *
     * @see EcomDev_PHPUnit_Model_Test_LoadableInterface::discard()
     */
    public function discard()
    {
        foreach ($this->_dataObjectIds as $objectId) {
            Mage::objects()->delete($objectId);
        }

        $this->_dataObjectIds = array();
        $this->_loadedData = null;

        return $this;
    }

    /**
     * Check that expectations is loaded
     *
     * @return boolean
     */
    public function isLoaded()
    {
        return $this->_loadedData !== null;
    }

    /**
     * Loads expected data from test case annotations
     *
     * @see EcomDev_PHPUnit_Model_Test_LoadableInterface::loadByTestCase()
     */
    public function loadByTestCase(PHPUnit_Framework_TestCase $testCase)
    {
        $expectations = EcomDev_PHPUnit_Test_Case_Util::getAnnotationByNameFromClass(
            get_class($testCase), 'loadExpectation', array('class', 'method'), $testCase->getName(false)
        );

        if (!$expectations) {
            $expectations[] = $testCase->getName(false);
        }

        $expectationData = array();

        foreach ($expectations as $expectation) {
            if (empty($expectation)) {
                $expectation = $testCase->getName(false);
            }

            $expectationFile = EcomDev_PHPUnit_Test_Case_Util::getYamlLoader(get_class($testCase))
                ->resolveFilePath(
                    get_class($testCase), EcomDev_PHPUnit_Model_Yaml_Loader::TYPE_EXPECTATION, $expectation
                );

            if (!$expectationFile) {
                $text = 'There was no expectation defined for current test case';
                if ($expectation) {
                    $text = sprintf('Cannot load expectation %s', $expectation);
                }
                throw new RuntimeException($text);
            }

            $expectationData = array_merge_recursive(
                $expectationData, EcomDev_PHPUnit_Test_Case_Util::getYamlLoader()->load($expectationFile)
            );
        }

        $this->_loadedData = new Varien_Object($expectationData);
        return $this;
    }


}