AbstractVcsDriver::initialize() - Code Metrics - webcreate/conveyor - Measure and Improve Code Quality continuously with Scrutinizer

AbstractVcsDriver::initialize() A
last analyzed 2016-12-08 12:42 UTC

↳ Parent: AbstractVcsDriver

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

/*
 * This file is part of the Conveyor package.
 *
 * (c) Jeroen Fiege <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Webcreate\Conveyor\Repository\Driver;

use Webcreate\Conveyor\IO\IOInterface;
use Webcreate\Conveyor\Repository\Version;
use Webcreate\Vcs\Common\Reference;
use Webcreate\Vcs\VcsInterface;

abstract class AbstractVcsDriver implements DriverInterface
{
    protected $url;

    /**
     * @var VcsInterface
     */
    protected $client;
    protected $io;

    protected $cacheDir;

    public function __construct($url, IOInterface $io = null)

    {
        $this->url = $url;
        $this->io = $io;
    }

    public function initialize($url)
    {
        $this->client = $this->getClient($url);
    }

    /**
     * @param $url
     * @return VcsInterface
     */
    abstract protected function getClient($url);

    public function setCacheDir($cacheDir)
    {
        $this->cacheDir = $cacheDir;
    }

    public function getVersions()
    {
        $versions = array();

        $tags = $this->client->tags();
        foreach ($tags as $tag) {
            $versions[] = $this->createVersion($tag->getName(), $tag->getRevision());
        }

        $branches = $this->client->branches();
        foreach ($branches as $branch) {
            $versions[] = $this->createVersion($branch->getName(), $branch->getRevision(), 'dev');
        }

        return $versions;
    }

    public function getHead(Version $version)
    {
        if ($version->getName() == 'dev-trunk') {
            $head = new Reference('trunk');
        } elseif (substr($version->getName(), 0, 4) == 'dev-') {
            $head = new Reference(substr($version->getName(), 4));
        } else {
            $head = new Reference($version->getName(), Reference::TAG);
        }

        return $head;
    }

    /**
     * @param string $name
     * @param string $revision
     * @param string $prefix
     * @return \Webcreate\Conveyor\Repository\Version
     */
    protected function createVersion($name, $revision, $prefix = null)
    {
        $name = ($prefix ? $prefix . '-' : '') . $name;


        $version = new Version();
        $version->setName($name);
        $version->setBuild($revision);

        return $version;
    }

    public function export(Version $version, $dest)
    {
        $head = $this->getHead($version);
        $this->client->setHead($head);

        /*
         * @todo Collect output of export process
         *
         * if ($this->io) {
         *   $io = $this->io;
         *   $this->client->setOutput(function ($type, $output) use ($io) {
         *       if ($io->isVerbose()) {
         *           $io->write($output, false);
         *       }
         *   });
         *}
         */

        $result = $this->client->export('', $dest);

        //$this->client->setOutput(null);
        return $result;
    }

    public function diff(Version $oldVersion, Version $newVersion)
    {
        $head = $this->getHead($oldVersion);
        $this->client->setHead($head);

        $result = $this->client->diff(
            $this->getHead($oldVersion), $this->getHead($newVersion),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $oldVersion->getBuild(), $newVersion->getBuild()
        );

        return $result;
    }

    public function revisionCompare($revision1, $revision2)
    {
        return $this->client->revisionCompare($revision1, $revision2);
    }

    public function changelog(Version $version1, Version $version2)
    {
        return $this->client->changelog($version1->getBuild(), $version2->getBuild());
    }
}


1		<?php
2
3		/*
4		* This file is part of the Conveyor package.
5		*
6		* (c) Jeroen Fiege <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Webcreate\Conveyor\Repository\Driver;
13
14		use Webcreate\Conveyor\IO\IOInterface;
15		use Webcreate\Conveyor\Repository\Version;
16		use Webcreate\Vcs\Common\Reference;
17		use Webcreate\Vcs\VcsInterface;
18
19		abstract class AbstractVcsDriver implements DriverInterface
20		{
21		protected $url;
22
23		/**
24		* @var VcsInterface
25		*/
26		protected $client;
27		protected $io;
		0 ignored issues – show Comprehensibility introduced 2016-02-05 09:59 UTC by Report Bug Copy Issue Report Avoid variables with short names like $io. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
28		protected $cacheDir;
29
30		public function __construct($url, IOInterface $io = null)
		0 ignored issues – show Comprehensibility introduced 2016-02-05 09:59 UTC by Report Bug Copy Issue Report Avoid variables with short names like $io. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
31		{
32		$this->url = $url;
33		$this->io = $io;
34		}
35
36	1	public function initialize($url)
37		{
38	1	$this->client = $this->getClient($url);
39	1	}
40
41		/**
42		* @param $url
43		* @return VcsInterface
44		*/
45		abstract protected function getClient($url);
46
47	1	public function setCacheDir($cacheDir)
48		{
49	1	$this->cacheDir = $cacheDir;
50	1	}
51
52	1	public function getVersions()
53		{
54	1	$versions = array();
55
56	1	$tags = $this->client->tags();
57	1	foreach ($tags as $tag) {
58	1	$versions[] = $this->createVersion($tag->getName(), $tag->getRevision());
59		}
60
61	1	$branches = $this->client->branches();
62	1	foreach ($branches as $branch) {
63	1	$versions[] = $this->createVersion($branch->getName(), $branch->getRevision(), 'dev');
64		}
65
66	1	return $versions;
67		}
68
69		public function getHead(Version $version)
70		{
71		if ($version->getName() == 'dev-trunk') {
72		$head = new Reference('trunk');
73		} elseif (substr($version->getName(), 0, 4) == 'dev-') {
74		$head = new Reference(substr($version->getName(), 4));
75		} else {
76		$head = new Reference($version->getName(), Reference::TAG);
77		}
78
79		return $head;
80		}
81
82		/**
83		* @param string $name
84		* @param string $revision
85		* @param string $prefix
86		* @return \Webcreate\Conveyor\Repository\Version
87		*/
88	1	protected function createVersion($name, $revision, $prefix = null)
89		{
90	1	$name = ($prefix ? $prefix . '-' : '') . $name;
		0 ignored issues – show Coding Style introduced 2016-01-14 09:42 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$name`. This often makes code more readable. Loading history...
91
92	1	$version = new Version();
93	1	$version->setName($name);
94	1	$version->setBuild($revision);
95
96	1	return $version;
97		}
98
99		public function export(Version $version, $dest)
100		{
101		$head = $this->getHead($version);
102		$this->client->setHead($head);
103
104		/*
105		* @todo Collect output of export process
106		*
107		* if ($this->io) {
108		* $io = $this->io;
109		* $this->client->setOutput(function ($type, $output) use ($io) {
110		* if ($io->isVerbose()) {
111		* $io->write($output, false);
112		* }
113		* });
114		*}
115		*/
116
117		$result = $this->client->export('', $dest);
118
119		//$this->client->setOutput(null);
120		return $result;
121		}
122
123		public function diff(Version $oldVersion, Version $newVersion)
124		{
125		$head = $this->getHead($oldVersion);
126		$this->client->setHead($head);
127
128		$result = $this->client->diff(
129		$this->getHead($oldVersion), $this->getHead($newVersion),
		0 ignored issues – show Documentation introduced 2016-01-14 09:42 UTC by Report Bug Copy Issue Report `$this->getHead($oldVersion)` is of type `object<Webcreate\Vcs\Common\Reference>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Documentation introduced 2016-01-14 09:42 UTC by Report Bug Copy Issue Report `$this->getHead($newVersion)` is of type `object<Webcreate\Vcs\Common\Reference>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
130		$oldVersion->getBuild(), $newVersion->getBuild()
131		);
132
133		return $result;
134		}
135
136		public function revisionCompare($revision1, $revision2)
137		{
138		return $this->client->revisionCompare($revision1, $revision2);
139		}
140
141		public function changelog(Version $version1, Version $version2)
142		{
143		return $this->client->changelog($version1->getBuild(), $version2->getBuild());
144		}
145		}
146

webcreate / conveyor

AbstractVcsDriver::initialize() A last analyzed 2016-12-08 12:42 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

AbstractVcsDriver::initialize() A
last analyzed 2016-12-08 12:42 UTC