jhedstrom /
drupalextension
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:
Complex classes like RawDrupalContext 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 RawDrupalContext, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 25 | class RawDrupalContext extends RawMinkContext implements DrupalAwareInterface { |
||
| 26 | |||
| 27 | /** |
||
| 28 | * Drupal driver manager. |
||
| 29 | * |
||
| 30 | * @var \Drupal\DrupalDriverManager |
||
| 31 | */ |
||
| 32 | private $drupal; |
||
| 33 | |||
| 34 | /** |
||
| 35 | * Test parameters. |
||
| 36 | * |
||
| 37 | * @var array |
||
| 38 | */ |
||
| 39 | private $drupalParameters; |
||
| 40 | |||
| 41 | /** |
||
| 42 | * Event dispatcher object. |
||
| 43 | * |
||
| 44 | * @var \Behat\Testwork\Hook\HookDispatcher |
||
| 45 | */ |
||
| 46 | protected $dispatcher; |
||
| 47 | |||
| 48 | /** |
||
| 49 | * Keep track of nodes so they can be cleaned up. |
||
| 50 | * |
||
| 51 | * @var array |
||
| 52 | */ |
||
| 53 | protected $nodes = array(); |
||
| 54 | |||
| 55 | /** |
||
| 56 | * Current authenticated user. |
||
| 57 | * |
||
| 58 | * A value of FALSE denotes an anonymous user. |
||
| 59 | * |
||
| 60 | * @var \stdClass|bool |
||
| 61 | */ |
||
| 62 | public $user = FALSE; |
||
| 63 | |||
| 64 | /** |
||
| 65 | * Keep track of all users that are created so they can easily be removed. |
||
| 66 | * |
||
| 67 | * @var array |
||
| 68 | */ |
||
| 69 | protected $users = array(); |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Keep track of all terms that are created so they can easily be removed. |
||
| 73 | * |
||
| 74 | * @var array |
||
| 75 | */ |
||
| 76 | protected $terms = array(); |
||
| 77 | |||
| 78 | /** |
||
| 79 | * Keep track of any roles that are created so they can easily be removed. |
||
| 80 | * |
||
| 81 | * @var array |
||
| 82 | */ |
||
| 83 | protected $roles = array(); |
||
| 84 | |||
| 85 | /** |
||
| 86 | * Keep track of any languages that are created so they can easily be removed. |
||
| 87 | * |
||
| 88 | * @var array |
||
| 89 | */ |
||
| 90 | protected $languages = array(); |
||
| 91 | |||
| 92 | /** |
||
| 93 | * {@inheritDoc} |
||
| 94 | */ |
||
| 95 | public function setDrupal(DrupalDriverManager $drupal) { |
||
| 96 | $this->drupal = $drupal; |
||
| 97 | } |
||
| 98 | |||
| 99 | /** |
||
| 100 | * {@inheritDoc} |
||
| 101 | */ |
||
| 102 | public function getDrupal() { |
||
| 105 | |||
| 106 | /** |
||
| 107 | * {@inheritDoc} |
||
| 108 | */ |
||
| 109 | public function setDispatcher(HookDispatcher $dispatcher) { |
||
| 112 | |||
| 113 | /** |
||
| 114 | * Set parameters provided for Drupal. |
||
| 115 | */ |
||
| 116 | public function setDrupalParameters(array $parameters) { |
||
| 119 | |||
| 120 | /** |
||
| 121 | * Returns a specific Drupal parameter. |
||
| 122 | * |
||
| 123 | * @param string $name |
||
| 124 | * Parameter name. |
||
| 125 | * |
||
| 126 | * @return mixed |
||
| 127 | */ |
||
| 128 | public function getDrupalParameter($name) { |
||
| 131 | |||
| 132 | /** |
||
| 133 | * Returns a specific Drupal text value. |
||
| 134 | * |
||
| 135 | * @param string $name |
||
| 136 | * Text value name, such as 'log_out', which corresponds to the default 'Log |
||
| 137 | * out' link text. |
||
| 138 | * @throws \Exception |
||
| 139 | * @return |
||
| 140 | */ |
||
| 141 | public function getDrupalText($name) { |
||
| 142 | $text = $this->getDrupalParameter('text'); |
||
| 143 | if (!isset($text[$name])) { |
||
| 144 | throw new \Exception(sprintf('No such Drupal string: %s', $name)); |
||
| 145 | } |
||
| 146 | return $text[$name]; |
||
| 147 | } |
||
| 148 | |||
| 149 | /** |
||
| 150 | * Returns a specific css selector. |
||
| 151 | * |
||
| 152 | * @param $name |
||
| 153 | * string CSS selector name |
||
| 154 | */ |
||
| 155 | public function getDrupalSelector($name) { |
||
| 156 | $text = $this->getDrupalParameter('selectors'); |
||
| 157 | if (!isset($text[$name])) { |
||
| 158 | throw new \Exception(sprintf('No such selector configured: %s', $name)); |
||
| 159 | } |
||
| 160 | return $text[$name]; |
||
| 161 | } |
||
| 162 | |||
| 163 | /** |
||
| 164 | * Get active Drupal Driver. |
||
| 165 | * |
||
| 166 | * @return \Drupal\Driver\DrupalDriver |
||
| 167 | */ |
||
| 168 | public function getDriver($name = NULL) { |
||
| 171 | |||
| 172 | /** |
||
| 173 | * Get driver's random generator. |
||
| 174 | */ |
||
| 175 | public function getRandom() { |
||
| 178 | |||
| 179 | /** |
||
| 180 | * Massage node values to match the expectations on different Drupal versions. |
||
| 181 | * |
||
| 182 | * @beforeNodeCreate |
||
| 183 | */ |
||
| 184 | public function alterNodeParameters(BeforeNodeCreateScope $scope) { |
||
| 185 | $node = $scope->getEntity(); |
||
| 186 | |||
| 187 | // Get the Drupal API version if available. This is not available when |
||
| 188 | // using e.g. the BlackBoxDriver or DrushDriver. |
||
| 189 | $api_version = NULL; |
||
| 190 | $driver = $scope->getContext()->getDrupal()->getDriver(); |
||
|
|
|||
| 191 | if ($driver instanceof \Drupal\Driver\DrupalDriver) { |
||
| 192 | $api_version = $scope->getContext()->getDrupal()->getDriver()->version; |
||
| 193 | } |
||
| 194 | |||
| 195 | // On Drupal 8 the timestamps should be in UNIX time. |
||
| 196 | switch ($api_version) { |
||
| 197 | case 8: |
||
| 198 | foreach (array('changed', 'created', 'revision_timestamp') as $field) { |
||
| 199 | if (!empty($node->$field) && !is_numeric($node->$field)) { |
||
| 200 | $node->$field = strtotime($node->$field); |
||
| 201 | } |
||
| 202 | } |
||
| 203 | break; |
||
| 204 | } |
||
| 205 | } |
||
| 206 | |||
| 207 | /** |
||
| 208 | * Remove any created nodes. |
||
| 209 | * |
||
| 210 | * @AfterScenario |
||
| 211 | */ |
||
| 212 | public function cleanNodes() { |
||
| 219 | |||
| 220 | /** |
||
| 221 | * Remove any created users. |
||
| 222 | * |
||
| 223 | * @AfterScenario |
||
| 224 | */ |
||
| 225 | public function cleanUsers() { |
||
| 226 | // Remove any users that were created. |
||
| 227 | if (!empty($this->users)) { |
||
| 228 | foreach ($this->users as $user) { |
||
| 229 | $this->getDriver()->userDelete($user); |
||
| 230 | } |
||
| 231 | $this->getDriver()->processBatch(); |
||
| 232 | $this->users = array(); |
||
| 233 | $this->user = FALSE; |
||
| 234 | if ($this->loggedIn()) { |
||
| 235 | $this->logout(); |
||
| 236 | } |
||
| 237 | } |
||
| 238 | } |
||
| 239 | |||
| 240 | /** |
||
| 241 | * Remove any created terms. |
||
| 242 | * |
||
| 243 | * @AfterScenario |
||
| 244 | */ |
||
| 245 | public function cleanTerms() { |
||
| 252 | |||
| 253 | /** |
||
| 254 | * Remove any created roles. |
||
| 255 | * |
||
| 256 | * @AfterScenario |
||
| 257 | */ |
||
| 258 | public function cleanRoles() { |
||
| 265 | |||
| 266 | /** |
||
| 267 | * Remove any created languages. |
||
| 268 | * |
||
| 269 | * @AfterScenario |
||
| 270 | */ |
||
| 271 | public function cleanLanguages() { |
||
| 278 | |||
| 279 | /** |
||
| 280 | * Clear static caches. |
||
| 281 | * |
||
| 282 | * @AfterScenario @api |
||
| 283 | */ |
||
| 284 | public function clearStaticCaches() { |
||
| 285 | $this->getDriver()->clearStaticCaches(); |
||
| 286 | } |
||
| 287 | |||
| 288 | /** |
||
| 289 | * Dispatch scope hooks. |
||
| 290 | * |
||
| 291 | * @param string $scope |
||
| 292 | * The entity scope to dispatch. |
||
| 293 | * @param \stdClass $entity |
||
| 294 | * The entity. |
||
| 295 | */ |
||
| 296 | protected function dispatchHooks($scopeType, \stdClass $entity) { |
||
| 297 | $fullScopeClass = 'Drupal\\DrupalExtension\\Hook\\Scope\\' . $scopeType; |
||
| 298 | $scope = new $fullScopeClass($this->getDrupal()->getEnvironment(), $this, $entity); |
||
| 299 | $callResults = $this->dispatcher->dispatchScopeHooks($scope); |
||
| 300 | |||
| 301 | // The dispatcher suppresses exceptions, throw them here if there are any. |
||
| 302 | foreach ($callResults as $result) { |
||
| 303 | if ($result->hasException()) { |
||
| 304 | $exception = $result->getException(); |
||
| 305 | throw $exception; |
||
| 306 | } |
||
| 307 | } |
||
| 308 | } |
||
| 309 | |||
| 310 | /** |
||
| 311 | * Create a node. |
||
| 312 | * |
||
| 313 | * @return object |
||
| 314 | * The created node. |
||
| 315 | */ |
||
| 316 | View Code Duplication | public function nodeCreate($node) { |
|
| 324 | |||
| 325 | /** |
||
| 326 | * Parse multi-value fields. Possible formats: |
||
| 327 | * A, B, C |
||
| 328 | * A - B, C - D, E - F |
||
| 329 | * |
||
| 330 | * @param string $entity_type |
||
| 331 | * The entity type. |
||
| 332 | * @param \stdClass $entity |
||
| 333 | * An object containing the entity properties and fields as properties. |
||
| 334 | */ |
||
| 335 | public function parseEntityFields($entity_type, \stdClass $entity) { |
||
| 411 | |||
| 412 | /** |
||
| 413 | * Create a user. |
||
| 414 | * |
||
| 415 | * @return object |
||
| 416 | * The created user. |
||
| 417 | */ |
||
| 418 | View Code Duplication | public function userCreate($user) { |
|
| 426 | |||
| 427 | /** |
||
| 428 | * Create a term. |
||
| 429 | * |
||
| 430 | * @return object |
||
| 431 | * The created term. |
||
| 432 | */ |
||
| 433 | View Code Duplication | public function termCreate($term) { |
|
| 441 | |||
| 442 | /** |
||
| 443 | * Creates a language. |
||
| 444 | * |
||
| 445 | * @param \stdClass $language |
||
| 446 | * An object with the following properties: |
||
| 447 | * - langcode: the langcode of the language to create. |
||
| 448 | * |
||
| 449 | * @return object|FALSE |
||
| 450 | * The created language, or FALSE if the language was already created. |
||
| 451 | */ |
||
| 452 | public function languageCreate(\stdClass $language) { |
||
| 461 | |||
| 462 | /** |
||
| 463 | * Log-in the current user. |
||
| 464 | */ |
||
| 465 | public function login() { |
||
| 496 | |||
| 497 | /** |
||
| 498 | * Logs the current user out. |
||
| 499 | */ |
||
| 500 | public function logout() { |
||
| 503 | |||
| 504 | /** |
||
| 505 | * Determine if the a user is already logged in. |
||
| 506 | * |
||
| 507 | * @return boolean |
||
| 508 | * Returns TRUE if a user is logged in for this session. |
||
| 509 | */ |
||
| 510 | public function loggedIn() { |
||
| 538 | |||
| 539 | /** |
||
| 540 | * User with a given role is already logged in. |
||
| 541 | * |
||
| 542 | * @param string $role |
||
| 543 | * A single role, or multiple comma-separated roles in a single string. |
||
| 544 | * |
||
| 545 | * @return boolean |
||
| 546 | * Returns TRUE if the current logged in user has this role (or roles). |
||
| 547 | */ |
||
| 548 | public function loggedInWithRole($role) { |
||
| 551 | |||
| 552 | } |
||
| 553 |
Loading history...
Let’s take a look at an example:
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.
Available Fixes
Change the type-hint for the parameter:
Add an additional type-check:
Add the method to the interface: