nelson6e65 /
php_nml
| Total Complexity | 51 |
| Total Lines | 327 |
| Duplicated Lines | 0 % |
| Coverage | 94.69% |
| Changes | 0 | ||
Complex classes like Version 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 Version, and based on these observations, apply Extract Interface, too.
| 1 | <?php declare(strict_types=1); |
||
| 39 | final class Version extends StrictObject implements IEquatable, IComparable, IMagicPropertiesContainer |
||
| 40 | { |
||
| 41 | /** |
||
| 42 | * The version metadata. |
||
| 43 | * |
||
| 44 | * @var array |
||
| 45 | */ |
||
| 46 | private $versionMetaData = []; |
||
| 47 | |||
| 48 | /** |
||
| 49 | * Crea una nueva instancia con los números principal, secundario, de |
||
| 50 | * compilación (opcional) y revisión (opcional). |
||
| 51 | * Para comprobar si la versión es válida, usar el método isValid. |
||
| 52 | * |
||
| 53 | * @param int $major Componente principal |
||
| 54 | * @param int $minor Componente secundario |
||
| 55 | * @param int|string|VersionComponent|null $build Componente de compilación |
||
| 56 | * @param int|string|VersionComponent|null $revision Componente de revisión |
||
| 57 | * |
||
| 58 | * @throws InvalidArgumentException |
||
| 59 | * */ |
||
| 60 | 28 | public function __construct(int $major, int $minor, $build = null, $revision = null) |
|
| 61 | { |
||
| 62 | 28 | parent::__construct(); |
|
| 63 | |||
| 64 | 28 | if ($major < 0) { |
|
| 65 | $args = [ |
||
| 66 | 1 | 'name' => 'major', |
|
| 67 | 1 | 'pos' => 0, |
|
| 68 | 1 | 'actual' => $major, |
|
| 69 | ]; |
||
| 70 | |||
| 71 | 1 | $msg = msg('Invalid argument value.'); |
|
| 72 | 1 | $msg .= msg( |
|
| 73 | 1 | ' "{name}" (position {pos}) must to be a positive number; "{actual}" given.', |
|
| 74 | 1 | $args |
|
| 75 | ); |
||
| 76 | |||
| 77 | 1 | throw new InvalidArgumentException($msg); |
|
| 78 | } |
||
| 79 | |||
| 80 | 27 | if ($minor < 0) { |
|
| 81 | $args = [ |
||
| 82 | 1 | 'name' => 'minor', |
|
| 83 | 1 | 'pos' => 1, |
|
| 84 | 1 | 'actual' => $minor, |
|
| 85 | ]; |
||
| 86 | |||
| 87 | 1 | $msg = msg('Invalid argument value.'); |
|
| 88 | 1 | $msg .= msg( |
|
| 89 | 1 | ' "{name}" (position {pos}) must to be a positive number; "{actual}" given.', |
|
| 90 | 1 | $args |
|
| 91 | ); |
||
| 92 | |||
| 93 | 1 | throw new InvalidArgumentException($msg); |
|
| 94 | } |
||
| 95 | |||
| 96 | 26 | $build = VersionComponent::parse($build); |
|
| 97 | 25 | $revision = VersionComponent::parse($revision); |
|
| 98 | |||
| 99 | 23 | $this->versionMetaData = compact('major', 'minor', 'build', 'revision'); |
|
| 100 | 23 | } |
|
| 101 | |||
| 102 | /** |
||
| 103 | * Convierte una cadena a su representación del tipo Version. |
||
| 104 | * |
||
| 105 | * @param Version|string|int|float|array $value Objeto a convertir. |
||
| 106 | * |
||
| 107 | * @return Version Objeto convertido desde $value. |
||
| 108 | * */ |
||
| 109 | 11 | public static function parse($value) : Version |
|
| 110 | { |
||
| 111 | 11 | if ($value instanceof Version) { |
|
| 112 | return $value; |
||
| 113 | } |
||
| 114 | |||
| 115 | 11 | $version = []; |
|
| 116 | |||
| 117 | // Try to convert into an array |
||
| 118 | 11 | if (is_integer($value)) { |
|
| 119 | // Integer for major value |
||
| 120 | $version = [$value, 0]; |
||
| 121 | 11 | } elseif (is_float($value)) { |
|
| 122 | // Integer part as major, and decimal part as minor |
||
| 123 | $version = sprintf('%F', $value); |
||
| 124 | $version = explode('.', $version); |
||
| 125 | 11 | } elseif (is_array($value)) { |
|
| 126 | // Implode first 4 places for major, minor, build and revision respectivally. |
||
| 127 | 5 | $version = array_slice($value, 0, 4); |
|
| 128 | 6 | } elseif (is_string($value)) { |
|
|
introduced
by
|
|||
| 129 | 6 | $version = explode('.', $value); |
|
| 130 | } else { |
||
| 131 | $msg = msg('Unable to parse. Argument passed has an invalid type: "{0}".', typeof($value)); |
||
| 132 | throw new InvalidArgumentException($msg); |
||
| 133 | } |
||
| 134 | |||
| 135 | // $value ya debería ser un array. |
||
| 136 | 11 | $c = count($version); |
|
| 137 | |||
| 138 | 11 | if ($c > 4 || $c < 2) { |
|
| 139 | 4 | $msg = msg('Unable to parse. Argument passed has an invalid format: "{0}".', $value); |
|
| 140 | 4 | throw new InvalidArgumentException($msg); |
|
| 141 | } |
||
| 142 | |||
| 143 | |||
| 144 | 9 | $major = (int) $version[0]; |
|
| 145 | 9 | $minor = (int) $version[1]; |
|
| 146 | 9 | $build = null; |
|
| 147 | 9 | $revision = null; |
|
| 148 | |||
| 149 | 9 | if (count($version) >= 3) { |
|
| 150 | 7 | $build = VersionComponent::parse($version[2]); |
|
| 151 | |||
| 152 | 7 | if (count($version) == 4) { |
|
| 153 | 1 | $revision = VersionComponent::parse($version[3]); |
|
| 154 | } |
||
| 155 | } |
||
| 156 | |||
| 157 | 9 | return new Version($major, $minor, $build, $revision); |
|
| 158 | } |
||
| 159 | |||
| 160 | /** |
||
| 161 | * Getter for major property. |
||
| 162 | * |
||
| 163 | * @return int |
||
| 164 | * @see Version::$major |
||
| 165 | */ |
||
| 166 | 42 | protected function getMajor() |
|
| 167 | { |
||
| 168 | 42 | return $this->versionMetaData['major']; |
|
| 169 | } |
||
| 170 | |||
| 171 | /** |
||
| 172 | * Getter for minor property. |
||
| 173 | * |
||
| 174 | * @return int |
||
| 175 | * @see Version::$minor |
||
| 176 | */ |
||
| 177 | 20 | protected function getMinor() |
|
| 178 | { |
||
| 179 | 20 | return $this->versionMetaData['minor']; |
|
| 180 | } |
||
| 181 | |||
| 182 | /** |
||
| 183 | * Getter for build property. |
||
| 184 | * |
||
| 185 | * @return VersionComponent |
||
| 186 | * @see Version::$build |
||
| 187 | */ |
||
| 188 | 32 | protected function getBuild() : VersionComponent |
|
| 189 | { |
||
| 190 | 32 | return $this->versionMetaData['build']; |
|
| 191 | } |
||
| 192 | |||
| 193 | /** |
||
| 194 | * Getter for revision property. |
||
| 195 | * |
||
| 196 | * @return VersionComponent |
||
| 197 | * @see Version::$revision |
||
| 198 | */ |
||
| 199 | 27 | protected function getRevision() : VersionComponent |
|
| 200 | { |
||
| 201 | 27 | return $this->versionMetaData['revision']; |
|
| 202 | } |
||
| 203 | |||
| 204 | |||
| 205 | /** |
||
| 206 | * Convierte la instancia actual en su representación en cadena. |
||
| 207 | * Por defecto, si no están definidos los componentes de compilación y |
||
| 208 | * revisión, no se incluyen en la salida. |
||
| 209 | * Use el método isValid si quiere determinar si la versión es válida |
||
| 210 | * antes de devolver esta cadena. |
||
| 211 | * |
||
| 212 | * @return string Representación de la versión en forma de cadena: |
||
| 213 | * 'major.minor[.build[.revision]]' |
||
| 214 | * @see VersionComponent::isNull() |
||
| 215 | * @see Version::isValid() |
||
| 216 | * */ |
||
| 217 | 8 | public function toString() : string |
|
| 233 | } |
||
| 234 | |||
| 235 | /** |
||
| 236 | * Indica si la instancia actual es un número de versión válido. |
||
| 237 | * |
||
| 238 | * Se considera válido si: |
||
| 239 | * 1. major o minor es mayor a cero (0). No puede ser '0.0'. |
||
| 240 | * 2. build y revision son nulos (no están definidos). |
||
| 241 | * 3. build está definido pero revision no. |
||
| 242 | * 4. Ambos están definidos, pero no poseen la parte de la cadena. |
||
| 243 | * 5. Ambos están definidos, pero build no posee la parte de cadena. |
||
| 244 | * 6. build está definido y tiene la cadena, pero revision no está definido. |
||
| 245 | * 7. revision posee cadena, pero build no. |
||
| 246 | * |
||
| 247 | * @return bool Un valor que indica si la instancia actual es válida. |
||
| 248 | * */ |
||
| 249 | 16 | public function isValid() : bool |
|
| 285 | } |
||
| 286 | |||
| 287 | /** |
||
| 288 | * Indicates whether the specified object is equal to the current instance. |
||
| 289 | * |
||
| 290 | * @param Version|mixed $other The other object to compare with. |
||
| 291 | * |
||
| 292 | * @return bool |
||
| 293 | * */ |
||
| 294 | 33 | public function equals($other) : bool |
|
| 295 | { |
||
| 296 | 33 | if ($other instanceof Version) { |
|
| 297 | 25 | if ($this->major == $other->major && $this->minor == $other->minor) { |
|
| 298 | 16 | if ($this->build->equals($other->build)) { |
|
| 299 | 11 | if ($this->revision->equals($other->revision)) { |
|
| 300 | 10 | return true; |
|
| 301 | } |
||
| 302 | } |
||
| 303 | } |
||
| 304 | } |
||
| 305 | |||
| 306 | 30 | return false; |
|
| 307 | } |
||
| 308 | |||
| 309 | |||
| 310 | // region IComparable |
||
| 311 | |||
| 312 | /** |
||
| 313 | * Determina la posición relativa de esta instancia con respecto al objeto especificado. |
||
| 314 | * |
||
| 315 | * For types different than `Version` (`null`, unparseable `string` and other value types) are considered lower |
||
| 316 | * than `Version`. |
||
| 317 | * |
||
| 318 | * @param Version|string|mixed $other The other object to compare with. If this is of type `string`, it will |
||
| 319 | * try to convert to a `Version` object before the comparation. |
||
| 320 | * |
||
| 321 | * @return int|null |
||
| 322 | * - ``= 0`` if this instance is considered equivalent to $other; |
||
| 323 | * - ``> 0`` si esta instancia se considera mayor a $other; |
||
| 324 | * - ``< 0`` si esta instancia se considera menor a $other. |
||
| 325 | * - ``null`` if this instance can't be compared against $other . |
||
| 326 | * @see \NelsonMartell\Extensions\Objects::compare() |
||
| 327 | * */ |
||
| 328 | 25 | public function compareTo($other) |
|
| 366 | } |
||
| 367 | |||
| 370 |
Loading history...