AutoConnector::getRelativeUrlConfig() - Code Metrics - Inspection of "Improved code climate" - apparat/object - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3c0880...647f1f )

by Joschi

created 2016-03-28 20:14 UTC

AutoConnector::getRelativeUrlConfig() B

↳ Parent: AutoConnector

Complexity

Conditions	8
Paths	4

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	8

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	13
ccs	8
cts	8
cp	1
rs	7.7777
cc	8
eloc	8
nc	4
nop	1
crap	8

<?php

/**
 * apparat-object
 *
 * @category    Apparat
 * @package     Apparat\Object
 * @subpackage  Apparat\Object\Infrastructure
 * @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 Apparat\Object\Infrastructure\Repository;

use Apparat\Object\Domain\Model\Path\Url;
use Apparat\Object\Domain\Repository\AutoConnectorInterface;
use Apparat\Object\Ports\Repository;

/**
 * Repository auto-connector service
 *
 * @package Apparat\Object
 * @subpackage Apparat\Object\Infrastructure
 */
class AutoConnector implements AutoConnectorInterface
{
    /**
     * Auto-connect a repository with URL default settings
     *
     * @param string $url Repository URL
     * @return boolean Success
     */
    public function connect($url)
    {
        // If it's an absolute URL
        $url = new Url($url);
        $config = $url->isAbsolute() ? $this->getAbsoluteUrlConfig() : $this->getRelativeUrlConfig($url);

        // If a repository configuration has been created
        if ($config !== null) {
            $repository = Repository::register(strval($url), $config);
            return $repository instanceof \Apparat\Object\Domain\Repository\Repository;
        }

        return true;
    }

    /**
     * Get the repository configuration for an absolute URL
     *
     * @return null Repository configuration for an absolute URL
     * @todo
     */
    protected function getAbsoluteUrlConfig()
    {
        return null;
    }

    /**
     * Get the repository configuration for a relative / local URL
     *
     * @param Url $url URL
     * @return array|null Repository configuration for an relative / local URL
     */
    protected function getRelativeUrlConfig(Url $url)
// 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);
    }
}
    {
        // Determine the document root (depending on the SAPI)
        $documentRoot = (php_sapi_name() == 'cli') ?
            realpath(getenv('APPARAT_DOCUMENT_ROOT') ?: (ini_get('doc_root') ?: getcwd())) :
            realpath(empty($_SERVER['DOCUMENT_ROOT']) ? (getenv('APPARAT_DOCUMENT_ROOT') ?: (ini_get('doc_root') ?: getcwd())) : $_SERVER['DOCUMENT_ROOT']);

        // If the is a document root: Create a file repository configuration
        return strlen($documentRoot) ? [
            'type' => FileAdapterStrategy::TYPE,
            'root' => rtrim($documentRoot, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.$url,
        ] : null;
    }
}


1		<?php
2
3		/**
4		* apparat-object
5		*
6		* @category Apparat
7		* @package Apparat\Object
8		* @subpackage Apparat\Object\Infrastructure
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 Apparat\Object\Infrastructure\Repository;
38
39		use Apparat\Object\Domain\Model\Path\Url;
40		use Apparat\Object\Domain\Repository\AutoConnectorInterface;
41		use Apparat\Object\Ports\Repository;
42
43		/**
44		* Repository auto-connector service
45		*
46		* @package Apparat\Object
47		* @subpackage Apparat\Object\Infrastructure
48		*/
49		class AutoConnector implements AutoConnectorInterface
50		{
51		/**
52		* Auto-connect a repository with URL default settings
53		*
54		* @param string $url Repository URL
55		* @return boolean Success
56		*/
57	3	public function connect($url)
58		{
59		// If it's an absolute URL
60	3	$url = new Url($url);
61	3	$config = $url->isAbsolute() ? $this->getAbsoluteUrlConfig() : $this->getRelativeUrlConfig($url);
62
63		// If a repository configuration has been created
64	3	if ($config !== null) {
65	2	$repository = Repository::register(strval($url), $config);
66	2	return $repository instanceof \Apparat\Object\Domain\Repository\Repository;
67		}
68
69	1	return true;
70		}
71
72		/**
73		* Get the repository configuration for an absolute URL
74		*
75		* @return null Repository configuration for an absolute URL
76		* @todo
77		*/
78	1	protected function getAbsoluteUrlConfig()
79		{
80	1	return null;
81		}
82
83		/**
84		* Get the repository configuration for a relative / local URL
85		*
86		* @param Url $url URL
87		* @return array\|null Repository configuration for an relative / local URL
88		*/
89	2	protected function getRelativeUrlConfig(Url $url)
		0 ignored issues – show Coding Style introduced 2016-03-28 20:17 UTC by Report Bug Copy Issue Report `getRelativeUrlConfig` uses the super-global variable `$_SERVER` 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...
90		{
91		// Determine the document root (depending on the SAPI)
92	2	$documentRoot = (php_sapi_name() == 'cli') ?
93	2	realpath(getenv('APPARAT_DOCUMENT_ROOT') ?: (ini_get('doc_root') ?: getcwd())) :
94	2	realpath(empty($_SERVER['DOCUMENT_ROOT']) ? (getenv('APPARAT_DOCUMENT_ROOT') ?: (ini_get('doc_root') ?: getcwd())) : $_SERVER['DOCUMENT_ROOT']);
95
96		// If the is a document root: Create a file repository configuration
97	2	return strlen($documentRoot) ? [
98	2	'type' => FileAdapterStrategy::TYPE,
99	2	'root' => rtrim($documentRoot, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.$url,
100	2	] : null;
101		}
102		}
103

apparat / object

Push — master ( 3c0880...647f1f )

AutoConnector::getRelativeUrlConfig() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like