Automattic /
jetpack
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 ) { |
|
| 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 | \Jetpack::activate_module( 'sso' ); |
||
| 91 | $this->disable_api_request(); |
||
| 92 | } |
||
| 93 | |||
| 94 | /** |
||
| 95 | * Test get_instance. |
||
| 96 | * |
||
| 97 | * @covers ::get_instance |
||
| 98 | * @covers ::__construct |
||
| 99 | */ |
||
| 100 | View Code Duplication | public function test_get_instance() { |
|
| 101 | $instance = Atomic_Admin_Menu::get_instance(); |
||
| 102 | |||
| 103 | $this->assertInstanceOf( Atomic_Admin_Menu::class, $instance ); |
||
| 104 | $this->assertSame( $instance, static::$admin_menu ); |
||
| 105 | |||
| 106 | $this->assertSame( 99998, has_action( 'admin_menu', array( $instance, 'reregister_menu_items' ) ) ); |
||
| 107 | $this->assertSame( 11, has_action( 'admin_enqueue_scripts', array( $instance, 'enqueue_scripts' ) ) ); |
||
| 108 | } |
||
| 109 | |||
| 110 | /** |
||
| 111 | * Tests add_browse_sites_link. |
||
| 112 | * |
||
| 113 | * @covers ::add_browse_sites_link |
||
| 114 | */ |
||
| 115 | public function test_add_browse_sites_link() { |
||
| 116 | global $menu; |
||
| 117 | |||
| 118 | // No output when executed in single site mode. |
||
| 119 | static::$admin_menu->add_browse_sites_link(); |
||
| 120 | $this->assertArrayNotHasKey( 0, $menu ); |
||
| 121 | } |
||
| 122 | |||
| 123 | /** |
||
| 124 | * Tests add_browse_sites_link. |
||
| 125 | * |
||
| 126 | * @covers ::add_browse_sites_link |
||
| 127 | */ |
||
| 128 | public function test_add_browse_sites_link_multisite() { |
||
| 129 | if ( ! is_multisite() ) { |
||
| 130 | $this->markTestSkipped( 'Only used on multisite' ); |
||
| 131 | } |
||
| 132 | |||
| 133 | global $menu; |
||
| 134 | |||
| 135 | // No output when user has just one site. |
||
| 136 | static::$admin_menu->add_browse_sites_link(); |
||
| 137 | $this->assertArrayNotHasKey( 0, $menu ); |
||
| 138 | |||
| 139 | // Give user a second site. |
||
| 140 | update_user_option( static::$user_id, 'wpcom_site_count', 2 ); |
||
| 141 | |||
| 142 | static::$admin_menu->add_browse_sites_link(); |
||
| 143 | |||
| 144 | $browse_sites_menu_item = array( |
||
| 145 | 'Browse sites', |
||
| 146 | 'read', |
||
| 147 | 'https://wordpress.com/home', |
||
| 148 | 'site-switcher', |
||
| 149 | 'menu-top toplevel_page_https://wordpress.com/home', |
||
| 150 | 'toplevel_page_https://wordpress.com/home', |
||
| 151 | 'dashicons-arrow-left-alt2', |
||
| 152 | ); |
||
| 153 | $this->assertSame( $menu[0], $browse_sites_menu_item ); |
||
| 154 | |||
| 155 | delete_user_option( static::$user_id, 'wpcom_site_count' ); |
||
| 156 | } |
||
| 157 | |||
| 158 | /** |
||
| 159 | * Tests add_new_site_link. |
||
| 160 | * |
||
| 161 | * @covers ::add_new_site_link |
||
| 162 | */ |
||
| 163 | public function test_add_new_site_link() { |
||
| 164 | global $menu; |
||
| 165 | |||
| 166 | // Set jetpack user data. |
||
| 167 | update_user_option( static::$user_id, 'wpcom_site_count', 1 ); |
||
| 168 | |||
| 169 | static::$admin_menu->add_new_site_link(); |
||
| 170 | |||
| 171 | $new_site_menu_item = array( |
||
| 172 | 'Add New Site', |
||
| 173 | 'read', |
||
| 174 | 'https://wordpress.com/start?ref=calypso-sidebar', |
||
| 175 | 'Add New Site', |
||
| 176 | 'menu-top toplevel_page_https://wordpress.com/start?ref=calypso-sidebar', |
||
| 177 | 'toplevel_page_https://wordpress.com/start?ref=calypso-sidebar', |
||
| 178 | 'dashicons-plus-alt', |
||
| 179 | ); |
||
| 180 | $this->assertSame( array_pop( $menu ), $new_site_menu_item ); |
||
| 181 | |||
| 182 | delete_user_option( static::$user_id, 'wpcom_site_count' ); |
||
| 183 | } |
||
| 184 | |||
| 185 | /** |
||
| 186 | * Tests add_site_card_menu |
||
| 187 | * |
||
| 188 | * @covers ::add_site_card_menu |
||
| 189 | */ |
||
| 190 | public function test_add_site_card_menu() { |
||
| 191 | global $menu; |
||
| 192 | |||
| 193 | if ( ! function_exists( 'site_is_private' ) ) { |
||
| 194 | function site_is_private() { // phpcs:ignore |
||
| 197 | } |
||
| 198 | static::$admin_menu->add_site_card_menu(); |
||
| 199 | |||
| 200 | $home_url = home_url(); |
||
| 201 | $site_card_menu_item = array( |
||
| 202 | // phpcs:ignore Squiz.Strings.DoubleQuoteUsage.NotRequired |
||
| 217 | |||
| 218 | /** |
||
| 219 | * Tests set_site_card_menu_class |
||
| 220 | * |
||
| 221 | * @covers ::set_site_card_menu_class |
||
| 222 | */ |
||
| 223 | public function test_set_site_card_menu_class() { |
||
| 249 | |||
| 250 | /** |
||
| 251 | * Shim wpcomsh fallback site icon. |
||
| 252 | * |
||
| 253 | * @return string |
||
| 254 | */ |
||
| 255 | public function wpcomsh_site_icon_url() { |
||
| 258 | |||
| 259 | /** |
||
| 260 | * Custom site icon. |
||
| 261 | * |
||
| 262 | * @return string |
||
| 263 | */ |
||
| 264 | public function custom_site_icon_url() { |
||
| 267 | |||
| 268 | /** |
||
| 269 | * Tests add_posts_menu |
||
| 270 | * |
||
| 271 | * @covers ::add_posts_menu |
||
| 272 | */ |
||
| 273 | View Code Duplication | public function test_add_posts_menu() { |
|
| 291 | |||
| 292 | /** |
||
| 293 | * Tests add_page_menu |
||
| 294 | * |
||
| 295 | * @covers ::add_page_menu |
||
| 296 | */ |
||
| 297 | View Code Duplication | public function test_add_page_menu() { |
|
| 315 | |||
| 316 | /** |
||
| 317 | * Tests add_upgrades_menu |
||
| 318 | * |
||
| 319 | * @covers ::add_upgrades_menu |
||
| 320 | */ |
||
| 321 | View Code Duplication | public function test_add_upgrades_menu() { |
|
| 337 | |||
| 338 | /** |
||
| 339 | * Tests add_tools_menu |
||
| 340 | * |
||
| 341 | * @covers ::add_tools_menu |
||
| 342 | */ |
||
| 343 | public function test_add_tools_menu() { |
||
| 351 | |||
| 352 | /** |
||
| 353 | * Tests add_options_menu |
||
| 354 | * |
||
| 355 | * @covers ::add_options_menu |
||
| 356 | */ |
||
| 357 | public function test_add_options_menu() { |
||
| 379 | |||
| 380 | /** |
||
| 381 | * Tests add_plugins_menu |
||
| 382 | * |
||
| 383 | * @covers ::add_plugins_menu |
||
| 384 | */ |
||
| 385 | public function test_add_plugins_menu() { |
||
| 393 | |||
| 394 | /** |
||
| 395 | * Tests add_appearance_menu |
||
| 396 | * |
||
| 397 | * @covers ::add_appearance_menu |
||
| 398 | */ |
||
| 399 | public function test_add_appearance_menu() { |
||
| 423 | |||
| 424 | /** |
||
| 425 | * Tests add_users_menu |
||
| 426 | * |
||
| 427 | * @covers ::add_users_menu |
||
| 428 | */ |
||
| 429 | public function test_add_users_menu() { |
||
| 442 | |||
| 443 | /** |
||
| 444 | * Tests add_comments_menu |
||
| 445 | * |
||
| 446 | * @covers ::add_comments_menu |
||
| 447 | */ |
||
| 448 | public function test_add_comments_menu() { |
||
| 465 | |||
| 466 | /** |
||
| 467 | * Tests add_gutenberg_menus |
||
| 468 | * |
||
| 469 | * @covers ::add_gutenberg_menus |
||
| 470 | */ |
||
| 471 | public function test_add_gutenberg_menus() { |
||
| 478 | |||
| 479 | /** |
||
| 480 | * Makes the admin class think the menu is requested by an API request. |
||
| 481 | */ |
||
| 482 | View Code Duplication | public function enable_api_request() { |
|
| 488 | |||
| 489 | /** |
||
| 490 | * Makes the admin class think the menu is requested by an API request. |
||
| 491 | */ |
||
| 492 | View Code Duplication | public function disable_api_request() { |
|
| 498 | } |
||
| 499 |
Loading history...
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
SomeClassto useselfinstead: