Package::__get() - Code Metrics - Inspection of "TORG-148: Replaced preg-match/replace of require b..." - netresearch/kite - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c5752c...f61021 )

unknown

created 2016-06-17 08:31 UTC

Package::__get() D

↳ Parent: Package

Complexity

Conditions	9
Paths	9

Size

Total Lines	25
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	0	Features	1

Metric	Value
cc	9
eloc	21
c	4
b	0
f	1
nc	9
nop	1
dl	0
loc	25
rs	4.909

<?php
/**
 * See class comment
 *
 * PHP Version 5
 *
 * @category Netresearch
 * @package  Netresearch\Kite\Service\Composer
 * @author   Christian Opitz <[email protected]>
 * @license  http://www.netresearch.de Netresearch Copyright
 * @link     http://www.netresearch.de
 */

namespace Netresearch\Kite\Service\Composer;
use Netresearch\Kite\Exception;
use Netresearch\Kite\Service\Composer;

/**
 * Class Package
 *
 * // Composer properties, not necessarily present:
 *
 * @property string      $name      Package name
 * @property string      $version   Package version
 * @property object      $source    Information about the source
 *                                  (may have f.i. "reference")
 *
 * // Additional properties
 *
 * @property string      $path      Package path
 * @property bool        $isRoot    Whether package is root (project)
 * @property array       $requires  The packages from $require as array
 * @property bool        $git       Whether installed package is a get repository
 * @property array       $branches  Git branches (including remote branches)
 * @property array       $upstreams Upstream branches (values) for local branches (keys)
 * @property string|null $branch    The currently checked out branch, if any
 *                                  If package is on a tag this will always be null
 * @property string|null $tag       The currently checked out tag, if any
 * @property string|null $remote    The remote url (no multiple urls supported)
 *
 *
 * @category Netresearch
 * @package  Netresearch\Kite\Service\Composer
 * @author   Christian Opitz <[email protected]>
 * @license  http://www.netresearch.de Netresearch Copyright
 * @link     http://www.netresearch.de
 */
class Package
{
    /**
     * @var Composer
     */
    protected $composer;

    /**
     * @var bool
     */
    protected static $forEachRefHeadSupported = true;

    /**
     * Package constructor.
     *
     * @param Composer      $composer     The parent object
     * @param string|object $composerJson The composer json
     * @param bool          $isRoot       Whether package is root
     */
    public function __construct(Composer $composer, $composerJson, $isRoot = false)
    {
        $this->composer = $composer;

        if (is_string($composerJson)) {
            $path = realpath($composerJson);
            if (!$path) {
                throw new Exception('Could not find ' . $composerJson);
            }
            $this->path = dirname($path);
            $composerJson = json_decode(file_get_contents($path));
            if (!is_object($composerJson)) {
                throw new Exception('Could not load ' . $path);
            }
        }
        foreach (get_object_vars($composerJson) as $key => $value) {
            $this->$key = $value;
        }

        $this->isRoot = $isRoot;
    }

    /**
     * Load lazy properties
     *
     * @param string $name The property name
     *
     * @return mixed
     */
    public function __get($name)
    {
        switch ($name) {
        case 'git':
            $gitDir = $this->path . '/.git';
            $this->git = file_exists($gitDir) && is_dir($gitDir);
            break;
        case 'branches':
        case 'upstreams':
        case 'branch':
        case 'tag':
            $this->loadGitInformation();
            break;
        case 'remote':
            $this->loadRemote();
            break;
        case 'requires':
            $this->loadRequires();
            break;
        default:
            throw new Exception('Invalid property ' . $name);

        }
        return $this->$name;
    }

    /**
     * Mark lazy properties as present
     *
     * @param string $name The name
     *
     * @return bool
     */
    public function __isset($name)
    {
        return in_array($name, ['branches', 'upstreams', 'branch', 'tag', 'git', 'remote', 'requires'], true);
    }

    /**
     * Load the requires - removes inline aliases
     *
     * @return void
     */
    protected function loadRequires()
    {
        $this->requires = isset($this->require) ? get_object_vars($this->require) : array();

        foreach ($this->requires as $package => $constraint) {
            if ($pos = strpos($constraint, ' as ')) {
                if ($hashPos = strpos($constraint, '#')) {
                    // dev-master#old-hash isn't treated by composer, so we don't as well
                    $pos = $hashPos;
                }
                $this->requires[$package] = substr($constraint, 0, $pos);
            }
        }
    }

    /**
     * Reload requires from composer.json
     *
     * @return $this
     */
    public function reloadRequires()
    {
        $file = $this->path . '/composer.json';
        if (file_exists($file)) {
            $composerJson = json_decode(file_get_contents($file));
            unset($this->require);
            if (isset($composerJson->require)) {
                $this->require = $composerJson->require;

            }
            $this->loadRequires();
        }
        return $this;
    }

    /**
     * Get the remote
     *
     * @return void
     */
    protected function loadRemote()
    {
        $this->remote = null;
        if ($this->git) {
            $remote = null;
            $remotesString = $this->composer->git('remote', $this->path, ['verbose' => true]);
            $lines = explode("\n", trim($remotesString));
            foreach ($lines as $line) {
                preg_match('/^([^\s]+)\s+(.+) \((fetch|push)\)$/', $line, $match);
                array_shift($match);
                list($name, $url) = $match;
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;
                if ($remote && $remote !== $url) {
                    $this->composer->output("<warning>Can not handle multiple remote urls - using $remote</warning>");
                    break;
                } else {
                    $remote = $url;
                }
            }
            $this->remote = $remote;
        }
    }

    /**
     * Load 'branches', 'upstreams', 'branch', 'tag', 'git'
     *
     * @throws Exception\ProcessFailedException
     *
     * @return void
     */
    protected function loadGitInformation()
    {
        $this->branches = array();
        $this->upstreams = array();
        $this->branch = null;
        $this->tag = null;
        if ($this->git) {
            $this->composer->git('fetch', $this->path, array('p' => true, 'origin'));
            try {
                $format = (self::$forEachRefHeadSupported ? '%(HEAD)' : '') . '|%(refname:short)|%(upstream:short)';
                $gitBr = $this->composer->git('for-each-ref', $this->path, ['format' => $format, 'refs/heads/', 'refs/remotes/origin']);
            } catch (Exception\ProcessFailedException $e) {
                if (trim($e->getProcess()->getErrorOutput()) === 'fatal: unknown field name: HEAD') {
                    self::$forEachRefHeadSupported = false;
                    $this->loadGitInformation();
                    return;
                } else {
                    throw $e;
                }
            }
            if (!self::$forEachRefHeadSupported && !($this->tag = $this->getTag())) {
                $this->branch = $this->composer->git('rev-parse', $this->path, ['abbrev-ref' => true, 'HEAD']) ?: null;
            }
            foreach (explode("\n", trim($gitBr)) as $line) {
                list($head, $branch, $upstream) = explode('|', $line);
                if ($branch === 'origin/HEAD') {
                    continue;
                }
                $this->branches[] = $branch;
                if ($head === '*') {
                    $this->branch = $branch;
                }
                if ($upstream) {
                    $this->upstreams[$branch] = $upstream;
                }
            }
            if (self::$forEachRefHeadSupported && !$this->branch) {
                $this->tag = $this->getTag();
            }
        }
    }

    /**
     * Get  the currently checked out tag
     *
     * @return string|null
     */
    protected function getTag()
    {
        try {
            return trim($this->composer->git('describe', $this->path, array('exact-match' => true, 'tags' => true)));
        } catch (Exception\ProcessFailedException $e) {
            return null;
        }

    }
}

?>


1			<?php
2			/**
3			* See class comment
4			*
5			* PHP Version 5
6			*
7			* @category Netresearch
8			* @package Netresearch\Kite\Service\Composer
9			* @author Christian Opitz <[email protected]>
10			* @license http://www.netresearch.de Netresearch Copyright
11			* @link http://www.netresearch.de
12			*/
13
14			namespace Netresearch\Kite\Service\Composer;
15			use Netresearch\Kite\Exception;
16			use Netresearch\Kite\Service\Composer;
17
18			/**
19			* Class Package
20			*
21			* // Composer properties, not necessarily present:
22			*
23			* @property string $name Package name
24			* @property string $version Package version
25			* @property object $source Information about the source
26			* (may have f.i. "reference")
27			*
28			* // Additional properties
29			*
30			* @property string $path Package path
31			* @property bool $isRoot Whether package is root (project)
32			* @property array $requires The packages from $require as array
33			* @property bool $git Whether installed package is a get repository
34			* @property array $branches Git branches (including remote branches)
35			* @property array $upstreams Upstream branches (values) for local branches (keys)
36			* @property string\|null $branch The currently checked out branch, if any
37			* If package is on a tag this will always be null
38			* @property string\|null $tag The currently checked out tag, if any
39			* @property string\|null $remote The remote url (no multiple urls supported)
40			*
41			*
42			* @category Netresearch
43			* @package Netresearch\Kite\Service\Composer
44			* @author Christian Opitz <[email protected]>
45			* @license http://www.netresearch.de Netresearch Copyright
46			* @link http://www.netresearch.de
47			*/
48			class Package
49			{
50			/**
51			* @var Composer
52			*/
53			protected $composer;
54
55			/**
56			* @var bool
57			*/
58			protected static $forEachRefHeadSupported = true;
59
60			/**
61			* Package constructor.
62			*
63			* @param Composer $composer The parent object
64			* @param string\|object $composerJson The composer json
65			* @param bool $isRoot Whether package is root
66			*/
67			public function __construct(Composer $composer, $composerJson, $isRoot = false)
68			{
69			$this->composer = $composer;
70
71			if (is_string($composerJson)) {
72			$path = realpath($composerJson);
73			if (!$path) {
74			throw new Exception('Could not find ' . $composerJson);
75			}
76			$this->path = dirname($path);
77			$composerJson = json_decode(file_get_contents($path));
78			if (!is_object($composerJson)) {
79			throw new Exception('Could not load ' . $path);
80			}
81			}
82			foreach (get_object_vars($composerJson) as $key => $value) {
83			$this->$key = $value;
84			}
85
86			$this->isRoot = $isRoot;
87			}
88
89			/**
90			* Load lazy properties
91			*
92			* @param string $name The property name
93			*
94			* @return mixed
95			*/
96			public function __get($name)
97			{
98			switch ($name) {
99			case 'git':
100			$gitDir = $this->path . '/.git';
101			$this->git = file_exists($gitDir) && is_dir($gitDir);
102			break;
103			case 'branches':
104			case 'upstreams':
105			case 'branch':
106			case 'tag':
107			$this->loadGitInformation();
108			break;
109			case 'remote':
110			$this->loadRemote();
111			break;
112			case 'requires':
113			$this->loadRequires();
114			break;
115			default:
116			throw new Exception('Invalid property ' . $name);
117
118			}
119			return $this->$name;
120			}
121
122			/**
123			* Mark lazy properties as present
124			*
125			* @param string $name The name
126			*
127			* @return bool
128			*/
129			public function __isset($name)
130			{
131			return in_array($name, ['branches', 'upstreams', 'branch', 'tag', 'git', 'remote', 'requires'], true);
132			}
133
134			/**
135			* Load the requires - removes inline aliases
136			*
137			* @return void
138			*/
139			protected function loadRequires()
140			{
141			$this->requires = isset($this->require) ? get_object_vars($this->require) : array();
			0 ignored issues – show Bug introduced 2016-05-10 09:23 UTC by Report Bug Copy Issue Report The property `require` does not seem to exist. Did you mean `requires`? 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...
142			foreach ($this->requires as $package => $constraint) {
143			if ($pos = strpos($constraint, ' as ')) {
144			if ($hashPos = strpos($constraint, '#')) {
145			// dev-master#old-hash isn't treated by composer, so we don't as well
146			$pos = $hashPos;
147			}
148			$this->requires[$package] = substr($constraint, 0, $pos);
149			}
150			}
151			}
152
153			/**
154			* Reload requires from composer.json
155			*
156			* @return $this
157			*/
158			public function reloadRequires()
159			{
160			$file = $this->path . '/composer.json';
161			if (file_exists($file)) {
162			$composerJson = json_decode(file_get_contents($file));
163			unset($this->require);
164			if (isset($composerJson->require)) {
165			$this->require = $composerJson->require;
			0 ignored issues – show Bug introduced 2016-05-10 09:23 UTC by Report Bug Copy Issue Report The property `require` does not seem to exist. Did you mean `requires`? 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...
166			}
167			$this->loadRequires();
168			}
169			return $this;
170			}
171
172			/**
173			* Get the remote
174			*
175			* @return void
176			*/
177			protected function loadRemote()
178			{
179			$this->remote = null;
180			if ($this->git) {
181			$remote = null;
182			$remotesString = $this->composer->git('remote', $this->path, ['verbose' => true]);
183			$lines = explode("\n", trim($remotesString));
184			foreach ($lines as $line) {
185			preg_match('/^([^\s]+)\s+(.+) \((fetch\|push)\)$/', $line, $match);
186			array_shift($match);
187			list($name, $url) = $match;
			0 ignored issues – show Unused Code introduced 2016-03-18 14:36 UTC by Report Bug Copy Issue Report The assignment to `$name` is unused. Consider omitting it like so `list($first,,$third)`. This checks looks for assignemnts to variables using the `list(...)` function, where not all assigned variables are subsequently used. Consider the following code example. <?php function returnThreeValues() { return array('a', 'b', 'c'); } list($a, $b, $c) = returnThreeValues(); print $a . " - " . $c; Only the variables `$a` and `$c` are used. There was no need to assign `$b`. Instead, the list call could have been. list($a,, $c) = returnThreeValues(); Loading history...
188			if ($remote && $remote !== $url) {
189			$this->composer->output("<warning>Can not handle multiple remote urls - using $remote</warning>");
190			break;
191			} else {
192			$remote = $url;
193			}
194			}
195			$this->remote = $remote;
196			}
197			}
198
199			/**
200			* Load 'branches', 'upstreams', 'branch', 'tag', 'git'
201			*
202			* @throws Exception\ProcessFailedException
203			*
204			* @return void
205			*/
206			protected function loadGitInformation()
207			{
208			$this->branches = array();
209			$this->upstreams = array();
210			$this->branch = null;
211			$this->tag = null;
212			if ($this->git) {
213			$this->composer->git('fetch', $this->path, array('p' => true, 'origin'));
214			try {
215			$format = (self::$forEachRefHeadSupported ? '%(HEAD)' : '') . '\|%(refname:short)\|%(upstream:short)';
216			$gitBr = $this->composer->git('for-each-ref', $this->path, ['format' => $format, 'refs/heads/', 'refs/remotes/origin']);
217			} catch (Exception\ProcessFailedException $e) {
218			if (trim($e->getProcess()->getErrorOutput()) === 'fatal: unknown field name: HEAD') {
219			self::$forEachRefHeadSupported = false;
220			$this->loadGitInformation();
221			return;
222			} else {
223			throw $e;
224			}
225			}
226			if (!self::$forEachRefHeadSupported && !($this->tag = $this->getTag())) {
227			$this->branch = $this->composer->git('rev-parse', $this->path, ['abbrev-ref' => true, 'HEAD']) ?: null;
228			}
229			foreach (explode("\n", trim($gitBr)) as $line) {
230			list($head, $branch, $upstream) = explode('\|', $line);
231			if ($branch === 'origin/HEAD') {
232			continue;
233			}
234			$this->branches[] = $branch;
235			if ($head === '*') {
236			$this->branch = $branch;
237			}
238			if ($upstream) {
239			$this->upstreams[$branch] = $upstream;
240			}
241			}
242			if (self::$forEachRefHeadSupported && !$this->branch) {
243			$this->tag = $this->getTag();
244			}
245			}
246			}
247
248			/**
249			* Get the currently checked out tag
250			*
251			* @return string\|null
252			*/
253			protected function getTag()
254			{
255			try {
256			return trim($this->composer->git('describe', $this->path, array('exact-match' => true, 'tags' => true)));
257			} catch (Exception\ProcessFailedException $e) {
258			return null;
259			}
260
261			}
262			}
263
264			?>
265

netresearch / kite

GitHub Access Token became invalid

Push — master ( c5752c...f61021 )

Package::__get() D

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like