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

Completed

Push — master ( b8c8f1...61af37 )

by Andrii

created 2016-02-19 19:05 UTC

GithubController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

Importance

Changes	5
Bugs	1	Features	1

Metric	Value
wmc	19
c	5
b	1
f	1
lcom	1
cbo	2
dl	0
loc	117
ccs	0
cts	76
cp	0
rs	10

12 Methods

Rating	Name	Size	Complexity
A	setName()	7	3
A	getName()	8	2
A	setVendor()	4	1
A	getVendor()	8	2
A	actionCreate()	3	1
A	setPackage()	4	1
A	getPackage()	8	2
A	actionClone()	4	1
A	actionRelease()	17	2
A	actionWaitPush()	6	1
A	request()	6	1
A	getToken()	8	2

<?php

/*
 * Task runner, code generator and build tool for easier continuos integration
 *
 * @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 $_package;

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

    public function setName($value)
    {
        list($vendor, $package) = explode('/', $value, 2);
        $this->_name    = $value;
        $this->_vendor  = $vendor ?: $package;
        $this->_package = $package ?: $vendor;
    }

    public function getName()
    {
        if ($this->_name === null) {
            $this->setName($this->takeGoal('package')->fullName);
        }

        return $this->_name;
    }

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

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

        return $this->_vendor;
    }

    public function actionCreate()
    {
    }

    public function setPackage($value)
    {
        $this->_package = $value;
    }

    public function getPackage()
    {
        if ($this->_package === null) {
            $this->_package = $this->takeGoal('package')->name;
        }

        return $this->_package;
    }

    /**
     * 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]);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

    public function actionRelease($version = null)
    {
        $this->runRequest('CHANGELOG.md');
        $changelog = $this->takeGoal('CHANGELOG.md');
        $notes = reset($changelog->getFile()->getHandler()->releaseNotes);
        $version = $this->takeGoal('bump')->getVersion($version);
        $wait = $this->actionWaitPush();
        if ($wait) {
            return $wait;
        }

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

    /**
     * Waits for push had 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]);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

    public function getToken()
// 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);
    }
}
    {
        if ($this->_token === null) {
            $this->_token = $_SERVER['GITHUB_TOKEN'];
        }

        return $this->_token;
    }
}


1			<?php
2
3			/*
4			* Task runner, code generator and build tool for easier continuos integration
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 $_package;
24
25			/**
26			* @var string GitHub OAuth access token
27			*/
28			protected $_token;
29
30			public function setName($value)
31			{
32			list($vendor, $package) = explode('/', $value, 2);
33			$this->_name = $value;
34			$this->_vendor = $vendor ?: $package;
35			$this->_package = $package ?: $vendor;
36			}
37
38			public function getName()
39			{
40			if ($this->_name === null) {
41			$this->setName($this->takeGoal('package')->fullName);
42			}
43
44			return $this->_name;
45			}
46
47			public function setVendor($value)
48			{
49			$this->_vendor = $value;
50			}
51
52			public function getVendor()
53			{
54			if ($this->_vendor === null) {
55			$this->_vendor = $this->takeVendor()->name;
56			}
57
58			return $this->_vendor;
59			}
60
61			public function actionCreate()
62			{
63			}
64
65			public function setPackage($value)
66			{
67			$this->_package = $value;
68			}
69
70			public function getPackage()
71			{
72			if ($this->_package === null) {
73			$this->_package = $this->takeGoal('package')->name;
74			}
75
76			return $this->_package;
77			}
78
79			/**
80			* Clone repo from github.
81			* TODO this action must be run without `start`.
82			* @param string $repo full name vendor/package
83			* @return int exit code
84			*/
85			public function actionClone($repo)
86			{
87			return $this->passthru('git', ['clone', '[email protected]:' . $repo]);
			0 ignored issues – show Documentation introduced 2016-01-13 13:30 UTC by Report Bug Copy Issue Report `array('clone', '[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...
88			}
89
90			public function actionRelease($version = null)
91			{
92			$this->runRequest('CHANGELOG.md');
93			$changelog = $this->takeGoal('CHANGELOG.md');
94			$notes = reset($changelog->getFile()->getHandler()->releaseNotes);
95			$version = $this->takeGoal('bump')->getVersion($version);
96			$wait = $this->actionWaitPush();
97			if ($wait) {
98			return $wait;
99			}
100
101			return $this->request('POST', '/repos/' . $this->getName() . '/releases', [
102			'tag_name' => $version,
103			'name' => $version,
104			'body' => $notes,
105			]);
106			}
107
108			/**
109			* Waits for push had actually finished.
110			* TODO Check github if it really has latest local commit.
111			* @return int 0 - success, 1 - failed
112			*/
113			public function actionWaitPush()
114			{
115			sleep(7);
116
117			return 0;
118			}
119
120			public function request($method, $path, $data)
121			{
122			$url = 'https://api.github.com' . $path;
123
124			return $this->passthru('curl', ['-X', $method, '-H', 'Authorization: token ' . $this->getToken(), '--data', Json::encode($data), $url]);
			0 ignored issues – show Documentation introduced 2016-01-26 12:27 UTC by Report Bug Copy Issue Report `array('-X', $method, '-H...n::encode($data), $url)` is of type `array<integer,?,{"0":"st..."string","6":"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...
125			}
126
127			public function getToken()
			0 ignored issues – show Coding Style introduced 2016-01-26 11:42 UTC by Report Bug Copy Issue Report `getToken` 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...
128			{
129			if ($this->_token === null) {
130			$this->_token = $_SERVER['GITHUB_TOKEN'];
131			}
132
133			return $this->_token;
134			}
135			}
136

hiqdev / hidev

Push — master ( b8c8f1...61af37 )

GithubController A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

12 Methods

Duplication Side-by-Side

Filter issues like