Magefix\Plugin\Spinner

Complexity

Total Complexity

14

Size/Duplication

Total Lines	129
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	5
Bugs	1	Features	2

8 Methods

Rating	Name	Duplication	Size	Complexity
A	spin()	0	16	4
A	spinUntilVisible()	0	6	1
A	spinUntilInvisible()	0	6	1
A	spinAndClick()	0	6	1
A	spinAndPress()	0	6	1
A	spinAndDo()	0	6	1
A	_throwBacktraceException()	0	9	1
A	_spinnerAction()	0	16	4

<?php

namespace Magefix\Plugin;

/**
 * Class Spinner
 *
 * Provide "waiting" functionality to contexts
 *
 * @package Magefix\Plugin
 * @author  Carlo Tasca <ctasca@inviqa.com>
 */
trait Spinner
{
    /**
     * @param $lambda
     * @param int $wait
     * @return bool
     * @throws \Exception
     */
    public function spin($lambda, $wait = 60)
    {
        for ($i = 0; $i < $wait; $i++) {
            try {
                if ($lambda($this)) {
                    return true;
                }
            } catch (\Exception $e) {
                // do nothing
            }

            sleep(1);
        }

        $this->_throwBacktraceException();
    }

    /**
     * Spin until element is visible. Default timeout is 60 seconds.
     *
     * @param string|Object $element
     * @param int $wait
     */
    public function spinUntilVisible($element, $wait = 60)
    {
        $this->spin(function ($context) use ($element) {
            return $this->_spinnerAction($context, $element, 'isVisible', true);
        }, $wait);
    }

    /**
     * Spin until element is not visible. Default timeout is 60 seconds.
     *
     * @param string|Object $element
     * @param int $wait
     */
    public function spinUntilInvisible($element, $wait = 60)
    {
        $this->spin(function ($context) use ($element) {
            return $this->_spinnerAction($context, $element, 'isVisible', false);
        }, $wait);
    }

    /**
     * Spin and click element. Default timeout is 60 seconds.
     *
     * @param string|Object $element
     * @param int $wait
     */
    public function spinAndClick($element, $wait = 60)
    {
        $this->spin(function ($context) use ($element) {
            return $this->_spinnerAction($context, $element, 'click');
        }, $wait);
    }

    /**
     * Spin and press element. Default timeout is 60 seconds.
     *
     * @param string|Object $element
     * @param int $wait
     */
    public function spinAndPress($element, $wait = 60)
    {
        $this->spin(function ($context) use ($element) {
            return $this->_spinnerAction($context, $element, 'press');
        }, $wait);
    }

    /**
     * Spin and carry out given action on an element. Default timeout is 60 seconds.
     *
     * @param string|Object $element
     * @param $action
     * @param null $condition
     * @param int $wait
     */
    public function spinAndDo($element, $action, $condition = null, $wait = 60)
    {
        $this->spin(function ($context) use ($element, $action, $condition) {
            return $this->_spinnerAction($context, $element, $action, $condition);
        }, $wait);
    }

    /**
     * @throws \Exception
     */
    protected function _throwBacktraceException()
    {
        $backtrace = debug_backtrace();

        throw new \Exception(
            "Timeout thrown by " . $backtrace[1]['class'] . "::" . $backtrace[1]['function'] . "()\n" .
            $backtrace[1]['file'] . ", line " . $backtrace[1]['line']
        );
    }

    /**
     * @param $context
     * @param $element
     * @param $action
     * @param null $condition
     * @return bool
     */
    private function _spinnerAction($context, $element, $action, $condition = null)
    {
        if (is_object($element)) {
            if (!is_null($condition)) {
                return $element->$action() === $condition;
            }
            $element->$action();
        } else {
            if (!is_null($condition)) {
                return  $context->getElement($element)->$action() === $condition;
            }
            $context->getElement($element)->$action();
        }

        return true;
    }
}