| Total Complexity | 40 |
| Total Lines | 242 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like Package 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 Package, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 15 | class Package |
||
| 16 | { |
||
| 17 | protected $package; |
||
| 18 | |||
| 19 | /** |
||
| 20 | * @var array composer.json raw data array |
||
| 21 | */ |
||
| 22 | protected $data; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * @var string absolute path to the root base directory |
||
| 26 | */ |
||
| 27 | protected $baseDir; |
||
| 28 | |||
| 29 | /** |
||
| 30 | * @var string absolute path to vendor directory |
||
| 31 | */ |
||
| 32 | protected $vendorDir; |
||
| 33 | |||
| 34 | /** |
||
| 35 | * @var Filesystem utility |
||
| 36 | */ |
||
| 37 | protected $filesystem; |
||
| 38 | |||
| 39 | public function __construct(PackageInterface $package, Composer $composer) |
||
| 40 | { |
||
| 41 | $this->package = $package; |
||
| 42 | $this->composer = $composer; |
||
|
|
|||
| 43 | } |
||
| 44 | |||
| 45 | /** |
||
| 46 | * Collects package aliases. |
||
| 47 | * @return array collected aliases |
||
| 48 | */ |
||
| 49 | public function collectAliases(): array |
||
| 50 | { |
||
| 51 | $aliases = array_merge( |
||
| 52 | $this->prepareAliases('psr-0'), |
||
| 53 | $this->prepareAliases('psr-4') |
||
| 54 | ); |
||
| 55 | if ($this->isRoot()) { |
||
| 56 | $aliases = array_merge($aliases, |
||
| 57 | $this->prepareAliases('psr-0', true), |
||
| 58 | $this->prepareAliases('psr-4', true) |
||
| 59 | ); |
||
| 60 | } |
||
| 61 | |||
| 62 | return $aliases; |
||
| 63 | } |
||
| 64 | |||
| 65 | /** |
||
| 66 | * Prepare aliases. |
||
| 67 | * @param string 'psr-0' or 'psr-4' |
||
| 68 | * @return array |
||
| 69 | */ |
||
| 70 | protected function prepareAliases($psr, $dev = false) |
||
| 71 | { |
||
| 72 | $autoload = $dev ? $this->getDevAutoload() : $this->getAutoload(); |
||
| 73 | if (empty($autoload[$psr])) { |
||
| 74 | return []; |
||
| 75 | } |
||
| 76 | |||
| 77 | $aliases = []; |
||
| 78 | foreach ($autoload[$psr] as $name => $path) { |
||
| 79 | if (is_array($path)) { |
||
| 80 | // ignore psr-4 autoload specifications with multiple search paths |
||
| 81 | // we can not convert them into aliases as they are ambiguous |
||
| 82 | continue; |
||
| 83 | } |
||
| 84 | $name = str_replace('\\', '/', trim($name, '\\')); |
||
| 85 | $path = $this->preparePath($path); |
||
| 86 | if ('psr-0' === $psr) { |
||
| 87 | $path .= '/' . $name; |
||
| 88 | } |
||
| 89 | $aliases["@$name"] = $path; |
||
| 90 | } |
||
| 91 | |||
| 92 | return $aliases; |
||
| 93 | } |
||
| 94 | |||
| 95 | public function getPrettyName(): string |
||
| 96 | { |
||
| 97 | return $this->package->getPrettyName(); |
||
| 98 | } |
||
| 99 | |||
| 100 | public function getVersion(): string |
||
| 101 | { |
||
| 102 | return $this->package->getVersion(); |
||
| 103 | } |
||
| 104 | |||
| 105 | public function getFullPrettyVersion(): string |
||
| 106 | { |
||
| 107 | return $this->package->getFullPrettyVersion(); |
||
| 108 | } |
||
| 109 | |||
| 110 | public function getSourceReference(): string |
||
| 111 | { |
||
| 112 | return $this->package->getSourceReference(); |
||
| 113 | } |
||
| 114 | |||
| 115 | public function getDistReference(): string |
||
| 116 | { |
||
| 117 | return $this->package->getDistReference(); |
||
| 118 | } |
||
| 119 | |||
| 120 | public function isComplete(): bool |
||
| 123 | } |
||
| 124 | |||
| 125 | public function isRoot(): bool |
||
| 126 | { |
||
| 127 | return $this->package instanceof RootPackageInterface; |
||
| 128 | } |
||
| 129 | |||
| 130 | public function getType(): string |
||
| 131 | { |
||
| 132 | return $this->getRawValue('type') ?? $this->package->getType(); |
||
| 133 | } |
||
| 134 | |||
| 135 | public function getAutoload(): array |
||
| 136 | { |
||
| 137 | return $this->getRawValue('autoload') ?? $this->package->getAutoload(); |
||
| 138 | } |
||
| 139 | |||
| 140 | public function getDevAutoload(): array |
||
| 141 | { |
||
| 142 | return $this->getRawValue('autoload-dev') ?? $this->package->getDevAutoload(); |
||
| 143 | } |
||
| 144 | |||
| 145 | public function getRequires(): array |
||
| 146 | { |
||
| 147 | return $this->getRawValue('require') ?? $this->package->getRequires(); |
||
| 148 | } |
||
| 149 | |||
| 150 | public function getDevRequires(): array |
||
| 151 | { |
||
| 152 | return $this->getRawValue('require-dev') ?? $this->package->getDevRequires(); |
||
| 153 | } |
||
| 154 | |||
| 155 | public function getExtra(): array |
||
| 156 | { |
||
| 157 | return $this->getRawValue('extra') ?? $this->package->getExtra(); |
||
| 158 | } |
||
| 159 | |||
| 160 | public function getRawValue(string $name) |
||
| 167 | } |
||
| 168 | |||
| 169 | public function getRawData(): array |
||
| 176 | } |
||
| 177 | |||
| 178 | /** |
||
| 179 | * @return array |
||
| 180 | */ |
||
| 181 | protected function readRawData(): array |
||
| 182 | { |
||
| 183 | $path = $this->preparePath('composer.json'); |
||
| 184 | if (file_exists($path)) { |
||
| 185 | return json_decode(file_get_contents($path), true); |
||
| 186 | } |
||
| 187 | |||
| 188 | return []; |
||
| 189 | } |
||
| 190 | |||
| 191 | /** |
||
| 192 | * Builds path inside of a package. |
||
| 193 | * @param Package $package |
||
| 194 | * @param mixed $path can be absolute or relative |
||
| 195 | * @return string absolute paths will stay untouched |
||
| 196 | */ |
||
| 197 | public function preparePath(string $file): string |
||
| 198 | { |
||
| 199 | if (0 === strncmp($file, '$', 1)) { |
||
| 200 | return $file; |
||
| 201 | } |
||
| 202 | |||
| 203 | $skippable = 0 === strncmp($file, '?', 1) ? '?' : ''; |
||
| 204 | if ($skippable) { |
||
| 205 | $file = substr($file, 1); |
||
| 206 | } |
||
| 207 | |||
| 208 | |||
| 209 | if (!$this->getFilesystem()->isAbsolutePath($file)) { |
||
| 210 | $prefix = $this->isRoot() |
||
| 211 | ? $this->getBaseDir() |
||
| 212 | : $this->getVendorDir() . '/' . $this->getPrettyName(); |
||
| 213 | $file = $prefix . '/' . $file; |
||
| 214 | } |
||
| 215 | |||
| 216 | return $skippable . $this->getFilesystem()->normalizePath($file); |
||
| 217 | } |
||
| 218 | |||
| 219 | /** |
||
| 220 | * Get absolute path to package base dir. |
||
| 221 | * @return string |
||
| 222 | */ |
||
| 223 | public function getBaseDir() |
||
| 224 | { |
||
| 225 | if (null === $this->baseDir) { |
||
| 226 | $this->baseDir = dirname($this->getVendorDir()); |
||
| 227 | } |
||
| 228 | |||
| 229 | return $this->baseDir; |
||
| 230 | } |
||
| 231 | |||
| 232 | /** |
||
| 233 | * Get absolute path to composer vendor dir. |
||
| 234 | * @return string |
||
| 235 | */ |
||
| 236 | public function getVendorDir() |
||
| 237 | { |
||
| 238 | if (null === $this->vendorDir) { |
||
| 239 | $dir = $this->composer->getConfig()->get('vendor-dir'); |
||
| 240 | $this->vendorDir = $this->getFilesystem()->normalizePath($dir); |
||
| 241 | } |
||
| 242 | |||
| 243 | return $this->vendorDir; |
||
| 244 | } |
||
| 245 | |||
| 246 | /** |
||
| 247 | * Getter for filesystem utility. |
||
| 248 | * @return Filesystem |
||
| 249 | */ |
||
| 250 | public function getFilesystem() |
||
| 257 | } |
||
| 258 | } |
||
| 259 |