datasift /
storyplayer
| Conditions | 11 |
| Paths | 123 |
| Total Lines | 108 |
| Code Lines | 62 |
| Lines | 108 |
| Ratio | 100 % |
| Changes | 1 | ||
| Bugs | 0 | Features | 0 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | <?php |
||
| 67 | public function doPhase($story) |
||
| 68 | { |
||
| 69 | // shorthand |
||
| 70 | $st = $this->st; |
||
| 71 | $storyResult = $story->getResult(); |
||
| 72 | |||
| 73 | // our results object |
||
| 74 | $phaseResult = $this->getNewPhaseResult(); |
||
| 75 | |||
| 76 | try { |
||
| 77 | // do we have anything to do? |
||
| 78 | if (!$story->hasPostTestInspection()) |
||
| 79 | { |
||
| 80 | $phaseResult->setContinuePlaying( |
||
| 81 | $phaseResult::HASNOACTIONS, |
||
| 82 | "story has no post-test inspection instructions" |
||
| 83 | ); |
||
| 84 | return $phaseResult; |
||
| 85 | } |
||
| 86 | |||
| 87 | // do any necessary setup |
||
| 88 | $this->doPerPhaseSetup(); |
||
| 89 | |||
| 90 | // make the call |
||
| 91 | $story = $st->getStory(); |
||
| 92 | $callbacks = $story->getPostTestInspection(); |
||
| 93 | foreach ($callbacks as $callback) { |
||
| 94 | if (is_callable($callback)) { |
||
| 95 | call_user_func($callback, $st); |
||
| 96 | } |
||
| 97 | } |
||
| 98 | |||
| 99 | // if we get here, the post-test inspection did not fail |
||
| 100 | // ... but should it have? |
||
| 101 | if ($storyResult->getStoryShouldFail()) { |
||
| 102 | $phaseResult->setPlayingFailed( |
||
| 103 | $phaseResult::SUCCEEDED, |
||
| 104 | "post-test inspection succeeded when it was expected to fail" |
||
| 105 | ); |
||
| 106 | $storyResult->setStoryHasFailed($phaseResult); |
||
| 107 | } |
||
| 108 | else { |
||
| 109 | $phaseResult->setContinuePlaying(); |
||
| 110 | } |
||
| 111 | } |
||
| 112 | catch (ActionFailedException $e) { |
||
| 113 | if ($storyResult->getStoryShouldFail()) { |
||
| 114 | $phaseResult->setContinuePlaying( |
||
| 115 | $phaseResult::SUCCEEDED, |
||
| 116 | $e->getMessage(), |
||
| 117 | $e |
||
| 118 | ); |
||
| 119 | } |
||
| 120 | else { |
||
| 121 | $phaseResult->setPlayingFailed( |
||
| 122 | $phaseResult::FAILED, |
||
| 123 | $e->getMessage(), |
||
| 124 | $e |
||
| 125 | ); |
||
| 126 | $storyResult->setStoryHasFailed($phaseResult); |
||
| 127 | } |
||
| 128 | } |
||
| 129 | catch (ExpectFailedException $e) { |
||
| 130 | if ($storyResult->getStoryShouldFail()) { |
||
| 131 | $phaseResult->setContinuePlaying( |
||
| 132 | $phaseResult::SUCCEEDED, |
||
| 133 | $e->getMessage(), |
||
| 134 | $e |
||
| 135 | ); |
||
| 136 | } |
||
| 137 | else { |
||
| 138 | $phaseResult->setPlayingFailed( |
||
| 139 | $phaseResult::FAILED, |
||
| 140 | $e->getMessage(), |
||
| 141 | $e |
||
| 142 | ); |
||
| 143 | $storyResult->setStoryHasFailed($phaseResult); |
||
| 144 | } |
||
| 145 | } |
||
| 146 | |||
| 147 | // this is treated as a hard fail |
||
| 148 | catch (NotImplementedException $e) { |
||
| 149 | $phaseResult->setPlayingFailed( |
||
| 150 | $phaseResult::INCOMPLETE, |
||
| 151 | $e->getMessage(), |
||
| 152 | $e |
||
| 153 | ); |
||
| 154 | $storyResult->setStoryIsIncomplete($phaseResult); |
||
| 155 | } |
||
| 156 | // this only happens when something has gone very badly wrong |
||
| 157 | catch (Exception $e) { |
||
| 158 | $phaseResult->setPlayingFailed( |
||
| 159 | $phaseResult::ERROR, |
||
| 160 | $e->getMessage(), |
||
| 161 | $e |
||
| 162 | ); |
||
| 163 | $storyResult->setStoryHasError($phaseResult); |
||
| 164 | } |
||
| 165 | |||
| 166 | // close off any open log actions |
||
| 167 | $st->closeAllOpenActions(); |
||
| 168 | |||
| 169 | // tidy up after ourselves |
||
| 170 | $this->doPerPhaseTeardown(); |
||
| 171 | |||
| 172 | // all done |
||
| 173 | return $phaseResult; |
||
| 174 | } |
||
| 175 | } |
||
| 176 |
Loading history...
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.