AbstractDatabaseTest::getPdo() - Code Metrics - Inspection of "Configured Travis (1)" - tollwerk/admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4d3cf1...203efa )

by Joschi

created 2016-10-07 20:21 UTC

AbstractDatabaseTest::getPdo() A

↳ Parent: AbstractDatabaseTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * admin
 *
 * @category    Apparat
 * @package     Apparat\Server
 * @subpackage  Tollwerk\Admin\Tests
 * @author      Joschi Kuphal <[email protected]> / @jkphl
 * @copyright   Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Tollwerk\Admin\Tests;

use Doctrine\DBAL\DriverManager;
use PHPUnit_Extensions_Database_DB_IDatabaseConnection;

/**
 * Abstract database test case
 *
 * @package Tollwerk\Admin
 * @subpackage Tollwerk\Admin\Tests
 */
abstract class AbstractDatabaseTest extends \PHPUnit_Extensions_Database_TestCase
{
    /**
     * PDO instance
     *
     * @var null
     */
    private static $pdo = null;
    /**
     * DBAL instance
     *
     * @var null
     */
    private static $dbal = null;

    // only instantiate PHPUnit_Extensions_Database_DB_IDatabaseConnection once per test
    /**
     * Connection
     *
     * @var PHPUnit_Extensions_Database_DB_IDatabaseConnection
     */
    private $conn = null;

    /**
     * Returns the test database connection.
     *
     * @return PHPUnit_Extensions_Database_DB_IDatabaseConnection Database connection
     */
    final protected function getConnection()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

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

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if ($this->conn === null) {
            if (self::$pdo == null) {
                self::$pdo = new \PDO($GLOBALS['DB_DSN'], $GLOBALS['DB_USER'], $GLOBALS['DB_PASSWD']);

            }
            $this->conn = $this->createDefaultDBConnection(self::$pdo, $GLOBALS['DB_DBNAME']);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        }

        return $this->conn;
    }

    /**
     * Return the PDO instance
     *
     * @return \PDO PDO instance
     */
    protected function getPdo()
    {
        return $this->getConnection()->getConnection();
    }

    /**
     * Return the DBAL connection
     *
     * @return \Doctrine\DBAL\Connection
     */
    protected function getDbal()
    {
        if (self::$dbal === null) {
            self::$dbal = DriverManager::getConnection(array('pdo' => $this->getPdo()));

        }

        return self::$dbal;
    }
}


1			<?php
2
3			/**
4			* admin
5			*
6			* @category Apparat
7			* @package Apparat\Server
8			* @subpackage Tollwerk\Admin\Tests
9			* @author Joschi Kuphal <[email protected]> / @jkphl
10			* @copyright Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
11			* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12			*/
13
14			/***********************************************************************************
15			* The MIT License (MIT)
16			*
17			* Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
18			*
19			* Permission is hereby granted, free of charge, to any person obtaining a copy of
20			* this software and associated documentation files (the "Software"), to deal in
21			* the Software without restriction, including without limitation the rights to
22			* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23			* the Software, and to permit persons to whom the Software is furnished to do so,
24			* subject to the following conditions:
25			*
26			* The above copyright notice and this permission notice shall be included in all
27			* copies or substantial portions of the Software.
28			*
29			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31			* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32			* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33			* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34			* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35			***********************************************************************************/
36
37			namespace Tollwerk\Admin\Tests;
38
39			use Doctrine\DBAL\DriverManager;
40			use PHPUnit_Extensions_Database_DB_IDatabaseConnection;
41
42			/**
43			* Abstract database test case
44			*
45			* @package Tollwerk\Admin
46			* @subpackage Tollwerk\Admin\Tests
47			*/
48			abstract class AbstractDatabaseTest extends \PHPUnit_Extensions_Database_TestCase
49			{
50			/**
51			* PDO instance
52			*
53			* @var null
54			*/
55			private static $pdo = null;
56			/**
57			* DBAL instance
58			*
59			* @var null
60			*/
61			private static $dbal = null;
62
63			// only instantiate PHPUnit_Extensions_Database_DB_IDatabaseConnection once per test
64			/**
65			* Connection
66			*
67			* @var PHPUnit_Extensions_Database_DB_IDatabaseConnection
68			*/
69			private $conn = null;
70
71			/**
72			* Returns the test database connection.
73			*
74			* @return PHPUnit_Extensions_Database_DB_IDatabaseConnection Database connection
75			*/
76			final protected function getConnection()
			0 ignored issues – show Coding Style introduced 2016-10-07 20:28 UTC by Report Bug Copy Issue Report `getConnection` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
77			{
78			if ($this->conn === null) {
79			if (self::$pdo == null) {
80			self::$pdo = new \PDO($GLOBALS['DB_DSN'], $GLOBALS['DB_USER'], $GLOBALS['DB_PASSWD']);
			0 ignored issues – show Documentation Bug introduced 2016-10-07 20:28 UTC by Report Bug Copy Issue Report It seems like `new \PDO($GLOBALS['DB_DS... $GLOBALS['DB_PASSWD'])` of type `object<PDO>` is incompatible with the declared type `null` of property `$pdo`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
81			}
82			$this->conn = $this->createDefaultDBConnection(self::$pdo, $GLOBALS['DB_DBNAME']);
			0 ignored issues – show Bug introduced 2016-10-07 20:28 UTC by Report Bug Copy Issue Report It seems like `self::$pdo` can be `null`; however, `createDefaultDBConnection()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
83			}
84
85			return $this->conn;
86			}
87
88			/**
89			* Return the PDO instance
90			*
91			* @return \PDO PDO instance
92			*/
93			protected function getPdo()
94			{
95			return $this->getConnection()->getConnection();
96			}
97
98			/**
99			* Return the DBAL connection
100			*
101			* @return \Doctrine\DBAL\Connection
102			*/
103			protected function getDbal()
104			{
105			if (self::$dbal === null) {
106			self::$dbal = DriverManager::getConnection(array('pdo' => $this->getPdo()));
			0 ignored issues – show Documentation Bug introduced 2016-10-07 20:28 UTC by Report Bug Copy Issue Report It seems like `\Doctrine\DBAL\DriverMan...o' => $this->getPdo()))` of type `object<Doctrine\DBAL\Connection>` is incompatible with the declared type `null` of property `$dbal`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
107			}
108
109			return self::$dbal;
110			}
111			}
112

tollwerk / admin

Push — master ( 4d3cf1...203efa )

AbstractDatabaseTest::getPdo() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like