SeleniumHelper::cancelForm() - Code Metrics - Inspection of "Merge pull request #3 from PagaMasTarde/v1.0.3" - pagantis/selenium-form-utils - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9672f8...4e6ecf )

unknown

created 2018-08-27 08:26 UTC

SeleniumHelper::cancelForm() A

↳ Parent: SeleniumHelper

Complexity

Conditions	1
Paths	1

Size

Total Lines	16
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	10
nc	1
nop	2
dl	0
loc	16
rs	9.9332
c	0
b	0
f	0

<?php

namespace PagaMasTarde\SeleniumFormUtils;

use Facebook\WebDriver\WebDriver;
use Facebook\WebDriver\WebDriverBy;
use Facebook\WebDriver\WebDriverExpectedCondition;
use PagaMasTarde\SeleniumFormUtils\Step\AbstractStep;
use PagaMasTarde\SeleniumFormUtils\Step\Result\Status\Approved;

/**
 * Class SeleniumHelper
 * @package PagaMasTarde\SeleniumFormUtils
 */
class SeleniumHelper
{
    /**
     * Form base domain, initial status to verify before start testing
     */
    const FORM_BASE_URL = 'https://form.pagamastarde.com';

    /**
     * @var WebDriver
     */
    static protected $webDriver;

    /**
     * @var string $mobilePhone needed to identify returning users
     */
    static public $mobilePhone = null;

    /**
     * @param WebDriver $webDriver
     * @param string $mobilePhone
     *
     * @throws \Exception
     */
    public static function finishForm(WebDriver $webDriver, $mobilePhone = null)
    {
        self::$webDriver = $webDriver;
        self::$mobilePhone = $mobilePhone;
        self::waitToLoad();
        self::removeCookiesNotification();
        self::validateFormUrl();
        $maxSteps = 15;
        do {
            $formStep = self::getFormStep();
            $formStepClass = self::getStepClass($formStep);
            /** @var AbstractStep $stepClass */
            $stepClass = new $formStepClass(self::$webDriver);
            $stepClass->run();
            self::waitToLoad();
            --$maxSteps;
        } while ($formStep !== Approved::STEP && $maxSteps > 0);

        if ($maxSteps <= 0) {
            throw new \Exception('Error while finishing form, step: ' . $formStep);
        }
    }

    /**
     * @param WebDriver $webDriver
     * @param string $mobilePhone
     *
     * @throws \Exception
     */
    public static function cancelForm(WebDriver $webDriver, $mobilePhone = null)
    {
        self::$webDriver = $webDriver;
        self::$mobilePhone = $mobilePhone;
        self::waitToLoad();
        self::removeCookiesNotification();
        self::validateFormUrl();

        self::$webDriver->wait()->until(
            WebDriverExpectedCondition::elementToBeClickable(
                WebDriverBy::name('back_to_store_button')
            )
        );

        $formCancel = self::$webDriver->findElement(WebDriverBy::name('back_to_store_button'));
        $formCancel->click();
    }

    /**
     * @throws \Exception
     */
    protected static function validateFormUrl()
    {
        $currentUrl = self::$webDriver->getCurrentURL();
        if (strpos($currentUrl, self::FORM_BASE_URL) === false) {
            throw new \Exception('Unable to identify form url');
        }
    }

    /**
     * Get the step of the form from the URL: '/result/status/approved'
     *
     * @return string
     */
    protected static function getFormStep()
    {
        $path = parse_url(self::$webDriver->getCurrentURL(), PHP_URL_PATH);
        $arguments = explode(DIRECTORY_SEPARATOR, $path);
        $step = '';
        for ($i = 2; $i < count($arguments); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
            $step .= DIRECTORY_SEPARATOR.$arguments[$i];
        }

        return $step;
    }

    /**
     * Turn the form step into a selenium handler class:
     * from: '/result/status-approved' to '\Result\StatusApproved'
     *
     * @param $formStep
     *
     * @return string
     */
    protected static function getStepClass($formStep)
    {
        $formSteps = explode(DIRECTORY_SEPARATOR, $formStep);
        $stepClass = 'PagaMasTarde\SeleniumFormUtils\Step';
        foreach ($formSteps as $formStep) {

            if ($formStep !== '') {
                $stepClass .= "\\".str_replace('-', '', ucwords($formStep, '-'));
            }
        }

        return $stepClass;
    }

    /**
     * @throws \Facebook\WebDriver\Exception\NoSuchElementException
     * @throws \Facebook\WebDriver\Exception\TimeOutException
     */
    public static function waitToLoad()
    {
        $element = WebDriverBy::cssSelector(".Loading .is-disabled");
        $condition = WebDriverExpectedCondition::presenceOfElementLocated($element);
        self::$webDriver->wait()->until($condition);
    }

    /**
     * @throws \Facebook\WebDriver\Exception\NoSuchElementException
     * @throws \Facebook\WebDriver\Exception\TimeOutException
     */
    public static function removeCookiesNotification()
    {
        $element = WebDriverBy::id('sg-notification-global-trigger');
        $condition = WebDriverExpectedCondition::presenceOfElementLocated($element);
        self::$webDriver->wait()->until($condition);
        self::$webDriver->findElement($element)->click();
    }
}


1			<?php
2
3			namespace PagaMasTarde\SeleniumFormUtils;
4
5			use Facebook\WebDriver\WebDriver;
6			use Facebook\WebDriver\WebDriverBy;
7			use Facebook\WebDriver\WebDriverExpectedCondition;
8			use PagaMasTarde\SeleniumFormUtils\Step\AbstractStep;
9			use PagaMasTarde\SeleniumFormUtils\Step\Result\Status\Approved;
10
11			/**
12			* Class SeleniumHelper
13			* @package PagaMasTarde\SeleniumFormUtils
14			*/
15			class SeleniumHelper
16			{
17			/**
18			* Form base domain, initial status to verify before start testing
19			*/
20			const FORM_BASE_URL = 'https://form.pagamastarde.com';
21
22			/**
23			* @var WebDriver
24			*/
25			static protected $webDriver;
26
27			/**
28			* @var string $mobilePhone needed to identify returning users
29			*/
30			static public $mobilePhone = null;
31
32			/**
33			* @param WebDriver $webDriver
34			* @param string $mobilePhone
35			*
36			* @throws \Exception
37			*/
38			public static function finishForm(WebDriver $webDriver, $mobilePhone = null)
39			{
40			self::$webDriver = $webDriver;
41			self::$mobilePhone = $mobilePhone;
42			self::waitToLoad();
43			self::removeCookiesNotification();
44			self::validateFormUrl();
45			$maxSteps = 15;
46			do {
47			$formStep = self::getFormStep();
48			$formStepClass = self::getStepClass($formStep);
49			/** @var AbstractStep $stepClass */
50			$stepClass = new $formStepClass(self::$webDriver);
51			$stepClass->run();
52			self::waitToLoad();
53			--$maxSteps;
54			} while ($formStep !== Approved::STEP && $maxSteps > 0);
55
56			if ($maxSteps <= 0) {
57			throw new \Exception('Error while finishing form, step: ' . $formStep);
58			}
59			}
60
61			/**
62			* @param WebDriver $webDriver
63			* @param string $mobilePhone
64			*
65			* @throws \Exception
66			*/
67			public static function cancelForm(WebDriver $webDriver, $mobilePhone = null)
68			{
69			self::$webDriver = $webDriver;
70			self::$mobilePhone = $mobilePhone;
71			self::waitToLoad();
72			self::removeCookiesNotification();
73			self::validateFormUrl();
74
75			self::$webDriver->wait()->until(
76			WebDriverExpectedCondition::elementToBeClickable(
77			WebDriverBy::name('back_to_store_button')
78			)
79			);
80
81			$formCancel = self::$webDriver->findElement(WebDriverBy::name('back_to_store_button'));
82			$formCancel->click();
83			}
84
85			/**
86			* @throws \Exception
87			*/
88			protected static function validateFormUrl()
89			{
90			$currentUrl = self::$webDriver->getCurrentURL();
91			if (strpos($currentUrl, self::FORM_BASE_URL) === false) {
92			throw new \Exception('Unable to identify form url');
93			}
94			}
95
96			/**
97			* Get the step of the form from the URL: '/result/status/approved'
98			*
99			* @return string
100			*/
101			protected static function getFormStep()
102			{
103			$path = parse_url(self::$webDriver->getCurrentURL(), PHP_URL_PATH);
104			$arguments = explode(DIRECTORY_SEPARATOR, $path);
105			$step = '';
106			for ($i = 2; $i < count($arguments); $i++) {
			0 ignored issues – show Performance Best Practice introduced 2018-08-24 08:41 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
107			$step .= DIRECTORY_SEPARATOR.$arguments[$i];
108			}
109
110			return $step;
111			}
112
113			/**
114			* Turn the form step into a selenium handler class:
115			* from: '/result/status-approved' to '\Result\StatusApproved'
116			*
117			* @param $formStep
118			*
119			* @return string
120			*/
121			protected static function getStepClass($formStep)
122			{
123			$formSteps = explode(DIRECTORY_SEPARATOR, $formStep);
124			$stepClass = 'PagaMasTarde\SeleniumFormUtils\Step';
125			foreach ($formSteps as $formStep) {
			0 ignored issues – show introduced 2018-08-24 08:41 UTC by Report Bug Copy Issue Report `$formStep` is overwriting one of the parameters of this function. Loading history...
126			if ($formStep !== '') {
127			$stepClass .= "\\".str_replace('-', '', ucwords($formStep, '-'));
128			}
129			}
130
131			return $stepClass;
132			}
133
134			/**
135			* @throws \Facebook\WebDriver\Exception\NoSuchElementException
136			* @throws \Facebook\WebDriver\Exception\TimeOutException
137			*/
138			public static function waitToLoad()
139			{
140			$element = WebDriverBy::cssSelector(".Loading .is-disabled");
141			$condition = WebDriverExpectedCondition::presenceOfElementLocated($element);
142			self::$webDriver->wait()->until($condition);
143			}
144
145			/**
146			* @throws \Facebook\WebDriver\Exception\NoSuchElementException
147			* @throws \Facebook\WebDriver\Exception\TimeOutException
148			*/
149			public static function removeCookiesNotification()
150			{
151			$element = WebDriverBy::id('sg-notification-global-trigger');
152			$condition = WebDriverExpectedCondition::presenceOfElementLocated($element);
153			self::$webDriver->wait()->until($condition);
154			self::$webDriver->findElement($element)->click();
155			}
156			}
157

pagantis / selenium-form-utils

Push — master ( 9672f8...4e6ecf )

SeleniumHelper::cancelForm() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like