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 |
||
| 20 | class Test_Atomic_Admin_Menu extends WP_UnitTestCase { |
||
| 21 | |||
| 22 | /** |
||
| 23 | * Menu data fixture. |
||
| 24 | * |
||
| 25 | * @var array |
||
| 26 | */ |
||
| 27 | public static $menu_data; |
||
| 28 | |||
| 29 | /** |
||
| 30 | * Submenu data fixture. |
||
| 31 | * |
||
| 32 | * @var array |
||
| 33 | */ |
||
| 34 | public static $submenu_data; |
||
| 35 | |||
| 36 | /** |
||
| 37 | * Test domain. |
||
| 38 | * |
||
| 39 | * @var string |
||
| 40 | */ |
||
| 41 | public static $domain; |
||
| 42 | |||
| 43 | /** |
||
| 44 | * Whether this testsuite is run on WP.com. |
||
| 45 | * |
||
| 46 | * @var bool |
||
| 47 | */ |
||
| 48 | public static $is_wpcom; |
||
| 49 | |||
| 50 | /** |
||
| 51 | * Admin menu instance. |
||
| 52 | * |
||
| 53 | * @var Atomic_Admin_Menu |
||
| 54 | */ |
||
| 55 | public static $admin_menu; |
||
| 56 | |||
| 57 | /** |
||
| 58 | * Mock user ID. |
||
| 59 | * |
||
| 60 | * @var int |
||
| 61 | */ |
||
| 62 | private static $user_id = 0; |
||
| 63 | |||
| 64 | /** |
||
| 65 | * Create shared fixtures. |
||
| 66 | * |
||
| 67 | * @param WP_UnitTest_Factory $factory Fixture factory. |
||
| 68 | */ |
||
| 69 | View Code Duplication | public static function wpSetUpBeforeClass( $factory ) { |
|
| 70 | static::$domain = ( new Status() )->get_site_suffix(); |
||
| 71 | static::$user_id = $factory->user->create( array( 'role' => 'administrator' ) ); |
||
|
|
|||
| 72 | |||
| 73 | static::$menu_data = get_menu_fixture(); |
||
| 74 | static::$submenu_data = get_submenu_fixture(); |
||
| 75 | } |
||
| 76 | |||
| 77 | /** |
||
| 78 | * Set up data. |
||
| 79 | */ |
||
| 80 | View Code Duplication | public function setUp() { |
|
| 81 | parent::setUp(); |
||
| 82 | global $menu, $submenu; |
||
| 83 | |||
| 84 | // Initialize in setUp so it registers hooks for every test. |
||
| 85 | static::$admin_menu = Atomic_Admin_Menu::get_instance(); |
||
| 86 | |||
| 87 | $menu = static::$menu_data; |
||
| 88 | $submenu = static::$submenu_data; |
||
| 89 | |||
| 90 | wp_set_current_user( static::$user_id ); |
||
| 91 | } |
||
| 92 | |||
| 93 | /** |
||
| 94 | * Test get_instance. |
||
| 95 | * |
||
| 96 | * @covers ::get_instance |
||
| 97 | * @covers ::__construct |
||
| 98 | */ |
||
| 99 | View Code Duplication | public function test_get_instance() { |
|
| 100 | $instance = Atomic_Admin_Menu::get_instance(); |
||
| 101 | |||
| 102 | $this->assertInstanceOf( Atomic_Admin_Menu::class, $instance ); |
||
| 103 | $this->assertSame( $instance, static::$admin_menu ); |
||
| 104 | |||
| 105 | $this->assertSame( 99999, has_action( 'admin_menu', array( $instance, 'reregister_menu_items' ) ) ); |
||
| 106 | $this->assertSame( 10, has_action( 'admin_enqueue_scripts', array( $instance, 'enqueue_scripts' ) ) ); |
||
| 107 | } |
||
| 108 | |||
| 109 | /** |
||
| 110 | * Tests add_browse_sites_link. |
||
| 111 | * |
||
| 112 | * @covers ::add_browse_sites_link |
||
| 113 | */ |
||
| 114 | public function test_add_browse_sites_link() { |
||
| 115 | global $menu; |
||
| 116 | |||
| 117 | // No output when executed in single site mode. |
||
| 118 | static::$admin_menu->add_browse_sites_link(); |
||
| 119 | $this->assertArrayNotHasKey( 0, $menu ); |
||
| 120 | } |
||
| 121 | |||
| 122 | /** |
||
| 123 | * Tests add_browse_sites_link. |
||
| 124 | * |
||
| 125 | * @covers ::add_browse_sites_link |
||
| 126 | */ |
||
| 127 | public function test_add_browse_sites_link_multisite() { |
||
| 128 | if ( ! is_multisite() ) { |
||
| 129 | $this->markTestSkipped( 'Only used on multisite' ); |
||
| 130 | } |
||
| 131 | |||
| 132 | global $menu; |
||
| 133 | |||
| 134 | // No output when user has just one site. |
||
| 135 | static::$admin_menu->add_browse_sites_link(); |
||
| 136 | $this->assertArrayNotHasKey( 0, $menu ); |
||
| 137 | |||
| 138 | // Give user a second site. |
||
| 139 | set_transient( 'jetpack_connected_user_data_' . static::$user_id, array( 'site_count' => 2 ) ); |
||
| 140 | |||
| 141 | static::$admin_menu->add_browse_sites_link(); |
||
| 142 | |||
| 143 | $browse_sites_menu_item = array( |
||
| 144 | 'Browse sites', |
||
| 145 | 'read', |
||
| 146 | 'https://wordpress.com/home', |
||
| 147 | 'site-switcher', |
||
| 148 | 'menu-top toplevel_page_https://wordpress.com/home', |
||
| 149 | 'toplevel_page_https://wordpress.com/home', |
||
| 150 | 'dashicons-arrow-left-alt2', |
||
| 151 | ); |
||
| 152 | $this->assertSame( $menu[0], $browse_sites_menu_item ); |
||
| 153 | |||
| 154 | delete_transient( 'jetpack_connected_user_data_' . static::$user_id ); |
||
| 155 | } |
||
| 156 | |||
| 157 | /** |
||
| 158 | * Tests add_new_site_link. |
||
| 159 | * |
||
| 160 | * @covers ::add_new_site_link |
||
| 161 | */ |
||
| 162 | public function test_add_new_site_link() { |
||
| 163 | global $menu; |
||
| 164 | |||
| 165 | // Set jetpack user data. |
||
| 166 | set_transient( 'jetpack_connected_user_data_' . static::$user_id, array( 'site_count' => 1 ) ); |
||
| 167 | |||
| 168 | static::$admin_menu->add_new_site_link(); |
||
| 169 | |||
| 170 | $new_site_menu_item = array( |
||
| 171 | 'Add new site', |
||
| 172 | 'read', |
||
| 173 | 'https://wordpress.com/start?ref=calypso-sidebar', |
||
| 174 | 'Add new site', |
||
| 175 | 'menu-top toplevel_page_https://wordpress.com/start?ref=calypso-sidebar', |
||
| 176 | 'toplevel_page_https://wordpress.com/start?ref=calypso-sidebar', |
||
| 177 | 'dashicons-plus-alt', |
||
| 178 | ); |
||
| 179 | $this->assertSame( $menu[1002], $new_site_menu_item ); // 1001 is the separator position, 1002 is the link position |
||
| 180 | |||
| 181 | delete_transient( 'jetpack_connected_user_data_' . static::$user_id ); |
||
| 182 | } |
||
| 183 | |||
| 184 | /** |
||
| 185 | * Tests add_site_card_menu |
||
| 186 | * |
||
| 187 | * @covers ::add_site_card_menu |
||
| 188 | */ |
||
| 189 | public function test_add_site_card_menu() { |
||
| 190 | global $menu; |
||
| 191 | |||
| 192 | if ( ! function_exists( 'site_is_private' ) ) { |
||
| 193 | function site_is_private() { // phpcs:ignore |
||
| 196 | } |
||
| 197 | static::$admin_menu->add_site_card_menu(); |
||
| 198 | |||
| 199 | $home_url = home_url(); |
||
| 200 | $site_card_menu_item = array( |
||
| 201 | // phpcs:ignore Squiz.Strings.DoubleQuoteUsage.NotRequired |
||
| 202 | ' |
||
| 216 | |||
| 217 | /** |
||
| 218 | * Tests set_site_card_menu_class |
||
| 219 | * |
||
| 220 | * @covers ::set_site_card_menu_class |
||
| 221 | */ |
||
| 222 | public function test_set_site_card_menu_class() { |
||
| 248 | |||
| 249 | /** |
||
| 250 | * Shim wpcomsh fallback site icon. |
||
| 251 | * |
||
| 252 | * @return string |
||
| 253 | */ |
||
| 254 | public function wpcomsh_site_icon_url() { |
||
| 257 | |||
| 258 | /** |
||
| 259 | * Custom site icon. |
||
| 260 | * |
||
| 261 | * @return string |
||
| 262 | */ |
||
| 263 | public function custom_site_icon_url() { |
||
| 266 | |||
| 267 | /** |
||
| 268 | * Tests add_upgrades_menu |
||
| 269 | * |
||
| 270 | * @covers ::add_upgrades_menu |
||
| 271 | */ |
||
| 272 | View Code Duplication | public function test_add_wpcom_upgrades_menu() { |
|
| 314 | |||
| 315 | /** |
||
| 316 | * Tests jetpack_parent_file |
||
| 317 | * |
||
| 318 | * @covers ::jetpack_parent_file |
||
| 319 | */ |
||
| 320 | View Code Duplication | public function test_jetpack_parent_file() { |
|
| 329 | |||
| 330 | /** |
||
| 331 | * Tests add_users_menu |
||
| 332 | * |
||
| 333 | * @covers ::add_users_menu |
||
| 334 | */ |
||
| 335 | View Code Duplication | public function test_add_users_menu() { |
|
| 398 | |||
| 399 | /** |
||
| 400 | * Tests add_tools_menu |
||
| 401 | * |
||
| 402 | * @covers ::add_tools_menu |
||
| 403 | */ |
||
| 404 | View Code Duplication | public function test_add_tools_menu() { |
|
| 480 | |||
| 481 | /** |
||
| 482 | * Tests add_options_menu |
||
| 483 | * |
||
| 484 | * @covers ::add_options_menu |
||
| 485 | */ |
||
| 486 | View Code Duplication | public function test_add_options_menu() { |
|
| 496 | } |
||
| 497 |
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: