GithubController - Code Metrics - Inspection of "fixed tests" - hiqdev/hidev - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 032f16...1de67f )

by Andrii

created 2016-08-08 21:48 UTC

GithubController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	173
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

Importance

Changes	9
Bugs	1	Features	1

Metric	Value
wmc	27
c	9
b	1
f	1
lcom	1
cbo	2
dl	0
loc	173
ccs	0
cts	10
cp	0
rs	10

19 Methods

Rating	Name	Size	Complexity
A	setFull_name()	4	1
A	getFull_name()	4	1
A	setFullName()	4	1
A	getFullName()	4	1
A	setName()	4	1
A	getName()	8	2
A	setVendor()	4	1
A	getVendor()	8	2
A	setDescription()	4	1
A	getDescription()	8	2
A	actionCreate()	12	2
A	actionExists()	4	2
A	exists()	4	1
A	actionClone()	4	1
A	actionWaitPush()	6	1
A	findToken()	4	2
A	actionRelease()	15	2
A	request()	6	1
A	getToken()	8	2

<?php

/*
 * Automation tool mixed with code generator for easier continuous development
 *
 * @link      https://github.com/hiqdev/hidev
 * @package   hidev
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
 */

namespace hidev\controllers;

use yii\helpers\Json;

/**
 * Goal for GitHub.
 */
class GithubController extends CommonController
{
    protected $_name;
    protected $_vendor;
    protected $_description;

    /**
     * @var string GitHub OAuth access token
     */
    protected $_token;

    public function setFull_name($value)
    {
        list($this->_vendor, $this->_name) = explode('/', $value, 2);
    }

    public function getFull_name()
    {
        return $this->getVendor() . '/' . $this->getName();
    }

    public function setFullName($value)
    {
        return $this->setFull_name($value);
    }

    public function getFullName()
    {
        return $this->getFull_name();
    }

    public function setName($value)
    {
        $this->_name = $value;
    }

    public function getName()
    {
        if (!$this->_name) {
            $this->_name = $this->takePackage()->name;
        }

        return $this->_name;
    }

    public function setVendor($value)
    {
        $this->_vendor = $value;
    }

    public function getVendor()
    {
        if (!$this->_vendor) {
            $this->_vendor = $this->takeVendor()->name;
        }

        return $this->_vendor;
    }

    public function setDescription($value)
    {
        $this->_description = $value;
    }

    public function getDescription()
    {
        if ($this->_description === null) {
            $this->_description = $this->takePackage()->getTitle();
        }

        return $this->_description;
    }

    /**
     * Create the repo on GitHub.
     * @return int exit code
     */
    public function actionCreate()
    {
        $res = $this->request('POST', '/orgs/' . $this->getVendor() . '/repos', [
            'name'        => $this->getName(),
            'description' => $this->getDescription(),
        ]);
        if (static::isOk($res)) {
            echo "\ngit remote add origin [email protected]:{$this->getFullName()}.git\ngit push -u origin master\n";
        }

        return $res;
    }

    /**
     * Clone repo from github.
     * TODO this action must be run without `start`.
     * @param string $repo full name vendor/package
     * @return int exit code
     */
    public function actionClone($repo)
    {
        return $this->passthru('git', ['clone', '[email protected]:' . $repo]);
    }

    /**
     * Action to check if repo exists.
     * @param string $repo full name vendor/package defaults to this repo name
     * @return int exit code
     */
    public function actionExists($repo = null)
    {
        return static::exists($repo ?: $this->getFull_name());
    }

    /**
     * Check if repo exists.
     * @param string $repo
     * @return bool
     */
    public static function exists($repo)
    {
        return !static::exec('git', ['ls-remote', '[email protected]:' . $repo], true);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Creates github release.
     */
    public function actionRelease($version = null)
    {
        $version = $this->takeGoal('version')->getVersion($version);
        $notes = $this->takeGoal('chkipper')->getReleaseNotes();
        $wait = $this->actionWaitPush();
        if ($wait) {
            return $wait;
        }

        return $this->request('POST', '/repos/' . $this->getFull_name() . '/releases', [
            'tag_name'  => $version,
            'name'      => $version,
            'body'      => $notes,
        ]);
    }

    /**
     * Waits until push is actually finished.
     * TODO Check github if it really has latest local commit.
     * @return int 0 - success, 1 - failed
     */
    public function actionWaitPush()
    {
        sleep(7);

        return 0;
    }

    public function request($method, $path, $data)
    {
        $url = 'https://api.github.com' . $path;

        return $this->passthru('curl', ['-X', $method, '-H', 'Authorization: token ' . $this->getToken(), '--data', Json::encode($data), $url]);
    }

    public function findToken()
// 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);
    }
}
    {
        return $_SERVER['GITHUB_TOKEN'] ?: $this->readpassword('GitHub token:');
    }

    public function getToken()
    {
        if ($this->_token === null) {
            $this->_token = $this->findToken();
        }

        return $this->_token;
    }
}


1			<?php
2
3			/*
4			* Automation tool mixed with code generator for easier continuous development
5			*
6			* @link https://github.com/hiqdev/hidev
7			* @package hidev
8			* @license BSD-3-Clause
9			* @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
10			*/
11
12			namespace hidev\controllers;
13
14			use yii\helpers\Json;
15
16			/**
17			* Goal for GitHub.
18			*/
19			class GithubController extends CommonController
20			{
21			protected $_name;
22			protected $_vendor;
23			protected $_description;
24
25			/**
26			* @var string GitHub OAuth access token
27			*/
28			protected $_token;
29
30			public function setFull_name($value)
31			{
32			list($this->_vendor, $this->_name) = explode('/', $value, 2);
33			}
34
35			public function getFull_name()
36			{
37			return $this->getVendor() . '/' . $this->getName();
38			}
39
40			public function setFullName($value)
41			{
42			return $this->setFull_name($value);
43			}
44
45			public function getFullName()
46			{
47			return $this->getFull_name();
48			}
49
50			public function setName($value)
51			{
52			$this->_name = $value;
53			}
54
55			public function getName()
56			{
57			if (!$this->_name) {
58			$this->_name = $this->takePackage()->name;
59			}
60
61			return $this->_name;
62			}
63
64			public function setVendor($value)
65			{
66			$this->_vendor = $value;
67			}
68
69			public function getVendor()
70			{
71			if (!$this->_vendor) {
72			$this->_vendor = $this->takeVendor()->name;
73			}
74
75			return $this->_vendor;
76			}
77
78			public function setDescription($value)
79			{
80			$this->_description = $value;
81			}
82
83			public function getDescription()
84			{
85			if ($this->_description === null) {
86			$this->_description = $this->takePackage()->getTitle();
87			}
88
89			return $this->_description;
90			}
91
92			/**
93			* Create the repo on GitHub.
94			* @return int exit code
95			*/
96			public function actionCreate()
97			{
98			$res = $this->request('POST', '/orgs/' . $this->getVendor() . '/repos', [
99			'name' => $this->getName(),
100			'description' => $this->getDescription(),
101			]);
102			if (static::isOk($res)) {
103			echo "\ngit remote add origin [email protected]:{$this->getFullName()}.git\ngit push -u origin master\n";
104			}
105
106			return $res;
107			}
108
109			/**
110			* Clone repo from github.
111			* TODO this action must be run without `start`.
112			* @param string $repo full name vendor/package
113			* @return int exit code
114			*/
115			public function actionClone($repo)
116			{
117			return $this->passthru('git', ['clone', '[email protected]:' . $repo]);
118			}
119
120			/**
121			* Action to check if repo exists.
122			* @param string $repo full name vendor/package defaults to this repo name
123			* @return int exit code
124			*/
125			public function actionExists($repo = null)
126			{
127			return static::exists($repo ?: $this->getFull_name());
128			}
129
130			/**
131			* Check if repo exists.
132			* @param string $repo
133			* @return bool
134			*/
135			public static function exists($repo)
136			{
137			return !static::exec('git', ['ls-remote', '[email protected]:' . $repo], true);
			0 ignored issues – show Documentation introduced 2016-03-16 10:10 UTC by Report Bug Copy Issue Report `array('ls-remote', '[email protected]:' . $repo)` is of type `array<integer,string,{"0":"string","1":"string"}>`, 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...
138			}
139
140			/**
141			* Creates github release.
142			*/
143			public function actionRelease($version = null)
144			{
145			$version = $this->takeGoal('version')->getVersion($version);
146			$notes = $this->takeGoal('chkipper')->getReleaseNotes();
147			$wait = $this->actionWaitPush();
148			if ($wait) {
149			return $wait;
150			}
151
152			return $this->request('POST', '/repos/' . $this->getFull_name() . '/releases', [
153			'tag_name' => $version,
154			'name' => $version,
155			'body' => $notes,
156			]);
157			}
158
159			/**
160			* Waits until push is actually finished.
161			* TODO Check github if it really has latest local commit.
162			* @return int 0 - success, 1 - failed
163			*/
164			public function actionWaitPush()
165			{
166			sleep(7);
167
168			return 0;
169			}
170
171			public function request($method, $path, $data)
172			{
173			$url = 'https://api.github.com' . $path;
174
175			return $this->passthru('curl', ['-X', $method, '-H', 'Authorization: token ' . $this->getToken(), '--data', Json::encode($data), $url]);
176			}
177
178			public function findToken()
			0 ignored issues – show Coding Style introduced 2016-03-15 18:31 UTC by Report Bug Copy Issue Report `findToken` 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...
179			{
180			return $_SERVER['GITHUB_TOKEN'] ?: $this->readpassword('GitHub token:');
181			}
182
183			public function getToken()
184			{
185			if ($this->_token === null) {
186			$this->_token = $this->findToken();
187			}
188
189			return $this->_token;
190			}
191			}
192

hiqdev / hidev

Push — master ( 032f16...1de67f )

GithubController A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

19 Methods

Duplication Side-by-Side

Filter issues like