phingofficial /
phing
| Total Complexity | 90 |
| Total Lines | 554 |
| Duplicated Lines | 0 % |
| Coverage | 71.03% |
| Changes | 6 | ||
| Bugs | 0 | Features | 0 |
Complex classes like AbstractFileSet 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.
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 AbstractFileSet, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 38 | abstract class AbstractFileSet extends DataType implements SelectorContainer, IteratorAggregate |
||
| 39 | { |
||
| 40 | use SelectorAware; |
||
| 41 | |||
| 42 | // These vars are public for cloning purposes |
||
| 43 | |||
| 44 | /** |
||
| 45 | * @var boolean |
||
| 46 | */ |
||
| 47 | public $useDefaultExcludes = true; |
||
| 48 | |||
| 49 | /** |
||
| 50 | * Whether to expand/dereference symbolic links, default is false |
||
| 51 | * |
||
| 52 | * @var boolean |
||
| 53 | */ |
||
| 54 | protected $expandSymbolicLinks = false; |
||
| 55 | |||
| 56 | /** |
||
| 57 | * @var PatternSet |
||
| 58 | */ |
||
| 59 | public $defaultPatterns; |
||
| 60 | |||
| 61 | public $additionalPatterns = []; |
||
| 62 | public $dir; |
||
| 63 | public $isCaseSensitive = true; |
||
| 64 | private $errorOnMissingDir = false; |
||
| 65 | private $directoryScanner; |
||
| 66 | |||
| 67 | /** |
||
| 68 | * @param null $fileset |
||
|
Documentation
Bug
introduced
by
|
|||
| 69 | */ |
||
| 70 | 123 | public function __construct($fileset = null) |
|
| 71 | { |
||
| 72 | 123 | parent::__construct(); |
|
| 73 | |||
| 74 | 123 | if ($fileset !== null && ($fileset instanceof FileSet)) { |
|
| 75 | 1 | $this->dir = $fileset->dir; |
|
| 76 | 1 | $this->additionalPatterns = $fileset->additionalPatterns; |
|
| 77 | 1 | $this->useDefaultExcludes = $fileset->useDefaultExcludes; |
|
| 78 | 1 | $this->isCaseSensitive = $fileset->isCaseSensitive; |
|
| 79 | 1 | $this->selectorsList = $fileset->selectorsList; |
|
| 80 | 1 | $this->expandSymbolicLinks = $fileset->expandSymbolicLinks; |
|
| 81 | 1 | $this->errorOnMissingDir = $fileset->errorOnMissingDir; |
|
| 82 | 1 | $this->setProject($fileset->getProject()); |
|
| 83 | } |
||
| 84 | |||
| 85 | 123 | $this->defaultPatterns = new PatternSet(); |
|
| 86 | 123 | } |
|
| 87 | |||
| 88 | /** |
||
| 89 | * Sets whether to expand/dereference symbolic links, default is false |
||
| 90 | * |
||
| 91 | * @var boolean |
||
| 92 | */ |
||
| 93 | 1 | public function setExpandSymbolicLinks(bool $expandSymbolicLinks) |
|
| 94 | { |
||
| 95 | 1 | if ($this->isReference()) { |
|
| 96 | 1 | throw $this->tooManyAttributes(); |
|
| 97 | } |
||
| 98 | $this->expandSymbolicLinks = $expandSymbolicLinks; |
||
| 99 | } |
||
| 100 | |||
| 101 | /** |
||
| 102 | * Makes this instance in effect a reference to another PatternSet |
||
| 103 | * instance. |
||
| 104 | * You must not set another attribute or nest elements inside |
||
| 105 | * this element if you make it a reference. |
||
| 106 | * |
||
| 107 | * @param Reference $r |
||
| 108 | * @throws BuildException |
||
| 109 | */ |
||
| 110 | 2 | public function setRefid(Reference $r) |
|
| 122 | 2 | } |
|
| 123 | |||
| 124 | /** |
||
| 125 | * @param $dir |
||
| 126 | * @throws IOException |
||
| 127 | * @throws NullPointerException |
||
| 128 | */ |
||
| 129 | 120 | public function setDir($dir) |
|
| 130 | { |
||
| 131 | 120 | if ($this->isReference()) { |
|
| 132 | 1 | throw $this->tooManyAttributes(); |
|
| 133 | } |
||
| 134 | 119 | if ($dir instanceof PhingFile) { |
|
| 135 | 2 | $dir = $dir->getPath(); |
|
| 136 | } |
||
| 137 | 119 | $this->dir = new PhingFile((string) $dir); |
|
| 138 | 119 | $this->directoryScanner = null; |
|
| 139 | 119 | } |
|
| 140 | |||
| 141 | /** |
||
| 142 | * @param Project $p |
||
| 143 | * @return mixed |
||
| 144 | * @throws BuildException |
||
| 145 | */ |
||
| 146 | 89 | public function getDir(Project $p = null) |
|
| 147 | { |
||
| 148 | 89 | if ($p === null) { |
|
| 149 | $p = $this->getProject(); |
||
| 150 | } |
||
| 151 | |||
| 152 | 89 | if ($this->isReference()) { |
|
| 153 | 1 | return $this->getRef($p)->getDir($p); |
|
| 154 | } |
||
| 155 | |||
| 156 | 89 | return $this->dir; |
|
| 157 | } |
||
| 158 | |||
| 159 | /** |
||
| 160 | * @return mixed |
||
| 161 | * @throws BuildException |
||
| 162 | */ |
||
| 163 | 2 | public function createPatternSet() |
|
| 164 | { |
||
| 165 | 2 | if ($this->isReference()) { |
|
| 166 | 1 | throw $this->noChildrenAllowed(); |
|
| 167 | } |
||
| 168 | 2 | $num = array_push($this->additionalPatterns, new PatternSet()); |
|
| 169 | |||
| 170 | 2 | return $this->additionalPatterns[$num - 1]; |
|
| 171 | } |
||
| 172 | |||
| 173 | /** |
||
| 174 | * add a name entry on the include list |
||
| 175 | */ |
||
| 176 | 77 | public function createInclude() |
|
| 177 | { |
||
| 178 | 77 | if ($this->isReference()) { |
|
| 179 | 1 | throw $this->noChildrenAllowed(); |
|
| 180 | } |
||
| 181 | |||
| 182 | 77 | return $this->defaultPatterns->createInclude(); |
|
| 183 | } |
||
| 184 | |||
| 185 | /** |
||
| 186 | * add a name entry on the include files list |
||
| 187 | */ |
||
| 188 | 1 | public function createIncludesFile() |
|
| 189 | { |
||
| 190 | 1 | if ($this->isReference()) { |
|
| 191 | 1 | throw $this->noChildrenAllowed(); |
|
| 192 | } |
||
| 193 | |||
| 194 | return $this->defaultPatterns->createIncludesFile(); |
||
| 195 | } |
||
| 196 | |||
| 197 | /** |
||
| 198 | * add a name entry on the exclude list |
||
| 199 | */ |
||
| 200 | 2 | public function createExclude() |
|
| 201 | { |
||
| 202 | 2 | if ($this->isReference()) { |
|
| 203 | 1 | throw $this->noChildrenAllowed(); |
|
| 204 | } |
||
| 205 | |||
| 206 | 1 | return $this->defaultPatterns->createExclude(); |
|
| 207 | } |
||
| 208 | |||
| 209 | /** |
||
| 210 | * add a name entry on the include files list |
||
| 211 | */ |
||
| 212 | 1 | public function createExcludesFile() |
|
| 213 | { |
||
| 214 | 1 | if ($this->isReference()) { |
|
| 215 | 1 | throw $this->noChildrenAllowed(); |
|
| 216 | } |
||
| 217 | |||
| 218 | return $this->defaultPatterns->createExcludesFile(); |
||
| 219 | } |
||
| 220 | |||
| 221 | 2 | public function setFile(PhingFile $file) |
|
| 222 | { |
||
| 223 | 2 | if ($this->isReference()) { |
|
| 224 | 1 | throw $this->tooManyAttributes(); |
|
| 225 | } |
||
| 226 | 1 | $this->setDir($file->getParentFile()); |
|
| 227 | 1 | $this->createInclude()->setName($file->getName()); |
|
| 228 | 1 | } |
|
| 229 | |||
| 230 | /** |
||
| 231 | * Sets the set of include patterns. Patterns may be separated by a comma |
||
| 232 | * or a space. |
||
| 233 | * |
||
| 234 | * @param $includes |
||
| 235 | * @throws BuildException |
||
| 236 | */ |
||
| 237 | 4 | public function setIncludes($includes) |
|
| 238 | { |
||
| 239 | 4 | if ($this->isReference()) { |
|
| 240 | 1 | throw $this->tooManyAttributes(); |
|
| 241 | } |
||
| 242 | 4 | $this->defaultPatterns->setIncludes($includes); |
|
| 243 | 4 | } |
|
| 244 | |||
| 245 | /** |
||
| 246 | * Sets the set of exclude patterns. Patterns may be separated by a comma |
||
| 247 | * or a space. |
||
| 248 | * |
||
| 249 | * @param $excludes |
||
| 250 | * @throws BuildException |
||
| 251 | */ |
||
| 252 | 2 | public function setExcludes($excludes) |
|
| 253 | { |
||
| 254 | 2 | if ($this->isReference()) { |
|
| 255 | 1 | throw $this->tooManyAttributes(); |
|
| 256 | } |
||
| 257 | 1 | $this->defaultPatterns->setExcludes($excludes); |
|
| 258 | 1 | } |
|
| 259 | |||
| 260 | /** |
||
| 261 | * Sets the name of the file containing the includes patterns. |
||
| 262 | * |
||
| 263 | * @param PhingFile $incl The file to fetch the include patterns from. |
||
| 264 | * @throws BuildException |
||
| 265 | */ |
||
| 266 | 1 | public function setIncludesfile(PhingFile $incl) |
|
| 267 | { |
||
| 268 | 1 | if ($this->isReference()) { |
|
| 269 | 1 | throw $this->tooManyAttributes(); |
|
| 270 | } |
||
| 271 | $this->defaultPatterns->setIncludesFile($incl); |
||
| 272 | } |
||
| 273 | |||
| 274 | /** |
||
| 275 | * Sets the name of the file containing the includes patterns. |
||
| 276 | * |
||
| 277 | * @param PhingFile $excl The file to fetch the exclude patterns from. |
||
| 278 | * @throws BuildException |
||
| 279 | */ |
||
| 280 | 1 | public function setExcludesfile($excl) |
|
| 281 | { |
||
| 282 | 1 | if ($this->isReference()) { |
|
| 283 | 1 | throw $this->tooManyAttributes(); |
|
| 284 | } |
||
| 285 | $this->defaultPatterns->setExcludesFile($excl); |
||
| 286 | } |
||
| 287 | |||
| 288 | /** |
||
| 289 | * Sets whether default exclusions should be used or not. |
||
| 290 | * |
||
| 291 | * @param $useDefaultExcludes "true"|"on"|"yes" when default exclusions |
||
| 292 | * should be used, "false"|"off"|"no" when they |
||
| 293 | * shouldn't be used. |
||
| 294 | * @throws BuildException |
||
| 295 | * @return void |
||
| 296 | */ |
||
| 297 | 3 | public function setDefaultexcludes($useDefaultExcludes) |
|
| 298 | { |
||
| 299 | 3 | if ($this->isReference()) { |
|
| 300 | throw $this->tooManyAttributes(); |
||
| 301 | } |
||
| 302 | 3 | $this->useDefaultExcludes = $useDefaultExcludes; |
|
| 303 | 3 | } |
|
| 304 | |||
| 305 | /** |
||
| 306 | * Sets case sensitivity of the file system |
||
| 307 | * |
||
| 308 | * @param $isCaseSensitive |
||
| 309 | */ |
||
| 310 | 1 | public function setCaseSensitive($isCaseSensitive) |
|
| 311 | { |
||
| 312 | 1 | if ($this->isReference()) { |
|
| 313 | 1 | throw $this->tooManyAttributes(); |
|
| 314 | } |
||
| 315 | $this->isCaseSensitive = $isCaseSensitive; |
||
| 316 | } |
||
| 317 | |||
| 318 | /** |
||
| 319 | * returns a reference to the dirscanner object belonging to this fileset |
||
| 320 | * |
||
| 321 | * @param Project $p |
||
| 322 | * @throws BuildException |
||
| 323 | * @return \DirectoryScanner |
||
| 324 | */ |
||
| 325 | 103 | public function getDirectoryScanner(Project $p = null) |
|
| 355 | } |
||
| 356 | |||
| 357 | /** |
||
| 358 | * feed dirscanner with infos defined by this fileset |
||
| 359 | * |
||
| 360 | * @param DirectoryScanner $ds |
||
| 361 | * @param Project $p |
||
| 362 | * @throws BuildException |
||
| 363 | */ |
||
| 364 | 102 | protected function setupDirectoryScanner(DirectoryScanner $ds, Project $p = null) |
|
| 365 | { |
||
| 366 | 102 | if ($p === null) { |
|
| 367 | $p = $this->getProject(); |
||
| 368 | } |
||
| 369 | |||
| 370 | 102 | if ($this->isReference()) { |
|
| 371 | $this->getRef($p)->setupDirectoryScanner($ds, $p); |
||
| 372 | return; |
||
| 373 | } |
||
| 374 | |||
| 375 | 102 | $stk[] = $this; |
|
| 376 | 102 | $this->dieOnCircularReference($stk, $p); |
|
| 377 | 102 | array_pop($stk); |
|
| 378 | |||
| 379 | // FIXME - pass dir directly when dirscanner supports File |
||
| 380 | 102 | $ds->setBasedir($this->dir->getPath()); |
|
| 381 | |||
| 382 | 102 | foreach ($this->additionalPatterns as $addPattern) { |
|
| 383 | 1 | $this->defaultPatterns->append($addPattern, $p); |
|
| 384 | } |
||
| 385 | |||
| 386 | 102 | $ds->setIncludes($this->defaultPatterns->getIncludePatterns($p)); |
|
| 387 | 102 | $ds->setExcludes($this->defaultPatterns->getExcludePatterns($p)); |
|
| 388 | |||
| 389 | 102 | $p->log( |
|
| 390 | 102 | $this->getDataTypeName() . ": Setup file scanner in dir " . (string) $this->dir . " with " . (string) $this->defaultPatterns, |
|
| 391 | 102 | Project::MSG_DEBUG |
|
| 392 | ); |
||
| 393 | |||
| 394 | 102 | if ($ds instanceof SelectorScanner) { |
|
| 395 | 102 | $selectors = $this->getSelectors($p); |
|
| 396 | 102 | foreach ($selectors as $selector) { |
|
| 397 | 5 | $p->log((string) $selector . PHP_EOL, Project::MSG_DEBUG); |
|
| 398 | } |
||
| 399 | 102 | $ds->setSelectors($selectors); |
|
| 400 | } |
||
| 401 | |||
| 402 | 102 | if ($this->useDefaultExcludes) { |
|
| 403 | 100 | $ds->addDefaultExcludes(); |
|
| 404 | } |
||
| 405 | 102 | $ds->setCaseSensitive($this->isCaseSensitive); |
|
| 406 | 102 | } |
|
| 407 | |||
| 408 | 102 | public function dieOnCircularReference(&$stk, Project $p = null) |
|
| 409 | { |
||
| 410 | 102 | if ($this->checked) { |
|
| 411 | 99 | return; |
|
| 412 | } |
||
| 413 | 5 | if ($this->isReference()) { |
|
| 414 | 1 | parent::dieOnCircularReference($stk, $p); |
|
| 415 | } else { |
||
| 416 | 5 | foreach ($this->selectorsList as $fileSelector) { |
|
| 417 | 5 | if ($fileSelector instanceof DataType) { |
|
| 418 | 5 | static::pushAndInvokeCircularReferenceCheck($fileSelector, $stk, $p); |
|
| 419 | } |
||
| 420 | } |
||
| 421 | 5 | foreach ($this->additionalPatterns as $ps) { |
|
| 422 | static::pushAndInvokeCircularReferenceCheck($ps, $stk, $p); |
||
| 423 | } |
||
| 424 | 5 | $this->setChecked(true); |
|
| 425 | } |
||
| 426 | 5 | } |
|
| 427 | |||
| 428 | /** |
||
| 429 | * Performs the check for circular references and returns the |
||
| 430 | * referenced FileSet. |
||
| 431 | * |
||
| 432 | * @param Project $p |
||
| 433 | * |
||
| 434 | * @throws BuildException |
||
| 435 | * |
||
| 436 | * @return FileSet |
||
| 437 | */ |
||
| 438 | 1 | public function getRef(Project $p) |
|
| 439 | { |
||
| 440 | 1 | return $this->getCheckedRef(__CLASS__, $this->getDataTypeName()); |
|
| 441 | } |
||
| 442 | |||
| 443 | // SelectorContainer methods |
||
| 444 | |||
| 445 | /** |
||
| 446 | * Indicates whether there are any selectors here. |
||
| 447 | * |
||
| 448 | * @return boolean Whether any selectors are in this container |
||
| 449 | */ |
||
| 450 | public function hasSelectors() |
||
| 451 | { |
||
| 452 | if ($this->isReference() && $this->getProject() !== null) { |
||
| 453 | return $this->getRef($this->getProject())->hasSelectors(); |
||
| 454 | } |
||
| 455 | $stk[] = $this; |
||
| 456 | $this->dieOnCircularReference($stk, $this->getProject()); |
||
| 457 | |||
| 458 | return !empty($this->selectorsList); |
||
| 459 | } |
||
| 460 | |||
| 461 | /** |
||
| 462 | * Indicates whether there are any patterns here. |
||
| 463 | * |
||
| 464 | * @return boolean Whether any patterns are in this container. |
||
| 465 | */ |
||
| 466 | public function hasPatterns() |
||
| 467 | { |
||
| 468 | if ($this->isReference() && $this->getProject() !== null) { |
||
| 469 | return $this->getRef($this->getProject())->hasPatterns(); |
||
| 470 | } |
||
| 471 | $stk[] = $this; |
||
| 472 | $this->dieOnCircularReference($stk, $this->getProject()); |
||
| 473 | |||
| 474 | if ($this->defaultPatterns->hasPatterns()) { |
||
| 475 | return true; |
||
| 476 | } |
||
| 477 | |||
| 478 | for ($i = 0, $size = count($this->additionalPatterns); $i < $size; $i++) { |
||
| 479 | $ps = $this->additionalPatterns[$i]; |
||
| 480 | if ($ps->hasPatterns()) { |
||
| 481 | return true; |
||
| 482 | } |
||
| 483 | } |
||
| 484 | |||
| 485 | return false; |
||
| 486 | } |
||
| 487 | |||
| 488 | /** |
||
| 489 | * Gives the count of the number of selectors in this container |
||
| 490 | * |
||
| 491 | * @throws Exception |
||
| 492 | * @return int The number of selectors in this container |
||
| 493 | */ |
||
| 494 | public function count() |
||
| 495 | { |
||
| 496 | if ($this->isReference() && $this->getProject() !== null) { |
||
| 497 | try { |
||
| 498 | return $this->getRef($this->getProject())->count(); |
||
| 499 | } catch (Exception $e) { |
||
| 500 | throw $e; |
||
| 501 | } |
||
| 502 | } |
||
| 503 | |||
| 504 | return count($this->selectorsList); |
||
| 505 | } |
||
| 506 | |||
| 507 | /** |
||
| 508 | * Returns the set of selectors as an array. |
||
| 509 | * |
||
| 510 | * @param Project $p |
||
| 511 | * @throws BuildException |
||
| 512 | * @return array of selectors in this container |
||
| 513 | */ |
||
| 514 | 102 | public function getSelectors(Project $p) |
|
| 527 | } |
||
| 528 | |||
| 529 | /** |
||
| 530 | * Returns an array for accessing the set of selectors. |
||
| 531 | * |
||
| 532 | * @return array The array of selectors |
||
| 533 | */ |
||
| 534 | public function selectorElements() |
||
| 535 | { |
||
| 536 | if ($this->isReference() && $this->getProject() !== null) { |
||
| 537 | return $this->getRef($this->getProject())->selectorElements(); |
||
| 538 | } |
||
| 539 | |||
| 540 | return $this->selectorsList; |
||
| 541 | } |
||
| 542 | |||
| 543 | /** |
||
| 544 | * Add a new selector into this container. |
||
| 545 | * |
||
| 546 | * @param FileSelector $selector new selector to add |
||
| 547 | * |
||
| 548 | * @throws BuildException |
||
| 549 | * |
||
| 550 | * @return void |
||
| 551 | */ |
||
| 552 | 8 | public function appendSelector(FileSelector $selector) |
|
| 553 | { |
||
| 554 | 8 | if ($this->isReference()) { |
|
| 555 | throw $this->noChildrenAllowed(); |
||
| 556 | } |
||
| 557 | 8 | $this->selectorsList[] = $selector; |
|
| 558 | 8 | $this->directoryScanner = null; |
|
| 559 | 8 | $this->setChecked(false); |
|
| 560 | 8 | } |
|
| 561 | |||
| 562 | /** |
||
| 563 | * @param array ...$options |
||
| 564 | * @return ArrayIterator |
||
| 565 | */ |
||
| 566 | 19 | public function getIterator(...$options): \ArrayIterator |
|
| 572 | } |
||
| 573 | |||
| 574 | abstract protected function getFiles(...$options); |
||
| 575 | |||
| 576 | public function __toString() |
||
| 577 | { |
||
| 578 | try { |
||
| 579 | if ($this->isReference()) { |
||
| 580 | return (string) $this->getRef($this->getProject()); |
||
| 581 | } |
||
| 582 | $stk[] = $this; |
||
| 583 | $this->dieOnCircularReference($stk, $this->getProject()); |
||
| 584 | $ds = $this->getDirectoryScanner($this->getProject()); |
||
| 585 | $files = $ds->getIncludedFiles(); |
||
| 586 | $result = implode(';', $files); |
||
| 592 | } |
||
| 593 | } |
||
| 594 |
Loading history...
