PhantomJsDriverFactory::createDriver() - Code Metrics - Inspection of "Added PhantomJsDriverFactory to project" - minkphp/phpunit-mink - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#75)

by Malte

created 2017-03-17 20:36 UTC

PhantomJsDriverFactory::createDriver() A

↳ Parent: PhantomJsDriverFactory

Complexity

Conditions	2
Paths	2

Size

Total Lines	15
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2.686

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	15
ccs	4
cts	9
cp	0.4444
rs	9.4285
cc	2
eloc	9
nc	2
nop	1
crap	2.686

<?php
/**
 * This file is part of the phpunit-mink library.
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 *
 * @copyright Alexander Obuhovich <[email protected]>
 * @link      https://github.com/aik099/phpunit-mink
 */


namespace aik099\PHPUnit\MinkDriver;


use aik099\PHPUnit\BrowserConfiguration\BrowserConfiguration;
use Behat\Mink\Driver\DriverInterface;

class PhantomJsDriverFactory implements IMinkDriverFactory
{

	/**
	 * Returns driver name, that can be used in browser configuration.
	 *
	 * @return string
	 */
	public function getDriverName()
	{
		return 'phantomjs';
	}

	/**
	 * Returns default values for browser configuration.
	 *
	 * @return array
	 */
	public function getDriverDefaults()
	{
		return array(
			'host' => 'localhost',
			'driver' => 'phantomjs',
			'driverOptions' => array(),
			'browserName' => 'phantomjs',
			'port' => 8510,
		);
	}

	/**
	 * Returns a new driver instance according to the browser configuration.
	 *
	 * @param BrowserConfiguration $browser The browser configuration.
	 *
	 * @return DriverInterface
	 */

	public function createDriver(BrowserConfiguration $browser)
	{
		if ( !class_exists('Zumba\Mink\Driver\PhantomJSDriver') ) {
			throw new \RuntimeException(
				'Install MinkPhantomJSDriver in order to use phantomjs driver.'
			);
		}

		return new \Zumba\Mink\Driver\PhantomJSDriver(sprintf(
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
			'http://%s:%s%s',
			$browser->getHost(),
			$browser->getPort(),
			'/api'
		));
	}

}


1		<?php
2		/**
3		* This file is part of the phpunit-mink library.
4		* For the full copyright and license information, please view
5		* the LICENSE file that was distributed with this source code.
6		*
7		* @copyright Alexander Obuhovich <[email protected]>
8		* @link https://github.com/aik099/phpunit-mink
9		*/
10
11
12		namespace aik099\PHPUnit\MinkDriver;
13
14
15		use aik099\PHPUnit\BrowserConfiguration\BrowserConfiguration;
16		use Behat\Mink\Driver\DriverInterface;
17
18		class PhantomJsDriverFactory implements IMinkDriverFactory
19		{
20
21		/**
22		* Returns driver name, that can be used in browser configuration.
23		*
24		* @return string
25		*/
26	11	public function getDriverName()
27		{
28	11	return 'phantomjs';
29		}
30
31		/**
32		* Returns default values for browser configuration.
33		*
34		* @return array
35		*/
36	1	public function getDriverDefaults()
37		{
38		return array(
39	1	'host' => 'localhost',
40	1	'driver' => 'phantomjs',
41	1	'driverOptions' => array(),
42	1	'browserName' => 'phantomjs',
43	1	'port' => 8510,
44	1	);
45		}
46
47		/**
48		* Returns a new driver instance according to the browser configuration.
49		*
50		* @param BrowserConfiguration $browser The browser configuration.
51		*
52		* @return DriverInterface
53		*/
		0 ignored issues – show Coding Style Documentation introduced 2016-02-01 03:40 UTC by Report Bug Copy Issue Report Missing @throws tag in function comment Loading history...
54	1	public function createDriver(BrowserConfiguration $browser)
55		{
56	1	if ( !class_exists('Zumba\Mink\Driver\PhantomJSDriver') ) {
57	1	throw new \RuntimeException(
58		'Install MinkPhantomJSDriver in order to use phantomjs driver.'
59	1	);
60		}
61
62		return new \Zumba\Mink\Driver\PhantomJSDriver(sprintf(
		0 ignored issues – show Bug Best Practice introduced 2017-03-17 20:35 UTC by Report Bug Copy Issue Report The return type of `return new \Zumba\Mink\D...r->getPort(), '/api'));` (`Zumba\Mink\Driver\PhantomJSDriver`) is incompatible with the return type declared by the interface `aik099\PHPUnit\MinkDrive...erFactory::createDriver` of type `Behat\Mink\Driver\DriverInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
63		'http://%s:%s%s',
64		$browser->getHost(),
65		$browser->getPort(),
66		'/api'
67		));
68		}
69
70		}
71

minkphp / phpunit-mink

Pull Request — master (#75)

PhantomJsDriverFactory::createDriver() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like