Complex classes like ThemeConfiguration 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 ThemeConfiguration, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 9 | class ThemeConfiguration extends AbstractConfigurableElement implements NavigableThemeInterface |
||
|
|
|||
| 10 | { |
||
| 11 | |||
| 12 | const THEME = 'Magium\Magento\Themes\Admin\ThemeConfiguration'; |
||
| 13 | |||
| 14 | public $baseUrl = 'http://localhost/admin'; |
||
| 15 | |||
| 16 | public $homeXpath = '//img[@class="logo"]'; |
||
| 17 | |||
| 18 | public $loginUsernameField = '//input[@type="text" and @id="username"]'; |
||
| 19 | public $loginPasswordField = '//input[@type="password" and @id="login"]'; |
||
| 20 | public $loginSubmitButton = '//input[@type="submit" and @value="{{Login}}"]'; |
||
| 21 | |||
| 22 | public $navigationBaseXPathSelector = '//ul[@id="nav"]'; |
||
| 23 | // public $navigationChildXPathSelector1 = 'li/descendant::span[.="{{%s}}"]'; |
||
| 24 | public $navigationChildXPathSelector = 'a[concat(" ",normalize-space(.)," ") = " {{%s}} "]/..'; |
||
| 25 | |||
| 26 | public $adminPopupMessageContainerXpath = '//*[@id="message-popup-window"]'; |
||
| 27 | public $adminPopupMessageCloseButtonXpath = '//*[@id="message-popup-window"]/descendant::*[@title="close"]'; |
||
| 28 | |||
| 29 | public $systemConfigTabsXpath = '//ul[@id="system_config_tabs"]/descendant::a[concat(" ",normalize-space(.)," ") = " {{%s}} "]'; |
||
| 30 | public $systemConfigSectionToggleXpath = '//form[@id="config_edit_form"]/descendant::div[contains(concat(" ",normalize-space(@class)," ")," section-config ")]/descendant::a[.="{{%s}}"]'; |
||
| 31 | public $systemConfigSectionDisplayCheckXpath = '//legend[.="{{%s}}"]/ancestor::fieldset'; |
||
| 32 | public $systemConfigToggleEnableXpath = '//legend[.="{{%s}}"]/../descendant::td[concat(" ",normalize-space(.)," ") = " {{Enabled}} "]/../td/descendant::select/option[@value="%d"]'; |
||
| 33 | |||
| 34 | public $xTreeRootXpath = '//ul[contains(concat(" ",normalize-space(@class)," ")," x-tree-root-ct ")]/div/li[contains(concat(" ",normalize-space(@class)," ")," x-tree-node ")]/div/a'; |
||
| 35 | public $xTreeNamedRootXpath = '//ul[contains(concat(" ",normalize-space(@class)," ")," x-tree-root-ct ")]/div/li[contains(concat(" ",normalize-space(@class)," ")," x-tree-node ")]/div/a[contains(concat("---",normalize-space(.)), "---{{%s}} (")]'; |
||
| 36 | public $xTreeChildXpath = 'ul/li[contains(concat(" ",normalize-space(@class)," ")," x-tree-node ")]/div/a/span[contains(concat("---",normalize-space(.)), "---{{%s}} (")]/..'; |
||
| 37 | public $xTreeChildNodePrefixXpath = '/../..'; |
||
| 38 | public $xTreeChildNodeExpandPrefixXpath = '/../img[contains(concat(" ",normalize-space(@class)," ")," x-tree-ec-icon ")]'; |
||
| 39 | |||
| 40 | public $systemConfigurationSaveButtonXpath = '//div[@class="main-col-inner"]/div[@class="content-header"]/descendant::button[@title="{{Save Config}}"]'; |
||
| 41 | |||
| 42 | public $systemConfigSaveSuccessfulXpath = '//li[@class="success-msg"]/descendant::span[.="{{The configuration has been saved}}."]'; |
||
| 43 | |||
| 44 | public $testLoggedInAtBaseUrl = '//a[@class="active"]/span[.="{{Dashboard}}"]'; |
||
| 45 | |||
| 46 | public $tableButtonXpath = '//table[@class="actions"]/descendant::span[.="{{%s}}"]'; |
||
| 47 | |||
| 48 | public $selectOrderXpath = '//table[@id="sales_order_grid_table"]/descendant::td[concat(" ",normalize-space(.)," ") = " %s "]/../td/a[.="{{View}}"]'; |
||
| 49 | public $selectCustomerXpath = '//table[@id="customerGrid_table"]/descendant::td[concat(" ",normalize-space(.)," ") = " %s "]/../td/a[.="{{Edit}}"]'; |
||
| 50 | |||
| 51 | public $systemConfigSettingLabelXpath = '//td[@class="label"]/label[.=" {{%s}}"]'; |
||
| 52 | |||
| 53 | public $widgetTabXpath = '//a[contains(@class, "tab-item-link")]/span[.="{{%s}}"]'; |
||
| 54 | public $widgetTabHeaderXpath = '//div[@class="entry-edit-head"]/h4[.="{{%s}}"]'; |
||
| 55 | public $widgetAttributeByLabelXpath = '//table[@class="form-list"]/descendant::td[@class="label"]/label[.="{{%s}} *" or .="{{%s}}*" or .="{{%s}} " or .="{{%s}}"]/ancestor::tr/td[@class="value"]/*[@name]'; |
||
| 56 | public $widgetActionButtonXpath = '//div[@class="content-header"]/descendant::button/descendant::span[.="{{%s}}"]'; |
||
| 57 | |||
| 58 | public $guaranteedPageLoadedElementDisplayedXpath = '//div[@class="footer"]'; |
||
| 59 | |||
| 60 | public $successfulActionXpath = '//li[@class="success-msg"]'; |
||
| 61 | public $errorActionXpath = '//li[@class="error-msg"]'; |
||
| 62 | |||
| 63 | public $shippingCarrierXpath = '//select[@name="tracking[%d][carrier_code]"]'; |
||
| 64 | public $shippingTitleXpath = '//input[@name="tracking[%d][title]"]'; |
||
| 65 | public $shippingTrackingNumberXpath = '//input[@name="tracking[%d][number]"]'; |
||
| 66 | |||
| 67 | public $formButtonXpath = '//div[@class="content-header"]/p[@class="form-buttons"]/descendant::span[.="{{%s}}"]'; |
||
| 68 | |||
| 69 | public $cacheNavigationPath = '{{System}}/{{Cache Management}}'; |
||
| 70 | |||
| 71 | public $cacheTargetXpath = '//input[@name="types" and @value="{{%s}}"]'; |
||
| 72 | |||
| 73 | public $cacheAllTargetsXpath = '//input[@name="types"]'; |
||
| 74 | |||
| 75 | public $cacheMassActionOptionXpath = '//select[@id="cache_grid_massaction-select"]/option[@value="{{%s}}"]'; |
||
| 76 | |||
| 77 | public $cacheSubmitXpath = '//button[@title="{{Submit}}"]'; |
||
| 78 | |||
| 79 | /** |
||
| 80 | * @return string |
||
| 81 | */ |
||
| 82 | public function getCacheSubmitXpath() |
||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | /** |
||
| 90 | * @return string |
||
| 91 | */ |
||
| 92 | public function getCacheMassActionOptionXpath($option) |
||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | /** |
||
| 101 | * @return string |
||
| 102 | */ |
||
| 103 | public function getCacheAllTargetsXpath() |
||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | /** |
||
| 111 | * @return string |
||
| 112 | */ |
||
| 113 | public function getCacheTargetXpath($type) |
||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | /** |
||
| 122 | * @return string |
||
| 123 | */ |
||
| 124 | public function getCacheNavigationPath() |
||
| 128 | |||
| 129 | |||
| 130 | public function getFormButtonXpath($button) |
||
| 135 | |||
| 136 | /** |
||
| 137 | * @return string |
||
| 138 | */ |
||
| 139 | public function getShippingCarrierXpath($count) |
||
| 144 | |||
| 145 | /** |
||
| 146 | * @return string |
||
| 147 | */ |
||
| 148 | public function getShippingTitleXpath($count) |
||
| 153 | |||
| 154 | /** |
||
| 155 | * @return string |
||
| 156 | */ |
||
| 157 | public function getShippingTrackingNumberXpath($count) |
||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | /** |
||
| 166 | * @return string |
||
| 167 | */ |
||
| 168 | public function getXTreeChildNodeExpandPrefixXpath() |
||
| 172 | |||
| 173 | /** |
||
| 174 | * @return string |
||
| 175 | */ |
||
| 176 | public function getXTreeNamedRootXpath($category) |
||
| 181 | |||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | /** |
||
| 186 | * @return string |
||
| 187 | */ |
||
| 188 | public function getXTreeChildNodePrefixXpath() |
||
| 192 | |||
| 193 | /** |
||
| 194 | * @return string |
||
| 195 | */ |
||
| 196 | public function getXTreeChildXpath($name) |
||
| 201 | |||
| 202 | /** |
||
| 203 | * @return string |
||
| 204 | */ |
||
| 205 | public function getXTreeRootXpath() |
||
| 209 | |||
| 210 | |||
| 211 | |||
| 212 | public function set($name, $value) |
||
| 216 | |||
| 217 | /** |
||
| 218 | * @return string |
||
| 219 | */ |
||
| 220 | public function getSuccessfulActionXpath() |
||
| 224 | |||
| 225 | /** |
||
| 226 | * @return string |
||
| 227 | */ |
||
| 228 | public function getErrorActionXpath() |
||
| 232 | |||
| 233 | |||
| 234 | |||
| 235 | /** |
||
| 236 | * @return string |
||
| 237 | */ |
||
| 238 | public function getWidgetActionButtonXpath($label) |
||
| 242 | |||
| 243 | /** |
||
| 244 | * @return string |
||
| 245 | */ |
||
| 246 | public function getWidgetAttributeByLabelXpath($attribute) |
||
| 250 | |||
| 251 | |||
| 252 | |||
| 253 | /** |
||
| 254 | * @return string |
||
| 255 | */ |
||
| 256 | public function getWidgetTabHeaderXpath($name) |
||
| 260 | |||
| 261 | /** |
||
| 262 | * @return string |
||
| 263 | */ |
||
| 264 | public function getWidgetTabXpath($name) |
||
| 268 | |||
| 269 | |||
| 270 | |||
| 271 | public function getGuaranteedPageLoadedElementDisplayedXpath() |
||
| 275 | |||
| 276 | /** |
||
| 277 | * @param mixed $guaranteedPageLoadedElementDisplayedXpath |
||
| 278 | */ |
||
| 279 | public function setGuaranteedPageLoadedElementDisplayedXpath($guaranteedPageLoadedElementDisplayedXpath) |
||
| 283 | |||
| 284 | /** |
||
| 285 | * @return string |
||
| 286 | */ |
||
| 287 | public function getHomeXpath() |
||
| 291 | |||
| 292 | /** |
||
| 293 | * @return string |
||
| 294 | */ |
||
| 295 | public function getSystemConfigSettingLabelXpath($label) |
||
| 300 | |||
| 301 | /** |
||
| 302 | * Why is this an option? So you can have a different theme setup for different languages and still use the same code. |
||
| 303 | * |
||
| 304 | * @var string |
||
| 305 | */ |
||
| 306 | |||
| 307 | public $searchButtonText = '{{Search}}'; |
||
| 308 | |||
| 309 | /** |
||
| 310 | * @return Translator |
||
| 311 | */ |
||
| 312 | public function getTranslator() |
||
| 316 | |||
| 317 | /** |
||
| 318 | * @return string |
||
| 319 | */ |
||
| 320 | public function getLoginUsernameField() |
||
| 324 | |||
| 325 | /** |
||
| 326 | * @return string |
||
| 327 | */ |
||
| 328 | public function getLoginPasswordField() |
||
| 332 | |||
| 333 | /** |
||
| 334 | * @return string |
||
| 335 | */ |
||
| 336 | public function getLoginSubmitButton() |
||
| 340 | |||
| 341 | /** |
||
| 342 | * @return string |
||
| 343 | */ |
||
| 344 | public function getNavigationBaseXPathSelector() |
||
| 348 | |||
| 349 | /** |
||
| 350 | * @return string |
||
| 351 | */ |
||
| 352 | public function getNavigationChildXPathSelector($text) |
||
| 357 | |||
| 358 | /** |
||
| 359 | * @return mixed |
||
| 360 | */ |
||
| 361 | public function getBaseUrl() |
||
| 365 | |||
| 366 | /** |
||
| 367 | * @return string |
||
| 368 | */ |
||
| 369 | public function getSearchButtonText() |
||
| 373 | |||
| 374 | |||
| 375 | |||
| 376 | /** |
||
| 377 | * @return string |
||
| 378 | */ |
||
| 379 | public function getSelectOrderXpath($order) |
||
| 384 | /** |
||
| 385 | * @return string |
||
| 386 | */ |
||
| 387 | public function getSelectCustomerXpath($value) |
||
| 392 | |||
| 393 | /** |
||
| 394 | * @return string |
||
| 395 | */ |
||
| 396 | public function getTableButtonXpath($buttonValue) |
||
| 401 | |||
| 402 | |||
| 403 | |||
| 404 | /** |
||
| 405 | * @return string |
||
| 406 | */ |
||
| 407 | public function getTestLoggedInAtBaseUrl() |
||
| 411 | |||
| 412 | |||
| 413 | |||
| 414 | /** |
||
| 415 | * @return string |
||
| 416 | */ |
||
| 417 | public function getSystemConfigSaveSuccessfulXpath() |
||
| 421 | |||
| 422 | /** |
||
| 423 | * @return string |
||
| 424 | */ |
||
| 425 | public function getSystemConfigurationSaveButtonXpath() |
||
| 429 | |||
| 430 | /** |
||
| 431 | * @return string |
||
| 432 | */ |
||
| 433 | public function getSystemConfigSectionToggleXpath($section) |
||
| 438 | |||
| 439 | /** |
||
| 440 | * @return string |
||
| 441 | */ |
||
| 442 | public function getSystemConfigSectionDisplayCheckXpath($section) |
||
| 447 | |||
| 448 | /** |
||
| 449 | * @return string |
||
| 450 | */ |
||
| 451 | public function getSystemConfigToggleEnableXpath($section, $option) |
||
| 456 | |||
| 457 | /** |
||
| 458 | * @return string |
||
| 459 | */ |
||
| 460 | public function getSystemConfigTabsXpath($tabName) |
||
| 465 | |||
| 466 | |||
| 467 | public function getAdminPopupMessageContainerXpath() |
||
| 471 | |||
| 472 | public function getAdminPopupMessageCloseButtonXpath() |
||
| 476 | |||
| 477 | public function configure(AbstractTestCase $testCase) |
||
| 481 | |||
| 482 | } |