libgraviton /
graviton
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 DocumentMap 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 DocumentMap, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 17 | class DocumentMap |
||
| 18 | { |
||
| 19 | /** |
||
| 20 | * @var array |
||
| 21 | */ |
||
| 22 | private $mappings = []; |
||
| 23 | /** |
||
| 24 | * @var Document[] |
||
| 25 | */ |
||
| 26 | private $documents = []; |
||
| 27 | |||
| 28 | /** |
||
| 29 | * Constructor |
||
| 30 | * |
||
| 31 | * @param Finder $doctrineFinder Doctrine mapping finder |
||
| 32 | * @param Finder $serializerFinder Serializer mapping finder |
||
| 33 | * @param Finder $validationFinder Validation mapping finder |
||
| 34 | */ |
||
| 35 | public function __construct(Finder $doctrineFinder, Finder $serializerFinder, Finder $validationFinder) |
||
| 49 | |||
| 50 | /** |
||
| 51 | * Get document |
||
| 52 | * |
||
| 53 | * @param string $className Document class |
||
| 54 | * @return Document |
||
| 55 | */ |
||
| 56 | public function getDocument($className) |
||
| 57 | { |
||
| 58 | if (isset($this->documents[$className])) { |
||
| 59 | return $this->documents[$className]; |
||
| 60 | } |
||
| 61 | if (!isset($this->mappings[$className])) { |
||
| 62 | throw new \InvalidArgumentException(sprintf('No XML mapping found for document "%s"', $className)); |
||
| 63 | } |
||
| 64 | |||
| 65 | return $this->documents[$className] = $this->processDocument( |
||
| 66 | $className, |
||
| 67 | $this->mappings[$className]['doctrine'], |
||
| 68 | $this->mappings[$className]['serializer'], |
||
| 69 | $this->mappings[$className]['validation'] |
||
| 70 | ); |
||
| 71 | } |
||
| 72 | |||
| 73 | /** |
||
| 74 | * Get all documents |
||
| 75 | * |
||
| 76 | * @return Document[] |
||
| 77 | */ |
||
| 78 | public function getDocuments() |
||
| 82 | |||
| 83 | /** |
||
| 84 | * Process document |
||
| 85 | * |
||
| 86 | * @param string $className Class name |
||
| 87 | * @param \DOMElement $doctrineMapping Doctrine XML mapping |
||
| 88 | * @param \DOMElement $serializerMapping Serializer XML mapping |
||
|
|
|||
| 89 | * @param \DOMElement $validationMapping Validation XML mapping |
||
| 90 | * @return Document |
||
| 91 | */ |
||
| 92 | private function processDocument( |
||
| 93 | $className, |
||
| 94 | \DOMElement $doctrineMapping, |
||
| 95 | \DOMElement $serializerMapping = null, |
||
| 96 | \DOMElement $validationMapping = null |
||
| 97 | ) { |
||
| 98 | if ($serializerMapping === null) { |
||
| 99 | $serializerFields = []; |
||
| 100 | } else { |
||
| 101 | $serializerFields = array_reduce( |
||
| 102 | $this->getSerializerFields($serializerMapping), |
||
| 103 | function (array $fields, array $field) { |
||
| 104 | $fields[$field['fieldName']] = $field; |
||
| 105 | return $fields; |
||
| 106 | }, |
||
| 107 | [] |
||
| 108 | ); |
||
| 109 | } |
||
| 110 | |||
| 111 | if ($validationMapping === null) { |
||
| 112 | $validationFields = []; |
||
| 113 | } else { |
||
| 114 | $validationFields = array_reduce( |
||
| 115 | $this->getValidationFields($validationMapping), |
||
| 116 | function (array $fields, array $field) { |
||
| 117 | $fields[$field['fieldName']] = $field; |
||
| 118 | return $fields; |
||
| 119 | }, |
||
| 120 | [] |
||
| 121 | ); |
||
| 122 | } |
||
| 123 | |||
| 124 | $fields = []; |
||
| 125 | foreach ($this->getDoctrineFields($doctrineMapping) as $doctrineField) { |
||
| 126 | $serializerField = isset($serializerFields[$doctrineField['name']]) ? |
||
| 127 | $serializerFields[$doctrineField['name']] : |
||
| 128 | null; |
||
| 129 | $validationField = isset($validationFields[$doctrineField['name']]) ? |
||
| 130 | $validationFields[$doctrineField['name']] : |
||
| 131 | null; |
||
| 132 | |||
| 133 | if ($doctrineField['type'] === 'collection') { |
||
| 134 | $fields[] = new ArrayField( |
||
| 135 | $serializerField === null ? 'array<string>' : $serializerField['fieldType'], |
||
| 136 | $doctrineField['name'], |
||
| 137 | $serializerField === null ? $doctrineField['name'] : $serializerField['exposedName'], |
||
| 138 | $serializerField === null ? false : $serializerField['readOnly'], |
||
| 139 | $validationField === null ? false : $validationField['required'], |
||
| 140 | $serializerField === null ? false : $serializerField['searchable'] |
||
| 141 | ); |
||
| 142 | } else { |
||
| 143 | $fields[] = new Field( |
||
| 144 | $doctrineField['type'], |
||
| 145 | $doctrineField['name'], |
||
| 146 | $serializerField === null ? $doctrineField['name'] : $serializerField['exposedName'], |
||
| 147 | $serializerField === null ? false : $serializerField['readOnly'], |
||
| 148 | $validationField === null ? false : $validationField['required'], |
||
| 149 | $serializerField === null ? false : $serializerField['searchable'] |
||
| 150 | ); |
||
| 151 | } |
||
| 152 | } |
||
| 153 | foreach ($this->getDoctrineEmbedOneFields($doctrineMapping) as $doctrineField) { |
||
| 154 | $serializerField = isset($serializerFields[$doctrineField['name']]) ? |
||
| 155 | $serializerFields[$doctrineField['name']] : |
||
| 156 | null; |
||
| 157 | $validationField = isset($validationFields[$doctrineField['name']]) ? |
||
| 158 | $validationFields[$doctrineField['name']] : |
||
| 159 | null; |
||
| 160 | |||
| 161 | $fields[] = new EmbedOne( |
||
| 162 | $this->getDocument($doctrineField['type']), |
||
| 163 | $doctrineField['name'], |
||
| 164 | $serializerField === null ? $doctrineField['name'] : $serializerField['exposedName'], |
||
| 165 | $serializerField === null ? false : $serializerField['readOnly'], |
||
| 166 | $validationField === null ? false : $validationField['required'], |
||
| 167 | $serializerField === null ? false : $serializerField['searchable'] |
||
| 168 | ); |
||
| 169 | } |
||
| 170 | foreach ($this->getDoctrineEmbedManyFields($doctrineMapping) as $doctrineField) { |
||
| 171 | $serializerField = isset($serializerFields[$doctrineField['name']]) ? |
||
| 172 | $serializerFields[$doctrineField['name']] : |
||
| 173 | null; |
||
| 174 | $validationField = isset($validationFields[$doctrineField['name']]) ? |
||
| 175 | $validationFields[$doctrineField['name']] : |
||
| 176 | null; |
||
| 177 | |||
| 178 | $fields[] = new EmbedMany( |
||
| 179 | $this->getDocument($doctrineField['type']), |
||
| 180 | $doctrineField['name'], |
||
| 181 | $serializerField === null ? $doctrineField['name'] : $serializerField['exposedName'], |
||
| 182 | $serializerField === null ? false : $serializerField['readOnly'], |
||
| 183 | $validationField === null ? false : $validationField['required'] |
||
| 184 | ); |
||
| 185 | } |
||
| 186 | |||
| 187 | return new Document($className, $fields); |
||
| 188 | } |
||
| 189 | |||
| 190 | /** |
||
| 191 | * Load doctrine class map |
||
| 192 | * |
||
| 193 | * @param Finder $finder Mapping finder |
||
| 194 | * @return array |
||
| 195 | */ |
||
| 196 | View Code Duplication | private function loadDoctrineClassMap(Finder $finder) |
|
| 197 | { |
||
| 198 | $classMap = []; |
||
| 199 | foreach ($finder as $file) { |
||
| 200 | $document = new \DOMDocument(); |
||
| 201 | $document->load($file); |
||
| 202 | |||
| 203 | $xpath = new \DOMXPath($document); |
||
| 204 | $xpath->registerNamespace('doctrine', 'http://doctrine-project.org/schemas/odm/doctrine-mongo-mapping'); |
||
| 205 | |||
| 206 | $classMap = array_reduce( |
||
| 207 | iterator_to_array($xpath->query('//*[self::doctrine:document or self::doctrine:embedded-document]')), |
||
| 208 | function (array $classMap, \DOMElement $element) { |
||
| 209 | $classMap[$element->getAttribute('name')] = $element; |
||
| 210 | return $classMap; |
||
| 211 | }, |
||
| 212 | $classMap |
||
| 213 | ); |
||
| 214 | } |
||
| 215 | |||
| 216 | return $classMap; |
||
| 217 | } |
||
| 218 | |||
| 219 | /** |
||
| 220 | * Load serializer class map |
||
| 221 | * |
||
| 222 | * @param Finder $finder Mapping finder |
||
| 223 | * @return array |
||
| 224 | */ |
||
| 225 | View Code Duplication | private function loadSerializerClassMap(Finder $finder) |
|
| 226 | { |
||
| 227 | $classMap = []; |
||
| 228 | foreach ($finder as $file) { |
||
| 229 | $document = new \DOMDocument(); |
||
| 230 | $document->load($file); |
||
| 231 | |||
| 232 | $xpath = new \DOMXPath($document); |
||
| 233 | |||
| 234 | $classMap = array_reduce( |
||
| 235 | iterator_to_array($xpath->query('//class')), |
||
| 236 | function (array $classMap, \DOMElement $element) { |
||
| 237 | $classMap[$element->getAttribute('name')] = $element; |
||
| 238 | return $classMap; |
||
| 239 | }, |
||
| 240 | $classMap |
||
| 241 | ); |
||
| 242 | } |
||
| 243 | |||
| 244 | return $classMap; |
||
| 245 | } |
||
| 246 | |||
| 247 | /** |
||
| 248 | * Load validation class map |
||
| 249 | * |
||
| 250 | * @param Finder $finder Mapping finder |
||
| 251 | * @return array |
||
| 252 | */ |
||
| 253 | View Code Duplication | private function loadValidationClassMap(Finder $finder) |
|
| 254 | { |
||
| 255 | $classMap = []; |
||
| 256 | foreach ($finder as $file) { |
||
| 257 | $document = new \DOMDocument(); |
||
| 258 | $document->load($file); |
||
| 259 | |||
| 260 | $xpath = new \DOMXPath($document); |
||
| 261 | $xpath->registerNamespace('constraint', 'http://symfony.com/schema/dic/constraint-mapping'); |
||
| 262 | |||
| 263 | $classMap = array_reduce( |
||
| 264 | iterator_to_array($xpath->query('//constraint:class')), |
||
| 265 | function (array $classMap, \DOMElement $element) { |
||
| 266 | $classMap[$element->getAttribute('name')] = $element; |
||
| 267 | return $classMap; |
||
| 268 | }, |
||
| 269 | $classMap |
||
| 270 | ); |
||
| 271 | } |
||
| 272 | |||
| 273 | return $classMap; |
||
| 274 | } |
||
| 275 | |||
| 276 | /** |
||
| 277 | * Get serializer fields |
||
| 278 | * |
||
| 279 | * @param \DOMElement $mapping Serializer XML mapping |
||
| 280 | * @return array |
||
| 281 | */ |
||
| 282 | private function getSerializerFields(\DOMElement $mapping) |
||
| 283 | { |
||
| 284 | $xpath = new \DOMXPath($mapping->ownerDocument); |
||
| 285 | |||
| 286 | return array_map( |
||
| 287 | function (\DOMElement $element) { |
||
| 288 | return [ |
||
| 289 | 'fieldName' => $element->getAttribute('name'), |
||
| 290 | 'fieldType' => $this->getSerializerFieldType($element), |
||
| 291 | 'exposedName' => $element->getAttribute('serialized-name') ?: $element->getAttribute('name'), |
||
| 292 | 'readOnly' => $element->getAttribute('read-only') === 'true', |
||
| 293 | 'searchable' => $element->getAttribute('searchable') === 'true', |
||
| 294 | ]; |
||
| 295 | }, |
||
| 296 | iterator_to_array($xpath->query('property', $mapping)) |
||
| 297 | ); |
||
| 298 | } |
||
| 299 | |||
| 300 | /** |
||
| 301 | * Get serializer field type |
||
| 302 | * |
||
| 303 | * @param \DOMElement $field Field node |
||
| 304 | * @return string|null |
||
| 305 | */ |
||
| 306 | private function getSerializerFieldType(\DOMElement $field) |
||
| 317 | |||
| 318 | /** |
||
| 319 | * Get validation fields |
||
| 320 | * |
||
| 321 | * @param \DOMElement $mapping Validation XML mapping |
||
| 322 | * @return array |
||
| 323 | */ |
||
| 324 | private function getValidationFields(\DOMElement $mapping) |
||
| 340 | |||
| 341 | /** |
||
| 342 | * Get doctrine document fields |
||
| 343 | * |
||
| 344 | * @param \DOMElement $mapping Doctrine XML mapping |
||
| 345 | * @return array |
||
| 346 | */ |
||
| 347 | View Code Duplication | private function getDoctrineFields(\DOMElement $mapping) |
|
| 362 | |||
| 363 | /** |
||
| 364 | * Get doctrine document embed-one fields |
||
| 365 | * |
||
| 366 | * @param \DOMElement $mapping Doctrine XML mapping |
||
| 367 | * @return array |
||
| 368 | */ |
||
| 369 | View Code Duplication | private function getDoctrineEmbedOneFields(\DOMElement $mapping) |
|
| 384 | |||
| 385 | /** |
||
| 386 | * Get doctrine document embed-many fields |
||
| 387 | * |
||
| 388 | * @param \DOMElement $mapping Doctrine XML mapping |
||
| 389 | * @return array |
||
| 390 | */ |
||
| 391 | View Code Duplication | private function getDoctrineEmbedManyFields(\DOMElement $mapping) |
|
| 406 | } |
||
| 407 |
Loading history...
This check looks for
@paramannotations where the type inferred by our type inference engine differs from the declared type.It makes a suggestion as to what type it considers more descriptive.
Most often this is a case of a parameter that can be null in addition to its declared types.