GithubController::request() - Code Metrics - Inspection of "renamed `console` <- controllers" - hiqdev/hidev - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 54b8af...0621ed )

by Andrii

created 2017-05-08 19:31 UTC

GithubController::request() A

↳ Parent: GithubController

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	6
rs	9.4285
cc	1
eloc	3
nc	1
nop	3

<?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-2017, HiQDev (http://hiqdev.com/)
 */

namespace hidev\console;

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->take('package')->name;
        }

        return $this->_name;
    }

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

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

        return $this->_vendor;
    }

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

    public function getDescription()

    {
        if ($this->_description === null) {
            $this->_description = $this->take('package')->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::isResponseOk($res)) {
            echo "\ngit remote add origin [email protected]:{$this->getFullName()}.git\n";
            echo "git 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]);
    }

    /**
     * Checks 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($release = null)
    {
        $release = $this->take('version')->getRelease($release);
        $notes = $this->take('chkipper')->getReleaseNotes();
        $wait = $this->actionWaitPush();
        if ($wait) {
            return $wait;
        }

        return $this->request('POST', '/repos/' . $this->getFull_name() . '/releases', [
            'tag_name'  => $release,
            'name'      => $release,
            '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		* Automation tool mixed with code generator for easier continuous development.
4		*
5		* @link https://github.com/hiqdev/hidev
6		* @package hidev
7		* @license BSD-3-Clause
8		* @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
9		*/
10
11		namespace hidev\console;
12
13		use yii\helpers\Json;
14
15		/**
16		* Goal for GitHub.
17		*/
18		class GithubController extends CommonController
19		{
20		protected $_name;
21		protected $_vendor;
22		protected $_description;
23
24		/**
25		* @var string GitHub OAuth access token
26		*/
27		protected $_token;
28
29		public function setFull_name($value)
30		{
31		list($this->_vendor, $this->_name) = explode('/', $value, 2);
32		}
33
34		public function getFull_name()
35		{
36		return $this->getVendor() . '/' . $this->getName();
37		}
38
39		public function setFullName($value)
40		{
41		return $this->setFull_name($value);
42		}
43
44		public function getFullName()
45		{
46		return $this->getFull_name();
47		}
48
49		public function setName($value)
50		{
51		$this->_name = $value;
52		}
53
54		public function getName()
55		{
56		if (!$this->_name) {
57		$this->_name = $this->take('package')->name;
58		}
59
60		return $this->_name;
61		}
62
63		public function setVendor($value)
64		{
65		$this->_vendor = $value;
66		}
67
68		public function getVendor()
69		{
70		if (!$this->_vendor) {
71		$this->_vendor = $this->take('vendor')->name;
72		}
73
74		return $this->_vendor;
75		}
76
77		public function setDescription($value)
78		{
79		$this->_description = $value;
80		}
81
82	View Code Duplication	public function getDescription()
		0 ignored issues – show Duplication introduced 2017-04-29 17:12 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
83		{
84		if ($this->_description === null) {
85		$this->_description = $this->take('package')->getTitle();
86		}
87
88		return $this->_description;
89		}
90
91		/**
92		* Create the repo on GitHub.
93		* @return int exit code
94		*/
95		public function actionCreate()
96		{
97		$res = $this->request('POST', '/orgs/' . $this->getVendor() . '/repos', [
98		'name' => $this->getName(),
99		'description' => $this->getDescription(),
100		]);
101		if (static::isResponseOk($res)) {
102		echo "\ngit remote add origin [email protected]:{$this->getFullName()}.git\n";
103		echo "git 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		* Checks 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($release = null)
144		{
145		$release = $this->take('version')->getRelease($release);
146		$notes = $this->take('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' => $release,
154		'name' => $release,
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 ( 54b8af...0621ed )

GithubController::request() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like