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

Failed Conditions

Pull Request — master (#75)

by Malte

created 2016-02-01 03:36 UTC

PhantomJsDriverFactory::getDriverName() A

↳ Parent: PhantomJsDriverFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

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

<?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(
				'api_endpoint' => '/api'

			),
			'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 PhantomJSDriver in order to use phantomjs driver.'
			);
		}

		$driverOptions = $browser->getDriverOptions();

		return new \Zumba\Mink\Driver\PhantomJSDriver(sprintf("http://%s:%s%s", $browser->getHost(), $browser->getPort(), $driverOptions['api_endpoint']));
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());
}
	}

}


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	8	public function getDriverName()
27		{
28	8	return 'phantomjs';
29		}
30
31		/**
32		* Returns default values for browser configuration.
33		*
34		* @return array
35		*/
36		public function getDriverDefaults()
37		{
38		return array(
39		'host' => 'localhost',
40		'driver' => 'phantomjs',
41		'driverOptions' => array(
42		'api_endpoint' => '/api'
		0 ignored issues – show introduced 2016-02-01 03:40 UTC by Report Bug Copy Issue Report A comma should follow the last multiline array item. Found: '/api' Loading history...
43		),
44		'browserName' => 'phantomjs',
45		'port' => 8510
		0 ignored issues – show introduced 2016-02-01 03:40 UTC by Report Bug Copy Issue Report A comma should follow the last multiline array item. Found: 8510 Loading history...
46		);
47		}
48
49		/**
50		* Returns a new driver instance according to the browser configuration.
51		*
52		* @param BrowserConfiguration $browser The browser configuration.
53		*
54		* @return DriverInterface
55		*/
		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...
56		public function createDriver(BrowserConfiguration $browser)
57		{
58		if ( !class_exists('Zumba\Mink\Driver\PhantomJSDriver') ) {
59		throw new \RuntimeException(
60		'Install PhantomJSDriver in order to use phantomjs driver.'
61		);
62		}
63
64		$driverOptions = $browser->getDriverOptions();
		0 ignored issues – show introduced 2016-02-01 03:40 UTC by Report Bug Copy Issue Report Variable "driverOptions" is not in valid snake caps format Loading history...
65		return new \Zumba\Mink\Driver\PhantomJSDriver(sprintf("http://%s:%s%s", $browser->getHost(), $browser->getPort(), $driverOptions['api_endpoint']));
		0 ignored issues – show Bug Best Practice introduced 2016-02-01 03:40 UTC by Report Bug Copy Issue Report The return type of `return new \Zumba\Mink\D...ions['api_endpoint']));` (`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... introduced 2016-02-01 03:40 UTC by Report Bug Copy Issue Report Expected 1 blank line before return statement; 0 found Loading history... Coding Style Comprehensibility introduced 2016-02-01 03:40 UTC by Report Bug Copy Issue Report The string literal `http://%s:%s%s` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history... introduced 2016-02-01 03:40 UTC by Report Bug Copy Issue Report Variable "driverOptions" is not in valid snake caps format Loading history... Coding Style introduced 2016-02-01 03:40 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 140 characters; contains 155 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
66		}
67
68		}
69

minkphp / phpunit-mink

Pull Request — master (#75)

PhantomJsDriverFactory::getDriverName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like