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:
1 | <?php |
||
19 | class Test_WPcom_Admin_Menu extends WP_UnitTestCase { |
||
20 | |||
21 | /** |
||
22 | * Menu data fixture. |
||
23 | * |
||
24 | * @var array |
||
25 | */ |
||
26 | public static $menu_data; |
||
27 | |||
28 | /** |
||
29 | * Submenu data fixture. |
||
30 | * |
||
31 | * @var array |
||
32 | */ |
||
33 | public static $submenu_data; |
||
34 | |||
35 | /** |
||
36 | * Test domain. |
||
37 | * |
||
38 | * @var string |
||
39 | */ |
||
40 | public static $domain; |
||
41 | |||
42 | /** |
||
43 | * Whether this testsuite is run on WP.com. |
||
44 | * |
||
45 | * @var bool |
||
46 | */ |
||
47 | public static $is_wpcom; |
||
48 | |||
49 | /** |
||
50 | * Admin menu instance. |
||
51 | * |
||
52 | * @var WPcom_Admin_Menu |
||
53 | */ |
||
54 | public static $admin_menu; |
||
55 | |||
56 | /** |
||
57 | * Mock user ID. |
||
58 | * |
||
59 | * @var int |
||
60 | */ |
||
61 | private static $user_id = 0; |
||
62 | |||
63 | /** |
||
64 | * Create shared fixtures. |
||
65 | * |
||
66 | * @param WP_UnitTest_Factory $factory Fixture factory. |
||
67 | */ |
||
68 | View Code Duplication | public static function wpSetUpBeforeClass( $factory ) { |
|
74 | |||
75 | /** |
||
76 | * Set up data. |
||
77 | */ |
||
78 | View Code Duplication | public function setUp() { |
|
90 | |||
91 | /** |
||
92 | * Test get_instance. |
||
93 | * |
||
94 | * @covers ::get_instance |
||
95 | * @covers ::__construct |
||
96 | */ |
||
97 | View Code Duplication | public function test_get_instance() { |
|
106 | |||
107 | /** |
||
108 | * Tests add_browse_sites_link. |
||
109 | * |
||
110 | * @covers ::add_browse_sites_link |
||
111 | */ |
||
112 | public function test_add_browse_sites_link() { |
||
141 | |||
142 | /** |
||
143 | * Tests add_new_site_link. |
||
144 | * |
||
145 | * @covers ::add_new_site_link |
||
146 | */ |
||
147 | public function test_add_new_site_link() { |
||
163 | |||
164 | /** |
||
165 | * Tests add_site_card_menu |
||
166 | * |
||
167 | * @covers ::add_site_card_menu |
||
168 | */ |
||
169 | public function test_add_site_card_menu() { |
||
195 | |||
196 | /** |
||
197 | * Tests set_site_card_menu_class |
||
198 | * |
||
199 | * @covers ::set_site_card_menu_class |
||
200 | */ |
||
201 | public function test_set_site_card_menu_class() { |
||
225 | |||
226 | /** |
||
227 | * Shim wpcomsh fallback site icon. |
||
228 | * |
||
229 | * @return string |
||
230 | */ |
||
231 | public function wpcomsh_site_icon_url() { |
||
234 | |||
235 | /** |
||
236 | * Custom site icon. |
||
237 | * |
||
238 | * @return string |
||
239 | */ |
||
240 | public function custom_site_icon_url() { |
||
243 | |||
244 | /** |
||
245 | * Tests add_upgrades_menu |
||
246 | * |
||
247 | * @covers ::add_upgrades_menu |
||
248 | */ |
||
249 | public function test_add_upgrades_menu() { |
||
250 | global $submenu; |
||
251 | |||
252 | static::$admin_menu->add_upgrades_menu(); |
||
253 | |||
254 | $this->assertSame( 'https://wordpress.com/domains/manage/' . static::$domain, array_pop( $submenu['paid-upgrades.php'] )[2] ); |
||
255 | } |
||
256 | |||
257 | /** |
||
258 | * Tests add_users_menu |
||
259 | * |
||
260 | * @covers ::add_users_menu |
||
261 | */ |
||
262 | View Code Duplication | public function test_add_users_menu() { |
|
270 | |||
271 | /** |
||
272 | * Tests add_tools_menu |
||
273 | * |
||
274 | * @covers ::add_tools_menu |
||
275 | */ |
||
276 | View Code Duplication | public function test_add_tools_menu() { |
|
284 | |||
285 | /** |
||
286 | * Tests add_options_menu |
||
287 | * |
||
288 | * @covers ::add_options_menu |
||
289 | */ |
||
290 | public function test_add_options_menu() { |
||
298 | |||
299 | /** |
||
300 | * Tests add_gutenberg_menus |
||
301 | * |
||
302 | * @covers ::add_gutenberg_menus |
||
303 | */ |
||
304 | public function test_add_gutenberg_menus() { |
||
311 | |||
312 | /** |
||
313 | * Tests add_plugins_menu |
||
314 | * |
||
315 | * @covers ::add_plugins_menu |
||
316 | */ |
||
317 | View Code Duplication | public function test_add_plugins_menu() { |
|
325 | } |
||
326 |
Let’s assume you have a class which uses late-static binding:
The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the
getSomeVariable()
on that sub-class, you will receive a runtime error:In the case above, it makes sense to update
SomeClass
to useself
instead: