BrowserTrait::getBrowserModule() - Code Metrics - ByTIC/Codeception - Measure and Improve Code Quality continuously with Scrutinizer

BrowserTrait::getBrowserModule() A
last analyzed 2021-04-29 20:30 UTC

↳ Parent: BrowserTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2

<?php

namespace ByTIC\Codeception\Helper\Traits;

use Codeception\Module\PhpBrowser;

/**
 * Class UriTrait
 * @package ByTIC\Common\Tests\Helper\Traits
 */
trait BrowserTrait
{
    use AbstractTrait;

    /**
     * @param $method
     * @param $url
     * @param $post
     *
     * @throws \Codeception\Exception\ModuleException
     */
    public function loadPage($method, $url, $post)
    {
        return $this->getBrowserModule()->_loadPage($method, $url, $post);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * @return \Codeception\Module|PhpBrowser
     * @throws \Codeception\Exception\ModuleException
     */
    protected function getBrowserModule()
    {
        return $this->getModule('PhpBrowser');
    }


    /**
     * @param $name
     *
     * @return mixed
     * @throws \Codeception\Exception\ModuleException
     */
    public function getCurrentUriParam($name)
    {
        $uri   = $this->getCurrentUri();
        $query = parse_url($uri, PHP_URL_QUERY);
        parse_str($query, $params);

        return $params[$name];
    }

    /**
     * @return mixed
     * @throws \Codeception\Exception\ModuleException
     */
    public function getCurrentUri()
    {
        return $this->getBrowserModule()->_getCurrentUri();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }


    /**
     * @return mixed
     * @throws \Codeception\Exception\ModuleException
     */
    public function getCurrentUrl()
    {
        return $this->getBrowserModule()->client->getHistory()->current()->getUri();

    }


    /**
     * @param $expected
     *
     * @throws \Codeception\Exception\ModuleException
     */
    public function seeFullUrlEquals($expected)
    {
        $url = $this->getCurrentUrl();

        $this->assertEquals($expected, $url);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }
}


1			<?php
2
3			namespace ByTIC\Codeception\Helper\Traits;
4
5			use Codeception\Module\PhpBrowser;
6
7			/**
8			* Class UriTrait
9			* @package ByTIC\Common\Tests\Helper\Traits
10			*/
11			trait BrowserTrait
12			{
13			use AbstractTrait;
14
15			/**
16			* @param $method
17			* @param $url
18			* @param $post
19			*
20			* @throws \Codeception\Exception\ModuleException
21			*/
22			public function loadPage($method, $url, $post)
23			{
24			return $this->getBrowserModule()->_loadPage($method, $url, $post);
			0 ignored issues – show Bug introduced 2020-02-27 19:03 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Codeception\Module` as the method `_loadPage()` does only exist in the following sub-classes of `Codeception\Module`: `Codeception\Lib\Framework`, `Codeception\Lib\InnerBrowser`, `Codeception\Module\PhpBrowser`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
25			}
26
27			/**
28			* @return \Codeception\Module\|PhpBrowser
29			* @throws \Codeception\Exception\ModuleException
30			*/
31			protected function getBrowserModule()
32			{
33			return $this->getModule('PhpBrowser');
34			}
35
36
37			/**
38			* @param $name
39			*
40			* @return mixed
41			* @throws \Codeception\Exception\ModuleException
42			*/
43			public function getCurrentUriParam($name)
44			{
45			$uri = $this->getCurrentUri();
46			$query = parse_url($uri, PHP_URL_QUERY);
47			parse_str($query, $params);
48
49			return $params[$name];
50			}
51
52			/**
53			* @return mixed
54			* @throws \Codeception\Exception\ModuleException
55			*/
56			public function getCurrentUri()
57			{
58			return $this->getBrowserModule()->_getCurrentUri();
			0 ignored issues – show Bug introduced 2020-02-27 19:03 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Codeception\Module` as the method `_getCurrentUri()` does only exist in the following sub-classes of `Codeception\Module`: `Codeception\Lib\Framework`, `Codeception\Lib\InnerBrowser`, `Codeception\Module\PhpBrowser`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
59			}
60
61
62			/**
63			* @return mixed
64			* @throws \Codeception\Exception\ModuleException
65			*/
66			public function getCurrentUrl()
67			{
68			return $this->getBrowserModule()->client->getHistory()->current()->getUri();
			0 ignored issues – show Bug introduced 2019-08-10 09:46 UTC by Report Bug Copy Issue Report The property `client` does not seem to exist in `Codeception\Module`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
69			}
70
71
72			/**
73			* @param $expected
74			*
75			* @throws \Codeception\Exception\ModuleException
76			*/
77			public function seeFullUrlEquals($expected)
78			{
79			$url = $this->getCurrentUrl();
80
81			$this->assertEquals($expected, $url);
			0 ignored issues – show Bug introduced 2019-08-10 09:46 UTC by Report Bug Copy Issue Report It seems like `assertEquals()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
82			}
83			}
84

ByTIC / Codeception

BrowserTrait::getBrowserModule() A last analyzed 2021-04-29 20:30 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

BrowserTrait::getBrowserModule() A
last analyzed 2021-04-29 20:30 UTC