Completed
Push — master ( 897567...887f9d )
by Andrii
03:40
created

GithubController   A

Complexity

Total Complexity 27

Size/Duplication

Total Lines 174
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 2

Test Coverage

Coverage 100%

Importance

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

19 Methods

Rating   Name   Duplication   Size   Complexity  
A actionClone() 0 4 1
A request() 0 6 1
A getToken() 0 8 2
A actionRelease() 0 15 2
A actionWaitPush() 0 6 1
A setFull_name() 0 4 1
A setFullName() 0 4 1
A getFullName() 0 4 1
A setName() 0 4 1
A setVendor() 0 4 1
A setDescription() 0 4 1
A getDescription() 0 8 2
A getFull_name() 0 4 1
A getName() 0 8 2
A getVendor() 0 8 2
A actionCreate() 0 13 2
A actionExists() 0 4 2
A exists() 0 4 1
A findToken() 0 4 2
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\controllers;
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 1
    public function getFull_name()
35
    {
36 1
        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 1
    public function getName()
55
    {
56 1
        if (!$this->_name) {
57 1
            $this->_name = $this->takePackage()->name;
58
        }
59
60 1
        return $this->_name;
61
    }
62
63
    public function setVendor($value)
64
    {
65
        $this->_vendor = $value;
66
    }
67
68 1
    public function getVendor()
69
    {
70 1
        if (!$this->_vendor) {
71 1
            $this->_vendor = $this->takeVendor()->name;
72
        }
73
74 1
        return $this->_vendor;
75
    }
76
77
    public function setDescription($value)
78
    {
79
        $this->_description = $value;
80
    }
81
82
    public function getDescription()
83
    {
84
        if ($this->_description === null) {
85
            $this->_description = $this->takePackage()->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::isOk($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
     * 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 by
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 by
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