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_Atomic_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 Atomic_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 ) { |
|
69 | static::$domain = ( new Status() )->get_site_suffix(); |
||
70 | static::$user_id = $factory->user->create( array( 'role' => 'administrator' ) ); |
||
|
|||
71 | static::$menu_data = get_menu_fixture(); |
||
72 | static::$submenu_data = get_submenu_fixture(); |
||
73 | } |
||
74 | |||
75 | /** |
||
76 | * Set up data. |
||
77 | */ |
||
78 | View Code Duplication | public function setUp() { |
|
79 | parent::setUp(); |
||
80 | global $menu, $submenu; |
||
81 | |||
82 | // Initialize in setUp so it registers hooks for every test. |
||
83 | static::$admin_menu = Atomic_Admin_Menu::get_instance(); |
||
84 | |||
85 | $menu = static::$menu_data; |
||
86 | $submenu = static::$submenu_data; |
||
87 | |||
88 | wp_set_current_user( static::$user_id ); |
||
89 | } |
||
90 | |||
91 | /** |
||
92 | * Test get_instance. |
||
93 | * |
||
94 | * @covers ::get_instance |
||
95 | * @covers ::__construct |
||
96 | */ |
||
97 | View Code Duplication | public function test_get_instance() { |
|
98 | $instance = Atomic_Admin_Menu::get_instance(); |
||
99 | |||
100 | $this->assertInstanceOf( Atomic_Admin_Menu::class, $instance ); |
||
101 | $this->assertSame( $instance, static::$admin_menu ); |
||
102 | |||
103 | $this->assertSame( 99999, has_action( 'admin_menu', array( $instance, 'reregister_menu_items' ) ) ); |
||
104 | $this->assertSame( 10, has_action( 'admin_enqueue_scripts', array( $instance, 'enqueue_scripts' ) ) ); |
||
105 | } |
||
106 | |||
107 | /** |
||
108 | * Tests add_browse_sites_link. |
||
109 | * |
||
110 | * @covers ::add_browse_sites_link |
||
111 | */ |
||
112 | public function test_add_browse_sites_link() { |
||
113 | global $menu; |
||
114 | |||
115 | // No output when executed in single site mode. |
||
116 | static::$admin_menu->add_browse_sites_link(); |
||
117 | $this->assertArrayNotHasKey( 0, $menu ); |
||
118 | } |
||
119 | |||
120 | /** |
||
121 | * Tests add_browse_sites_link. |
||
122 | * |
||
123 | * @covers ::add_browse_sites_link |
||
124 | */ |
||
125 | public function test_add_browse_sites_link_multisite() { |
||
126 | if ( ! is_multisite() ) { |
||
127 | $this->markTestSkipped( 'Only used on multisite' ); |
||
128 | } |
||
129 | |||
130 | global $menu; |
||
131 | |||
132 | // No output when user has just one site. |
||
133 | static::$admin_menu->add_browse_sites_link(); |
||
134 | $this->assertArrayNotHasKey( 0, $menu ); |
||
135 | |||
136 | // Give user a second site. |
||
137 | update_user_option( static::$user_id, 'wpcom_site_count', 2 ); |
||
138 | |||
139 | static::$admin_menu->add_browse_sites_link(); |
||
140 | |||
141 | $browse_sites_menu_item = array( |
||
142 | 'Browse sites', |
||
143 | 'read', |
||
144 | 'https://wordpress.com/home', |
||
145 | 'site-switcher', |
||
146 | 'menu-top toplevel_page_https://wordpress.com/home', |
||
147 | 'toplevel_page_https://wordpress.com/home', |
||
148 | 'dashicons-arrow-left-alt2', |
||
149 | ); |
||
150 | $this->assertSame( $menu[0], $browse_sites_menu_item ); |
||
151 | |||
152 | delete_user_option( static::$user_id, 'wpcom_site_count' ); |
||
153 | } |
||
154 | |||
155 | /** |
||
156 | * Tests add_new_site_link. |
||
157 | * |
||
158 | * @covers ::add_new_site_link |
||
159 | */ |
||
160 | public function test_add_new_site_link() { |
||
161 | global $menu; |
||
162 | |||
163 | // Set jetpack user data. |
||
164 | update_user_option( static::$user_id, 'wpcom_site_count', 1 ); |
||
165 | |||
166 | static::$admin_menu->add_new_site_link(); |
||
167 | |||
168 | $new_site_menu_item = array( |
||
169 | 'Add new site', |
||
170 | 'read', |
||
171 | 'https://wordpress.com/start?ref=calypso-sidebar', |
||
172 | 'Add new site', |
||
173 | 'menu-top toplevel_page_https://wordpress.com/start?ref=calypso-sidebar', |
||
174 | 'toplevel_page_https://wordpress.com/start?ref=calypso-sidebar', |
||
175 | 'dashicons-plus-alt', |
||
176 | ); |
||
177 | $this->assertSame( $menu[1002], $new_site_menu_item ); // 1001 is the separator position, 1002 is the link position |
||
178 | |||
179 | delete_user_option( static::$user_id, 'wpcom_site_count' ); |
||
180 | } |
||
181 | |||
182 | /** |
||
183 | * Tests add_site_card_menu |
||
184 | * |
||
185 | * @covers ::add_site_card_menu |
||
186 | */ |
||
187 | public function test_add_site_card_menu() { |
||
188 | global $menu; |
||
189 | |||
190 | if ( ! function_exists( 'site_is_private' ) ) { |
||
191 | function site_is_private() { // phpcs:ignore |
||
194 | } |
||
195 | static::$admin_menu->add_site_card_menu(); |
||
196 | |||
197 | $home_url = home_url(); |
||
198 | $site_card_menu_item = array( |
||
199 | // phpcs:ignore Squiz.Strings.DoubleQuoteUsage.NotRequired |
||
200 | ' |
||
214 | |||
215 | /** |
||
216 | * Tests set_site_card_menu_class |
||
217 | * |
||
218 | * @covers ::set_site_card_menu_class |
||
219 | */ |
||
220 | public function test_set_site_card_menu_class() { |
||
246 | |||
247 | /** |
||
248 | * Shim wpcomsh fallback site icon. |
||
249 | * |
||
250 | * @return string |
||
251 | */ |
||
252 | public function wpcomsh_site_icon_url() { |
||
255 | |||
256 | /** |
||
257 | * Custom site icon. |
||
258 | * |
||
259 | * @return string |
||
260 | */ |
||
261 | public function custom_site_icon_url() { |
||
264 | |||
265 | /** |
||
266 | * Tests add_upgrades_menu |
||
267 | * |
||
268 | * @covers ::add_upgrades_menu |
||
269 | */ |
||
270 | public function test_add_wpcom_upgrades_menu() { |
||
283 | |||
284 | /** |
||
285 | * Tests add_tools_menu |
||
286 | * |
||
287 | * @covers ::add_tools_menu |
||
288 | */ |
||
289 | View Code Duplication | public function test_add_tools_menu() { |
|
304 | |||
305 | /** |
||
306 | * Tests add_options_menu |
||
307 | * |
||
308 | * @covers ::add_options_menu |
||
309 | */ |
||
310 | public function test_add_options_menu() { |
||
318 | |||
319 | /** |
||
320 | * Tests add_plugins_menu |
||
321 | * |
||
322 | * @covers ::add_plugins_menu |
||
323 | */ |
||
324 | public function test_add_plugins_menu() { |
||
332 | } |
||
333 |
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: