Zookal_Mock_Model_Mocks_Abstract

Complexity

Total Complexity

21

Size/Duplication

Total Lines	190
Duplicated Lines	0 %

Coupling/Cohesion

Components	4
Dependencies	1

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	3
A	__call()	0	17	3
A	_isReturnFalse()	0	5	2
A	_isReturnNull()	0	5	2
A	_isReturnThis()	0	7	3
A	getMessages()	0	4	1
A	_log()	0	6	2
A	getHelper()	0	7	2
A	getMockMethodsReturnFalse()	0	4	1
A	getMockMethodsReturnNull()	0	4	1
A	getMockMethodsReturnThis()	0	4	1

<?php

/**
 * @category    Zookal_Mock
 * @package     Model
 * @author      Cyrill Schumacher | {firstName}@{lastName}.fm | @SchumacherFM
 * @copyright   Copyright (c) Zookal Pty Ltd
 * @license     OSL - Open Software Licence 3.0 | http://opensource.org/licenses/osl-3.0.php
 */

/**
 * Class Zookal_Mock_Model_Mocks_Abstract
 * @method Zookal_Mock_Model_Mocks_Abstract getWildCatsCollection()
 * @method Zookal_Mock_Model_Mocks_Abstract zzz() Calling this method throws an error in the test
 */
abstract class Zookal_Mock_Model_Mocks_Abstract

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{

    /**
     * @var Zookal_Mock_Helper_Data
     */
    protected $_helper = null;

    protected $_isLogEnabled = false;

    protected $_mockMethodsReturnThis = array(
        'add'            => 1, // e.g. addCustomerFilter ...
        'cle'            => 1, // e.g. clean() clear() clearasil()

36% of this comment could be valid code. Did you maybe forget this after debugging?

        'collectrates'   => 1, // e.g. Mage_Shipping_Model_Shipping::collectRates()
        'fil'            => 1, // e.g. filterByCustomerId() when getCollection() is called
        'gettotals'      => 1, // Special case in Sales_Collection
        'gro'            => 1, // e.g. groupByCustomer
        'joi'            => 1, // e.g. joinCustomerName
        'loa'            => 1, // e.g. load and loadBy....
        'lim'            => 1, // e.g. limit() -> on collection
        'ord'            => 1, // e.g. orderByTotalAmount
        'pre'            => 1, // e.g. prepare()
        'resetsortorder' => 1,
        'renewsession'   => 1,
        'sav'            => 1, // e.g. save()
        'set'            => 1,
        'too'            => 1, // e.g. toOptionArray, toOptionHash
        'uns'            => 1,
        'pro'            => 1, // Weee Helper->processTierPrices()

38% of this comment could be valid code. Did you maybe forget this after debugging?

    );
    protected $_mockMethodsReturnNull = array(
        'count' => 1,
        'get'   => 1,
        'toh'   => 1, // toHtml() on blocks
    );
    protected $_mockMethodsReturnFalse = array(
        'displaygirthvalue' => 1, // Mage_Usa helper in packaging/popup.phtml
        'can'               => 1, // canCapture and all other payment related methods
        'has'               => 1,
        'isa'               => 1, // e.g. isAvailable -> Payment
        'isd'               => 1, // e.g. isDiscounted e.g. Weee helper
        'ise'               => 1, // e.g. isEnabled e.g. Weee helper
        'isg'               => 1, // e.g. isGateway -> Payment
        'isi'               => 1, // e.g. isInitializeNeeded -> Payment
        'ism'               => 1, // e.g. isMessagesAvailable -> GiftMessage
        'iss'               => 1, // e.g. isSubscribed
        'ist'               => 1, // e.g. isTaxable in Weee
        'isv'               => 1, // e.g. isValid...
        'isl'               => 1, // e.g. isLoggedIn
        'use'               => 1,
        'typ'               => 1, // Weee Helper->typeofdisplay()

38% of this comment could be valid code. Did you maybe forget this after debugging?

        'val'               => 1, // Weee Helper->validateCatalogPricesAndFptConfiguration()

38% of this comment could be valid code. Did you maybe forget this after debugging?

        'inc'               => 1, // Weee Helper->includeInSubtotal()

38% of this comment could be valid code. Did you maybe forget this after debugging?

    );

    /**
     * @param Zookal_Mock_Helper_Data $helper
     */
    public function __construct($helper = null)
    {
        // $helper is sometimes an empty array ...
        if (false === empty($helper) && $helper instanceof Zookal_Mock_Helper_Data) {
            $this->_helper = $helper;
        }

        $this->_isLogEnabled = $this->getHelper()->isLogMethodEnabled();
    }

    /**
     * Add/Set/Get attribute wrapper
     *
     * @param string $method
     * @param array  $args
     *
     * @return $this|bool|null
     * @throws Varien_Exception
     */
    public function __call($method, $args)
    {
        $lowerMethod = strtolower($method);
        $firstThree  = substr($lowerMethod, 0, 3);
        $methods     = array(
            '_isReturnThis'  => $this,
            '_isReturnNull'  => null,
            '_isReturnFalse' => false,
        );
        foreach ($methods as $method => $return) {
            if (true === $this->$method($lowerMethod, $firstThree)) {
                $this->_log('return: ' . $method);
                return $return;
            }
        }
        throw new Varien_Exception("Invalid method " . get_class($this) . "::" . $method . ' Cannot print args ...');
    }

    /**
     * @param string $lowerMethod
     * @param string $firstThree
     *
     * @return bool
     */
    protected function _isReturnFalse($lowerMethod, $firstThree)
    {
        return isset($this->_mockMethodsReturnFalse[$firstThree]) ||
        isset($this->_mockMethodsReturnFalse[$lowerMethod]);
    }

    /**
     * @param string $lowerMethod
     * @param string $firstThree
     *
     * @return bool
     */
    protected function _isReturnNull($lowerMethod, $firstThree)
    {
        return isset($this->_mockMethodsReturnNull[$lowerMethod]) ||
        isset($this->_mockMethodsReturnNull[$firstThree]);
    }

    /**
     * @param string $lowerMethod
     * @param string $firstThree
     *
     * @return bool
     */
    protected function _isReturnThis($lowerMethod, $firstThree)
    {
        // e.g. getCollection() getItemCollection() and so on
        return strpos($lowerMethod, 'collection') !== false ||
        isset($this->_mockMethodsReturnThis[$lowerMethod]) ||
        isset($this->_mockMethodsReturnThis[$firstThree]);
    }

    /**
     * Special case if Mage_Tag is disabled or any other module which rely on initLayoutMessages
     *
     * @return Mage_Core_Model_Message_Collection
     */
    public function getMessages()
    {
        return Mage::getModel('core/message_collection');
    }

    /**
     * uncomment this in dev env to see what methods are called
     *
     * @param string $msg
     */
    protected function _log($msg)
    {
        if (true === $this->_isLogEnabled) {
            Mage::log(get_class($this) . '::' . $msg, null, 'mock.log');
        }
    }

    /**
     * @return Zookal_Mock_Helper_Data
     */
    public function getHelper()
    {
        if (null === $this->_helper) {
            $this->_helper = Mage::helper('zookal_mock');
        }
        return $this->_helper;
    }

    /**
     * @return array
     */
    public function getMockMethodsReturnFalse()
    {
        return $this->_mockMethodsReturnFalse;
    }

    /**
     * @return array
     */
    public function getMockMethodsReturnNull()
    {
        return $this->_mockMethodsReturnNull;
    }

    /**
     * @return array
     */
    public function getMockMethodsReturnThis()
    {
        return $this->_mockMethodsReturnThis;
    }
}