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 GithubIssueConverterSpec 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 GithubIssueConverterSpec, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
11 | class GithubIssueConverterSpec extends ObjectBehavior |
||
12 | { |
||
13 | public function it_is_initializable() |
||
17 | |||
18 | public function let(GithubRepo $githubRepo, GithubRepoId $repoId) |
||
23 | |||
24 | /** |
||
25 | * @dataProvider provideAllIssues |
||
26 | */ |
||
27 | public function it_returns_github_issue_source_as_result($arrayData) |
||
32 | |||
33 | /** |
||
34 | * @dataProvider provideAllIssues |
||
35 | */ |
||
36 | public function it_will_have_repo_id_in_converted_result($arrayData) |
||
43 | |||
44 | /** |
||
45 | * @dataProvider provideAllIssues |
||
46 | */ |
||
47 | public function it_will_have_repo_in_converted_result($arrayData) |
||
54 | |||
55 | // |
||
56 | // |
||
57 | // |
||
58 | // |
||
59 | |||
60 | /** |
||
61 | * @dataProvider provideAllIssues |
||
62 | */ |
||
63 | public function it_will_have_issue_state_in_converted_result($arrayData) |
||
69 | |||
70 | /** |
||
71 | * @dataProvider provideOpenIssues |
||
72 | */ |
||
73 | public function it_will_have_open_issue_state_in_converted_result($arrayData) |
||
79 | |||
80 | /** |
||
81 | * @dataProvider provideClosedIssues |
||
82 | */ |
||
83 | public function it_will_have_closed_issue_state_in_converted_result($arrayData) |
||
89 | |||
90 | /** |
||
91 | * @dataProvider provideAllIssues |
||
92 | */ |
||
93 | public function it_will_have_issue_title_in_converted_result($arrayData) |
||
98 | |||
99 | /** |
||
100 | * @dataProvider provideAllIssues |
||
101 | */ |
||
102 | public function it_will_have_issue_description_in_converted_result($arrayData) |
||
107 | |||
108 | /** |
||
109 | * @dataProvider provideAllIssues |
||
110 | */ |
||
111 | public function it_will_have_user_id_of_creator_in_converted_result($arrayData) |
||
118 | |||
119 | /** |
||
120 | * @dataProvider provideAllIssues |
||
121 | */ |
||
122 | public function it_will_have_creator_in_converted_result($arrayData) |
||
129 | |||
130 | /** |
||
131 | * @dataProvider provideAssignedIssues |
||
132 | */ |
||
133 | public function it_will_have_user_id_of_assigned_user_in_converted_result($arrayData) |
||
140 | |||
141 | /** |
||
142 | * @dataProvider provideAssignedIssues |
||
143 | */ |
||
144 | public function it_will_have_assigned_user_in_converted_result($arrayData) |
||
151 | |||
152 | /** |
||
153 | * @dataProvider provideNonAssignedIssues |
||
154 | */ |
||
155 | public function it_will_have_null_for_user_id_on_unassigned_user_in_converted_result($arrayData) |
||
161 | |||
162 | /** |
||
163 | * @dataProvider provideNonAssignedIssues |
||
164 | */ |
||
165 | public function it_will_have_null_for_user_on_unassigned_user_in_converted_result($arrayData) |
||
171 | |||
172 | /** |
||
173 | * @dataProvider provideMilestonedIssues |
||
174 | */ |
||
175 | public function it_will_have_milestone_in_converted_result($arrayData) |
||
184 | |||
185 | /** |
||
186 | * @dataProvider provideNonMilestonedIssues |
||
187 | */ |
||
188 | public function it_will_have_null_for_issue_without_milestone_in_converted_result($arrayData) |
||
195 | |||
196 | /** |
||
197 | * @dataProvider provideAllIssues |
||
198 | */ |
||
199 | public function it_will_have_comment_count_in_converted_result($arrayData) |
||
204 | |||
205 | /** |
||
206 | * @dataProvider provideAllIssues |
||
207 | */ |
||
208 | public function it_will_have_github_created_datetime_in_converted_result($arrayData) |
||
215 | |||
216 | /** |
||
217 | * @dataProvider provideAllIssues |
||
218 | */ |
||
219 | View Code Duplication | public function it_will_have_github_last_updated_datetime_in_converted_result($arrayData) |
|
226 | |||
227 | /** |
||
228 | * @dataProvider provideClosedIssues |
||
229 | */ |
||
230 | View Code Duplication | public function it_will_have_github_closed_datetime_for_closed_milestones_in_converted_result($arrayData) |
|
237 | |||
238 | public function provideAllIssues() |
||
248 | |||
249 | public function provideOpenIssues() |
||
261 | |||
262 | public function provideClosedIssues() |
||
274 | |||
275 | public function provideAssignedIssues() |
||
287 | |||
288 | public function provideNonAssignedIssues() |
||
300 | |||
301 | public function provideMilestonedIssues() |
||
313 | |||
314 | public function provideNonMilestonedIssues() |
||
326 | |||
327 | protected function getDataProvider() |
||
331 | } |
||
332 |
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.