silverstripe /
deploynaut
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like ApprovalsDispatcher often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use ApprovalsDispatcher, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 3 | class ApprovalsDispatcher extends Dispatcher { |
||
| 4 | |||
| 5 | const ACTION_APPROVALS = 'approvals'; |
||
| 6 | |||
| 7 | const ALLOW_APPROVAL = 'ALLOW_APPROVAL'; |
||
| 8 | |||
| 9 | const ALLOW_APPROVAL_BYPASS = 'ALLOW_APPROVAL_BYPASS'; |
||
| 10 | |||
| 11 | /** |
||
| 12 | * @var array |
||
| 13 | */ |
||
| 14 | private static $allowed_actions = [ |
||
| 15 | 'submit', |
||
| 16 | 'cancel', |
||
| 17 | 'approve', |
||
| 18 | 'reject' |
||
| 19 | ]; |
||
| 20 | |||
| 21 | private static $dependencies = [ |
||
| 22 | 'formatter' => '%$DeploynautAPIFormatter' |
||
| 23 | ]; |
||
| 24 | |||
| 25 | /** |
||
| 26 | * @var \DNProject |
||
| 27 | */ |
||
| 28 | protected $project = null; |
||
| 29 | |||
| 30 | /** |
||
| 31 | * @var \DNEnvironment |
||
| 32 | */ |
||
| 33 | protected $environment = null; |
||
| 34 | |||
| 35 | /** |
||
| 36 | * @var array |
||
| 37 | */ |
||
| 38 | private static $action_types = [ |
||
| 39 | self::ACTION_APPROVALS |
||
| 40 | ]; |
||
| 41 | |||
| 42 | View Code Duplication | public function init() { |
|
| 56 | |||
| 57 | /** |
||
| 58 | * @param \SS_HTTPRequest $request |
||
| 59 | * @return \SS_HTTPResponse |
||
| 60 | */ |
||
| 61 | public function submit(\SS_HTTPRequest $request) { |
||
| 62 | if ($request->httpMethod() !== 'POST') { |
||
| 63 | return $this->getAPIResponse(['message' => 'Method not allowed, requires POST'], 405); |
||
| 64 | } |
||
| 65 | |||
| 66 | $this->checkSecurityToken(); |
||
| 67 | |||
| 68 | $deployment = DNDeployment::get()->byId($request->postVar('id')); |
||
| 69 | $errorResponse = $this->validateDeployment($deployment); |
||
| 70 | if ($errorResponse instanceof \SS_HTTPResponse) { |
||
| 71 | return $errorResponse; |
||
| 72 | } |
||
| 73 | |||
| 74 | $approver = Member::get()->byId($request->postVar('approver_id')); |
||
| 75 | if ($approver && $approver->exists()) { |
||
| 76 | if (!$this->project->allowed(ApprovalsDispatcher::ALLOW_APPROVAL, $approver)) { |
||
| 77 | return $this->getAPIResponse(['message' => 'The given approver does not have permissions to approve'], 403); |
||
| 78 | } |
||
| 79 | |||
| 80 | $deployment->ApproverID = $approver->ID; |
||
| 81 | $deployment->write(); |
||
| 82 | } |
||
| 83 | |||
| 84 | // title and summary may have changed, ensure they are saved |
||
| 85 | if ($request->postVar('title')) { |
||
| 86 | $deployment->Title = $request->postVar('title'); |
||
| 87 | } |
||
| 88 | if ($request->postVar('summary')) { |
||
| 89 | $deployment->Summary = $request->postVar('summary'); |
||
| 90 | } |
||
| 91 | |||
| 92 | try { |
||
| 93 | $deployment->getMachine()->apply(DNDeployment::TR_SUBMIT); |
||
| 94 | } catch (\Exception $e) { |
||
| 95 | return $this->getAPIResponse([ |
||
| 96 | 'message' => $e->getMessage() |
||
| 97 | ], 400); |
||
| 98 | } |
||
| 99 | |||
| 100 | return $this->getAPIResponse([ |
||
| 101 | 'message' => 'Deployment request has been submitted', |
||
| 102 | 'deployment' => $this->formatter->getDeploymentData($deployment) |
||
| 103 | ], 200); |
||
| 104 | } |
||
| 105 | |||
| 106 | /** |
||
| 107 | * @param \SS_HTTPRequest $request |
||
| 108 | * @return \SS_HTTPResponse |
||
| 109 | */ |
||
| 110 | public function cancel(\SS_HTTPRequest $request) { |
||
| 111 | if ($request->httpMethod() !== 'POST') { |
||
| 112 | return $this->getAPIResponse(['message' => 'Method not allowed, requires POST'], 405); |
||
| 113 | } |
||
| 114 | |||
| 115 | $this->checkSecurityToken(); |
||
| 116 | |||
| 117 | $deployment = DNDeployment::get()->byId($request->postVar('id')); |
||
| 118 | $errorResponse = $this->validateDeployment($deployment); |
||
| 119 | if ($errorResponse instanceof \SS_HTTPResponse) { |
||
| 120 | return $errorResponse; |
||
| 121 | } |
||
| 122 | |||
| 123 | // if the person cancelling is not the one who created the deployment, update the deployer |
||
| 124 | if (Member::currentUserID() !== $deployment->DeployerID) { |
||
| 125 | $deployment->DeployerID = Member::currentUserID(); |
||
| 126 | $deployment->write(); |
||
| 127 | } |
||
| 128 | |||
| 129 | try { |
||
| 130 | $deployment->getMachine()->apply(DNDeployment::TR_NEW); |
||
| 131 | } catch (\Exception $e) { |
||
| 132 | return $this->getAPIResponse([ |
||
| 133 | 'message' => $e->getMessage() |
||
| 134 | ], 400); |
||
| 135 | } |
||
| 136 | |||
| 137 | return $this->getAPIResponse([ |
||
| 138 | 'message' => 'Deployment request has been cancelled', |
||
| 139 | 'deployment' => $this->formatter->getDeploymentData($deployment) |
||
| 140 | ], 200); |
||
| 141 | } |
||
| 142 | |||
| 143 | /** |
||
| 144 | * @param \SS_HTTPRequest $request |
||
| 145 | * @return \SS_HTTPResponse |
||
| 146 | */ |
||
| 147 | public function approve(\SS_HTTPRequest $request) { |
||
| 148 | if ($request->httpMethod() !== 'POST') { |
||
| 149 | return $this->getAPIResponse(['message' => 'Method not allowed, requires POST'], 405); |
||
| 150 | } |
||
| 151 | |||
| 152 | $this->checkSecurityToken(); |
||
| 153 | |||
| 154 | $deployment = DNDeployment::get()->byId($request->postVar('id')); |
||
| 155 | $errorResponse = $this->validateDeployment($deployment); |
||
| 156 | if ($errorResponse instanceof \SS_HTTPResponse) { |
||
| 157 | return $errorResponse; |
||
| 158 | } |
||
| 159 | |||
| 160 | // ensure we have either bypass or approval permission of the logged in user |
||
| 161 | if ( |
||
| 162 | !$this->project->allowed(self::ALLOW_APPROVAL_BYPASS, Member::currentUser()) |
||
| 163 | || !$this->project->allowed(self::ALLOW_APPROVAL, Member::currentUser()) |
||
| 164 | ) { |
||
| 165 | return $this->getAPIResponse(['message' => 'You are not authorised to approve or bypass this deployment'], 403); |
||
| 166 | } |
||
| 167 | |||
| 168 | // check for specific permission depending on the current state of the deployment: |
||
| 169 | // submitted => approved requires approval permissions |
||
| 170 | // new => approved requires bypass permissions. |
||
| 171 | View Code Duplication | if ( |
|
| 172 | $deployment->State === DNDeployment::STATE_SUBMITTED |
||
| 173 | && !$this->project->allowed(self::ALLOW_APPROVAL, Member::currentUser()) |
||
| 174 | ) { |
||
| 175 | return $this->getAPIResponse(['message' => 'You are not authorised to approve this deployment'], 403); |
||
| 176 | } |
||
| 177 | View Code Duplication | if ( |
|
| 178 | $deployment->State === DNDeployment::STATE_NEW |
||
| 179 | && !$this->project->allowed(self::ALLOW_APPROVAL_BYPASS, Member::currentUser()) |
||
| 180 | ) { |
||
| 181 | return $this->getAPIResponse(['message' => 'You are not authorised to bypass approval of this deployment'], 403); |
||
| 182 | } |
||
| 183 | |||
| 184 | if ($deployment->State === DNDeployment::STATE_NEW) { |
||
| 185 | // Bypassing approval: Ensure that approver is not set. This may happen when someone has requested approval, |
||
| 186 | // cancelled approval, then bypassed. |
||
| 187 | $deployment->ApproverID = 0; |
||
| 188 | $deployment->write(); |
||
| 189 | } else { |
||
| 190 | // if the current user is not the person who was selected for approval on submit, but they got |
||
| 191 | // here because they still have permission, then change the approver to the current user |
||
| 192 | if (Member::currentUserID() !== $deployment->ApproverID) { |
||
| 193 | $deployment->ApproverID = Member::currentUserID(); |
||
| 194 | $deployment->write(); |
||
| 195 | } |
||
| 196 | } |
||
| 197 | |||
| 198 | // title and summary may have changed, ensure they are saved |
||
| 199 | if ($request->postVar('title')) { |
||
| 200 | $deployment->Title = $request->postVar('title'); |
||
| 201 | } |
||
| 202 | if ($request->postVar('summary')) { |
||
| 203 | $deployment->Summary = $request->postVar('summary'); |
||
| 204 | } |
||
| 205 | |||
| 206 | try { |
||
| 207 | $deployment->getMachine()->apply(DNDeployment::TR_APPROVE); |
||
| 208 | } catch (\Exception $e) { |
||
| 209 | return $this->getAPIResponse([ |
||
| 210 | 'message' => $e->getMessage() |
||
| 211 | ], 400); |
||
| 212 | } |
||
| 213 | |||
| 214 | return $this->getAPIResponse([ |
||
| 215 | 'message' => 'Deployment request has been approved', |
||
| 216 | 'deployment' => $this->formatter->getDeploymentData($deployment) |
||
| 217 | ], 200); |
||
| 218 | } |
||
| 219 | |||
| 220 | /** |
||
| 221 | * @param \SS_HTTPRequest $request |
||
| 222 | * @return \SS_HTTPResponse |
||
| 223 | */ |
||
| 224 | public function reject(\SS_HTTPRequest $request) { |
||
| 225 | if ($request->httpMethod() !== 'POST') { |
||
| 226 | return $this->getAPIResponse(['message' => 'Method not allowed, requires POST'], 405); |
||
| 227 | } |
||
| 228 | |||
| 229 | $this->checkSecurityToken(); |
||
| 230 | |||
| 231 | $deployment = DNDeployment::get()->byId($request->postVar('id')); |
||
| 232 | $errorResponse = $this->validateDeployment($deployment); |
||
| 233 | if ($errorResponse instanceof \SS_HTTPResponse) { |
||
| 234 | return $errorResponse; |
||
| 235 | } |
||
| 236 | // reject permissions are the same as can approve |
||
| 237 | View Code Duplication | if (!$this->project->allowed(self::ALLOW_APPROVAL, Member::currentUser())) { |
|
| 238 | return $this->getAPIResponse(['message' => 'You are not authorised to reject this deployment'], 403); |
||
| 239 | } |
||
| 240 | |||
| 241 | // if the current user is not the person who was selected for approval on submit, but they got |
||
| 242 | // here because they still have permission, then change the approver to the current user |
||
| 243 | if (Member::currentUserID() !== $deployment->ApproverID) { |
||
| 244 | $deployment->ApproverID = Member::currentUserID(); |
||
| 245 | $deployment->write(); |
||
| 246 | } |
||
| 247 | |||
| 248 | if ($request->postVar('rejected_reason')) { |
||
| 249 | $deployment->RejectedReason = $request->postVar('rejected_reason'); |
||
| 250 | } |
||
| 251 | |||
| 252 | try { |
||
| 253 | $deployment->getMachine()->apply(DNDeployment::TR_REJECT); |
||
| 254 | } catch (\Exception $e) { |
||
| 255 | return $this->getAPIResponse([ |
||
| 256 | 'message' => $e->getMessage() |
||
| 257 | ], 400); |
||
| 258 | } |
||
| 259 | |||
| 260 | return $this->getAPIResponse([ |
||
| 261 | 'message' => 'Deployment request has been rejected', |
||
| 262 | 'deployment' => $this->formatter->getDeploymentData($deployment) |
||
| 263 | ], 200); |
||
| 264 | } |
||
| 265 | |||
| 266 | /** |
||
| 267 | * Check if a DNDeployment exists and do permission checks on it. If there is something wrong it will return |
||
| 268 | * an APIResponse with the error, otherwise null. |
||
| 269 | * |
||
| 270 | * @param \DNDeployment $deployment |
||
| 271 | * |
||
| 272 | * @return null|SS_HTTPResponse |
||
| 273 | */ |
||
| 274 | View Code Duplication | protected function validateDeployment($deployment) { |
|
| 286 | |||
| 287 | /** |
||
| 288 | * @param string $name |
||
| 289 | * @return array |
||
| 290 | */ |
||
| 291 | public function getModel($name = '') { |
||
| 294 | |||
| 295 | /** |
||
| 296 | * @param string $action |
||
| 297 | * @return string |
||
| 298 | */ |
||
| 299 | public function Link($action = '') { |
||
| 302 | |||
| 303 | } |
||
| 304 |
Loading history...
This check marks property names that have not been written in camelCase.
In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes
databaseConnectionString.